LUA Reference Guide
Search…
EdgeTX v2.7
EdgeTX 2.7 Lua Reference Guide
Introduction
Part I - Script Type Overview
Part II - EdgeTX Lua API Programming Guide
Part III - EdgeTX Lua API Reference
Constants
General Functions
GREY()
accessTelemetryPush()
chdir(directory)
crossfireTelemetryPop()
crossfireTelemetryPush()
defaultChannel(stick)
defaultStick(channel)
getAvailableMemory()
getDateTime()
getFieldInfo(source)
getFlightMode(mode)
getGeneralSettings()
getGlobalTimer()
getLogicalSwitchValue(id)
getRAS()
getRSSI()
getRotEncSpeed()
getRtcTime()
getShmVar(id)
getSourceIndex(sourceName)
getSourceName(sourceIndex)
getSwitchIndex(positionName)
getSwitchName(switchIndex)
getSwitchValue(switchIndex)
getTime()
getTxGPS()
getUsage()
getValue(source)
getVersion()
killEvents(key)
loadScript(file [, mode], [,env])
multiBuffer(address[,value])
playDuration(duration [, hourFormat])
playFile(name)
playHaptic(duration, pause [, flags])
playNumber(value, unit [, attributes])
playTone(frequency, duration, pause [, flags [, freqIncr]])
popupConfirmation(title, message, event)
popupInput(title, event, input, min, max)
popupWarning(title, event)
resetGlobalTimer([type])
serialRead([num])
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
Lcd Functions
Bitmap Functions
Filesystem
Part IV - Advanced Topics
Appendix
Powered By GitBook
serialRead([num])
@param num (optional): maximum number of bytes to read. If non-zero, serialRead will read up to num characters from the buffer. If 0 or left out, serialRead will read up to and including the first newline character or the end of the buffer. Note that the returned string may not end in a newline if this character is not present in the buffer.
Reads characters from the serial port. The string is allowed to contain any character, including 0.
@status current Introduced in 2.3.8

Parameters

none

Return value

  • str string. Empty if no new characters were available.
Previous
resetGlobalTimer([type])
Next
serialWrite(str)
Last modified 4mo ago
Export as PDF
Copy link
Contents
Parameters
Return value