Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lua Script Updates #383

Merged
merged 7 commits into from
May 27, 2024
Merged

Lua Script Updates #383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8255193
Crossband RF Modes
deadbytefpv May 14, 2024
2e3f7dd
Other 3.4.0 Lua Updates
deadbytefpv May 14, 2024
5af0df6
Expanding Spellcheck
deadbytefpv May 14, 2024
c0f6b6a
Removed extra line as artifact of a rebase
deadbytefpv May 18, 2024
5ad214e
Reduce the
deadbytefpv May 25, 2024
6e31299
Corrected a typo. Rearranged the RF modes.
deadbytefpv May 25, 2024
1c14a89
Add Backpack Telemetry.
deadbytefpv May 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Configs
Configurator
Configurator's
CrazyF
Crossband
CubeProgrammer
Cura
DFU
Expand Down Expand Up @@ -91,6 +92,7 @@ Freestylers
FreqCorrection
GCS
GDPR
GemX
GEPRC
GH
GND
Expand Down
45 changes: 36 additions & 9 deletions docs/quick-start/transmitters/lua-howto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ From these examples:

Items with `>` before the name is a folder that when selected shows another level of customization. `TX Power`, `VTX Administrator`, `Wifi Connectivity` are examples of these items.

:new: These items will now show what is currently set for the items within. An example would be on `TX Power`, which will show the current Power set, and if Dynamic Power is enabled, it will show the current set Max Power, followed by the indicator `Dyn`.
These items will now show what is currently set for the items within. An example would be on `TX Power`, which will show the current Power set, and if Dynamic Power is enabled, it will show the current set Max Power, followed by the indicator `Dyn`.

### Packet Rate and Telemetry Ratio

Expand All @@ -131,30 +131,41 @@ These are shown as `Packet Rate` and `Telem Ratio` in the Lua script, which allo
The following options are available for `2.4GHz`:

- `50Hz, 150Hz, 250Hz & 500Hz`: Lora-based options. Higher means lower latency at the expense of sensitivity. Since v1.0.
- `F500 & F1000` :new: : Pure FLRC for lowest latency, reduced range compared to LoRa, 500Hz and 1000Hz. [Details](https://github.com/ExpressLRS/ExpressLRS/pull/1277)
- `D250 & D500` :new: : Redundant transmit FLRC modes. `D` stands for `Déjà Vu`, 250Hz and 500Hz. Higher latency, reduced packet jitter and higher LQ. Same range as other FLRC modes. [Details](https://github.com/ExpressLRS/ExpressLRS/pull/1527)
- `100Hz Full & 333Hz Full` :new: : Lora-based 10-bit Full Resolution with 8ch/12ch/16 Switch Mode options. [Details](https://github.com/ExpressLRS/ExpressLRS/pull/1572)
- `F500 & F1000`: Pure FLRC for lowest latency, reduced range compared to LoRa, 500Hz and 1000Hz. [Details](https://github.com/ExpressLRS/ExpressLRS/pull/1277)
- `D250 & D500`: Redundant transmit FLRC modes. `D` stands for `Déjà Vu`, 250Hz and 500Hz. Higher latency, reduced packet jitter and higher LQ. Same range as other FLRC modes. [Details](https://github.com/ExpressLRS/ExpressLRS/pull/1527)
- `100Hz Full & 333Hz Full`: Lora-based 10-bit Full Resolution with 8ch/12ch/16 Switch Mode options. [Details](https://github.com/ExpressLRS/ExpressLRS/pull/1572)

The following options are available for `900MHz`:

- `25Hz, 50Hz, 100Hz & 200Hz`: LoRa-based options. Higher means lower latency at the expense of sensitivity. Since v1.0.
- `100Hz Full` :new: : Lora-based 10-bit Full Resolution with 8ch/12ch/16 Switch Mode options. [Details](https://github.com/ExpressLRS/ExpressLRS/pull/1572)
- `100Hz Full`: Lora-based 10-bit Full Resolution with 8ch/12ch/16 Switch Mode options. [Details](https://github.com/ExpressLRS/ExpressLRS/pull/1572)
- `D50Hz` :new: : Lora-based Redundant transmit mode via DVDA. [Details here.](https://github.com/ExpressLRS/ExpressLRS/pull/2089)
- `250Hz` :new: : Only Available for GemX Devices. [Details here.](https://github.com/ExpressLRS/ExpressLRS/pull/2540)
- `200Hz Full` :new: : Only Available for GemX Devices. [Details here.](https://github.com/ExpressLRS/ExpressLRS/pull/2540)

The number following the rate in parentheses (e.g. -105dBm for 500Hz) is the Sensitivity Limit for the rate, the lowest RSSI where packets will still be received. See [Signal Health](../../info/signal-health.md) for more information about the sensitivity limit.
The following options are available for `GemX`:

- `X150Hz`:new: : Crossband mode, combining 900MHz and 2.4GHz in Gemini Mode.
- `X100Hz Full` :new: : Crossband mode, combining 900MHz and 2.4GHz in Gemini Mode, Full Resolution with 8ch/12ch/16 Switch Mode options

!!! info "GemX is a 3.4.0 feature"
Gemini Crossband (GemX) is available on select hardware, requiring the LR1121 RF Chip. GemX is an ExpressLRS 3.4.0 feature. [Details here.](https://github.com/ExpressLRS/ExpressLRS/pull/2540)

The number following the rate in parentheses (e.g. -105dBm for 500Hz) is the Sensitivity Limit for the rate, the lowest RSSI dBm value where packets will still be received. See [Signal Health](../../info/signal-health.md) for more information about the sensitivity limit.

!!! warning "WARNING"
Never change the packet rate while flying as this **FORCES A DISCONNECT** between the TX and RX.

* `Telem Ratio` sets the telemetry ratio or how much of the packet rate is used to send telemetry. The options, in order of increasing telemetry rate, are: `Off, 1:128, 1:64, 1:32, 1:16, 1:8, 1:4, 1:2`. A Telem Ratio of 1:64 means one out of every 64 packets are used for telemetry data.
- :new: v3.0 comes with `Std` and `Race` options. `Std` changes ratio depending on the Packet Rate, and `Race` is the same as Std, but will disable telemetry and sync while Armed.
- v3.0 comes with `Std` and `Race` options. `Std` changes ratio depending on the Packet Rate, and `Race` is the same as Std, but will disable telemetry and sync while Armed.

For information on telemetry setup, see [First Flight: Telemetry](../pre-1stflight.md#telemetry) and [Telemetry Bandwidth](../../info/telem-bandwidth.md).

### Switch Mode

The Switch Mode setting controls how channels AUX1-AUX8 are sent to the receiver (the 4 main channels are always 10-bit). The options are `Hybrid & Wide`. **Hybrid** mode is 6x 2, 3 or 6-position + 1x 16-position, and **Wide** is 7x 64 or 128-position. For detail about the differences, see the [Switch Configs](../../software/switch-config.md) documentation.

:new: In full resolution modes, the Switch Mode parameter selects the number of channels to be used. [Full Resolution Switch Modes](../../software/switch-config.md#full-resolution-switch-configuration-modes)
In full resolution modes, the Switch Mode parameter selects the number of channels to be used. [Full Resolution Switch Modes](../../software/switch-config.md#full-resolution-switch-configuration-modes)

!!! hint "Hot Tip"
The Switch Mode can only be changed when not connected to a receiver. The top right corner of the Lua script will show a `-` if you're not connected.
Expand Down Expand Up @@ -270,14 +281,15 @@ The parameters in this folder enables you to change the Backpack-related paramet
* `DVR Stp Delay` - How soon should the DVR stop Recording upon deactivation of the Aux switch?
* `HT Enable` - Turn Headtracking On or Off. Only available on some FPV Goggles with VRX Backpack integration.
* `HT Start Channel` - Starting Channel to send Head Tracking positions to.
* `Telemetry` - Allow the Backpack to Send the Telemetry frames via ESPNOW. See [Backpack Telemetry](../../software/backpack-telemetry.md)
* `Version` - The Backpack Firmware version flashed into the TX Backpack.

For more information, see the [Backpack Guide](../../hardware/backpack/esp-backpack.md).

### Bind

!!! info "Take Notice!"
This command will only work on receivers that are already in `Bind Mode` (indicated by two blinks LED pattern). Receivers with a binding phrase set/flashed into them will NOT EVER go into this Bind Mode, and thus this command will not do anything.
This command will only work on receivers that are already in `Bind Mode` (indicated by two blinks LED pattern). Receivers (with version 3.3.2 and earlier) flashed or set with a binding phrase will NOT go into this Bind Mode, and thus this command will not do anything.

Devices with the same binding phrase and compatible firmware versions should automatically sync/bind upon power up.

Expand Down Expand Up @@ -376,6 +388,8 @@ Team Racing allows selection between multiple connected models, failsafing all u

These commands allow the user to Loan/Return the model. For more information, see the [Loan Model](../../software/loan-model.md) guide.

This is deprecated and removed in ExpressLRS 3.4.0 in favor of the new Binding Procedures. See the [binding](../binding.md) page for details.

### Output Mapping

<figure markdown>
Expand All @@ -391,6 +405,19 @@ This folder is only available to PWM receivers. This will allow users to set opt

For more information, see [PWM Receivers](../../hardware/pwm-receivers.md) page.

### Bind Storage

* `Persistent` - Binding info is kept across power-cycles.
* `Volatile` - Binding info is forgotten after a power-cycle.

This option is available on ExpressLRS 3.4.0 and newer. See the details [here](https://github.com/ExpressLRS/ExpressLRS/pull/2542).

### Enter Bind Mode command

This will put the receiver into Bind Mode. It works even if the receiver is already flashed with a binding phrase or already bound traditionally.

This command is available on ExpressLRS 3.4.0 and newer. See the details [here](https://github.com/ExpressLRS/ExpressLRS/pull/2542).

### Model ID

This line shows the currently set Model ID for the receiver when Model Matching is enabled. This number should match the Receiver ID set with the current active Model on the Radio handset, otherwise, there will be Model Mismatch! See [Model Match](../../software/model-config-match.md) for more details.
Expand Down