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 no serial port is set to be telemetry-only then telemetry will only be enabled when armed.
   6
   7 Telemetry is enabled using the 'TELEMETRY` feature.
   8
   9 ```
  10 feature TELEMETRY
  11 ```
  12
  13 Multiple telemetry providers are currently supported, FrSky (the default), Graupner HoTT V4, SmartPort (S.Port) and MultiWii Serial Protocol (MSP)
  14
  15 Use the `telemetry_provider` cli command to select one.
  16
  17 | Value | Meaning         |
  18 | ----- | --------------- |
  19 | 0     | FrSky (Default) |
  20 | 1     | HoTT            |
  21 | 2     | MSP             |
  22 | 3     | SmartPort       |
  23
  24 Example:
  25
  26 ```
  27 set telemetry_provider = 1
  28 ```
  29
  30 There are further examples in the Configuration section of the documentation.
  31
  32 ## FrSky telemetry
  33
  34 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.
  35
  36 FrSky telemetry signals are inverted.  To connect a cleanflight capable board to an FrSKy receiver you have some options.
  37
  38 1. A hardware inverter - Built in to some flight controllers.
  39 2. Use software serial and enable frsky_inversion.
  40 3. Use a flight controller that has software configurable hardware inversion (e.g. STM32F30x).
  41
  42 For 1, just connect your inverter to a usart or software serial port.
  43
  44 For 2 and 3 use the CLI command as follows:
  45
  46 ```
  47 set telemetry_inversion = 1
  48 ```
  49
  50 ### Notes
  51
  52 RPM shows throttle output when armed.
  53 RPM shows when diarmed.
  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 HoTT telemetry can be used when the TX and RX pins of a serial port are connected using a diode and a single wire to the T port on a HoTT receiver.
  61
  62 Only Electric Air Modules and GPS Modules are emulated, remember to enable them on your transmitter - in the Telemetry Menu on the MX-20.
  63
  64 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.
  65
  66 Connect as follows:
  67
  68 * HoTT TX/RX `T` -> Serial RX (connect directly)
  69 * HoTT TX/RX `T` -> Diode `-(  |)-` > Serial TX (connect via diode)
  70
  71 The diode should be arranged to allow the data signals to flow the right way
  72
  73 ```
  74 -(  |)- == Diode, | indicates cathode marker.
  75 ```
  76
  77 1N4148 diodes have been tested and work with the GR-24.
  78
  79 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.
  80
  81 Note: The SoftSerial ports are not listed as 5V tolerant in the STM32F103xx data sheet pinouts and pin description section.  Verify if you require a 5v/3.3v level shifters.
  82
  83 ## MultiWii Serial Protocol (MSP)
  84
  85 MSP Telemetry simply transmitts MSP packets in sequence to any MSP device attached to the telemetry port.  It rotates though a fixes sequence of command responses.
  86
  87 It is transmit only, it can work at any supported baud rate.
  88
  89 ## SmartPort (S.Port)
  90
  91 Smartport is a telemetry system used by newer FrSky transmitters and receivers such as the Taranis/XJR and X8R, X6R and X4R(SB).
  92
  93 Smartport telemetry is currently experimental, more information can be found here: https://github.com/frank26080115/cleanflight/wiki/Using-Smart-Port
  94
  95 In time this documentation will be updated with further details.