Enable telemetry on SPARKY
[betaflight.git] / docs / Rx.md
blob85c7a06f018624a85bb3d0ded67457446d6041a7
1 # Receivers (RX)
3 A receiver is used to receive radio control signals from your transmitter and convert them into signals that the flight controller can understand.
5 There are 3 basic types of receivers:
7 1. Parallel PWM Receivers
8 2. PPM Receivers
9 3. Serial Receivers
11 ## Parallel PWM Receivers
13 8 channel support, 1 channel per input pin.  On some platforms using parallel input will disable the use of serial ports
14 and SoftSerial making it hard to use telemetry or GPS features.
16 ## PPM Receivers
18 PPM is sometimes known as PPM SUM or CPPM.
20 12 channels via a single input pin, not as accurate or jitter free as methods that use serial communications, but readily available.
22 These receivers are reported working:
24 FrSky D4R-II
25 http://www.frsky-rc.com/product/pro.php?pro_id=24
27 Graupner GR24
28 http://www.graupner.de/en/products/33512/product.aspx
30 R615X Spektrum/JR DSM2/DSMX Compatible 6Ch 2.4GHz Receiver w/CPPM
31 http://orangerx.com/2014/05/20/r615x-spektrumjr-dsm2dsmx-compatible-6ch-2-4ghz-receiver-wcppm-2/
33 FrSky D8R-XP 8ch telemetry receiver, or CPPM and RSSI enabled receiver
34 http://www.frsky-rc.com/product/pro.php?pro_id=21
36 ## Serial Receivers
38 ### Spektrum
40 8 channels via serial currently supported.
42 These receivers are reported working:
44 Lemon Rx DSMX Compatible PPM 8-Channel Receiver + Lemon DSMX Compatible Satellite with Failsafe
45 http://www.lemon-rx.com/shop/index.php?route=product/product&product_id=118
48 ### S.BUS
50 16 channels via serial currently supported.  See the Serial chapter in the documentation for a configuration example.
52 * In most cases you will need an inverter between the receiver output and the flight controller hardware.  
53 * Softserial ports cannot be used with SBUS because it runs at too high of a bitrate (1Mbps).  Refer to the chapter specific to your board to determine which port(s) may be used.
54 * You will need to configure the channel mapping in the GUI (Receiver tab) or CLI (`map` command).
56 These receivers are reported working:
58 FrSky X4RSB 3/16ch Telemetry Receiver
59 http://www.frsky-rc.com/product/pro.php?pro_id=135
61 FrSky X8R 8/16ch Telemetry Receiver
62 http://www.frsky-rc.com/product/pro.php?pro_id=105
64 Futaba R2008SB 2.4GHz S-FHSS
65 http://www.futaba-rc.com/systems/futk8100-8j/
68 #### OpenTX S.BUS configuration
70 If using OpenTX set the transmitter module to D16 mode and select CH1-16 on the transmitter before binding to allow reception
71 of 16 channels. 
73 OpenTX 2.09, which is shipped on some Taranis X9D Plus transmitters, has a bug - [issue:1701](https://github.com/opentx/opentx/issues/1701).
74 The bug prevents use of all 16 channels.  Upgrade to the latest OpenTX version to allow correct reception of all 16 channels,
75 without the fix you are limited to 8 channels regardless of the CH1-16/D16 settings.
78 ### XBUS
80 The firmware currently supports the MODE B version of the XBus protocol.
81 Make sure to set your TX to use "MODE B" for XBUS in the TX menus!
82 See here for info on JR's XBUS protocol: http://www.jrpropo.com/english/propo/XBus/
84 These receivers are reported working:
86 XG14 14ch DMSS System w/RG731BX XBus Receiver
87 http://www.jramericas.com/233794/JRP00631/
89 There exist a remote receiver made for small BNF-models like the Align T-Rex 150 helicopter. The code also supports using the Align DMSS RJ01 receiver directly with the cleanflight software.
90 To use this receiver you must power it with 3V from the hardware, and then connect the serial line as other serial RX receivers.
91 In order for this receiver to work, you need to specify the XBUS_MODE_B_RJ01 for serialrx_provider. Note that you need to set your radio mode for XBUS "MODE B" also for this receiver to work.
92 Receiver name: Align DMSS RJ01 (HER15001)
94 ### SUMD
96 16 channels via serial currently supported.
98 These receivers are reported working:
100 GR-24 receiver HoTT
101 http://www.graupner.de/en/products/33512/product.aspx
103 Graupner receiver GR-12SH+ HoTT
104 http://www.graupner.de/en/products/870ade17-ace8-427f-943b-657040579906/33565/product.aspx
106 ### SUMH
108 8 channels via serial currently supported.
110 SUMH is a legacy Graupner protocol.  Graupner have issued a firmware updates for many recivers that lets them use SUMD instead.
112 ## MultiWii serial protocol (MSP)
114 Allows you to use MSP commands as the RC input.  Only 8 channel support to maintain compatibility with MSP.
116 ## Configuration
118 There are 3 features that control receiver mode:
121 RX_PPM
122 RX_SERIAL
123 RX_PARALLEL_PWM
124 RX_MSP
127 Only one receiver feature can be enabled at a time.
129 ### Serial RX
131 See the Serial chapter for some some RX configuration examples.
133 For Serial RX enable `RX_SERIAL` and set the `serialrx_provider` CLI setting as follows.
135 | Serial RX Provider | Value |
136 | ------------------ | ----- |
137 | SPEKTRUM1024       | 0     |
138 | SPEKTRUM2048       | 1     |
139 | SBUS               | 2     |
140 | SUMD               | 3     |
141 | SUMH               | 4     |
142 | XBUS_MODE_B        | 5     |
143 | XBUS_MODE_B_RJ01   | 6     |
145 ### PPM/PWM input filtering.
147 Hardware input filtering can be enabled if you are experiencing interference on the signal sent via your PWM/PPM RX.
149 Use the `input_filtering_mode` CLI setting to select a mode.
151 | Value | Meaning   |
152 | ----- | --------- |
153 | 0     | Disabled  |
154 | 1     | Enabled   |