Skip to content

Support and API documentation for the Lua implementation used in EdgeTX

Notifications You must be signed in to change notification settings

EdgeTX/lua-reference-guide

Repository files navigation

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 the SD card in the transmitter.

{% hint style="info" %} The latest version of this guide will always be available here. At the top of the left sidebar there is a version option if you are running an older version of EdgeTX and need the docs for that specific version. {% endhint %}

Sections

Chapter Content
Overview Covers various topics of LUA implementation in EdgeTX operating system system
LUA API Reference Reference of all constants and functions available in EdgeTX LUA API
LUA API Programming EdgeTX LUA programming guide that covers coding techniques with examples.
Appendixes

EdgeTX LUA development support

Quickest way to get support from seasoned EdgeTX LUA developers is to join our Discord server and ask on dedicated #lua channel

Join the chat on Discord

LUA Reference guide collaboration

Please feel free to make suggestions or corrections to the documentation.

  • Preferred method of editing is to use GitBook, as it uses WYSWIG editor allowing two-stage publication. If you want to change or add whole page or become collaborator <decribe what to do>.
  • For simple typos or proof reading you may submit PR to lua-reference-guide repository on EdgeTX GitHub.

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 more expensive to maintain than most open source projects. This in mainly because there is a never ending flood of hardware to integrate and maintain code for. Hardware that costs. In addition, in order to develop for this hardware, certain specalised test and measurement equipment is also required.

In order to support this, EdgeTX has chosen to use OpenCollective to allow for donations from the community, as well as funding from manufacturers who choose to partner with and sponsor the project. This also allows for transparent accounting of what the funds are spent on.

Please visit our OpenCollective page if you would like to financially help support the project!

About

Support and API documentation for the Lua implementation used in EdgeTX

Topics

Resources

Code of conduct

Stars

Watchers

Forks

Languages