EdgeTX Lua Reference Guide¶
This guide covers the development of user-written scripts for R/C transmitters running the EdgeTX operating system with Lua support. Readers should be familiar with EdgeTX, the EdgeTX Companion, and know how to transfer files to the SD card in the transmitter.
Info
The latest version of this guide will always be available at luadoc.edgetx.org. There is a version option in the header if you are running an older version of EdgeTX and need the docs for that specific version.
Sections¶
| Chapter | Content |
|---|---|
| API Overview | Covers various topics of Lua implementation in the EdgeTX operating system |
| API Reference | Reference of all constants and functions available in the EdgeTX Lua API |
| Programming | EdgeTX Lua programming guide that covers coding techniques with examples |
| Radios | Hardware support overview with transmitter families, model pages, and EdgeTX version coverage |
EdgeTX Lua development support¶
The quickest way to get support from seasoned EdgeTX Lua developers is to join the Discord server and ask in the dedicated #lua channel.
Lua Reference Guide collaboration¶
Please feel free to make suggestions or corrections to the documentation.
- For simple typos or proofreading, submit a PR to the lua-reference-guide repository on GitHub.
- For larger content improvements, this MkDocs site now accepts Markdown changes directly in the repo alongside the generated API pipeline.
Project support¶
The EdgeTX team has no intention of making a profit from their work. EdgeTX is free and open source and will remain free and open source. However, the project is expensive to maintain because of the amount of hardware that must be integrated and supported, along with the tools required to develop and test it.
Please visit the OpenCollective page if you would like to financially help support the project.