One-Time Scripts

Purpose

One-time scripts are used mainly to perform tasks that are not connected with flying. In example ELRS configuration LUA script. They do their task and are then terminated (by user or function) and unloaded.

Execution & 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 (except returning string that contains new script name to be executed)

• 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 low

  memory)

File Location

One-Time Scripts can be placed anywhere on SD card, however, the folder /SCRIPTS/ is recommended.

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:

Parameters

Return values

Parameters none

Return Values none

Examples

Simplest one-time LUA script

local function my_run(event, touchState)
  print("Script run executed")
  return 0
end

return { run = my_run }

One-Time LUA script with initialization and exit feature if user short press and release EXIT (RTN) key

local exit = 0

local function my_run(event, touchState)
  print("Script my_run function executed")
  -- code to execute
  if event == EVT_VIRTUAL_EXIT then 
    print("Script exit executed")
    exit = 1
  end 
  return exit
end

local function my_init()
  print("Script my_init function executed")
  -- code to execute
end

return { run = my_run, init = my_init }