docs/Telemetry.md

   1 # Telemetry
   2
   3 Telemetry allows you to know what is happening on your aircraft while you are flying it.  Among other things you can receive battery voltages and GPS positions on your transmitter.
   4
   5 Telemetry can be either always on, or enabled when armed.  If a serial port for telemetry is shared with other functionality then then telemetry will only be enabled when armed on that port.
   6
   7 Telemetry is enabled using the 'TELEMETRY` feature.
   8
   9 ```
  10 feature TELEMETRY
  11 ```
  12
  13 Multiple telemetry providers are currently supported, FrSky, Graupner HoTT V4, SmartPort (S.Port) and MultiWii Serial Protocol (MSP)
  14
  15 All telemetry systems use serial ports, configure serial ports to use the telemetry system required.
  16
  17 ## FrSky telemetry
  18
  19 FrSky telemetry is transmit only and just requires a single connection from the TX pin of a serial port to the RX pin on an FrSky telemetry receiver.
  20
  21 FrSky telemetry signals are inverted.  To connect a cleanflight capable board to an FrSKy receiver you have some options.
  22
  23 1. A hardware inverter - Built in to some flight controllers.
  24 2. Use software serial and enable frsky_inversion.
  25 3. Use a flight controller that has software configurable hardware inversion (e.g. STM32F30x).
  26
  27 For 1, just connect your inverter to a usart or software serial port.
  28
  29 For 2 and 3 use the CLI command as follows:
  30
  31 ```
  32 set telemetry_inversion = 1
  33 ```
  34
  35 ### Precision setting for VFAS
  36
  37 Cleanflight can send VFAS (FrSky Ampere Sensor Voltage) in two ways:
  38
  39 ```
  40 set frsky_vfas_precision  = 0
  41 ```
  42 This is default setting which supports VFAS resolution of 0.2 volts and is supported on all FrSky hardware.
  43
  44 ```
  45 set frsky_vfas_precision  = 1
  46 ```
  47 This is new setting which supports VFAS resolution of 0.1 volts and is only supported by OpenTX radios (this method uses custom ID 0x39).
  48
  49
  50 ### Notes
  51
  52 RPM shows throttle output when armed.
  53 RPM shows when disarmed.
  54 TEMP2 shows Satellite Signal Quality when GPS is enabled.
  55
  56 RPM requires that the 'blades' setting is set to 12 on your receiver/display - tested with Taranis/OpenTX.
  57
  58 ## HoTT telemetry
  59
  60 Only Electric Air Modules and GPS Modules are emulated.
  61
  62 Use the latest Graupner firmware for your transmitter and receiver.
  63
  64 Older HoTT transmitters required the EAM and GPS modules to be enabled in the telemetry menu of the transmitter. (e.g. on MX-20)
  65
  66 Serial ports use two wires but HoTT uses a single wire so some electronics are required so that the signals don't get mixed up.  The TX and RX pins of
  67 a serial port should be connected using a diode and a single wire to the `T` port on a HoTT receiver.
  68
  69 Connect as follows:
  70
  71 * HoTT TX/RX `T` -> Serial RX (connect directly)
  72 * HoTT TX/RX `T` -> Diode `-(  |)-` > Serial TX (connect via diode)
  73
  74 The diode should be arranged to allow the data signals to flow the right way
  75
  76 ```
  77 -(  |)- == Diode, | indicates cathode marker.
  78 ```
  79
  80 1N4148 diodes have been tested and work with the GR-24.
  81
  82 As noticed by Skrebber the GR-12 (and probably GR-16/24, too) are based on a PIC 24FJ64GA-002, which has 5V tolerant digital pins.
  83
  84 Note: The SoftSerial ports may not be 5V tolerant on your board.  Verify if you require a 5v/3.3v level shifters.
  85
  86 ## MultiWii Serial Protocol (MSP)
  87
  88 MSP Telemetry simply transmits MSP packets in sequence to any MSP device attached to the telemetry port.  It rotates though a fixes sequence of command responses.
  89
  90 It is transmit only, it can work at any supported baud rate.
  91
  92 ## SmartPort (S.Port)
  93
  94 Smartport is a telemetry system used by newer FrSky transmitters and receivers such as the Taranis/XJR and X8R, X6R and X4R(SB).
  95
  96 More information about the implementation can be found here: https://github.com/frank26080115/cleanflight/wiki/Using-Smart-Port
  97
  98 In time this documentation will be updated with further details.
  99
 100 Smartport devices can be connected directly to STM32F3 boards such as the SPRacingF3 and Sparky, with a single straight through cable without the need for any hardware modifications on the FC or the receiver.
 101
 102 For Smartport on F3 based boards, enable the telemetry inversion setting.
 103
 104 ```
 105 set telemetry_inversion = 1
 106 ```