LUA Reference Guide
Search…
One-Time Scripts
WARNING - Running a One-Time script will suspend execution of all other currently loaded Lua scripts (Custom, Telemetry, and Functions)
Overview
One-Time scripts start when called upon by a specific radio function or when the user selects them from a contextual menu. They do their task and are then terminated and unloaded. Please note that all persistent scripts are halted during the execution of One-Time scripts. They are automatically restarted once the One-Time script is finished. This is done to provide enough system resources to execute the One-Time script.
Lifetime
Script is executed when user selects Execute on a script file from SD card browser screen, or opens a Lua Tool, or creates a new model with a Wizard script.
The script executes until:
- it returns value different from 0
- is forcefully closed by user by long press of EXIT key
- is forcefully closed by system if it misbehaves (e.g. run-time error or lowmemory)
File Location
General One-Time scripts can be placed anywhere on SD card, however, the folder /SCRIPTS/ is recommended.
Tool scripts must be stored in /SCRIPTS/TOOLS.
Wizard scripts must be stored in the same subfolder of /TEMPLATES/ with the same "first name" as the template file using it. Some Wizard scripts are just small scripts that load one of the common scripts located in /SCRIPTS/WIZARD/.
Interface
Every script must include a
return statement at the end, defining its interface to EdgeTX. This statement returns a table with the following fields:initfunction (optional)runfunction
Example
1
local function init()
2
-- init is called once when model is loaded
3
end
4
​
5
local function run(event, touchState)
6
-- run is called periodically only when screen is visible
7
-- A non-zero return value will halt the script
8
return x
9
end
10
​
11
return { run=run, init=init }
Copied!
Notes:
- A non-zero return value from
runwill halt the script. If the return value is a text string with the file path to a new Lua script, then the new script will be loaded and run.
Last modified 2mo ago