Merge branch 'master' of https://github.com/pascallanger/DIY-Multiprotocol-TX-Module

BootLoaders/README.md

@@ -1,5 +1,5 @@
 # Arduino IDE board definitions for Multi 4-in-1
-Board definitions are available for both the Atmega328p and STM32F103C boards.  The board definitions make it easier to compile and install the multiprotocol module firmware.
+Board definitions are available for the Atmega328p, STM32, and OrangeRX modules.  The board definitions make it easier to compile and install the multiprotocol module firmware.
 
 ## Installing
 The board definitions are installed using the Arduino IDE Boards Manager.
@@ -32,13 +32,15 @@ The board definitions are installed using the Arduino IDE Boards Manager.
 ## Verify the boards are installed
 1. Click **Tools -> Board**
 2. Scroll down the list to the **Multi 4-in-1** board headings verify that the boards you installed are available:
-  * **Multi 4-in-1 (Atmega328p, 3.3V, 16MHz)** for the Atmega board
-  * **Multi 4-in-1 (STM32F103CB)** for the STM32 board
-  
-    ![Image of Yaktocat](/docs/images/boards-menu.jpg)
+    ![Image](/docs/images/boards-menu.jpg)
+    
+    * **Multi 4-in-1 (Atmega328p, 3.3V, 16MHz)** for the Atmega module
+    * **Multi 4-in-1 (STM32F103CB)** for the STM32 module
+    * **Multi 4-in-1 (OrangeRX)** for the OrangeRX module
 
 ## Compiling and Uploading
 Refer to the hardware-specific pages for information on compiling the firmware and uploading it to the multiprotocol module:
 
 * [Compiling for Atmega](/docs/Compiling.md)
 * [Compiling for STM32](/docs/Compiling_STM32.md)
+* [Compiling for OrangeRX](/docs/Compiling_OrangeTx.md)

Protocols_Details.md

@@ -377,8 +377,6 @@ CH1|CH2|CH3|CH4|CH5|CH6|CH7|CH8
 The transmitter must be close to the receiver while binding.
 
 ## BAYANG - *14*
-Models: EAchine H8(C) mini, BayangToys X6/X7/X9, JJRC JJ850, Floureon H101 ...
-
 Autobind protocol
 
 CH1|CH2|CH3|CH4|CH5|CH6|CH7|CH8|CH9|CH10|CH11
@@ -388,6 +386,8 @@ A|E|T|R|FLIP|RTH|PICTURE|VIDEO|HEADLESS|INVERTED|RATE
 RATE: -100%(default)=>higher rates by enabling dynamic trims (except for Headless), 100%=>disable dynamic trims
 
 ### Sub_protocol BAYANG - *0*
+Models: EAchine H8(C) mini, BayangToys X6/X7/X9, JJRC JJ850, Floureon H101 ...
+
 Option=0 -> normal Bayang protocol
 
 Option=1 -> enable telemetry with [Silverxxx firmware](https://github.com/silver13/H101-acro/tree/master). Value returned to the TX using FrSkyD Hub are RX RSSI, TX RSSI, A1=uncompensated battery voltage, A2=compensated battery voltage
@@ -400,9 +400,9 @@ Same channels assignement as above.
 ### Sub_protocol X16_AH - *2*
 Model: X16 AH
 
-CH12
-----
-TAKE_OFF
+CH12|
+----|
+TAKE_OFF|
 
 ### Sub_protocol IRDRONE - *3*
 Model: IRDRONE

README.md

@@ -23,15 +23,15 @@ If you like this project and want to support further development please consider
 * [Available Protocols list](Protocols_Details.md)
 * [The old documentation](docs/README-old.md)
 
-
 ## Outline of the documentation
 1. Introduction (this page)
 1. [Available protocols](Protocols_Details.md)
 1. [Transmitters and serial/telemetry options](docs/Transmitters.md)
 1. [Module Hardware options](docs/Hardware.md)
 1. Compiling and programming the module
-    * [4in1/DIY Multiprotocol module based on ATmega328](docs/Compiling.md)
-    * [DIY Multiprotocol module based on STM32](docs/Compiling_STM32.md)
+    * [Atmega328p Multiprotocol Module](docs/Compiling.md)
+    * [STM32 Multiprotocol Module](docs/Compiling_STM32.md)
+    * [OrangeRX Module](docs/Compiling_OrangeTx.md)
 1. [Transmitter Setup](docs/Transmitters.md) 
 1. [How to for popular models](docs/Models.md)
 1. [Troubleshooting](docs/Troubleshooting.md)

docs/Troubleshooting.md

@@ -31,6 +31,9 @@
 - Make sure you have done the serial mods as indicated in the [hardware page for your board](Hardware.md).
 - Protocol selection dial must be in the 0 position or leave all 4 selection pins unconnected.
 - Often the signal is not sent to the module until the transmitter has performed safety checks (like switch and throttle position settings)
+- The protocols/subprotocols names which appear on the OpenTX/er9x/ersky9x radios are only based on the radio firmware version. The module does not send this information. You likely have to upgrade your radio firmware to get all the latest.
+  - For ersky9x radios, you can update the protocols list by placing the file [Multi.txt](/Multiprotocol/Multi.txt) at the root of the SD card. This feature is not supported by OpenTX.
+  - Even if not listed on the radio you can still access protocols/subprotcols by using their numbers as given on the [Protocol page](/Protocols_Details.md).
 
 ## Bind
 
@@ -40,11 +43,15 @@ For serial, the preffered method is to bind via the GUI protocol page.
 If your module is always/sometime binding at power up without pressing the button:
  - 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.
+ - check that your module case is not pressing the bind button.
 
-FrSky & SFHSS bind issues are ususally due to Option=fine frequency tuning not set properly. This value is different for each Module. To determine this value:
+
+FrSky & SFHSS bind issues, heratic moves and telemetry losses are ususally due to Option=fine frequency tuning not set properly. This value is different for each RF module and some RXs. To determine this value:
  - find a value where the RX accepts to bind. A good start is to use one of these values -40, 0 and 40.
  - find the values min/max where the RX loses connection. In serial mode you can change the value and see the effect live.
- - set the value to half way between min and max.
+ - set the value to half way between min and max ( (min+max)/2 ).
+
+Note: it's better to use a genuine RX to find the real RF module frequency tuning value for a given protocol. After that you should apply the same value for the all other RXs of that protocol and rebind them if they were already bound. This is because most of the none genuine RXs are doing an auto frequency tuning at bind time to compensate for frequency deviation. If you change the frequency tuning of the transmitter then the RX has to relearn it.
 
 ## Report issues
 
@@ -52,6 +59,6 @@ You can report your problem using the [GitHub issue](https://github.com/pascalla
 Please provide the following information:
 - Multiprotocol code version
 - TX type
-- Using PPM or Serial, if using er9x or ersky9x the version in use
+- Using PPM or Serial, if using er9x or ersky9x or OpenTX the version in use
 - Different led status (multimodule and model)
 - Explanation of the behavior and reproduction steps