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

Protocols_Details.md

@@ -15,7 +15,7 @@ Dial|Protocol|Sub_protocol|RX Num|Power|Auto Bind|Option|RF Module
 0|Select serial||||||
 1|FLYSKY|Flysky|0|High|No|0|A7105
 2|HUBSAN|-|0|High|No|0|A7105
-3|FRSKYD|-|0|High|No|-41|CC2500
+3|FRSKYD|-|0|High|No|40|CC2500
 4|HISKY|Hisky|0|High|No|0|NRF24L01
 5|V2X2|-|0|High|No|0|NRF24L01
 6|DSM|DSM2|0|High|No|6|CYRF6936
@@ -62,6 +62,26 @@ CH5|CH6
 ---|---
 BTMBTN|TOPBTN
 
+##FLYSKY AFHDS2A
+Extended limits supported
+
+Telemetry enabled for battery voltage and RX RSSI using FrSky Hub protocol
+
+Option values =0->50Hz, =1->400Hz, =2->5Hz
+
+RX_Num is used to give a number a given RX. You must use a different RX_Num per RX. A maximum of 16 AFHDS2A RXs are supported.
+
+CH1|CH2|CH3|CH4|CH5|CH6|CH7|CH8|CH9|CH10|CH11|CH12|CH13|CH14
+---|---|---|---|---|---|---|---|---|---|---|---|---|---
+A|E|T|R|CH5|CH6|CH7|CH8|CH9|CH10|CH11|CH12|CH13|CH14
+
+Note that the RX ouput will be AETR.
+
+###Sub_protocol PWM_IBUS
+###Sub_protocol PPM_IBUS
+###Sub_protocol PWM_SBUS
+###Sub_protocol PPM_SBUS
+
 ##HUBSAN
 Models: Hubsan H102D, H107/L/C/D and Hubsan H107P/C+/D+
 

README.md

@@ -1,6 +1,6 @@
 # Overview of the MULTI-Module
 
-The **Multiprotocol Tx Module** (or **MULTI-Module**) is a 2.4GHz transmitter module which enables almost any TX to control lot of different models available on the market.
+The **Multiprotocol Tx Module** (or **MULTI-Module**) is a 2.4GHz transmitter module which enables almost any TX to control lot of different models available on the market.  
 
 The source code is partly based on the [Deviation TX project](http://www.deviationtx.com), thanks to all the developers for their great job on protocols.
 
@@ -9,7 +9,7 @@ The source code is partly based on the [Deviation TX project](http://www.deviati
 * [Forum on rcroups](http://www.rcgroups.com/forums/showthread.php?t=2165676)
 * [Available Protocols list](Protocols_Details.md)
 * [The old documentation](docs/README-old.md)
-* [Documentation to-do list](docs/Documentation_To_Do_List.md)
+
 
 ## Outline of the documentation
 1. Introduction (this page)
@@ -21,13 +21,14 @@ The source code is partly based on the [Deviation TX project](http://www.deviati
    - [Taranis](docs/Tx-Taranis.md)
    - [FlySky TH9X, Turnigy 9X/R](docs/Tx-FlyskyTH9X.md)
    - [erSky Transmitters](docs/Tx-erSky9X.md)
+1. [Overview of Telemetry options and capabilities](docs/Telemetry.md)
 1. [How to for popular models](docs/Models.md)
 1. [Troubleshooting](docs/Troubleshooting.md)
 2. [Advanced Topics (not for the fainthearted!)](docs/Advanced_Topics.md)
 
 ## Introduction
 A functioning MULTI-Module consists of (see image below):  
-<img src="docs/images/DIY_Multiprotocol_Module_Overview.png" width="500" height="300" />
+<img src="docs/images/MULTI_Module_Overview.png" width="700" height="400" />
 
 1.  A host RC Tx
 
@@ -43,7 +44,7 @@ A functioning MULTI-Module consists of (see image below):
      * In the case of some protocols (for example DSMX and FrSky) it receives and decodes the telemetry information and makes this available to the receiver.
 1. The physical 2.4GHz antenna (or in some cases multiple antennas) for the modules
 
-
+On of the most attractive features of the MULTI-module is the ability to send telemetry signals back to the transmitter. The MULTI-Module is fully telemetry capable for all protocols that support telemetry.  Your ability to use the telemetry information depends on the your transmitter hardware and your transmitter firmware.
 
 In constructing a functioning MULTI-Module there are important choices to be made and tradeoffs to be aware of.  The most important are:
 
@@ -66,17 +67,17 @@ This depends on your specific needs.  However, recent the availability of the 4-
 Manufacturer|RF Chip|Example Protocols
 :-----------|-------|:-------
 Cyprus Semiconductor| CYRF6936|DSM/DSMX
-||Walkera Devo
-||J6Pro
+ | |Walkera Devo
+ | |J6Pro
 Texas Instruments|CC2500|FrSky
-||Futaba SFHSS
+ | |Futaba SFHSS
 Amiccom|A7105|FlySky
-||Turnigy (most)
-||Hubsan
+ | |FlySky AFHDS2A
+ | |Hubsan
 Nordic Semiconductor|NRF24L01|HiSky
-||Syma
-||ASSAN
-||and most other Chinese models
+ | |Syma
+ | |ASSAN
+ | |and most other Chinese models
 
 For example, if you have no interest in binding your Tx to an model with and FrSky or Futaba SFHSS receiver you do not need to include the CC2500 RF module in your system.
 
@@ -96,7 +97,7 @@ The all the MULTI-Module options supports industry standard PPM interface that w
 
 Most of the older FM radios support the PPM interface.
 
-If you are the owner of a transmitter that supports the er9X/erSky9X or OpenTX firmwares (Frsky Taranis running erSky9x or OpenTx, or any of the FlySky/Turnigy family of Txs running ER9X, ERSky9x or OpenTx) you have the additional option to use a serial protocol to communicate between your Tx and the MULTI-Module. (Owners of Walkera Devo transmitters should look at the [Deviation Tx](http://www.deviationtx.com) project for how to achieve the same end goal). This serial protocol does not require any hardware modifications, but will require updating the firmware on your radio. For those willing to do this, there are some nice advantages:
+If you are the owner of a transmitter that supports the er9X/erSky9X or OpenTX firmwares (Frsky Taranis or the FlySky TH9X or the Turnigy 9X family) you have the additional option to use a serial protocol to communicate between your Tx and the MULTI-Module. (Owners of Walkera Devo transmitters should look at the [Deviation Tx](http://www.deviationtx.com) project for how to achieve the same end goal). This serial protocol does not require any hardware modifications, but will likely require updating the firmware on your radio. For those willing to do this, there are some nice advantages:
   - The model and protocol selection and binding is done from the Model Settings menu on the Tx
   - For telemetry capable transmitters, the telemetry integration is done seamlessly with the Tx firmware. (Note that FrSky TH9X/Turnigy 9X/R transmitters require a telemetry mod to be done before telemetry can work).  Click on the link corressponding to your Tx on the [Transmitters](docs/Transmitters.md) page for more details.
 

docs/Transmitters.md

@@ -1,9 +1,9 @@
 # Compatible Transmitters
 
 
-There are two different options for the interface between the Mulitprotocol Module and the transmitter: PPM and Serial. The considerations are different for each.
+There are two different options for the interface between the MULTI-Module and the transmitter: PPM and Serial. The considerations are different for each.
 - **PPM** is more generic, easy to implement and will work with most transmitters. 
-- **Serial** requires custom firmware on the transmitter but brings added functionality including protocol selection through the Tx interface.
+- **Serial** requires custom firmware on the transmitter but brings added functionality including protocol selection through the Tx interface and the option of telemetry (with the right transmitter firmware).
 
 Any Tx that provides a PPM output (like a trainer port, or a transmitter with a RF module bay) is compatible with the MULTI-module.  In practice, most of the documentation on this site is focused on building modules that slip into your transmitter’s module bay. 
  
@@ -22,12 +22,12 @@ Even in PPM mode it may still be possible to access telemetry information from s
 For transmitter setup using the PPM protocol go to the [PPM Setup page](PPM_Setup.md)
 
 ##Serial
-Transmitters that run er9X, erSky9X or OpenTx firmwares - like the FrSky Taranis and FlySky TH9X/Turnigy 9X/R family of transmitters - have the option of using a fast, two-way serial, communication protocol between the Tx and the DIY Multiprotocol module.  Using this serial communication protocol has some significant advantages:
+Transmitters that run er9X, erSky9X or OpenTx firmwares (like the FrSky Taranis, FlySky TH9X and Turnigy 9X family of transmitters) have the option of using a fast serial communication protocol between the Tx and the DIY Multiprotocol module.  Using this serial communication protocol has some significant advantages:
 
-1. selecting the specific radio protocol (e.g. DSM) and the sub protocol (e.g. DSMX) directly in the menu system of the Tx (see the picture below) 
+1. selecting the specific radio protocol (e.g. DSM) and the sub protocol (e.g. DSMX22) is done directly in the menu system of the Tx (see the picture below) 
 1. binding through the menu on the Tx 
 1. range checking through the menu on the Tx 
-1. in some cases enabling two-way telemetry for telemetry capable receivers and protocols. 
+1. in some cases enabling two-way serial communication for telemetry capable receivers/models. 
 
 <img src="images/OpenTx_Multi_Menu.jpg" width="470" height="180" /> <img src="images/er9X_Multi_Menu.jpg" width="250" height="180" /> 
 
@@ -54,7 +54,7 @@ Transmitter|Firmware Options|Telemetry Enabled
 Click on your transmitter above to view specific setup instructions.
 
 <a name="Telemetry_Mod"></a>   
-##Optional Telemetry mod for 9X/r TH9X transmitters
+##Optional Telemetry mod for 9X/R TH9X transmitters
 The telemetry mod for these transmitters has evolved.  The original and popular "FrSky Telemetry Mod" requires 2 pins on the transmitter module board to be modified (RX on pin 5 and TX on pin 2).  All the recent MULTI-Module hardware options supports serial transmission on pin 1 (the same pin as the PPM signal) so, in this case, only the mod on pin 5 is required. 
 
 A good tutorial to follow is Oscar Liang's [here](http://blog.oscarliang.net/turnigy-9x-advance-mod/) but when you get to wiring up the Tx Module bay pins, you only need to perform the steps relevant for Pin 5.
@@ -67,7 +67,7 @@ You can see Midelic's original instructions [here](http://www.rcgroups.com/forum
 
 - Owners of Walkera Devo transmitters should look at the [Deviation-Tx](http://www.deviationtx.com) project for how to achieve the same end goal with your transmitters. 
 
-- To enable telemetry on a Turnigy 9X or 9XR you need to modify your TX following one of the Frsky mod like this [one](http://blog.oscarliang.net/turnigy-9x-advance-mod/).
+- To enable telemetry on a Turnigy 9X or 9XR you need to modify your TX [read this.](#Telemetry_Mod).
 
 - DSM telemetry is not available on er9x due to a lack of flash space.