Skip to content
EdgeTX Lua Reference Guide
Screen Constants
Initializing search
EdgeTX/lua-reference-guide
EdgeTX Lua Reference Guide
EdgeTX/lua-reference-guide
EdgeTX Lua Reference Guide
Introduction
Introduction
Acknowledgments
Getting Started
Script Type Overview
Script Type Overview
Custom (Mixer) Scripts
Telemetry Scripts
One-Time Scripts
Function Scripts
Widget Scripts
EdgeTX Lua API Programming Guide
EdgeTX Lua API Programming Guide
Lua Basics
Loading Code Modules Dynamically
Saving Memory
Using Key and Touch Events
Drawing Flags and Colors
Data Exchange with the EdgeTX Model Setup
Included Lua Libraries
Included Lua Libraries
io Library
io Library
io.open()
io.close()
io.read()
io.write()
io.seek()
EdgeTX Lua API Reference
EdgeTX Lua API Reference
Constants
Constants
Key Event Constants
Touch Event Constants
Flags and Pattern Constants
Color Constants
Special Character Constants
Screen Constants
Logical Switch Function Constants
Special Function Constants
Widget Options Constants
General Functions
General Functions
GREY()
accessTelemetryPush()
chdir(directory)
crossfireTelemetryPop()
crossfireTelemetryPush()
defaultChannel(stick)
defaultStick(channel)
flushAudio()
getAvailableMemory()
getDateTime()
getFieldInfo(source)
getFlightMode(mode)
getGeneralSettings()
getGlobalTimer()
getLogicalSwitchValue(id)
getOutputValue(outputIndex)
getRAS()
getRSSI()
getRotEncMode()
getRotEncSpeed()
getRtcTime()
getShmVar(id)
getSourceIndex(sourceName)
getSourceName(sourceIndex)
getSourceValue(source)
getSwitchIndex(positionName)
getSwitchName(switchIndex)
getSwitchValue(switchIndex)
getTime()
getTxGPS()
getUsage()
getValue(source)
getVersion()
ghostTelemetryPop()
ghostTelemetryPush()
killEvents(key)
loadScript(file \[, mode\], \[,env\])
multiBuffer(address\[,value\])
playDuration(duration \[, hourFormat \[, volume\]\])
playFile(filename \[, volume\])
playHaptic(duration, pause \[, flags\])
playNumber(value, unit \[, attributes \[, volume\]\])
playTone(frequency, duration, pause \[, flags \[, freqIncr \[, volume\]\]\])
popupConfirmation(title, message, event)
popupInput(title, event, input, min, max)
popupWarning(title, event)
resetGlobalTimer(\[type\])
serialGetPower(port\_nr)
serialRead(\[num\])
serialSetPower(port\_nr, value)
serialWrite(str)
setSerialBaudrate(baudrate)
setShmVar(id, value)
setStickySwitch(id, value)
setTelemetryValue(id, subID, instance, value \[, unit \[, precision \[, name\]\]\])
sources(\[first\[, last\]\])
switches(\[first\[, last\]\])
sportTelemetryPop()
sportTelemetryPush()
Model Functions
Model Functions
model.defaultInputs()
model.deleteFlightModes()
model.deleteInput(input, line)
model.deleteInputs()
model.deleteMix(channel, line)
model.deleteMixes()
model.getCurve(curve)
model.getCustomFunction(function)
model.getFlightMode(index)
model.getGlobalVariable(index, flight\_mode)
model.getInfo()
model.getInput(input, line)
model.getInputsCount(input)
model.getLogicalSwitch(switch)
model.getMix(channel, line)
model.getMixesCount(channel)
model.getModule(index)
model.getOutput(index)
model.getSensor(sensor)
model.getSwashRing()
model.getTimer(timer)
model.insertInput(input, line, value)
model.insertMix(channel, line, value)
model.resetSensor(sensor)
model.resetTimer(timer)
model.setCurve(curve, params)
model.setCustomFunction(function, value)
model.setFlightMode(index, params)
model.setGlobalVariable(index, flight\_mode, value)
model.setInfo(value)
model.setLogicalSwitch(switch, value)
model.setModule(index, value)
model.setOutput(index, value)
model.setSwashRing(params)
model.setTimer(timer, value)
Lcd Functions
Lcd Functions
Lcd Functions Overview
lcd.RGB(r, g, b | rgb)
lcd.clear(\[color\])
lcd.drawAnnulus(x, y, r1, r2, start, end \[, flags\])
lcd.drawArc(x, y, r, start, end \[, flags\])
lcd.drawBitmap(bitmap, x, y \[, scale\])
lcd.drawBitmapPattern(bitmap, x, y \[, flags\])
lcd.drawBitmapPatternPie(bitmap, x, y, startAngle, endAngle \[, flags\])
lcd.drawChannel(x, y, source, flags)
lcd.drawCircle(x, y, r \[, flags\])
lcd.drawCombobox(x, y, w, list, idx \[, flags\])
lcd.drawFilledCircle(x, y, r \[, flags\])
lcd.drawFilledRectangle(x, y, w, h \[, flags\])
lcd.drawFilledTriangle(x1, y1, x2, y2, x3, y3 \[, flags\])
lcd.drawGauge(x, y, w, h, fill, maxfill \[, flags\])
lcd.drawHudRectangle(pitch, roll, xmin, xmax, ymin, ymax \[, flags\])
lcd.drawLine(x1, y1, x2, y2, pattern, flags)
lcd.drawLineWithClipping(x1, y1, x2, y2, xmin, xmax, ymin, ymax, pattern \[, flags\])
lcd.drawNumber(x, y, value \[, flags \[, inversColor\]\])
lcd.drawPie(x, y, r, start, end \[, flags\])
lcd.drawPixmap(x, y, name)
lcd.drawPoint(x, y)
lcd.drawRectangle(x, y, w, h \[, flags \[, t\]\])
lcd.drawScreenTitle(title, page, pages)
lcd.drawSource(x, y, source \[, flags\])
lcd.drawSwitch(x, y, switch, flags)
lcd.drawText(x, y, text \[, flags \[, inversColor\]\])
lcd.drawTextLines(x, y, w, h, text \[, flags\])
lcd.drawTimer(x, y, value \[, flags \[, inversColor\]\])
lcd.drawTriangle(x1, y1, x2, y2, x3, y3 \[, flags\])
lcd.exitFullScreen()
lcd.getColor(flags)
lcd.getLastLeftPos()
lcd.getLastPos()
lcd.getLastRightPos()
lcd.invertRect(x, y, w, h \[, flags\])
lcd.refresh()
lcd.resetBacklightTimeout()
lcd.setColor(colorIndex, color)
lcd.sizeText(text \[, flags\])
Bitmap Functions
Bitmap Functions
Bitmap.getSize(name)
Bitmap.open(name)
Bitmap.resize(bitmap, width, height)
Bitmap.toMask(bitmap)
Filesystem
Filesystem
dir(directory)
fstat(path)
del(file or directory)
Advanced Topics
Advanced Topics
Lua data sharing across scripts
Debugging techniques
Speed/memory optimizaton tricks
Appendix
Appendix
Fonts
Units
EdgeTX Lua Reference Guide
EdgeTX Lua API Reference
Constants
Screen Constants
¶
Name
Description
LCD_W
width in pixels
LCD_H
height in pixels
Back to top