Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/inavflight/opentx-telemetry-widget

INAV Lua Telemetry with support for EdgeTX
https://github.com/inavflight/opentx-telemetry-widget

hacktoberfest

Last synced: about 1 year ago
JSON representation

INAV Lua Telemetry with support for EdgeTX

Awesome Lists containing this project

README 

          
## INAV Lua Telemetry Flight Status for EdgeTX and OpenTX



### Smartport and Crossfile radios by various manufacturers.



- **New documentation:** https://luatelemetry.readthedocs.io/en/latest/



## Interface



#### [Video of Lua Telemetry running on X9D+](https://youtu.be/YaUgywuT1YM)



#### Colour LCD "big screen" view



![sample](assets/iNavHorus.png "View on Horus transmitters")  

![sample](assets/iNavNirvana.jpg "View on Nirvana NV14 transmitter")



#### Pilot (glass cockpit) view for fixed wing pilots (Monochrome / small LCD radios)



![sample](assets/iNavQX7pilot.png "Pilot view on Q X7, X-Lite & Jumper T12")  

![sample](assets/iNavX9Dpilot.png "Pilot view on Taranis X9D, X9D+ and X9E")



#### Radar (map) view (Monochrome / small LCD radios)



![sample](assets/iNavQX7radar.png "Radar view on Q X7, X-Lite & Jumper T12")  

![sample](assets/iNavX9Dradar.png "Radar view on Taranis X9D, X9D+ and X9E")



#### Altitude graph view (Monochrome / small LCD radios)



![sample](assets/iNavQX7alt.png "Altitude graph view on Q X7, X-Lite & Jumper T12")  

![sample](assets/iNavX9Dalt.png "Altitude graph view on Taranis X9D, X9D+ and X9E")



#### Classic view (Monochrome / small LCD radios)



![sample](assets/iNavQX7.png "Classic view on Q X7, X-Lite & Jumper T12")  

![sample](assets/iNavX9D.png "Classic view on Taranis X9D, X9D+ and X9E")



## Features



* Supported receivers: FrSky (compatible) telemetry receivers (X, R9 and D series) and Crossfire receivers.

* Supported transmitters: FrSky Taranis and Horus transmitters, Jumper T12, T16, FLYSKY Nirvana NV14, Radiomaster TX16S, TX12, Zorro, Boxer (at least).

* Note other transmitters may work, but are not considered "supported".

* Launch/pilot-based model orientation and location indicators (great for lost orientation/losing sight of your model)

* Compass-based direction indicator (with magnetometer sensor on multirotor or fixed-wing with GPS)

* Pilot (glass cockpit) view which includes attitude indicator as well as pilot-familiar layout of additional data

* Radar (map) view shows model in relationship to home position, can be displayed either as launch/pilot-based or compass-based orientation

* Altitude graph view shows altitude for the last 1-6 minutes

* Colour LCD transmitters show all views at the same time, and include additional features like roll scale

* Bar gauges for Fuel (% battery mAh capacity remaining), Battery voltage, RSSI strength, Transmitter battery, GPS accuracy (HDOP), Variometer (and Altitude for X9D, X9D+ and X9E transmitters)

* Display and voice alerts for flight modes and flight mode modifiers (altitude hold, heading hold, home reset, etc.)

* Voice notifications for % battery remaining (based on current), voltage low/critical, high altitude, lost GPS, ready to arm, armed, disarmed, etc.

* GPS info: Satellites locked, GPS accuracy (HDOP), GPS altitude, GPS coordinates. Also logs the last GPS location (reviewed from the config menu)

* Display of current/maximum: Altitude, Distance, Speed and Current

* Display of current/minimum: Battery voltage, RSSI strength

* Title display of model name, flight timer, transmitter voltage and receiver voltage

* Menu configuration options can be changed from inside the script and can be unique to each model

* Speed and distance values are displayed in metric or imperial based on transmitter's telemetry settings

* Voice files, modes and config menu in English, German, French or Spanish.

* OpenTX: Playback previous flights via telemetry log files, including fast forward, rewind, and pause features

* May work with other (non-INAV) firmware; this is not a supported use case.



## Requirements



Supported environments are given below, older versions may also work but are unsupported.



* [INAV v6.0+](https://github.com/iNavFlight/inav/releases) running on your flight controller.

* [OpenTX v2.3.14+](http://www.open-tx.org/) running on Taranis Q X7/Q X7S, X9D/X9D+, X9E, X9 Lite, X-Lite/X-Lite Pro, Horus X10/X10S or X12S

* [EdgeTX v2.8.0+](https://edgetx.org/) running on a [supported radio](https://github.com/EdgeTX/edgetx.github.io/wiki/Frequently-Asked-Questions).

* FrSky X, R9 or D series telemetry receiver: X4RSB, X8R, XSR, R-XSR, XSR-M, XSR-E, RX4R, RX6R, R9, R9 Slim, R9 Slim+, R9 Mini, R9 MM, D8R-II plus, D8R-XP, D4R-II, etc. or any Crossfire receiver: Micro, Nano, Diversity, ELRS etc.

* GPS - On the aircraft.



## Suggested Sensors



* Altimeter/barometer (GPS altitude used if barometer not present)

* Magnetometer/compass for multi-rotor (fixed-wing craft use GPS for directional info)

* Current/amperage (for fuel gauge)



## Notes



* Crossfire is not fully supported with OpenTX, due to a long-standing OpenTX issue; EdgeTX is recommended for use with Crossfire (and generally).

* Some telemetry is missing from Crossfire: HDOP, GPS altitude and some secondary flight mode notifications like heading hold

* Other Lua scripts may not run at the same time as INAV Lua Telemetry due to limited transmitter resources)



## Special Thanks



* [RadioMaster](https://www.radiomasterrc.com/) - Sponsoring [RadioMaster Boxer](https://www.radiomasterrc.com/collections/boxer-1) support as well as general small screen radio and ELRS maintenance.

* [Team Black Sheep](https://www.team-blacksheep.com/) - Sponsoring TBS Crossfire telemetry support

* [FrSky](https://www.frsky-rc.com/) - Sponsoring [FrSky Horus](https://us.banggood.com/custlink/vG3D6Kiprr) transmitter support

* [Jumper](https://www.jumper.xyz/) - Sponsoring Jumper T16 transmitter support

* [FLYSKY](https://www.flysky-cn.com/) - Sponsoring [FLYSKY Nirvana NV14](https://us.banggood.com/custlink/GmGm0GZcpt) transmitter support



## Setup



* [Lua Telemetry Docs](https://luatelemetry.readthedocs.io/en/latest/)

* [Download latest release](https://github.com/iNavFlight/OpenTX-Telemetry-Widget/releases/latest)

* [Installation Instructions](https://luatelemetry.readthedocs.io/en/latest/Getting-Started/)

* [Upgrade Instructions](https://luatelemetry.readthedocs.io/en/latest/Upgrade/)

* [Download Options](https://luatelemetry.readthedocs.io/en/latest/Getting-Started/#download-options)



## Information & Settings



* [Configuration Settings and more](https://luatelemetry.readthedocs.io/en/latest/Configuration-Settings/) (!)

* [Playback Telemetry Logs](https://luatelemetry.readthedocs.io/en/latest/Configuration-Settings/#playback-telemetry-log-files)



## Support



* [Tips & Common Problems](https://luatelemetry.readthedocs.io/en/latest/Tips-%26-Common-Problems/)

* [Support Issues](https://github.com/iNavFlight/OpenTX-Telemetry-Widget/issues?q=is%3Aissue)

* ~~Support Chat (Telegram)~~: Contact current maintainer @nvrm17 on telegram for any questions



## Other



* [Upgrade to Development Build](https://luatelemetry.readthedocs.io/en/latest/Upgrade/#upgrade-to-development-build)

* [Release History](https://luatelemetry.readthedocs.io/en/latest/Change-Log)

* [Multilingual Support](https://luatelemetry.readthedocs.io/en/latest/Multilingual-Support/)

* [License](https://github.com/iNavFlight/OpenTX-Telemetry-Widget/blob/master/LICENSE)



## Contributors ✨



Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



  

    

      Tim Eckel
Tim Eckel
💬 💻 🔣 🎨 📖 🤔 🚧 🔬

      Jonathan Hudson
Jonathan Hudson
💬 💻 🤔 🚧 🔬 👀

      Даниил Николаев (NeverMine)
Даниил Николаев (NeverMine)
🐛 💻 📖 🤔 🚇 🚧 🔧 🌍

      Alberto García Hierro
Alberto García Hierro
🔊 🐛 💻 🎨 🤔 📦 🌍

      Darren Lines
Darren Lines
💻

      Tim O'Brien
Tim O'Brien
💻 🤔

      Peschi90
Peschi90
🌍

    

    

      Louis-Land
Louis-Land
🤔

      Paweł Spychalski
Paweł Spychalski
💬 🤔 🚇 🚧

      Frank Petrilli
Frank Petrilli
💬 💻

      Ikko Eltociear Ashimine
Ikko Eltociear Ashimine
💻

      MRC3742
MRC3742
💻 🔬