https://github.com/edgetx/lua-reference-guide

Support and API documentation for the Lua implementation used in EdgeTX
https://github.com/edgetx/lua-reference-guide

lua

Last synced: 3 months ago
JSON representation

Support and API documentation for the Lua implementation used in EdgeTX

• Host: GitHub
• URL: https://github.com/edgetx/lua-reference-guide
• Owner: EdgeTX
• Created: 2021-07-20T06:38:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-14T03:42:04.000Z (9 months ago)
• Last Synced: 2024-05-23T01:23:50.878Z (8 months ago)
• Topics: lua
• Language: Python
• Homepage: https://luadoc.edgetx.org/
• Size: 4.32 MB
• Stars: 8
• Watchers: 2
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://luadoc.edgetx.org). 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](overview/)                       | Covers various topics of LUA implementation in EdgeTX operating system system |

| [LUA API Reference](lua-api-reference/)     | Reference of all constants and functions available in EdgeTX LUA API          |

| [LUA API Programming](lua-api-programming/) | EdgeTX LUA programming guide that covers coding techniques with examples.     |

| [Appendixes](appendix/)                     |                                                                               |

## 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](https://discord.gg/DrHkAn28sq)

## LUA Reference guide collaboration

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

* Preferred method of editing is to use [GitBook](https://www.gitbook.com), as it uses WYSWIG editor allowing two-stage publication. If you want to change or add whole page or become collaborator _\_.

* For simple typos or proof reading you may submit PR to [lua-reference-guide](https://github.com/EdgeTX/lua-reference-guide/pulls)[ ](https://github.com/EdgeTX/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](https://opencollective.com/edgetx) if you would like to financially help support the project!