diff --git a/docs/README-old.md b/docs/README-old.md index 3d6b7ff..ceb1c4e 100644 --- a/docs/README-old.md +++ b/docs/README-old.md @@ -10,7 +10,7 @@ The source code is partly based on the Deviation TX project, thanks to all the d **To download the latest compiled version (hex file), click on [Release](https://github.com/pascallanger/DIY-Multiprotocol-TX-Module/releases) on the top menu.** -##Contents +## Contents [Compatible TX](https://github.com/pascallanger/DIY-Multiprotocol-TX-Module#compatible-tx) @@ -22,9 +22,9 @@ The source code is partly based on the Deviation TX project, thanks to all the d [Troubleshooting](https://github.com/pascallanger/DIY-Multiprotocol-TX-Module#troubleshooting) -##Compatible TX +## Compatible TX -###Using standard PPM output (trainer port) +### Using standard PPM output (trainer port) The multiprotocol TX module can be used on any TX with a trainer port. Channels order is AETR by default but can be changed in the _Config.h. @@ -44,7 +44,7 @@ Settings per selection are located in _Config.h: - Option: -127..+127 allowing to set specific protocol options. Like for Hubsan to set the video frequency. - Autobind: Yes or No. At the model selection (or power applied to the TX) a bind sequence will be initiated -###Using a serial output +### Using a serial output The multiprotocol TX module takes full advantage of being used on a Turnigy 9X, 9XR, 9XR Pro, Taranis, 9Xtreme, AR9X, ... running [er9x](http://openrcforums.com/forum/viewtopic.php?f=5&t=4598) or [ersky9X](http://openrcforums.com/forum/viewtopic.php?f=7&t=4676). An OpenTX version for Taranis is available [here](http://plaisthos.de/opentx/). This enables full integration using the radio GUI to setup models with all the available protocols options. @@ -65,7 +65,7 @@ Notes: - There are 2 versions of serial protocol either 8 or 16 channels. 16 channels is the latest and only available version going forward. Make sure to use the right version based on your version of er9x/ersky9x. - Channels order is AETR by default but can be changed in _Config.h. -###Telemetry +### Telemetry There are 4 protocols supporting telemetry: Hubsan, DSM, FrSkyD and FrSkyX. @@ -94,9 +94,9 @@ Enabling telemetry on a 9XR PRO and may be other TXs does not require any hardwa Once the TX is telemetry enabled, it just needs to be configured on the model (see er9x/ersky9x documentation). -##Protocols +## Protocols -###TX ID +### TX ID The multiprotocol TX module is using a 32bits ID generated randomly at first power up. This global ID is used by nearly all protocols. There are little chances to get a duplicated ID. @@ -104,7 +104,7 @@ For DSM2/X and Devo the CYRF6936 unique manufacturer ID is used. It's possible to generate a new ID using bind button on the Hubsan protocol during power up. -###Bind +### Bind To bind a model in PPM Mode press the physical bind button, apply power and then release. In Serial Mode you have 2 options: @@ -115,9 +115,9 @@ Notes: - the physical bind button is only effective at power up. Pressing the button later has no effects. - a bind in progress is indicated by the LED fast blinking. Make sure to bind during this period. -###Protocol selection +### Protocol selection -####Using the dial for PPM input +#### Using the dial for PPM input PPM is only allowing access to a subset of existing protocols. The protocols, subprotocols and all other settings can be personalized by modifying the **_Config.h** file. @@ -145,10 +145,10 @@ Dial|Protocol|Sub_protocol|RX Num|Power|Auto Bind|Option|RF Module Note: - The dial selection must be done before the power is applied. -####Using serial input with er9x/ersky9x +#### Using serial input with er9x/ersky9x Serial is allowing access to all existing protocols & sub_protocols listed below. -#####A7105 RF module +##### A7105 RF module Protocol|Sub_protocol --------|------------ Flysky| @@ -158,7 +158,7 @@ Flysky| |V912 Hubsan| -#####CC2500 RF module +##### CC2500 RF module Protocol|Sub_protocol --------|------------ FrSkyV| @@ -168,7 +168,7 @@ FrSkyX| |CH_8 SFHSS| -#####CYRF6936 RF module +##### CYRF6936 RF module Protocol|Sub_protocol --------|------------ DSM| @@ -177,7 +177,7 @@ DSM| Devo| J6Pro| -#####NRF24L01 RF module +##### NRF24L01 RF module Protocol|Sub_protocol --------|------------ Hisky| @@ -235,12 +235,12 @@ HONTAI| Note: - The dial should be set to 0 for serial. Which means all protocol selection pins should be left unconnected. -###Protocols details +### Protocols details **Check the [Protocols_Details.md](./Protocols_Details.md) file for a detailed description of every protocols with channels assignements.** -##Hardware +## Hardware -###RF modules +### RF modules Up to 4 RF modules can be installed: - [A7105](http://www.banggood.com/XL7105-D03-A7105-Modification-Module-Support-Deviation-Galee-Flysky-p-922603.html) for Flysky, Hubsan - [CC2500](http://www.banggood.com/CC2500-PA-LNA-Romote-Wireless-Module-CC2500-SI4432-NRF24L01-p-922595.html) for FrSkyV, FrSkyD, FrSkyX and SFHSS @@ -251,21 +251,21 @@ RF modules can be installed for protocols need only. Example: if you only need t You also need some [antennas](http://www.banggood.com/2_4GHz-3dBi-RP-SMA-Connector-Booster-Wireless-Antenna-Modem-Router-p-979407.html) and [cables](http://www.banggood.com/10cm-PCI-UFL-IPX-to-RPSMA-Female-Jack-Pigtail-Cable-p-924933.html). -###Board +### Board The main program is running on an ATMEGA328p running @16MHz and 3.3V. An [Arduino pro mini 16Mhz/5V](http://www.banggood.com/Wholesale-New-Ver-Pro-Mini-ATMEGA328-328p-5V-16MHz-Arduino-Compatible-Nano-Size-p-68534.html) powered at 3.3V (yes it works) can be used to build your own Multimodule. An Arduino Mini based on Atmega328p can also be used. -####Using stripboard: +#### Using stripboard: ![Screenshot](http://static.rcgroups.net/forums/attachments/4/0/8/5/8/3/t8214655-87-thumb-uploadfromtaptalk1405598143749.jpg?d=1441459923) ![Screenshot](http://static.rcgroups.net/forums/attachments/4/0/8/5/8/3/t8214656-102-thumb-uploadfromtaptalk1405598152484.jpg?d=1441459924) -####Using a [home made PCB](http://www.rcgroups.com/forums/showpost.php?p=32645328&postcount=1621): +#### Using a [home made PCB](http://www.rcgroups.com/forums/showpost.php?p=32645328&postcount=1621): ![Screenshot](http://static.rcgroups.net/forums/attachments/1/1/5/4/3/7/t8226720-197-thumb-IMG_20150715_230603155.jpg?d=1441816457) ![Screenshot](http://static.rcgroups.net/forums/attachments/1/1/5/4/3/7/t8226719-72-thumb-IMG_20150715_230024065.jpg?d=1441816456) -####Build your own board using [SMD components](http://www.rcgroups.com/forums/showpost.php?p=31064232&postcount=1020) and an [associated PCB v2.3c](https://oshpark.com/shared_projects/MaGYDg0y): +#### Build your own board using [SMD components](http://www.rcgroups.com/forums/showpost.php?p=31064232&postcount=1020) and an [associated PCB v2.3c](https://oshpark.com/shared_projects/MaGYDg0y): ![Screenshot](http://static.rcgroups.net/forums/attachments/4/0/8/5/8/3/t7566755-3-thumb-i.png?d=1423810885) ![Screenshot](http://static.rcgroups.net/forums/attachments/4/0/8/5/8/3/t7952726-108-thumb-image-62c29cf2.jpg?d=1433909893) @@ -284,7 +284,7 @@ lines through them. [OSH Park link](https://oshpark.com/shared_projects/Ztus1ah8) if you want to order. -####Buy a ready to use and complete Multi module +#### Buy a ready to use and complete Multi module ![Screenshot](http://img.banggood.com/thumb/view/oaupload/banggood/images/1D/EB/19bb6434-4616-411e-b8fa-a4c21d9dca24.jpg) This module can be purchased [here](http://www.banggood.com/2_4G-CC2500-A7105-Flysky-Frsky-Devo-DSM2-Multiprotocol-TX-Module-With-Antenna-p-1048377.html). All the 4 RF modules are already implemented A7105, NRF24L01, CC2500 and CYRF6936. The board is also equiped with an antenna switcher which means only one antenna for all. @@ -299,14 +299,14 @@ If you want to enable serial mode for er9x/ersky9x/Taranis/... and depending on Note: if you have the 1st board revision (check pictures above), sometime bind occures at power up even without pressing the bind button or not having an autobind protocol. To solve this issue, replacing the BIND led resistor (on the board back) of 1.2K by a 4.7K. -###Schematic +### Schematic ![Screenshot](http://static.rcgroups.net/forums/attachments/4/0/8/5/8/3/a8443844-119-multiprotocol_diagram_rotary_serial_2.jpg) Notes: - Attention: All modules are 3.3V only, never power them with 5V. - For serial, the dial switch is not needed and the bind button optionnal -###Radio integration +### Radio integration If you build your own version of the board you can 3D print this case (details [here](http://www.rcgroups.com/forums/showpost.php?p=33294140&postcount=2034)): ![Screenshot](http://static.rcgroups.net/forums/attachments/1/1/5/4/3/7/t8462144-54-thumb-Multi_case_9XR.jpg?d=1448575289) @@ -318,9 +318,9 @@ If you have the Banggood ready to use board you can 3D print this case (details -##Compilation and programmation +## Compilation and programmation -###Toolchain +### Toolchain Multiprotocol source can be compiled using the Arduino IDE. The currently supported Arduino version is [1.6.10](https://www.arduino.cc/download_handler.php?f=/arduino-1.6.10-windows.exe). @@ -335,7 +335,7 @@ Notes: - Compilation of the code posted here works. So if it doesn't for you this is a problem with your setup, please double check everything before asking. - If you want to reduce the code size even further, you can modify the file platform.txt located in "C:\Program Files (x86)\Arduino\hardware\arduino\avr". Set the line "compiler.c.elf.extra_flags=" to "compiler.c.elf.extra_flags=-Wl,--relax". -###Upload the code using ISP (In System Programming) +### Upload the code using ISP (In System Programming) It is recommended to use an external programmer like [USBASP](http://www.banggood.com/USBASP-USBISP-3_3-5V-AVR-Downloader-Programmer-With-ATMEGA8-ATMEGA128-p-934425.html) to upload the code in the Atmega328. The programmer should be set to 3.3V or nothing to not supply any over voltage to the multimodule and avoid any damages. The dial must be set to 0 before flashing! @@ -344,7 +344,7 @@ From the Arduino environment, you can use this shortcut to compile and upload to To flash the latest provided hex file under [Release](https://github.com/pascallanger/DIY-Multiprotocol-TX-Module/releases), you can use a tool like [AVR Burn-O-Mat](http://avr8-burn-o-mat.aaabbb.de/), set the microcontroller to m328p and flash it. -###Upload the code using FTDI (USB serial to TTL) +### Upload the code using FTDI (USB serial to TTL) Use this method only for Arduino Pro Mini boards with bootloader. Use an external FTDI adapter like [this one](http://www.banggood.com/FT232RL-FTDI-USB-To-TTL-Serial-Converter-Adapter-Module-For-Arduino-p-917226.html). @@ -355,7 +355,7 @@ From the Arduino environment, you can use Upload button which will compile and u To upload the latest provided hex file under [Release](https://github.com/pascallanger/DIY-Multiprotocol-TX-Module/releases), you can use a tool like [XLoader](http://russemotto.com/xloader/), set the microcontroller to Atmega328 and upload it. -###Set fuses +### Set fuses Use a tool like [AVR Burn-O-Mat](http://avr8-burn-o-mat.aaabbb.de/) to set the fuses of the Atmega328 to: - Extended Fuse 0x05 (or 0xFD which is the same) - High Fuse 0xD2 @@ -363,25 +363,25 @@ Use a tool like [AVR Burn-O-Mat](http://avr8-burn-o-mat.aaabbb.de/) to set the f This will make sure your ATMEGA328 is well configured and the global TX ID is not erased at each updates. -##Troubleshooting +## Troubleshooting -###LED status +### LED status - off: program not running or a protocol selected with the associated module not installed. - flash(on=0.1s,off=1s): invalid protocol selected (excluded from compilation or invalid protocol number) - slow blink(on=0.5s,off=0.5s): serial has been selected but no valid signal has been seen on the RX pin. - fast blink(on=0.1s,off=0.1s): bind in progress. - on: normal operation. -###Protocol selection -####Input Mode - PPM +### Protocol selection +#### Input Mode - PPM - The protocol/mode selection must be done before the power is applied. - Connect 1 to 4 of the selection protocol pins to GND. -####Input Mode - Serial +#### Input Mode - Serial - Make sure you have done the mods to the v2.3c PCB by adding the 2.2k and 470 ohm resistors as indicated in the [Board section] (https://github.com/pascallanger/DIY-Multiprotocol-TX-Module#board). - Leave all 4 selection pins unconnected. -###Bind +### Bind Make sure to follow this procedure: press the bind button, apply power and then release it after 1sec. The LED should be blinking fast indicating a bind status and then fixed on when the bind period is over. It's normal that the LED turns off when you press the bind button, this behavior is not controlled by the Atmega328. For serial, the preffered method is to bind via the GUI protocol page. @@ -389,7 +389,7 @@ If your module is always/sometime binding at power up without pressing the butto - Arduino Pro Mini with an external status LED: to work around this issue connect a 10K resistor between D13 and 3.3V. - 4in1 module V1 (check 4in1 pictures): to solve this issue, replacing the BIND led resistor (on the board back) of 1.2K by a 4.7K. -###Report issues +### Report issues You can report your problem using the [GitHub issue](https://github.com/pascallanger/DIY-Multiprotocol-TX-Module/issues) system or go to the [Main thread on RCGROUPS](http://www.rcgroups.com/forums/showthread.php?t=2165676) to ask your question. Please provide the following information: - Multiprotocol code version