README.md

   1 # Yaapu Frsky Telemetry script
   2
   3 A lua based telemetry script for the Taranis X9D+ and X7 radio using the frsky passthrough protocol.
   4 Requires OpenTX 2.2 and arducopter 3.5.x.
   5
   6 Tested on a pixracer with copter 3.5.3 and on a pixhawk clone with copter 3.5.4
   7
   8 ![Taranis X9D+](https://github.com/yaapu/FrskyTelemetry/blob/master/IMAGES/screenshot_x9.JPG)
   9
  10 ![Taranis X7](https://github.com/yaapu/FrskyTelemetry/blob/master/IMAGES/screenshot_x7.JPG)
  11
  12 ## Features
  13
  14  - artificial horizon with roll,pitch and yaw with numeric compass heading
  15  - battery voltage from 3 sources (in order of priority)
  16  - - frsky FLVSS voltage sensor if available (vs is displayed next to voltage)
  17  - - frsky analog port if available (a2 is displayed next to voltage)
  18  - - flight controller via telemetry (fc is displayed next to voltage)
  19  - battery lowest cell if available or cell average if not
  20  - battery current
  21  - battery capacity and battery capacity used in mAh and %
  22  - vertical speed on left side of HUD
  23  - altitude on right side of HUD
  24  - gps altitude
  25  - gps fix status and hdop
  26  - flight time
  27  - rssi value
  28  - transmitter voltage
  29  - home distance
  30  - home heading as rotating triangle
  31  - mavlink messages with history accessible with +/- buttons short press
  32  - english sound files for selected events: battery levels, failsafe, flightmode and landing
  33
  34 ## Installation
  35
  36 The script is quite big and compilation on your radio may fail.
  37 The safest way is to compile it on Companion and then copy the .luac compiled version to the SD card in the /SCRIPTS/TELEMETRY folder.
  38
  39 To enable sound files playback copy them to /SOUNDS/yaapu0/en folder.
  40
  41 ## Hardware requirements
  42
  43 Please refer to the arducopter wiki for information on how to configure your flight controller for passthrough protocol
  44  - http://ardupilot.org/copter/docs/common-frsky-passthrough.html
  45
  46 For information on how to connect the FrSky equipment together, please refer to
  47  - http://ardupilot.org/copter/docs/common-frsky-telemetry.html#common-frsky-equipment
  48  - http://ardupilot.org/copter/docs/common-frsky-telemetry.html#frsky-cables
  49
  50 ## Notes
  51
  52 Speech sound files generated with https://soundoftext.com/
  53
  54 As of now only english is supported