diff --git a/.github/ISSUE_TEMPLATE/Attempt_to_call_a_nil_value.md b/.github/ISSUE_TEMPLATE/Attempt_to_call_a_nil_value.md index 6138d7bc..5bbb01c1 100644 --- a/.github/ISSUE_TEMPLATE/Attempt_to_call_a_nil_value.md +++ b/.github/ISSUE_TEMPLATE/Attempt_to_call_a_nil_value.md @@ -3,6 +3,7 @@ name: "\U0001F4A5 Attempt to call a nil value" about: Are you getting the message "Attempt to call a nil value"? title: '' labels: support +assignees: teckel12 --- If you're getting an `Attempt to call a nil value` error, it either means you don't have the `luac` build option checked for your OpenTX/JumperTX firmware or you're out of memory on your transmitter. The Taranis series has very little free memory to work with for Lua scripts, so this error is quite common. There's a few things that typically cause this error which are listed below: @@ -25,4 +26,4 @@ https://github.com/iNavFlight/LuaTelemetry/wiki/Installation As this is a common issue that I've tried to cover in the Wiki, I would appreciate if you could let me know how the instructions could be improved to avoid any confusion. -Thanks! +Thanks! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index d56ac38f..9e9802c1 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -3,6 +3,7 @@ name: "\U0001F41B Possible bug" about: Report a possible bug or issue with Lua Telemetry title: '' labels: 'bug?' +assignees: teckel12 --- ### Describe the bug diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 1bd143b4..aa2968a7 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -3,6 +3,7 @@ name: "\U0001F680 Feature request" about: Suggest an idea for Lua Telemetry title: '' labels: feature request +assignees: teckel12 --- ### Is your feature request related to a problem? Please describe diff --git a/.github/ISSUE_TEMPLATE/Not_enough_memory.md b/.github/ISSUE_TEMPLATE/Not_enough_memory.md index f9df90c3..5fa396fd 100644 --- a/.github/ISSUE_TEMPLATE/Not_enough_memory.md +++ b/.github/ISSUE_TEMPLATE/Not_enough_memory.md @@ -3,6 +3,7 @@ name: "\U0001F4A5 Not enough memory error" about: Are you getting a "not enough memory error"? title: '' labels: support +assignees: teckel12 --- If you're getting a `not enough memory error`, it means you're out of memory on your transmitter. The Taranis series has very little free memory to work with for Lua scripts, so this error is quite common. There's a few things that typically cause this error which are listed below: @@ -21,4 +22,4 @@ https://github.com/iNavFlight/LuaTelemetry/wiki/Installation As this is a common issue that seems clear by the error message and covered in the Wiki, I would appreciate if you could let me know how the instructions could be improved to avoid any confusion. -Thanks! +Thanks! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Question.md b/.github/ISSUE_TEMPLATE/Question.md index c23cbc26..d50ec8c4 100644 --- a/.github/ISSUE_TEMPLATE/Question.md +++ b/.github/ISSUE_TEMPLATE/Question.md @@ -3,6 +3,7 @@ name: "\U00002753 Question" about: Ask a question about Lua Telemetry title: '' labels: question +assignees: teckel12 --- ### Describe your question diff --git a/.gitignore b/.gitignore index 5b392418..e9507d5c 100644 --- a/.gitignore +++ b/.gitignore @@ -4,198 +4,4 @@ dist/SCRIPTS/TELEMETRY/iNav/*.lua *.zip desktop.ini dist/THEMES/ -obj/ -.idea - -### Lua ### -# Compiled Lua sources -luac.out - -# luarocks build files -*.src.rock -*.tar.gz - -# Object files -*.o -*.os -*.ko -*.obj -*.elf - -# Precompiled Headers -*.gch -*.pch - -# Libraries -*.lib -*.a -*.la -*.lo -*.def -*.exp - -# Shared objects (inc. Windows DLLs) -*.dll -*.so -*.so.* -*.dylib - -# Executables -*.exe -*.out -*.app -*.i*86 -*.x86_64 -*.hex - - -### Python ### -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -pip-wheel-metadata/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ -pytestdebug.log - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ -doc/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -.python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ -pythonenv* - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ - -# pytype static type analyzer -.pytype/ - -# profiling data -.prof - -### VirtualEnv ### -# Virtualenv -# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ -[Bb]in -[Ii]nclude -[Ll]ib -[Ll]ib64 -[Ll]ocal -[Ss]cripts -pyvenv.cfg -pip-selfcheck.json \ No newline at end of file +obj/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index 06a750a2..724f7319 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,14 +2,16 @@ os: linux dist: trusty -sudo: false - language: c +branches: + except: + - master + env: global: - LUAROCKS=2.3.0 - matrix: + jobs: - LUA=lua5.2 before_install: @@ -30,12 +32,12 @@ script: after_success: - coveralls -b .. -r .. -i ./src --dump c.report.json - luacov-coveralls -j c.report.json -v - - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then curl -X POST https://api.telegram.org/bot797688679:AAEcKXFJ-0cDfiQLmn_hMg83FDFEtV7x2LQ/sendMessage -d chat_id=@luatelemetry -d "text=Build successful - PR #$TRAVIS_PULL_REQUEST $TRAVIS_PULL_REQUEST_BRANCH > $TRAVIS_BRANCH"; fi' - - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then curl -X POST https://api.telegram.org/bot797688679:AAEcKXFJ-0cDfiQLmn_hMg83FDFEtV7x2LQ/sendMessage -d chat_id=@luatelemetry -d "text=Build successful - Branch $TRAVIS_BRANCH: $TRAVIS_COMMIT_MESSAGE"; fi' + - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then curl -X POST "https://api.telegram.org/bot$TELEGRAM_TOKEN/sendMessage" -d chat_id=@luatelemetry -d "text=Build successful - PR #$TRAVIS_PULL_REQUEST $TRAVIS_PULL_REQUEST_BRANCH > $TRAVIS_BRANCH"; fi' + - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then curl -X POST "https://api.telegram.org/bot$TELEGRAM_TOKEN/sendMessage" -d chat_id=@luatelemetry -d "text=Build successful - Branch $TRAVIS_BRANCH: $TRAVIS_COMMIT_MESSAGE"; fi' notifications: email: recipients: - - eckel.tim@gmail.com + - "$EMAIL_NOTIFICATION" on_success: never on_failure: always diff --git a/README.md b/README.md index 4804d872..25d23dac 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -## INAV Lua Telemetry Flight Status for Taranis/Horus/Jumper/Nirvana - v1.7.4 +## INAV Lua Telemetry Flight Status for Taranis/Horus/Jumper/Nirvana - v1.7.5 -### FrSky SmartPort(S.Port), D-series, F.Port & TBS Crossfire telemetry on Taranis, Horus, Jumper & Nirvana transmitters +> The new official repo for Lua Telemetry by the original (and only) author: +> +> **https://github.com/teckel12/LuaTelemetry** -[![Build Status](https://travis-ci.com/iNavFlight/LuaTelemetry.svg?branch=master)](https://travis-ci.com/iNavFlight/LuaTelemetry) +### FrSky SmartPort(S.Port), D-series, F.Port & TBS Crossfire telemetry on Taranis, Horus, Jumper & Nirvana transmitters -- **New documentation:** https://luatelemetry.readthedocs.io/en/latest/ +[![Build Status](https://travis-ci.com/teckel12/LuaTelemetry.svg?branch=master)](https://travis-ci.com/teckel12/LuaTelemetry) ## Interface @@ -39,7 +41,7 @@ * Supported receivers: All FrSky telemetry receivers (X, R9 and D series) and all TBS Crossfire receivers * Supported transmitters: All FrSky Taranis and Horus transmitters, Jumper T12 & T16 and the FLYSKY Nirvana NV14 -* Compatible with Betaflight using FrSky X or R9 series receivers (with reduced functionality) and TBS Crossfire support with Betaflight v4.0.0+ +* Compatible with Betaflight using FrSky X or R9 series receivers (with reduced functionality) and TBS Crossfire support * 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 @@ -81,34 +83,34 @@ ## Special Thanks * [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 +* [FrSky](https://www.frsky-rc.com/) - Sponsoring FrSky Horus 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 +* [FLYSKY](https://www.flysky-cn.com/) - Sponsoring FLYSKY Nirvana NV14 transmitter support ## Setup -* [Lua Telemetry Wiki](https://github.com/iNavFlight/LuaTelemetry/wiki) -* [Download latest release](https://github.com/iNavFlight/LuaTelemetry/releases/latest) -* [Installation Instructions](https://github.com/iNavFlight/LuaTelemetry/wiki/Installation) -* [Upgrade Instructions](https://github.com/iNavFlight/LuaTelemetry/wiki/Upgrade) -* [Download Options](https://github.com/iNavFlight/LuaTelemetry/wiki/Download-Options) +* [Lua Telemetry Wiki](https://github.com/teckel12/LuaTelemetry/wiki) +* [Download latest release](https://github.com/teckel12/LuaTelemetry/releases/latest) +* [Installation Instructions](https://github.com/teckel12/LuaTelemetry/wiki/Installation) +* [Upgrade Instructions](https://github.com/teckel12/LuaTelemetry/wiki/Upgrade) +* [Download Options](https://github.com/teckel12/LuaTelemetry/wiki/Download-Options) ## Information & Settings -* [Screen Description](https://github.com/iNavFlight/LuaTelemetry/wiki/Screen-Description) -* [Configuration Settings](https://github.com/iNavFlight/LuaTelemetry/wiki/Configuration-Settings) -* [Suggested Battery Settings](https://github.com/iNavFlight/LuaTelemetry/wiki/Suggested-Battery-Settings) -* [Playback Telemetry Logs](https://github.com/iNavFlight/LuaTelemetry/wiki/Playback-Telemetry-Log-Files) +* [Screen Description](https://github.com/teckel12/LuaTelemetry/wiki/Screen-Description) +* [Configuration Settings](https://github.com/teckel12/LuaTelemetry/wiki/Configuration-Settings) +* [Suggested Battery Settings](https://github.com/teckel12/LuaTelemetry/wiki/Suggested-Battery-Settings) +* [Playback Telemetry Logs](https://github.com/teckel12/LuaTelemetry/wiki/Playback-Telemetry-Log-Files) ## Support -* [Tips & Common Problems](https://github.com/iNavFlight/LuaTelemetry/wiki/Tips-&-Common-Problems) -* [Support Issues](https://github.com/iNavFlight/LuaTelemetry/issues?q=is%3Aissue) +* [Tips & Common Problems](https://github.com/teckel12/LuaTelemetry/wiki/Tips-&-Common-Problems) +* [Support Issues](https://github.com/teckel12/LuaTelemetry/issues?q=is%3Aissue) * [Support Chat (Telegram)](https://t.me/luatelemetry) ## Other -* [Upgrade to Development Build](https://github.com/iNavFlight/LuaTelemetry/wiki/Upgrade-to-Development-Build) -* [Release History](https://github.com/iNavFlight/LuaTelemetry/wiki/Change-Log) -* [Multilingual Support](https://github.com/iNavFlight/LuaTelemetry/wiki/Multilingual-Support) -* [License](https://github.com/iNavFlight/LuaTelemetry/blob/master/LICENSE) +* [Upgrade to Development Build](https://github.com/teckel12/LuaTelemetry/wiki/Upgrade-to-Development-Build) +* [Release History](https://github.com/teckel12/LuaTelemetry/wiki/Change-Log) +* [Multilingual Support](https://github.com/teckel12/LuaTelemetry/wiki/Multilingual-Support) +* [License](https://github.com/teckel12/LuaTelemetry/blob/master/LICENSE) diff --git a/dist/SCRIPTS/TELEMETRY/iNav.lua b/dist/SCRIPTS/TELEMETRY/iNav.lua index 6e5a2a87..bbe3a061 100644 Binary files a/dist/SCRIPTS/TELEMETRY/iNav.lua and b/dist/SCRIPTS/TELEMETRY/iNav.lua differ diff --git a/dist/SCRIPTS/TELEMETRY/iNav.luac b/dist/SCRIPTS/TELEMETRY/iNav.luac index 6e5a2a87..bbe3a061 100644 Binary files a/dist/SCRIPTS/TELEMETRY/iNav.luac and b/dist/SCRIPTS/TELEMETRY/iNav.luac differ diff --git a/dist/SCRIPTS/TELEMETRY/iNav/crsf.luac b/dist/SCRIPTS/TELEMETRY/iNav/crsf.luac index 349b5bda..2daba0ba 100644 Binary files a/dist/SCRIPTS/TELEMETRY/iNav/crsf.luac and b/dist/SCRIPTS/TELEMETRY/iNav/crsf.luac differ diff --git a/docs/Change-Log.md b/docs/Change-Log.md deleted file mode 100644 index 7f129afb..00000000 --- a/docs/Change-Log.md +++ /dev/null @@ -1,232 +0,0 @@ -# Release History -## v1.7.2 - 08/25/2019 -- [Playback log files](../Configuration-Settings/#playback-telemetry-log-files) (may run out of memory on Taranis) -- Runs without luac or lua build options (broke in v1.7.1) -- Refactored code for higher speed and reduced memory usage -- Fix for french translation of OpenTX with the `RxBt` sensor labeled `BtRx` -- Crossfire: Add vertical speed option -- Crossfire: Fix for Q X7 Tx battery options -- Crossfire: Fix distance calculation errors -- Crossfire: Resolved edge-case yaw issue due to Crossfire rollover bug -- Horus: Home indicator now shows as a HUD indicator instead of a simple direction icon -- Horus: Uses vertical speed (if available) for better vertical placement of flight path vector icon -- Horus: Adds flight path vector support to S.Port/F.Port TELEMETRY (will require a yet to be released version of INAV) -- Detect X9 Lite transmitter correctly - -## v1.7.1 - 06/29/2019 -- Uses "flat earth" algebra for faster orientation/distance calculation -- Crossfire on Horus: Option for flight path vector indicator -- Crossfire: Resolved default orientation bug -- Horus: Nice 15% speedup -- Horus: Show satellite and HDOP (on S.Port) on config menu -- Horus: Changes to the config menu controls -- Horus: Trim 6 can be used while flying to switch between launch and compass-based orientation -- Horus: Added alternative location for speed and altitude units when certain options are enabled -- Horus: Distance value in radar always shows current distance (doesn't change when min/max is being viewed) -- Crossfire: Show total current drawn after flight when min/max is selected even if fuel % is usually shown -- Crossfire: Slightly better audio messages when exiting RTH -- Moved some things around and made a few functions to reduce memory usage -- Simplified things by using getRSSI() for both S.Port and Crossfire -- X9D: Altitude graph inverted so altitude values are grey and minute markers are dotted black -- Added automatic development mode for testing - -## v1.7.0 - 06/03/2019 -* Logs altitude graph in background so changing views doesn't halt altitude graph -* Refactored config options which saved a ton of memory -* Total rewrite of artificial horizon and pitch ladder, faster and better looking -* Horus: Optional roll indicator at top of attitude indicator -* Horus: 5 different aircraft symbols on attitude indicator (preview in config menu) -* Added support for [Jumper T16](https://www.jumper.xyz/) transmitter (operates just like Horus) -* Resolved bug that caused RSSI to always show 99dB on pilot, radar and altitude views -* Resolved bug that caused low voltage voice warning to occur too often if voltage was erratic -* Horus: Resolved bug which caused `disabled` message to appear -* Report when GPS lock is lost, not sure when this was mistakenly removed -* Style changes to variometer on Horus and on Taranis pilot, map, and altitude views -* Q X7: Cleaned up distance, altitude and GPS coordinate data below altitude graph - -## v1.6.1 - 03/29/2019 -* Added new option for altitude graph (additional view on Taranis / map overlay on Horus) -* Config option to set max cell voltage for calculating cell count (primary use: LiHV batteries) -* Horus: Fix display bug that caused disabled error -* Horus: Further optimized view for faster rendering -* Crossfire: Better fuel percentage estimation when battery isn't full -* Update language files for new config menu options - -## v1.6.0 - 01/21/2019 -* Adds Crossfire support (requires INAV v2.1.0 or later) -* Horus: Enhanced display speed (up to 40% faster) -* Horus: Script variables initialize on flight/telemetry reset -* Compatible with Betaflight using FrSky X or R9 series receivers (with reduced functionality) and TBS Crossfire support with Betaflight 4.0+ - -## v1.5.1 - 01/04/2019 -* Fixed draw error and HDOP graph on Q X7 -* Fixed setting `View Mode` and `GPS HDOP View` on Taranis -* Restore color options fixed on Horus widget -* Warning message when not a full-screen widget on Horus -* Changed Horus widget option names to fit within 10 character limit - -## v1.5.0 - 12/29/2018 -* Added support for Horus transmitters -* Updated Spanish voice files -* Fixed km/h in radar view - -## v1.4.3 - 11/13/2018 -* Added French language voice files, modes and config menu (thanks @d00bld0ze) -* Added Spanish language voice files, modes and config menu (thanks @fmartinezo) - * [Other language submissions encouraged!](../Multilingual-Support/) -* Instead of a single configuration shared by all models, it now uses a unique configuration for each model (be sure folder `\SCRIPTS\TELEMETRY\iNav\cfg` exists on the transmitter's SD card) -* Radar view UI tweaks -* Pitch added to QX7 display on radar view -* Heading hold indicator consistent for all views -* Better cell voltage value based on A4 sensor -* Better rounding for pitch and avoids ugly `-0°` -* Consolidated several complex routines into shared functions -* Uses Travis ci for pull request testing and future unit tests - -## v1.4.2 - 09/28/2018 - -* New radar view shows model in relationship to home position, can be displayed either as launch/pilot-based or compass-based orientation -* Added German language voice files, modes and config menu (thanks @Peschi90). [Other language submissions encouraged!](../Multilingual-Support) -* New feature gives feedback when altitude hold is activated and throttle position is in neutral hover position (vibrate when entering neutral hover position and beep when exiting) -* Cycle through views by short-pressing `Enter` -* Config menu now works with X9E transmitter -* Resolve battery warnings when no current sensor is present -* Refactored to speed up script (uses a bit more memory as a result however) -* Created build script for Companion (should keep all files in sync) - -## v1.4.1 - 08/25/2018 - -* Min/max values after flight added to pilot view -* For speed reasons, background and widget scripts moved back to core script, something in OpenTX 2.2.2 caused a great slow-down when loading scripts - -## v1.4.0 - 08/21/2018 - -* Pilot view (glass cockpit) which includes attitude indicator as well as pilot-familiar layout of additional data -* Shows GPS fix accuracy (HDOP) as strength indicator graph or decimal value (required INAV 2.0.0) -* You can customize when weak GPS fix accuracy (HDOP) triggers alert -* Allows speed sensor selection between GPS speed or pitot sensor's air speed (if available) -* GPS coordinates and altitude are displayed before launch even if there's no GPS fix -* Fuel can report mAh or mWh used instead of percent fuel remaining (percent highly suggested for fuel level alerts) -* The setup, config menu and views loads as separate scripts, greatly reducing memory used -* Variometer graph now correctly uses vertical speed as source instead of Z-axis accelerometer -* Config option under Variometer to also report altitude as voice notifications -* X9D display now uses gray when appropriate to enhance view clarity -* Disable config setting (and set to default) if sensor isn't present -* Config menu wraps from top to bottom (and vice versa) to more easily locate desired config option, also remembers last menu option -* Config menu supports button hold-repeat on X9D and X9D+ to make changes easier -* Config menu fuel percentage warning and critical changed to 1% steps to increase flexibility -* Only shows the last good GPS coordinates instead of the last 5 to reduce complexity (didn't provide more useful info either) -* Removed `getLastPos()` function dependency which is faster, cleans up code and could allow Horus support -* Fixed an issue with "NO TELEM" and "THR WARN" being displayed incorrectly -* Cleaned up readme, broke up into Wiki pages - -## v1.3.1 - 05/29/2018 - -* Support added for the X-Lite transmitter (requires OpenTX v2.2.2) -* Option to set the low and critical warning level for fuel percentage remaining -* Option to display the transmitter voltage as a graph and/or the numerical value -* Modified how battery cell count is calculated -* Can now set cell critical voltage to as low as 2.6v to support 18650 batteries -* Slightly adjusted display positioning to show greater GPS accuracy on QX7 and X-Lite transmitters - -## v1.3.0 - 05/13/2018 - -* Compatibility with new F.Port protocol (requires INAV v1.9.1+) -* Support added for D-series receivers with telemetry (requires INAV v2.0+) -* Option to show GPS coordinates as degrees and minutes or in geocoding format instead of the previous decimal only -* Shows `THR WARN` if not okay to fly and throttle isn't at minimum position -* If distance sensor name is the default `0420`, the max distance now displays correctly -* Updated data digits to display before truncating unit of measure - -## v1.2.5 - 04/28/2018 - -* Uses GPS for launch-based altitude if barometer isn't present -* No longer requires `0420` sensor to be renamed `Dist` -* Better error handling, specially if `iNav` folder doesn't exist -* Renamed PASSTHRU mode MANUAL and add audio file for manual mode -* Correct altitude unit designation in configuration when barometer isn't present -* Adjustment to data display for min/max indicator - -## v1.2.4 - 04/17/2018 - -* Satellite and altitude hold are now icons -* Added flashing notification for headfree mode on QX7 (already existed on X9D) -* Smarter unit designation resulting in a cleaner display (ft = ', MPH & km/h) - -## v1.2.3 - 12/19/2017 - -* Logs the last 5 unique GPS coordinates -* Updated readme screenshots to show variometer -* Release history is now here instead of in readme file - -## v1.2.2 - 12/09/2017 - -* Last 5 GPS coordinates can be reviewed from the config menu -* Resolved issue where if telemetry was lost/recovered it would incorrectly give voice alerts for flight modes/engines armed/disarmed -* Config menu can be accessed at any time, even when armed - -## v1.2.1 - 12/01/2017 - -* Lots of new/changed config settings (press `Menu` button to access) - **Please review!** -* Enhanced and cleaned up config menu, centered menu on QX7 & X9D/+ -* Variometer shows if model is gaining or decreasing altitude -* Cell voltage battery view shows with two digits of precision -* Added `S` (South) to X9D/+ directional display - -## v1.2.0 - 11/18/2017 - -* Lua Telemetry is now pre-compiled to greatly reduce memory (source still available) -* Press `Menu` button (when not armed) to modify user configuration options -* Fixed `FAILSAFE`, `RTH`, `NOT OK` & `NO TELEM` modes to flash as they should -* Barometer and magnetometer are now optional (but suggested for full functionality) -* Headfree indication on QX7 changed to show directional indicators as dotted lines -* Startup message/version and error if not running OpenTX v2.2.0 or later - -## v1.1.7 - 11/02/2017 - -* Fix for the default unit type of the `Dist` (`0420`) sensor - -## v1.1.6 - 11/01/2017 - -* On home reset, reset GPS home position, orientation and distance -* Option to display average battery cell voltage instead of total voltage -* Extra digit for data on X9D & X9D+ transmitters -* Variable cleanup saving memory - -## v1.1.5 - 10/20/2017 - -* Voice notification for `Home Reset` with INAV v1.8+ -* Moved head free warning on QX7 to top center -* Values convert from decimal to integer when larger to allow for more room -* Better text centering and right justification technique -* Cleaned up code saving more memory - -## v1.1.4 - 10/13/2017 - -* More accurate max altitude alerts and altitude flashes when above max altitude -* Long-press resets values (suggest doing this between flights before armed) - -## v1.1.3 - 10/10/2017 - -* Shows metric or imperial values based on transmitter telemetry settings - -## v1.1.2 - 10/06/2017 - -* Lots of refactoring which greatly reduced memory usage -* Re-enabled altitude bar gauge for X9D, X9D+ & X9E transmitters -* Better information layout if no current sensor is present -* Refactored GPS lock calculation to prevent script syntax errors - -## v1.1.1 - 09/28/2017 - -* Refactored code to reduce memory -* Removed altitude bar gauge for X9D, X9D+ & X9E transmitters (used too much memory?) - -## v1.1.0 - 09/22/2017 - -* Repository moved to INAVFlight -* Screen formatting for Taranis X9D, X9D+ & X9E - -## v1.0.0 - 09/19/2017 - -* Initial release \ No newline at end of file diff --git a/docs/Configuration-Settings.md b/docs/Configuration-Settings.md deleted file mode 100644 index 68fae5d6..00000000 --- a/docs/Configuration-Settings.md +++ /dev/null @@ -1,117 +0,0 @@ -## Taranis - -Press the `Menu` button (`Shift` on X-Lite) to display the configuration options menu: - -* Use the dial or +/- buttons to cycle through the menu or select the desired setting -* Press Enter/dial to select and deselect a menu option -* Press `Exit` or `RTN` to deselect a menu option or escape the configuration menu - -## Horus/Jumper T16 - -* Must be unarmed to access the config menu when running as a widget -* Use the following (mode 2) stick controls to navigate the config menu: - -![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavConfigHorus.png "Horus config menu") - -### Configuration menu options - -![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavConfig.png "Configuration menu") - -!!! note - Options without selections have either been disabled by another option setting or are not available on your transmitter or telemetry protocol. - - * **Battery View** - Total battery voltage / Cell voltage average (default: Total) - * **Battery Alert** - All battery alerts on, off or only critical alerts (default: All) - * **Cell Low** - Cell voltage for low battery warning (default: 3.5V) **[[help](#suggested-battery-settings)]** - * **Cell Critical** - Cell voltage for battery critical warning (default: 3.4V) **[[help](#suggested-battery-settings)]** - * **Cell Calculation** - Voltage to calculate cell count, 4.3V for LiPo, 4.4V for LiHV (default: 4.3V) - * **Fuel Unit** - Match to INAV CLI value `smartport_fuel_unit` (default: Percent) **[[help](#suggested-battery-settings)]** - * **Battery Capacity** - Set the battery capacity for Crossfire (default: 1500mAh) - * **Fuel Low** - Fuel percentage for low battery warning (default: 30%) **[[help](#suggested-battery-settings)]** - * **Fuel Critical** - Fuel percentage for battery critical warning (default: 20%) **[[help](#suggested-battery-settings)]** - * **Altitude Alert** - Turn on/off the altitude alert (default: On) - * **Max Altitude** - Altitude warning starts when over this value (default: 400' or 120m) - * **Timer** - Show the automatic flight timer, timer1, timer2 or turn timer off (default: Auto) - * **Tx Voltage** - Show transmitter voltage as graph and/or numerical value (default: Both or Graph) - * **Rx Voltage** - Turn on/off the receiver voltage in the title (default: On) - * **Variometer** - Vertical speed graph, voice notifications or off (default: Off) - * **Vario Steps** - If Variometer is set to Voice, select the altitude steps (default: 10' or 10m) - * **Altitude Graph** - Turn off or set altitude graph time period from 1-6 minutes (default: Off) - * **Voice Alerts** - All voice alerts on, off or only critical alerts (default: All) - * **Feedback** - Turn beeper and/or haptic feedback for alerts on or off (default: All) - * **RTH Feedback** - Return to home beeper and haptic feedback on or off (default: On) - * **HeadFree Feedback** - Head free beeper and haptic feedback on or off (default: On) - * **RSSI Feedback** - RSSI beeper and haptic feedback on or off (default: On) - * **AltHold Center FB** - Hepatic/audio feedback for Alt Hold center throttle position (default: Off) - * **Speed Sensor** - Speed sensor to use, GPS or (if available) Pitot air speed (default: GPS) - * **View Mode** - Classic, pilot, radar or altitude graph view modes (default: Classic) - * **Roll Indicator** - Turn on/off roll indicator on Horus (default: Off) - * **Aircraft Symbol** - Options 0 - 5 on Horus, [see below](#horusjumper-t16-aircraft-symbol-options) for options (default: 0) - * **HUD Home Icon** - Select HUD or simple orientation for home icon on Horus (default: Off) - * **Center Map Home** - Turn on/off centering of the radar home position on Horus (default: Off) - * **Orientation** - Launch/pilot-based or compass-based default orientation (default: Launch) - * **GPS HDOP View** - View the GPS accuracy (HDOP) as a Graph or Decimal (default: Graph) - * **GPS Warning** - GPS accuracy (HDOP) to trigger warning (default: > 3.5 HDOP [at least 1 bar]) - * **GPS** - GPS coordinates as decimal or degrees/minutes format (default: Decimal) - * **Playback Log** - Playback telemetry log files (latest 5 logs from the last 2 weeks) **[[help](../Configuration-Settings/#playback-telemetry-log-files)]** - -## Suggested Battery Settings -### Voltage and Current Calibration - -1. Using a multimeter, calibrate the voltage with the "Voltage Scale" in INAV configurator -1. If you have a current sensor, make sure you [calibrate it](https://www.youtube.com/watch?v=AWjblvHgjjI) - -### In INAV Configurator - -* Voltage source to use for alarms and telemetry: **Raw** -* Number of cells: **0** (0=auto, set if you always use the same cell count) -* Maximum cell voltage for cell count detection: **4.3** -* Minimum cell voltage: **3.4** (match "Cell Critical" in Lua Telemetry) -* Maximum cell voltage: **4.2** -* Warning cell voltage: **3.5** (match "Cell Low" in Lua Telemetry) -* Set capacity in **mAh** to battery capacity -* Warning capacity: **30%** (match "Fuel Low" in Lua Telemetry) -* Critical capacity: **10%** - -### In INAV CLI (ignore for TBS Crossfire) - -* `set smartport_fuel_unit = percent` -* `set report_cell_voltage = OFF` (if set to `ON` Lua Telemetry can't show total battery voltage) - -### In Lua Telemetry - -* Cell Low: **3.5V** (match "Warning cell voltage" in INAV) -* Cell Critical: **3.4V** (match "Minimum cell voltage" in INAV) -* Fuel Unit: **Percent** -* Fuel Low: **30%** (match "Warning capacity" in INAV) -* Fuel Critical: **20%** - -## Playback Telemetry Log Files - -!!!warning - Telemetry log file playback works really well on Horus transmitters. However, while it works on my Taranis Q X7, for others it may crash with a "**attempt to call a nil value**" or "**not enough memory**" error. This means you're using too much memory for other things on your transmitter and it doesn't have enough memory to playback the logs. Not switching views and not using the pilot view will use less memory, but it's possible you just won't be able to playback log files on a Taranis transmitter if you have too little memory available. - -Log file playback allows you to playback the latest 5 telemetry log files from up to the last 2 weeks on the currently selected model. You must be _unarmed_ for this to work and if you arm while playing back a log file, the playback will be terminated. - -### Setup - -Before you can playback a telemetry log file you need to make sure you're logging your telemetry. By default for each telemetry sensor, the **Logs** option is already checked (unless you unchecked it). However, it still won't log unless you setup a special function. In the model setup on your transmitter, page to the **SPECIAL FUNCTIONS** page. In an empty slot, create a special function that's activated from your arm switch (in my case **SF↓**). It should look something like this: - -``` -SF1 SF↓ SD Logs 0.2s -``` - -This will log your telemetry 5 times per second automatically every time you arm. You can set this up on any switch you'd like, but the arm switch is most common. You can also change the value to 0.1s to log 10 times a second or any other value you wish. Note that the log playback will be smoother if you select a lower log frequency value. - -### Playback - -To playback a log file, go to the config menu and scroll to the last item. If there's any log files in the last 2 weeks, you'll see a date (in YY-MM-DD format). You can cycle through the dates and select the one you wish to playback (exit will unselect the menu option). - -Standard playback will be at close to normal speed (note the timestamp in the title bar). When playing back, you can use the right stick (mode 2) to fast forward (stick up), reverse (stick down), pause (hold stick right), or quit (stick left). The further you move the stick up and down the faster the forward or reverse. The stick center position is playback at normal speed. When it gets to the end of the log, it will pause. - -As multiple flights from the same day are recorded to the same telemetry log files, the playback will continue to the next flight (note the timestamp in the title for time jumps which will be a new flight). - - -## Horus/Jumper T16 aircraft symbol options - -![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/development/assets/AircraftSymbols.png "Horus aircraft symbols") \ No newline at end of file diff --git a/docs/Getting-Started.md b/docs/Getting-Started.md deleted file mode 100644 index 14d4db32..00000000 --- a/docs/Getting-Started.md +++ /dev/null @@ -1,79 +0,0 @@ -### Installation - -!!! tip - To upgrade from a previous version, see the (_**much**_ shorter) [upgrade instructions](../Upgrade) - -Don't be too concerned about the length of these instructions. The first two sections are about setting up telemetry in INAV and your transmitter, which for most is already completed. Also, the instructions are for multiple transmitters, telemetry protocols and I've tried to be very descriptive so even a novice could follow along. Therefore, it's a bit verbose but proceeds quickly, I promise. - -#### INAV Configurator Telemetry Setup - -1. Setup SmartPort(S.Port), F.Port, D-series, or Crossfire telemetry to send to your transmitter: [INAV telemetry docs](https://github.com/iNavFlight/inav/master/docs/Telemetry.md) -1. FrSky receivers (skip for TBS Crossfire): - 1. If you have an current sensor and want to show fuel percent remaining: - * `set smartport_fuel_unit = PERCENT` - * Set `battery_capacity` to the mAh you want to draw from your battery - 1. If instead you want to show the current sensor's mAh: - * `set smartport_fuel_unit = MAH` - 1. With INAV v2.0.0+, `set frsky_pitch_roll = ON` in CLI settings for accurate attitude display and pitch angle - -#### Add Telemetry Sensors to Transmitter - -1. With battery connected and **after GPS fix** [discover telemetry sensors](https://www.youtube.com/watch?v=n09q26Gh858) so all telemetry sensors are discovered -1. FrSky receivers (skip for TBS Crossfire): - 1. Telemetry distance sensor name `0420` (or `0007` with D-series receivers) should be changed to `Dist` and set to the desired unit: `m` or `ft` - 1. The sensors `Dist`, `Alt`, `GAlt` and `Gspd` can be changed to the desired unit: `m` or `ft` / `kmh` or `mph` - 1. If you `set frsky_pitch_roll = ON` on INAV v2.0.0+ (which I suggest) you can optionally change the following for clarification: - * Telemetry sensor `0430` (or `0008` with D-series receivers) can be changed to `Ptch` - * Telemetry sensor `0440` (or `0020` with D-series receivers) can be changed to `Roll` - 1. **Don't** change `Tmp1` or `Tmp2` from Celsius to Fahrenheit! They're not temps (used for flight modes and GPS info) - 1. If you don't have a current sensor, you can optionally delete or rename the `Fuel` sensor so it doesn't show in Lua Telemetry - -#### Install/Setup Lua Telemetry on Transmitter - -1. Download the latest [LuaTelemetry.zip](https://github.com/iNavFlight/LuaTelemetry/releases/latest) file (Note: **NOT** the source code) -1. Copy the contents of the ZIP file (`SCRIPTS` and `WIDGETS` folders) to the transmitter's SD card's root - * Taranis: - 1. In model setup, page to `DISPLAY` - 1. Set desired screen to `Script` - 1. Select `iNav` - * Horus/Jumper T16: - 1. Long-press `TELE` to access the user interface/views layout - 1. Select the desired view (or create a new one) - 1. Make `Layout` full screen, turn off `Top bar` and `Sliders+Trims` - 1. Select `Setup widgets` - 1. Press `Enter` till a menu appears and select `Select widget` - 1. Scroll to the `iNav` widget and press `Enter` - 1. Optionally (while still selecting the `iNAV` script), long-press `Enter`, select `Widget settings` where you can enable `Restore` (to restore your theme's colors) and set your theme's `Text` color and `Warning` color - * Nirvana NV14: - 1. Press the Widgets icon - 1. Select the desired view - 1. Change the layout to full screen - 1. Uncheck all boxes - 1. Select `Setup widgets`, tap the screen and select `iNAV` - 1. Optionally, you can enable `Restore` (to restore your theme's colors) and set your theme's `Text` color and `Warning` color -1. Press `EXIT` or `RTN` several times to exit (back icon on Nirvana) - -### Download Options -When [downloading INAV Lua Telemetry](https://github.com/iNavFlight/LuaTelemetry/releases/latest), you may notice there's several different download options at the bottom of the release. Following are descriptions of each download option: - -* **LuaTelemetry-Horus-en.zip** - Horus transmitters with English sound files only -* **LuaTelemetry-Horus.zip** - Horus transmitters with sound files for all supported languages -* **LuaTelemetry-Taranis-en.zip** - Taranis transmitters with English sound files only -* **LuaTelemetry-Taranis.zip** - Taranis transmitters with sound files for all supported languages -* **LuaTelemetry.zip** - Taranis and Horus including sound files for all supported languages -* **Source code** (zip) - ZIP compressed source code for this release - *not for transmitter install* -* **Source code** (tar.gz) - Tarball format source code for this release - *not for transmitter install* - -If you just want to install without thinking about it, download and install the latest [LuaTelemetry.zip](https://github.com/iNavFlight/LuaTelemetry/releases/latest) file which includes everything and will work on both Taranis and Horus in any language. The other download options are available to save a bit of SD card space on the transmitter and to keep the install clean of unneeded files. - - -#### Running Lua Telemetry - -* Taranis: - 1. From the main screen on your transmitter, long-press `Page` (down d-pad on X-Lite) - 1. If Lua Telemetry isn't on your first page, short-press `Page` to the Lua Telemetry screen -* Horus/Jumper T16/Nirvava NV14: - 1. From the main screen on your transmitter, press `PgUp/Dn` (swipe left on Nirvana) to the Lua Telemetry view -* [Screen Description](../Screen-Description) -* [Configuration Settings](../Configuration-Settings) -* [Tips & Common Problems](../Tips-&-Common-Problems) \ No newline at end of file diff --git a/docs/Multilingual-Support.md b/docs/Multilingual-Support.md deleted file mode 100644 index 7c484b3f..00000000 --- a/docs/Multilingual-Support.md +++ /dev/null @@ -1,34 +0,0 @@ -### Currently supported ([language submissions encouraged!](Multilingual-Support/#adding-new-language)) - - - [ ] Czech (cz) - - [ ] Dutch (nl) - - [X] English (en) - - [X] French (fr) - - [X] German (de) - - [ ] Hungarian (hu) - - [ ] Italian (it) - - [ ] Polish (pl) - - [ ] Portuguese (pt) - - [ ] Russian (ru) - - [ ] Slovak (sk) - - [X] Spanish (es) - - [ ] Swedish (se) - -### How to select a supported language -Lua Telemetry uses the OpenTX settings for multilingual support. If language voice files or language translation file doesn't exist, Lua Telemetry will default to English. - -* To change the voice prompts you set the `Voice Language` setting on the `RADIO SETUP` menu. You'll need to cycle power to your transmitter for Lua Telemetry to see the change. - -* For the flight modes and config menu translation, you need to be running OpenTX firmware with the desired Menu Language. From the OpenTX Companion: -1. Go to `Settings` (the gear icon) -1. Select the desired `Menu Language` -1. Download firmware -1. Write firmware to radio. - -### Adding new language -To add support for one of the above languages, follow these steps: - -1. Language voice files need to be created. Here's is a [list of the 32 voice files required](https://github.com/iNavFlight/LuaTelemetry/tree/development/dist/SCRIPTS/TELEMETRY/iNav/en) -1. A `lang_XX.lua` language translation file needs to be created. Here's an example of the German translation file: [lang_de.lua](https://github.com/iNavFlight/LuaTelemetry/development/src/iNav/lang_de.lua) (note the maximum character length comments) - -The voice and translation files can be submitted in a PR or you can [create a feature request issue](https://github.com/iNavFlight/LuaTelemetry/issues/new/choose) and attach the files and I'll take care of it. Either way, be prepared to possibly do some tweaking if the translation lengths are too long. \ No newline at end of file diff --git a/docs/Screen-Description.md b/docs/Screen-Description.md deleted file mode 100644 index 62e1915d..00000000 --- a/docs/Screen-Description.md +++ /dev/null @@ -1,34 +0,0 @@ -### Getting Started - -* From transmitter's main screen, long hold the `Page` button (down d-pad on X-Lite) to show custom screens, short press `Page` to the iNav screen -* If you get a `not enough memory` error when starting Lua Telemetry, please see the [Tips & Common Problems](../Tips-&-Common-Problems) wiki - -### General Information - -* Flashing values indicate a warning (for example: no telemetry, battery low, altitude too high) -* Beeping/vibration is associated with critical warnings and there will be an associated flashing value to indicate what the beep/vibration is a result of -* The script gives voice feedback for flight modes, battery levels and warnings (no need to manually set this up) -* Voice alerts will play in background even if iNav Lua Telemetry screen is not displayed -* When not armed you can flip between max/min and current values by using the dial or +/- buttons -* Short press `Enter` to quickly flip between the views - -### Classic View - -![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/development/assets/iNavKey.png "Classic view screen description") -![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/development/assets/iNavKeyX9D.png "Classic view screen description for X9D") - -* To flip between compass-based direction and launch/pilot-based orientation and location, use the dial or +/- buttons -* The launch/pilot-based orientation view is useful if model orientation is unknown -* If model is further than 25 feet away, the launch/pilot-based view will show the direction of the model based on launch/pilot position and orientation (useful to locate a lost model) - -### Pilot (Glass Cockpit) View - -![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/development/assets/iNavPilotKey.png "Pilot view screen description")   - - -### Radar (Map) View - -![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/development/assets/iNavQX7radarKey.png "Radar view screen description")   -![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/development/assets/iNavX9DradarKey.png "Radar view screen description for X9D") - -* To flip between compass-based and launch/pilot-based orientation and radar, use the dial or +/- buttons diff --git a/docs/Tips-&-Common-Problems.md b/docs/Tips-&-Common-Problems.md deleted file mode 100644 index 2a4571a1..00000000 --- a/docs/Tips-&-Common-Problems.md +++ /dev/null @@ -1,35 +0,0 @@ -## Common Taranis Errors - -* Script syntax error -* attempt to call a nil value -* Script panic not enough memory -* Script syntax error not enough memory - -#### Solution - -* Be sure you're following the [Install/Setup Lua Telemetry on Transmitter](../Getting-Started/#installsetup-lua-telemetry-on-transmitter) instructions -* If you're still getting the above errors, it's probably due to a lack of memory available on your transmitter (very common on Taranis). You can free up memory by removing other Lua Scripts from other screens, deleting unused models or turning off OpenTX firmware build options. Be sure to reboot your controller to free up memory after making a change. - -> **NOTE:** If trying to run Betaflight Tx lua script for VTx control, you can't run Betaflight Tx lua script and Lua Telemetry at the same time. Instead, change VTx settings by using the [OSD menu](https://github.com/iNavFlight/inav/master/docs/Controls.md) - -## Common Horus Errors - -* **disabled** error on widget -* refresh(): ?:0: attempt to compare number with nil - -#### Solution - -* Upgrade to the [latest release](../Upgrade) which fixes these issues - -## Tips - -* If you have any issues, first make sure you're using the release version 2.2.2+ of OpenTX. There's some bugs in pre-release and release candidate versions that cause Lua Telemetry to crash -* Between flights (before armed), long-press Enter/dial and select `Reset telemetry` to reset telemetry values -* If current sensor isn't present or _battery isn't fully charged when plugged in_, fuel gauge will be based on battery voltage -* If fuel gauge isn't shown or accurate, be sure you've set CLI values `smartport_fuel_unit = percent` and `battery_capacity` correctly. Also, current sensor settings in the configurator need to be calibrated for proper amperage and fuel % data (not applicable to Crossfire) -* If using INAV v2.0.0+ and FrSky telemetry, `set frsky_pitch_roll = ON` in CLI settings and search for new telemetry sensors for accurate attitude display and pitch angle (not applicable to Crossfire) -* Lua Telemetry uses transmitter settings for RSSI warning/critical levels for bar gauge range and audio/haptic warnings -* Lua Telemetry uses transmitter settings for transmitter voltage min/max for battery bar gauge in screen title -* If you change a telemetry sensor's unit (for example m to ft), power cycle the transmitter to see changes -* If config option `Battery View` is set to `Total` but average cell voltage is displayed, send INAV CLI command: `set report_cell_voltage = OFF` -* When GPS accuracy (HDOP) is displayed as a decimal, the range is 0.8 - 5.3 and it's rounded to the nearest 0.5 HDOP. This is due to HDOP being sent as a single integer from 0 to 9, not as the actual HDOP decimal value (not applicable to Crossfire) \ No newline at end of file diff --git a/docs/Upgrade.md b/docs/Upgrade.md deleted file mode 100644 index 6756ea88..00000000 --- a/docs/Upgrade.md +++ /dev/null @@ -1,29 +0,0 @@ -# Upgrade INAV Telemetry -## Already have Lua Telemetry installed -If you're already running Lua Telemetry, you can quickly upgrade to the latest release version by following these simple steps: - -1. Download the latest [LuaTelemetry.zip](https://github.com/iNavFlight/LuaTelemetry/releases/latest) file (Note: **NOT** the source code) -1. Copy the contents of the ZIP file (`SCRIPTS` and `WIDGETS` folders) to the transmitter's SD card's root - -![](http://www.leethost.com/link_pics/master.png) - -And you're ready to go! - -## Upgrade to development build - -> **Please note:** These instructions are for upgrading from a previous version of Lua Telemetry. If you haven't yet installed Lua Telemetry, you'll need to first do a full installation and then follow these instructions. - -Typically, the development branch of Lua Telemetry is fairly bug free. For the most part, features are added and tested before merging to development. Current status of development branch: - -[![Build Status](https://travis-ci.com/iNavFlight/LuaTelemetry.svg?branch=development)](https://travis-ci.com/iNavFlight/LuaTelemetry) - -To upgrade to the development build, use the following instructions: - -1. Download [LuaTelemetry-development.zip](https://github.com/iNavFlight/LuaTelemetry/archive/development.zip) -1. Open or extract the `LuaTelemetry-development.zip` file -1. Open the `LuaTelemetry-development` folder and navigate to the `dist` folder -1. Copy the contents of the `dist` folder (`SCRIPTS` and `WIDGETS` folders) to the transmitter's SD card's root - -![](http://www.leethost.com/link_pics/development.png) - -You'll also sometimes need the latest INAV build to go along with the development branch of Lua Telemetry. So it's also a good idea to [upgrade INAV](https://github.com/iNavFlight/inav/releases) to the latest release. If there's ever an issue, you can roll back to the latest release by following the [upgrade](../Upgrade) instructions. \ No newline at end of file diff --git a/docs/inav.png b/docs/inav.png deleted file mode 100644 index 47180b78..00000000 Binary files a/docs/inav.png and /dev/null differ diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index f639b0c2..00000000 --- a/docs/index.md +++ /dev/null @@ -1,27 +0,0 @@ -# INAV Lua Telemetry - -INAV Lua Telemetry Flight Status for Taranis/Horus/Jumper Transmitters -FrSky SmartPort(S.Port), D-series, F.Port & TBS Crossfire on Taranis, Horus & Jumper - - - [Support Chat (Telegram)](https://t.me/luatelemetry) - - [Support Issues](https://github.com/iNavFlight/LuaTelemetry/issues?q=is%3Aissue) - -### Screenshots of FrSky SmartPort(S.Port), D-series, F.Port & TBS Crossfire on Taranis, Horus & Jumper - -#### View on Horus/Jumper T16 transmitters -![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavHorus.png "View on Horus/Jumper T16 transmitters") -![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavNirvana.jpg "View on Nirvana NV14 transmitter") - -#### Views on other radios (Jumper T12, Taranis X9D and more) - -| Q X7, X-Lite & Jumper T12 | Taranis X9D, X9D+ and X9E | -|-|-| -| ![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavQX7pilot.png "Pilot view on Q X7, X-Lite & Jumper T12")| ![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavX9Dpilot.png "Pilot view on Taranis X9D, X9D+ and X9E") | -| ![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavQX7radar.png "Radar view on Q X7, X-Lite & Jumper T12") | ![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavX9Dradar.png "Radar view on Taranis X9D, X9D+ and X9E") | -| ![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavQX7alt.png "Altitude graph view on Q X7, X-Lite & Jumper T12") | ![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavX9Dalt.png "Altitude graph view on Taranis X9D, X9D+ and X9E") | -| ![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavQX7.png "Classic view on Q X7, X-Lite & Jumper T12") | ![sample](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavX9D.png "Classic view on Taranis X9D, X9D+ and X9E") | - - -### Video of Lua Telemetry -[![](https://raw.githubusercontent.com/iNavFlight/LuaTelemetry/master/assets/iNavX9Dvideo.png "Video of Lua Telemetry")](https://www.youtube.com/watch?v=YaUgywuT1YM) - diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 944392f3..00000000 --- a/mkdocs.yml +++ /dev/null @@ -1,25 +0,0 @@ -site_name: INAV Lua Telemetry -theme: - name: material - palette: - scheme: slate - primary: blue -extra: - social: - - icon: fontawesome/brands/telegram - link: https://t.me/luatelemetry - -markdown_extensions: - - pymdownx.superfences - - pymdownx.details - - admonition - - pymdownx.tasklist -nav: - - "INAV Lua Telemetry": index.md - - "Getting Started": Getting-Started.md - - "Configuration Settings": Configuration-Settings.md - - "Screen Description": Screen-Description.md - - "Tips & Common Problems": Tips-&-Common-Problems.md - - "Upgrade": Upgrade.md - - "Multilingual Support": Multilingual-Support.md - - "Change Log": Change-Log.md \ No newline at end of file diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index 61bbef07..00000000 --- a/readthedocs.yml +++ /dev/null @@ -1,9 +0,0 @@ -version: 2 - -mkdocs: - configuration: mkdocs.yml - -python: - version: 3.7 - install: - - requirements: requirements-docs.txt diff --git a/requirements-docs.txt b/requirements-docs.txt deleted file mode 100644 index 21f876b4..00000000 --- a/requirements-docs.txt +++ /dev/null @@ -1,2 +0,0 @@ -mkdocs -mkdocs-material \ No newline at end of file diff --git a/src/iNav.lua b/src/iNav.lua index 3b95d8b5..cdf10ae2 100644 --- a/src/iNav.lua +++ b/src/iNav.lua @@ -3,7 +3,7 @@ -- Docs: https://github.com/iNavFlight/LuaTelemetry local buildMode = ... -local VERSION = "1.7.4" +local VERSION = "1.7.5" local FILE_PATH = "/SCRIPTS/TELEMETRY/iNav/" local SMLCD = LCD_W < 212 local HORUS = LCD_W >= 480 or LCD_H >= 480 diff --git a/src/iNav/crsf.lua b/src/iNav/crsf.lua index f6946c85..3a92c31c 100644 --- a/src/iNav/crsf.lua +++ b/src/iNav/crsf.lua @@ -78,7 +78,7 @@ local function crsf(data) elseif data.fm == "OK" or bfArmed == false then data.mode = 1 -- Armed modes - elseif data.fm == "ACRO" then + elseif data.fm == "ACRO" or data.fm == "AIR" then data.mode = 5 elseif data.fm == "ANGL" or data.fm == "STAB" then data.mode = 15 @@ -106,4 +106,4 @@ local function crsf(data) return 0 end -return crsf \ No newline at end of file +return crsf