Skip to content

Commit

Permalink
Merge pull request #112 from iNavFlight/doc_version_bump
Browse files Browse the repository at this point in the history
update docs versions
  • Loading branch information
stronnag authored Aug 12, 2023
2 parents 088093f + fd2a283 commit 3b0ad01
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 34 deletions.
8 changes: 6 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ version: 2
mkdocs:
configuration: mkdocs.yml

build:
os: ubuntu-22.04
tools:
python: "3.11"

python:
version: 3.7
install:
- requirements: requirements-docs.txt
- requirements: requirements-docs.txt
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,11 @@

## Requirements

* [INAV v2.6.1+](https://github.com/iNavFlight/inav/releases) running on your flight controller.Also compatible with Betaflight v4.0.0+ (with reduced functionality)
* [OpenTX v2.3+](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.5.0+](https://edgetx.org/) running on a [supported radio](https://github.com/EdgeTX/edgetx.github.io/wiki/Frequently-Asked-Questions).
* Jumper T12/T16 requires [JumperTX 2.2.3+](https://www.jumper.xyz/) (May 23, 2019 or after release)
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.Also compatible with Betaflight v4.0.0+ (with reduced functionality)
* [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.

Expand Down
6 changes: 1 addition & 5 deletions docs/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,8 @@ Don't be too concerned about the length of these instructions. The first two sec
1. Press `EXIT` or `RTN` several times to exit (back icon on Nirvana)

### Download Options
When [downloading INAV Lua Telemetry](https://github.com/iNavFlight/OpenTX-Telemetry-Widget/releases/latest). There may be multiple download options at the bottom of the release. Following are descriptions of each download option:
When [downloading INAV Lua Telemetry](https://github.com/iNavFlight/OpenTX-Telemetry-Widget/releases/latest).

* **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*
Expand Down
9 changes: 5 additions & 4 deletions docs/Tips-And-Common-Problems.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@

#### Solution

* Upgrade to the [latest release](../Upgrade) which fixes these issues
* Upgrade to the [latest release](../Upgrade) which may fix these issues
* If it doesn't raise a Github issue.

## 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
* If you have any issues, first make sure you're using a supported version of OpenTX / EdgeTX.
* Preferably use the latest version of your TX firmware (OpenTX or EdgeTX)
* 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
Expand All @@ -43,11 +44,11 @@ Please include:

* The TX type (e.g. Radiomaster TX16S, Horus, Zorro etc.)
* The type and version of radio firmware (e.g. EdgeTX 2.8.0, OpenTX 2.3.15 etc).
* The flight controller and INAV version (e.g. MATEKF405, INAV 5.1.0)
* The flight controller and INAV version (e.g. MATEKF405, INAV 6.1.0)
* Details of Other active Lua widgets

Try running the script in the EdgeTX / OpenTX Companion. This will force debug mode and display additional information, in particular module line numbers. Please including this information in any Github issue.

Please also check that the problem can actually be reproduced in the firmware "Companion" application. If it cannot, it is probable that the maintainer cannot investigate the problem. You should also raise a firmware issue that "Companion" and real hardware exhibit different behaviours.

For issues concerning discovery or display of sensor information, please provide an EdgeTX / OpenTX telemetry log for TXs that provide such a facility.
For issues concerning discovery or display of sensor information, **please provide an EdgeTX / OpenTX telemetry log for TXs that provide such a facility**.
19 changes: 0 additions & 19 deletions docs/Upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,3 @@ If you're already running Lua Telemetry, you can quickly upgrade to the latest r
![](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.

0 comments on commit 3b0ad01

Please sign in to comment.