iNav-Telemetry.md

   1 # Overview
   2
   3 This page discusses the telemetry options available in INAV. Some of the information is expanded upon in the [Mission Panning](https://github.com/iNavFlight/inav/wiki/iNavFlight-Missions) page.
   4
   5 # Definitions
   6
   7 Factually and classically, telemetry is an automated communications process by which measurements and other data are collected at remote or inaccessible points and transmitted to receiving equipment for monitoring. The word is derived from Greek roots: tele = remote, and metron = measure.
   8
   9 In INAV terms, it has a rather more specific meaning, describing a means by which measurement data is pushed automatically from the vehicle to another device, typically a CGS (Computer Ground Station) or OSD (On-screen Display).
  10
  11 It is also the case in INAV that getting data into a CGS or OSD can be achieved _without_ defining a telemetry protocol (using MSP, below).
  12
  13 This page attempts to disambiguate these options.
  14
  15 # INav Messaging Protocols
  16
  17 INav supports a number of protocols for message exchange (and telemetry).
  18
  19 For INAV, the following rules apply:
  20 * If a telemetry protocol is defined for a UART, without MSP, then the 'push' telemetry protocol will be sent unconditionally.
  21 * If a UART defines both MSP and a telemetry protocol, then MSP is active when unarmed, and the push telemetry protocol is transmitted from the FC when armed.
  22 * If _just_ MSP is enabled for a USART, it is always available (armed and unarmed).
  23
  24 The latter mode is preferred for use with CGS like mwp or EZ-GUI; the CGS can take advantage of the metadata available in MSP prior to arming (e.g. vehicle type, FC capabilities) and then use the efficient push telemetry when armed.
  25
  26 * Multiwii Serial Protocol (MSP). This is a polled protocol, and thus in INAV terms, not considered 'telemetry', even when used for remote measurement. The application (OSD, CGS) polls the flight controller "send me status data" and the FC responds, "here's the status data"; "send me the GPS data" -> "here's the GPS data". This is supported by most OSDs and CGS. It has advantages and disadvantages:
  27   - The remote (OSD, CGS) can determine what data it requests (+ve)
  28   - The configurator uses MSP to communicate with and configure the FC (+ve)
  29   - The remote (OSD, CGS) must maintain a timeout and retry, as data can be lost in transmission (-ve)
  30   - For packet radio links (3DR, HC-12), this is slow (much slower than the data rate would indicate), due the overheads on creating and tearing down the packets.
  31
  32   **It is not necessary to define an "telemetry protocol" to use MSP alone.**
  33
  34 * Lightweight Telemetry (LTM). LTM, as its name implies, is a light-weight protocol that has been enhanced for INAV specific attributes by the INAV developers. Its attraction is its ability to send useful flight data at high rates over slow data links, for example 10Hz update of attitude is possible at 4800 baud, and 5Hz at 2400 baud. LTM is supported by [Ghettostation](https://github.com/KipK/Ghettostation),  [LTM Telemetry OLED ](https://github.com/sppnk/LTM-Telemetry-OLED) , [EZGUI](http://ez-gui.com/) , [MwpTools](https://github.com/stronnag/mwptools), [LTM OSD](https://github.com/digitalentity/ltm-osd-simple), [Scarab OSD](https://github.com/ShikOfTheRa/scarab-osd) and possibly others. For more detail, see the [wiki LTM entry](https://github.com/iNavFlight/inav/wiki/Lightweight-Telemetry-(LTM))
  35
  36 * Mavlink. Mavlink is the telemetry protocol (and configuration protocol) of APM and other FCs. It has limited support in INAV and requires more bandwidth than the svelte LTM. It does however allow the use of other CGS and OSD. Mavlink one way telemetry is supported by [Droid Planner 2 (Android)](https://github.com/DroidPlanner/Tower/releases/download/Droidplanner_v2.8.6_RC2/Droidplanner_v2.8.6_RC2.apk)
  37
  38 * TX protocols. A number of TX devices (FrSky, Hott, IBUS, Smartport) can also receive telemetry.
  39
  40  # Example
  41
  42 ![LTM setting](https://imgur.com/PnqqpAN.png)
  43
  44 In the above example, MSP is available on USART1 when unarmed, and LTM when armed (in this case used with a 3DR or HC-12 telemetry radio and the mwp groundstation). Note in particular, the baud rate is common for MSP and LTM.