EdgeTX LUA Reference Guide

https://luadoc.edgetx.org/
Admin
This guide covers the development of user-written scripts for R/C transmitters running the EdgeTX...
Tokens:1,538,972
Snippets:4,937
Trust Score:8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Lua Scripts for Announcements

Source: https://luadoc.edgetx.org/lua-api-programming/advanced-topics/lua-data-sharing-across-scripts

Demonstrates a set of example Lua scripts for creating custom announcements based on timers and switches. Includes installation instructions and usage scenarios for mix, function, and telemetry scripts.

```lua
-- count-dn.lua (Mix Script)
-- Updates global variables gCountUp and gCountDown.
-- Creates output values ctup and ctdn.

-- count-up.lua (Function Script)
-- Performs count up announcements based on hardcoded values.

-- shocount.lua (Telemetry Script)
-- Displays the current values of gCountUp and gCountDown.

-- Installation:
-- Mix script: /SCRIPTS/MIXES
-- Function script: /SCRIPTS/FUNCTIONS
-- Telemetry script: /SCRIPTS/TELEMETRY
```

--------------------------------

### EdgeTX Input Table Example with SOURCE and VALUE

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=300

An example showcasing how to define both SOURCE and VALUE inputs for an EdgeTX mix script. It includes a `run` function that utilizes these inputs.

```lua
local input =
    {
        { "Strength", SOURCE},                -- user selects source (typically slider or knob)
        { "Interval", VALUE, 0, 100, 0 }    -- interval value, default = 0.
    }
local function run(strength, interval)
    -- variable strength will contain the current slider value
    -- variable interval is set by the user and constant through script lifetime
    -- this script has no return value but may use playFile() to alert user
    return
end
return {input=input, run=run}
```

--------------------------------

### EdgeTX Input Table Example with SOURCE and VALUE

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=250

An example showcasing how to define both SOURCE and VALUE inputs for an EdgeTX mix script. It includes a `run` function that utilizes these inputs.

```lua
local input =
    {
        { "Strength", SOURCE},                -- user selects source (typically slider or knob)
        { "Interval", VALUE, 0, 100, 0 }    -- interval value, default = 0.
    }
local function run(strength, interval)
    -- variable strength will contain the current slider value
    -- variable interval is set by the user and constant through script lifetime
    -- this script has no return value but may use playFile() to alert user
    return
end
return {input=input, run=run}
```

--------------------------------

### EdgeTX Mixes Script Example

Source: https://luadoc.edgetx.org/overview/script-types/mixes-scripts

A complete example of an EdgeTX Mixes Script, demonstrating the definition of input and output tables, and the structure of the init and run functions. Shows how to return the interface table.

```Lua
local my_input =
  {
    { "Strength", SOURCE},
    { "Interval", VALUE, 0, 100, 0 }
  }
local my_output = { "Val1", "Val2" }
local function my_init()
  -- Called once when the script is loaded
end
local function my_run(Strength, Interval)
  local v1, v2
  -- Called periodically
  return v1, v2
end
return { input = my_input, output = my_output, run = my_run, init = my_init }
```

--------------------------------

### Telemetry Script Example

Source: https://luadoc.edgetx.org/overview/script-types/telemetry-scripts

An example demonstrating the structure of a telemetry script in EdgeTX, including the initialization, background, and run functions, and the required return statement that defines the script's interface.

```lua
local function my_init()
  -- init is called once when model is loaded
end
local function my_background()
  -- background is called periodically
end
local function my_run(event)
  -- run is called periodically only when screen is visible
end
return { run = my_run, background = my_background, init = my_init }
```

--------------------------------

### Widget Options Example

Source: https://luadoc.edgetx.org/lua-api-reference/constants/widget-options

Example LUA code demonstrating how to create a table with default widget options, including various types like SOURCE, BOOL, VALUE, COLOR, STRING, and FILE.

```lua
-- Create a table with default options
-- Options can be changed by the user from the Widget Settings menu
-- Notice that each line is a table inside { }
local options = {
  { "Source", SOURCE, 1 },
-- BOOL is actually not a boolean, but toggles between 0 and 1
  { "Boolean", BOOL, 1 },
  { "Value", VALUE, 1, 0, 10},
  { "Color", COLOR, ORANGE },
  { "Text", STRING, "Max8chrs" },
  { "File", FILE, "default", "PATH" }
}
```

--------------------------------

### Get Time Since Radio Start (Lua)

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=200

Returns the time elapsed since the radio was started, measured in units of 10ms. The internal 32-bit counter prevents overflow for up to 497 days.

```lua
getTime()
-- Returns: 1254 (representing 12.54 seconds)
```

--------------------------------

### One-Time Script Example with LVGL

Source: https://luadoc.edgetx.org/lua-api-reference/lvgl-for-lua/examples

An example of a one-time script using the LVGL library for creating a simple UI with a page, label, and button. Demonstrates script initialization, running logic, and handling user exit actions.

```lua
local exitTool =false
localfunctionclose()
  lvgl.confirm({title="Exit", message="Really exit?",
    confirm=(function() exitTool =trueend)
  })
end
localfunctioninit()
if lvgl ==nilthenreturnend
  lvgl.clear();
local pg = lvgl.page({title="Test Tool", subtitle="Page 1", back=close})
  pg:label({x=70, y=16, color=BLACK, font=DBLSIZE, text="Test Page"})
  pg:button({x=200, y=150, text="CLOSE", press=close})
end
localfunctionrun(event,touchState)
if lvgl ==nilthen
    lcd.drawText(0, 0, "LVGL support required", COLOR_THEME_WARNING)
end
if (exitTool) thenreturn2end
return0
end
return {init = init, run = run, useLvgl=true}
```

--------------------------------

### Create and Configure a Popup Menu

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=250

Demonstrates how to create a popup menu with a title, a list of options, and callback functions for selection and initial display.

```Lua
lvgl.menu({
  title="Menu",
  values={"Option 1","Option 2","Option 3","Option 4","Option 5","Option 6","Option 7","Option 8","Option 9","Option 10",},
  set=function(n)
      -- 'Do something with the selected value'
  end
})
```

--------------------------------

### Lua Closure Example

Source: https://luadoc.edgetx.org/overview/lua-basics

Demonstrates a Lua closure using a 'counter' function. The returned function captures the 'start' and 'step' variables from its lexical environment, allowing it to maintain state across multiple calls.

```lua
local function counter(start, step) 
  local x = start
  return function() 
    local y = x
    x = x + step
    return y
  end
end
```

--------------------------------

### EdgeTX Lua API for Data Exchange

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=300

Provides an overview of the Lua API functions available for interacting with the EdgeTX model setup. This includes functions for retrieving information about value sources, getting and setting global variables, and managing telemetry data.

```APIDOC
getFieldInfo(name)
  Gets the meta-index of a _value_ source with `name`.

getValue(index)
  Gets the current value of a source, where `index` is from the above.

getFlightMode()
  Returns the current flight mode number and name. **Do not** confuse with `model.getFlightMode`, which is a completely different function!

model.getGlobalVariable( index, fm)
  Read the value of a global variable between -1024 and 1024. You can use the above to get the current flioght mode for `fm`, or you can setup the GV to always use the value from FM0.

model.setGlobalVariable( index, fm, value)
  Sets the value of a global variable.

setTelemetryValue(id, subID, instance, value, ...)
  Sets a telemetry value.
```

--------------------------------

### Create and Configure a Popup Menu

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=200

Demonstrates how to create a popup menu with a title, a list of options, and callback functions for selection and initial display.

```Lua
lvgl.menu({
  title="Menu",
  values={"Option 1","Option 2","Option 3","Option 4","Option 5","Option 6","Option 7","Option 8","Option 9","Option 10",},
  set=function(n)
      -- 'Do something with the selected value'
  end
})
```

--------------------------------

### Create and Configure a Popup Menu

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=300

Demonstrates how to create a popup menu with a title, a list of options, and callback functions for selection and initial display.

```Lua
lvgl.menu({
  title="Menu",
  values={"Option 1","Option 2","Option 3","Option 4","Option 5","Option 6","Option 7","Option 8","Option 9","Option 10",},
  set=function(n)
      -- 'Do something with the selected value'
  end
})
```

--------------------------------

### EdgeTX Lua API for Data Exchange

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=250

Provides an overview of the Lua API functions available for interacting with the EdgeTX model setup. This includes functions for retrieving information about value sources, getting and setting global variables, and managing telemetry data.

```APIDOC
getFieldInfo(name)
  Gets the meta-index of a _value_ source with `name`.

getValue(index)
  Gets the current value of a source, where `index` is from the above.

getFlightMode()
  Returns the current flight mode number and name. **Do not** confuse with `model.getFlightMode`, which is a completely different function!

model.getGlobalVariable( index, fm)
  Read the value of a global variable between -1024 and 1024. You can use the above to get the current flioght mode for `fm`, or you can setup the GV to always use the value from FM0.

model.setGlobalVariable( index, fm, value)
  Sets the value of a global variable.

setTelemetryValue(id, subID, instance, value, ...)
  Sets a telemetry value.
```

--------------------------------

### Create and Configure a Popup Menu

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=150

Demonstrates how to create a popup menu with a title, a list of options, and callback functions for selection and initial display.

```Lua
lvgl.menu({
  title="Menu",
  values={"Option 1","Option 2","Option 3","Option 4","Option 5","Option 6","Option 7","Option 8","Option 9","Option 10",},
  set=function(n)
      -- 'Do something with the selected value'
  end
})
```

--------------------------------

### EdgeTX Lua API for Data Exchange

Source: https://luadoc.edgetx.org/lua-api-programming/data-exchange-with-the-edgetx-model-setup

Provides an overview of the Lua API functions available for interacting with the EdgeTX model setup. This includes functions for retrieving information about value sources, getting and setting global variables, and managing telemetry data.

```APIDOC
getFieldInfo(name)
  Gets the meta-index of a _value_ source with `name`.

getValue(index)
  Gets the current value of a source, where `index` is from the above.

getFlightMode()
  Returns the current flight mode number and name. **Do not** confuse with `model.getFlightMode`, which is a completely different function!

model.getGlobalVariable( index, fm)
  Read the value of a global variable between -1024 and 1024. You can use the above to get the current flioght mode for `fm`, or you can setup the GV to always use the value from FM0.

model.setGlobalVariable( index, fm, value)
  Sets the value of a global variable.

setTelemetryValue(id, subID, instance, value, ...)
  Sets a telemetry value.
```

--------------------------------

### EdgeTX Lua: Get Timer Parameters

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=150

Retrieves the parameters of a specified timer. Returns nil if the timer does not exist. The returned table includes mode, start value, current value, countdown beep settings, minute beep, persistence, and timer name.

```lua
model.getTimerParameters()
-- Returns:
-- nil: requested timer does not exist
-- table: timer parameters:
--   mode (number): timer trigger source (off, abs, stk, stk%, sw/!sw, !m_sw/!m_sw)
--   start (number): start value [seconds], 0 for up timer, 0> down timer
--   value (number): current value [seconds]
--   countdownBeep (number): countdown beep (0 = silent, 1 = beeps, 2 = voice)
--   minuteBeep (boolean): minute beep
--   persistent (number): persistent timer
--   name (string): timer name
```

--------------------------------

### EdgeTX Widget Options Example

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=250

Example Lua code demonstrating how to create a table with default widget options, including various option types like SOURCE, BOOL, VALUE, COLOR, STRING, and FILE.

```lua
-- Create a table with default options
-- Options can be changed by the user from the Widget Settings menu
-- Notice that each line is a table inside { }
local options = {
  { "Source", SOURCE, 1 },
  -- BOOL is actually not a boolean, but toggles between 0 and 1
  { "Boolean", BOOL, 1 },
  { "Value", VALUE, 1, 0, 10},
  { "Color", COLOR, ORANGE },
  { "Text", STRING, "Max8chrs" },
  { "File", FILE, "default", "PATH" }
}
```

--------------------------------

### EdgeTX Widget Options Example

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=200

Example Lua code demonstrating how to create a table with default widget options, including various option types like SOURCE, BOOL, VALUE, COLOR, STRING, and FILE.

```lua
-- Create a table with default options
-- Options can be changed by the user from the Widget Settings menu
-- Notice that each line is a table inside { }
local options = {
  { "Source", SOURCE, 1 },
  -- BOOL is actually not a boolean, but toggles between 0 and 1
  { "Boolean", BOOL, 1 },
  { "Value", VALUE, 1, 0, 10},
  { "Color", COLOR, ORANGE },
  { "Text", STRING, "Max8chrs" },
  { "File", FILE, "default", "PATH" }
}
```

--------------------------------

### libGUI Utility and Initialization Functions

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=100&only=yes&page=LpnmpGATkZIJoQdwUwkS

Provides utility functions like `match` for comparing multiple values and `newGUI` for creating new GUI objects, essential for application structure.

```Lua
-- libGUI.match(x, ...)
-- Returns true if x matches any of the following arguments.
-- Example: libGUI.match(event, EVT_VIRTUAL_ENTER, EVT_VIRTUAL_EXIT, EVT_VIRTUAL_MENU)

-- libGUI.newGUI()
-- Creates a new GUI object. Typically one GUI object per screen.
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/overview/radios/radiomaster

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### One-Time Script with LVGL UI

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=250

This example demonstrates a one-time script using the LVGL API to create a simple UI with a page, a label, and a button. The 'init' function sets up the UI, and the 'run' function handles script logic and checks for exit conditions. A confirmation dialog is used for exiting the script.

```Lua
local exitTool = false
local function close()
  lvgl.confirm({title="Exit", message="Really exit?",
    confirm=(function() exitTool = true end)
  })
end
local function init()
  if lvgl == nil then return end
  lvgl.clear();
  local pg = lvgl.page({title="Test Tool", subtitle="Page 1", back=close})
  pg:label({x=70, y=16, color=BLACK, font=DBLSIZE, text="Test Page"})
  pg:button({x=200, y=150, text="CLOSE", press=close})
end
local function run(event, touchState)
  if lvgl == nil then
    lcd.drawText(0, 0, "LVGL support required", COLOR_THEME_WARNING)
  end
  if ( exitTool) then return 2 end
  return 0
end
return {init = init, run = run, useLvgl=true}
```

--------------------------------

### GetVersion Example

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=100&only=yes&page=FnqUOQ2rExFedh3WsJGn

An example demonstrating how to use the getVersion() function to retrieve and print various details about the OpenTX/EdgeTX version, radio type, and OS name.

```lua
local function run(event) 
  local ver, radio, maj, minor, rev, osname = getVersion() 
  print("version: "..ver) 
  if radio then print ("radio: "..radio) end 
  if maj then print ("maj: "..maj) end 
  if minor then print ("minor: "..minor) end 
  if rev then print ("rev: "..rev) end 
  if osname then print ("osname: "..osname) end 
  return 1 
end 
return {  run=run }
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/overview/radios/flysky

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/overview/radios/jumper

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### Lua Basics and First Class Functions

Source: https://luadoc.edgetx.org/overview/lua-basics

Explains fundamental Lua concepts relevant to EdgeTX scripting, including its suitability for embedded systems and the nature of first-class functions and closures.

```APIDOC
Lua Basics:
  Introduction:
    Lua is a small, extensible, and efficient language chosen for EdgeTX due to its suitability for embedded systems.
  First Class Functions:
    Functions can be treated as variables: passed as arguments, returned from other functions, and reassigned.
    Example:
      local function add(x) return x + 1 end
      local myAdd = add
    Functions can be added to tables:
      t = { f = add }
    A script is an anonymous function returning a list of functions called periodically by the system.
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/overview/internal-indexes

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### One-Time Script with LVGL UI

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=200

This example demonstrates a one-time script using the LVGL API to create a simple UI with a page, a label, and a button. The 'init' function sets up the UI, and the 'run' function handles script logic and checks for exit conditions. A confirmation dialog is used for exiting the script.

```Lua
local exitTool = false
local function close()
  lvgl.confirm({title="Exit", message="Really exit?",
    confirm=(function() exitTool = true end)
  })
end
local function init()
  if lvgl == nil then return end
  lvgl.clear();
  local pg = lvgl.page({title="Test Tool", subtitle="Page 1", back=close})
  pg:label({x=70, y=16, color=BLACK, font=DBLSIZE, text="Test Page"})
  pg:button({x=200, y=150, text="CLOSE", press=close})
end
local function run(event, touchState)
  if lvgl == nil then
    lcd.drawText(0, 0, "LVGL support required", COLOR_THEME_WARNING)
  end
  if ( exitTool) then return 2 end
  return 0
end
return {init = init, run = run, useLvgl=true}
```

--------------------------------

### One-Time Script with LVGL UI

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=150

This example demonstrates a one-time script using the LVGL API to create a simple UI with a page, a label, and a button. The 'init' function sets up the UI, and the 'run' function handles script logic and checks for exit conditions. A confirmation dialog is used for exiting the script.

```Lua
local exitTool = false
local function close()
  lvgl.confirm({title="Exit", message="Really exit?",
    confirm=(function() exitTool = true end)
  })
end
local function init()
  if lvgl == nil then return end
  lvgl.clear();
  local pg = lvgl.page({title="Test Tool", subtitle="Page 1", back=close})
  pg:label({x=70, y=16, color=BLACK, font=DBLSIZE, text="Test Page"})
  pg:button({x=200, y=150, text="CLOSE", press=close})
end
local function run(event, touchState)
  if lvgl == nil then
    lcd.drawText(0, 0, "LVGL support required", COLOR_THEME_WARNING)
  end
  if ( exitTool) then return 2 end
  return 0
end
return {init = init, run = run, useLvgl=true}
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/variables/setstickyswitch

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### One-Time Script with LVGL UI

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=100

This example demonstrates a one-time script using the LVGL API to create a simple UI with a page, a label, and a button. The 'init' function sets up the UI, and the 'run' function handles script logic and checks for exit conditions. A confirmation dialog is used for exiting the script.

```Lua
local exitTool = false
local function close()
  lvgl.confirm({title="Exit", message="Really exit?",
    confirm=(function() exitTool = true end)
  })
end
local function init()
  if lvgl == nil then return end
  lvgl.clear();
  local pg = lvgl.page({title="Test Tool", subtitle="Page 1", back=close})
  pg:label({x=70, y=16, color=BLACK, font=DBLSIZE, text="Test Page"})
  pg:button({x=200, y=150, text="CLOSE", press=close})
end
local function run(event, touchState)
  if lvgl == nil then
    lcd.drawText(0, 0, "LVGL support required", COLOR_THEME_WARNING)
  end
  if ( exitTool) then return 2 end
  return 0
end
return {init = init, run = run, useLvgl=true}
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/variables/getsourcevalue

Function to get the GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### One-Time Script with LVGL UI

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=300

This example demonstrates a one-time script using the LVGL API to create a simple UI with a page, a label, and a button. The 'init' function sets up the UI, and the 'run' function handles script logic and checks for exit conditions. A confirmation dialog is used for exiting the script.

```Lua
local exitTool = false
local function close()
  lvgl.confirm({title="Exit", message="Really exit?",
    confirm=(function() exitTool = true end)
  })
end
local function init()
  if lvgl == nil then return end
  lvgl.clear();
  local pg = lvgl.page({title="Test Tool", subtitle="Page 1", back=close})
  pg:label({x=70, y=16, color=BLACK, font=DBLSIZE, text="Test Page"})
  pg:button({x=200, y=150, text="CLOSE", press=close})
end
local function run(event, touchState)
  if lvgl == nil then
    lcd.drawText(0, 0, "LVGL support required", COLOR_THEME_WARNING)
  end
  if ( exitTool) then return 2 end
  return 0
end
return {init = init, run = run, useLvgl=true}
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/time/gettime

Function to get the GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/rf-module/sporttelemetrypush

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### EdgeTX Widget Options Example

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=100

Example Lua code demonstrating how to create a table with default widget options, including various option types like SOURCE, BOOL, VALUE, COLOR, STRING, and FILE.

```lua
-- Create a table with default options
-- Options can be changed by the user from the Widget Settings menu
-- Notice that each line is a table inside { }
local options = {
  { "Source", SOURCE, 1 },
  -- BOOL is actually not a boolean, but toggles between 0 and 1
  { "Boolean", BOOL, 1 },
  { "Value", VALUE, 1, 0, 10},
  { "Color", COLOR, ORANGE },
  { "Text", STRING, "Max8chrs" },
  { "File", FILE, "default", "PATH" }
}
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/serial-ports/serialgetpower

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### EdgeTX Widget Options Example

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=300

Example Lua code demonstrating how to create a table with default widget options, including various option types like SOURCE, BOOL, VALUE, COLOR, STRING, and FILE.

```lua
-- Create a table with default options
-- Options can be changed by the user from the Widget Settings menu
-- Notice that each line is a table inside { }
local options = {
  { "Source", SOURCE, 1 },
  -- BOOL is actually not a boolean, but toggles between 0 and 1
  { "Boolean", BOOL, 1 },
  { "Value", VALUE, 1, 0, 10},
  { "Color", COLOR, ORANGE },
  { "Text", STRING, "Max8chrs" },
  { "File", FILE, "default", "PATH" }
}
```

--------------------------------

### EdgeTX Widget Options Example

Source: https://luadoc.edgetx.org/~gitbook/pdf_limit=150

Example Lua code demonstrating how to create a table with default widget options, including various option types like SOURCE, BOOL, VALUE, COLOR, STRING, and FILE.

```lua
-- Create a table with default options
-- Options can be changed by the user from the Widget Settings menu
-- Notice that each line is a table inside { }
local options = {
  { "Source", SOURCE, 1 },
  -- BOOL is actually not a boolean, but toggles between 0 and 1
  { "Boolean", BOOL, 1 },
  { "Value", VALUE, 1, 0, 10},
  { "Color", COLOR, ORANGE },
  { "Text", STRING, "Max8chrs" },
  { "File", FILE, "default", "PATH" }
}
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/rf-module/crossfiretelemetrypush

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/lvgl-for-lua/api

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/key-inputs/getrotencspeed

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/filesystem/dir

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/display-lcd/resetbacklighttimeout

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### Widget Script Example (Counter) with LVGL

Source: https://luadoc.edgetx.org/lua-api-reference/lvgl-for-lua/examples

An LVGL version of the 'Counter' script, demonstrating how to create a reusable widget. It includes options for color and shadow, and functions for creating, updating, and handling background logic for the widget.

```lua
local options = {
  { "Color", COLOR, COLOR_THEME_SECONDARY1 },
  { "Shadow", BOOL, 0 }
}
local function create(zone, options) 
  local wgt = { zone=zone, options=options, counter=0 }
  return wgt
end
local function update(wgt, options) 
  wgt.options = options
  lvgl.clear() 
  if wgt.options.Shadow ~= 0 then
    lvgl.label({x=wgt.zone.x+1, y=wgt.zone.y+1, color=BLACK, font=DBLSIZE, text=(function() return wgt.counter end)})
  end
  lvgl.label({x=wgt.zone.x, y=wgt.zone.y, color=wgt.options.Color, font=DBLSIZE, text=(function() return wgt.counter end)})
end
local function background(wgt) 
  wgt.counter = wgt.counter + 1
end
function refresh(wgt)
  wgt.counter = wgt.counter + 1
end
return { name="CounterLVGL", options=options, create=create, update=update, refresh=refresh, background=background, useLvgl=true }
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/display-lcd/grey

Function to get GPS transmission data.

```lua
getTxGPS()
```

--------------------------------

### System and Input Handling

Source: https://luadoc.edgetx.org/lua-api-programming/advanced-topics/lua-data-sharing-across-scripts

Provides system-level functions like setting default channels and sticks, retrieving version information, taking screenshots, and managing key input events.

```lua
defaultChannel(stick)
defaultStick(channel)
getGeneralSettings()
getVersion()
screenshot()
getRotEncMode()
getRotEncSpeed()
killEvents(key)
```

--------------------------------

### System Information and Control

Source: https://luadoc.edgetx.org/lua-api-programming/data-exchange-with-the-edgetx-model-setup

Functions for accessing system settings, retrieving version information, and capturing screenshots.

```lua
defaultChannel(stick)
defaultStick(channel)
getGeneralSettings()
getVersion()
screenshot()
```

--------------------------------

### GPS Data Retrieval

Source: https://luadoc.edgetx.org/lua-api-reference/display-lcd/lcd

Function to get GPS transmission data.

```lua
getTxGPS()
```
Tokens:
Raw