Skip to content

Commit 3b73c9d

Browse files
committed
Readme download clarification
1 parent ad6b4e4 commit 3b73c9d

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,15 @@
2727
* [INAV v1.7.3+](https://github.com/iNavFlight/inav/releases) running on your flight controller
2828
* GPS, altimeter (barometer), and magnetometer (compass) sensors
2929

30-
> Note: Lua Telemetry **requires** SmartPort telemetry (the above requirements imply that).
31-
> Lua Telemetry won't work with Crossfire for example because it uses proprietary sensors and missing sensor information.
32-
> The above requirements are really that, they're required for this script to function.
30+
> Note: This Lua Telemetry script **requires** SmartPort telemetry as noted above.
31+
> Lua Telemetry **won't work with Crossfire** for example because it uses proprietary sensor names/formatting and missing sensor information that Lua Telemetry needs.
3332
3433
## Setup
3534

3635
#### In INAV Configurator
3736

38-
1. Setup telemetry to send to your transmitter - [INAV telemetry docs](https://github.com/iNavFlight/inav/blob/master/docs/Telemetry.md)
39-
2. If you have an amperage sensor, configure `battery_capacity` to the mAh you want to draw from your battery and set `smartport_fuel_percent = ON` in CLI settings (allows proper calibration of battery used percentage)
37+
1. Setup SmartPort telemetry to send to your transmitter - [INAV telemetry docs](https://github.com/iNavFlight/inav/blob/master/docs/Telemetry.md#smartport-sport-telemetry)
38+
2. If you have an amperage sensor (which I highly suggest), configure `battery_capacity` to the mAh you want to draw from your battery and set `smartport_fuel_percent = ON` in CLI settings (allows proper calibration of fuel used percentage)
4039

4140
#### From Transmitter
4241

@@ -47,9 +46,10 @@
4746

4847
#### INAV Lua Telemetry Screen Setup
4948

50-
1. Copy `iNav.lua` file to transmitter SD card's `\SCRIPTS\TELEMETRY\` folder
51-
2. Copy `iNav` folder to transmitter SD card's `\SCRIPTS\TELEMETRY\` folder
52-
3. In model setup, page to `DISPLAY`, set desired screen to `Script`, and select `iNav`
49+
1. Download the Lua Telemetry ZIP file by clicking the green `Clone or download` button towards the top right and select `Download ZIP`
50+
2. From the downloaded `LuaTelemetry.zip`, copy the `iNav.lua` file to the transmitter's SD card's `\SCRIPTS\TELEMETRY\` folder
51+
3. Also from the ZIP file, copy the `iNav` folder to the transmitter's SD card's `\SCRIPTS\TELEMETRY\` folder
52+
4. In model setup, page to `DISPLAY`, set desired screen to `Script`, and select `iNav`
5353

5454
## Notice
5555

@@ -70,7 +70,7 @@ Using transmitter firmware with `luac` included will reduce memory usage and inc
7070
* The launch/pilot-based orientation view is useful if model orientation is unknown
7171
* If model is further than 25 feet away, the launch/pilot-based view will show the direction of the model based upon launch/pilot position and orientation (useful to locate a lost model)
7272
* The script gives voice feedback for flight modes, battery levels, and warnings (no need to manually set this up for each model)
73-
* Voice alerts will play in background even if iNav LuaTelemetry screen is not displayed
73+
* Voice alerts will play in background even if iNav Lua Telemetry screen is not displayed
7474

7575
#### User Setting
7676

iNav.lua

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
-- Value that can be changed
77
local SHOW_CELL = false -- false = Show total battery voltage / true = Show cell average (default = false)
8-
98
local WAVPATH = "/SCRIPTS/TELEMETRY/iNav/"
9+
1010
local FLASH = INVERS + BLINK
1111
local QX7 = LCD_W < 212
1212
local RIGHT_POS = QX7 and 129 or 195

0 commit comments

Comments
 (0)