diff --git a/.wordlist.txt b/.wordlist.txt index 05e3d9234..01c2f58c8 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -589,4 +589,6 @@ counsel Rotorflight X-Band heggy_fpv -zomg \ No newline at end of file +zomg +wimalopaan +CapnBry diff --git a/docs/assets/images/blog/lua-scripts/telemetry_bw.png b/docs/assets/images/blog/lua-scripts/telemetry_bw.png new file mode 100644 index 000000000..65e305807 Binary files /dev/null and b/docs/assets/images/blog/lua-scripts/telemetry_bw.png differ diff --git a/docs/assets/images/blog/lua-scripts/telemetry_vtxadmin_bw.png b/docs/assets/images/blog/lua-scripts/telemetry_vtxadmin_bw.png new file mode 100644 index 000000000..e5d28206e Binary files /dev/null and b/docs/assets/images/blog/lua-scripts/telemetry_vtxadmin_bw.png differ diff --git a/docs/assets/images/blog/lua-scripts/tool_bind.png b/docs/assets/images/blog/lua-scripts/tool_bind.png new file mode 100644 index 000000000..692125775 Binary files /dev/null and b/docs/assets/images/blog/lua-scripts/tool_bind.png differ diff --git a/docs/assets/images/blog/lua-scripts/tool_bind_bw.png b/docs/assets/images/blog/lua-scripts/tool_bind_bw.png new file mode 100644 index 000000000..dedfb131b Binary files /dev/null and b/docs/assets/images/blog/lua-scripts/tool_bind_bw.png differ diff --git a/docs/assets/images/blog/lua-scripts/tool_main.png b/docs/assets/images/blog/lua-scripts/tool_main.png new file mode 100644 index 000000000..41c010181 Binary files /dev/null and b/docs/assets/images/blog/lua-scripts/tool_main.png differ diff --git a/docs/assets/images/blog/lua-scripts/tool_main_bw.png b/docs/assets/images/blog/lua-scripts/tool_main_bw.png new file mode 100644 index 000000000..b87dccfb7 Binary files /dev/null and b/docs/assets/images/blog/lua-scripts/tool_main_bw.png differ diff --git a/docs/assets/images/blog/lua-scripts/widget_telemetry_fullscreen.png b/docs/assets/images/blog/lua-scripts/widget_telemetry_fullscreen.png new file mode 100644 index 000000000..6db88d0ed Binary files /dev/null and b/docs/assets/images/blog/lua-scripts/widget_telemetry_fullscreen.png differ diff --git a/docs/assets/images/blog/lua-scripts/widget_vtxadmin_fullscreen.png b/docs/assets/images/blog/lua-scripts/widget_vtxadmin_fullscreen.png new file mode 100644 index 000000000..6b31ccb1e Binary files /dev/null and b/docs/assets/images/blog/lua-scripts/widget_vtxadmin_fullscreen.png differ diff --git a/docs/assets/images/blog/lua-scripts/widgets.png b/docs/assets/images/blog/lua-scripts/widgets.png new file mode 100644 index 000000000..935e47963 Binary files /dev/null and b/docs/assets/images/blog/lua-scripts/widgets.png differ diff --git a/docs/blog/posts/2026-11-08-meet-the-new-expresslrs-lua-scripts.md b/docs/blog/posts/2026-11-08-meet-the-new-expresslrs-lua-scripts.md new file mode 100644 index 000000000..b85b88eb0 --- /dev/null +++ b/docs/blog/posts/2026-11-08-meet-the-new-expresslrs-lua-scripts.md @@ -0,0 +1,104 @@ +--- +title: "Meet the New ExpressLRS Lua Scripts" +date: 2026-11-08 +categories: + - Project update +authors: + - jurg +slug: meet-the-new-expresslrs-lua-scripts +--- + +# Meet the New ExpressLRS Lua Scripts + +The ExpressLRS Lua script has had a major overhaul. It loads faster, colour radios get a new touch user interface, and it now comes with three new tools: a VTX Admin widget for quick channel changes at race events, a telemetry widget for your home screen, and a Bind Phrase Manager. + + + +## A new home and updated priorities + +Since its inception, the Lua script was a single `elrs.lua` file with a design focus on memory optimization and a single-file install. These priorities meant there was rarely a reason to upgrade, as very little functionality was added over the years: there just wasn't space for it. The scripts now live in [ExpressLRS/Lua](https://github.com/ExpressLRS/Lua) and are designed for rich and expanding functionality, which can be released as needed without waiting for the next ExpressLRS firmware version. + +Every [release](https://github.com/ExpressLRS/Lua/releases) is a single zip that you extract onto your SD card, and it contains all of the tools and widgets below. + +## What's in the package + +### ExpressLRS Configuration Tool + +The `ExpressLRS` tool configures your transmitter module and receiver, just like `elrs.lua` did. On colour radios it now has a new touch user interface built from native EdgeTX controls, so it looks and behaves like the rest of your radio. Black & white radios keep the classic text layout. It also loads faster, so you spend less time looking at `Loading...` when you open the tool or a folder. + +![ExpressLRS Configuration Tool on a colour radio](../../assets/images/blog/lua-scripts/tool_main.png){ width="480" } + +![ExpressLRS Configuration Tool on a B&W radio](../../assets/images/blog/lua-scripts/tool_main_bw.png){ width="384" style="image-rendering: pixelated" } + +### VTX Admin widget and screen + +The `ExpressLRS VTX Admin` widget was built with racing in mind, but it is just as handy whenever you share the air with other pilots, such as a freestyle session with friends. At a race, the race director hands out video channels heat by heat, and digging through the Lua menus to change yours adds extra steps and extra stress right before you fly. + +Set it up once before the event: program each band and channel you'll need into a preset, one for each of the six 6POS buttons on your radio. When your heat is called, press the matching button and your VTX changes channel, along with your goggles if they have a [VRX Backpack](../../hardware/backpack/esp-backpack.md). + +You can keep up to six sets of six presets, for example one per race series or regular flying spot, and swap between them in the settings. + +The widget also shows the current band, channel, power and pit mode at a glance, and a long press opens its full-screen settings. + +![ExpressLRS Telemetry and VTX Admin widgets on the home screen](../../assets/images/blog/lua-scripts/widgets.png) + +![VTX Admin widget in full-screen view](../../assets/images/blog/lua-scripts/widget_vtxadmin_fullscreen.png) + +Black & white radios get the same features as a telemetry screen: in **Model Setup > Telemetry**, pick the `ELRVTX` script for one of the screens. It shows the current band, channel, power, pit mode and 6POS presets. Press ++enter++ for the settings. + +![VTX Admin telemetry screen on a B&W radio](../../assets/images/blog/lua-scripts/telemetry_vtxadmin_bw.png){ width="384" style="image-rendering: pixelated" } + +### Telemetry widget and screen + +The `ExpressLRS Telemetry` widget shows live link statistics on your home screen. Bigger widget zones show more detail, and a long press opens a full-screen list of every telemetry item. + +![ExpressLRS Telemetry and VTX Admin widgets on the home screen](../../assets/images/blog/lua-scripts/widgets.png) + +![ExpressLRS Telemetry widget in full-screen view](../../assets/images/blog/lua-scripts/widget_telemetry_fullscreen.png) + +On black & white radios, pick the `ELRTLM` script for a telemetry screen. It shows link quality, RSSI, RF mode, power and battery at a glance. Press ++enter++ for the full list. + +![ExpressLRS telemetry screen on a B&W radio](../../assets/images/blog/lua-scripts/telemetry_bw.png){ width="384" style="image-rendering: pixelated" } + +### ExpressLRS Bind Phrase Manager + +The `ExpressLRS Bind` tool lets you set the binding phrase on your transmitter or receiver directly from the radio. If you share models by swapping binding phrases, you can now do it from the handset without going through WiFi. Instead of a phrase you can also type a UID as 4 to 6 comma-separated numbers, or read back the UID a device is using. The tool keeps a history of phrases you have used, so switching back to one is quick. It works on both colour and B&W screens. + +![ExpressLRS Bind Phrase Manager on a colour radio](../../assets/images/blog/lua-scripts/tool_bind.png) + +![ExpressLRS Bind Phrase Manager on a B&W radio](../../assets/images/blog/lua-scripts/tool_bind_bw.png){ width="384" style="image-rendering: pixelated" } + +!!! note "ExpressLRS 4.1" + Setting the binding phrase from the radio requires ExpressLRS 4.1 or newer on the device you are changing. + +## Compatibility + +| Radio | EdgeTX | ExpressLRS | Download | +|-------|--------|------------|----------| +| Colour or B&W screen | 2.12.1+ or 3.0+ | 3.5.4+ | `expresslrs-lua-vX.Y.Z.zip` | +| Older EdgeTX, OpenTX or low-RAM radios | any | any | `expresslrs-lua-legacy.zip` | + +The Bind Phrase Manager additionally needs ExpressLRS 4.1+ to set a binding phrase. The widgets need a colour screen; B&W radios use the telemetry screens instead. + +## Installing or upgrading + +1. Download `expresslrs-lua-vX.Y.Z.zip` from the [latest release](https://github.com/ExpressLRS/Lua/releases/latest). +2. Delete any old ELRS scripts from `SCRIPTS/TOOLS/` on your SD card: `elrs.lua`, `elrsV2.lua`, `elrsV3.lua` and their `.luac` counterparts. +3. Extract the zip onto the **root** of your SD card, keeping the folder structure and overwriting existing files. +4. Open the Tools menu on your radio. You will find **ExpressLRS** and **ExpressLRS Bind** there. +5. Optional: add the **ExpressLRS VTX Admin** or **ExpressLRS Telemetry** widget to a home screen, or on a B&W radio pick `ELRVTX` or `ELRTLM` as a telemetry screen. + +## Older radios: the legacy script + +If your radio can't run EdgeTX 2.12.1, runs OpenTX, or doesn't have enough RAM for the new scripts, the original single-file `elrs.lua` is still available. Every release also includes `expresslrs-lua-legacy.zip`; extract it onto your SD card root and use it as before. + +## Feedback and nightly builds + +Found a bug, or have an idea? Open an issue on [ExpressLRS/Lua](https://github.com/ExpressLRS/Lua/issues). Please include your radio model, your EdgeTX version and your ExpressLRS firmware version. + +If you want the latest changes before they are released, a [nightly build](https://github.com/ExpressLRS/Lua/releases/tag/nightly) is published from the main branch. Nightly builds are development builds and may contain bugs. + +## Special thanks + +- [CapnBry](https://github.com/CapnBry) for the years of work on the original `elrs.lua`, developing the Bind Phrase Manager, and a sharp eye on bugs, extensive testing and support throughout development. +- [wimalopaan](https://github.com/wimalopaan) for all the testing, the edge cases found and the feature requests.