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
   5 Requires OpenTX 2.2 and a recent release of arducoper, arduplane or rover.
   6
   7 Tested on a pixracer with copter 3.5.3 and on a pixhawk clone with copter 3.5.4
   8
   9 ![Taranis X9D+](https://github.com/yaapu/FrskyTelemetry/blob/master/IMAGES/screenshot_x9.JPG)
  10
  11 ![Taranis X7](https://github.com/yaapu/FrskyTelemetry/blob/master/IMAGES/screenshot_x7.JPG)
  12
  13 ## Features
  14
  15  - flight mode (modes are displayed based on the frame type:copter,plane or rover)
  16  - artificial horizon with roll,pitch and yaw with numeric compass heading
  17  - battery voltage from 3 sources (in order of priority)
  18  - - frsky FLVSS voltage sensor if available (vs is displayed next to voltage)
  19  - - frsky analog port if available (a2 is displayed next to voltage)
  20  - - flight controller via telemetry (fc is displayed next to voltage)
  21  - battery lowest cell if available or cell average if not
  22  - battery current
  23  - battery capacity and battery capacity used in mAh and %
  24  - vertical speed on left side of HUD
  25  - altitude on right side of HUD
  26  - gps altitude
  27  - gps fix status and hdop
  28  - flight time
  29  - rssi value
  30  - transmitter voltage
  31  - home distance
  32  - home heading as rotating triangle
  33  - mavlink messages with history accessible with +/- buttons short press
  34  - english sound files for selected events: battery levels, failsafe, flightmodes and landing
  35
  36 ## Installation
  37
  38 The script is quite big and compilation on your radio may fail.
  39 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.
  40
  41 To enable sound files playback copy them to /SOUNDS/yaapu0/en folder.
  42
  43 ## Hardware requirements
  44
  45 Please refer to the arducopter wiki for information on how to configure your flight controller for passthrough protocol
  46  - http://ardupilot.org/copter/docs/common-frsky-passthrough.html
  47
  48 For information on how to connect the FrSky equipment together, please refer to
  49  - http://ardupilot.org/copter/docs/common-frsky-telemetry.html#common-frsky-equipment
  50  - http://ardupilot.org/copter/docs/common-frsky-telemetry.html#frsky-cables
  51
  52 ## Test Mode
  53
  54 The script can be run in TEST mode. By using TEST mode you can control the telemetry values by moving the radio sticks.
  55
  56 PLEASE DO NOT FLY IN THIS MODE
  57
  58 To enable TEST mode you need to uncomment some code and recompile the script.
  59
  60 the first change is in function telemetryEnabled which should be as below
  61
  62 ```lua
  63 local function telemetryEnabled()
  64         if getValue("RxBt") == 0 then
  65                 noTelemetryData = 1
  66         end
  67         return true
  68         --return noTelemetryData == 0
  69 end
  70 ```
  71
  72 the second part that needs to be changed is in the run() function where the line symMode() must be uncommented
  73
  74 ```lua
  75 local function run(event)
  76    ...
  77                         processTelemetry()
  78                         lcd.clear()
  79                         symMode()
  80                         drawHud()
  81                         drawGrid()
  82                         drawBattery()
  83    ...
  84 ```
  85 Now you can test how the script behaves by using your radio channels 1,2,3,4,10 and 12.
  86
  87 ## Notes
  88
  89 Speech sound files generated with https://soundoftext.com/
  90
  91 As of now only english is supported