SUMMARY.md

Summary

• OpenTX 2.1 Lua Reference Guide
  • Introduction
    • Acknowledgments
    • Getting Started
• Part I - Script Type Overview
  • Mix Scripts
  • Telemetry Scripts
  • One-Time Scripts
  • Wizard Script
  • Function Scripts
• Part II - OpenTX Lua API Programming Guide
  • Input Table Syntax
  • Output Table Syntax
  • Init Function Syntax
  • Run Function Syntax
  • Return Statement Syntax
  • Included Lua Libraries
    • io Library
      • io.open()
      • io.close()
      • io.read()
      • io.write()
      • io.seek()
• Part III - OpenTX Lua API Reference
  • Constants
    • Key Event Constants
  • General Functions [//]: <> (LUADOC-BEGIN:general)
    • GREY()
    • defaultChannel(stick)
    • defaultStick(channel)
    • getDateTime()
    • getFieldInfo(name)
    • getFlightMode(mode)
    • getGeneralSettings()
    • getTime()
    • getValue(source)
    • getVersion()
    • killEvents(key)
    • playDuration(duration [, hourFormat])
    • playFile(name)
    • playNumber(value, unit [, attributes])
    • playTone(frequency, duration, pause [, flags [, freqIncr]])
    • popupInput(title, event, input, min, max) [//]: <> (LUADOC-END:general)
  • Model Functions [//]: <> (LUADOC-BEGIN:model)
    • model.defaultInputs()
    • model.deleteInput(input, line)
    • model.deleteInputs()
    • model.deleteMix(channel, line)
    • model.deleteMixes()
    • model.getCurve(curve)
    • model.getCustomFunction(function)
    • 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.getTimer(timer)
    • model.insertInput(input, line, value)
    • model.insertMix(channel, line, value)
    • model.resetTimer(timer)
    • model.setCustomFunction(function, value)
    • model.setGlobalVariable(index, flight_mode, value)
    • model.setInfo(value)
    • model.setLogicalSwitch(switch, value)
    • model.setModule(index, value)
    • model.setOutput(index, value)
    • model.setTimer(timer, value) [//]: <> (LUADOC-END:model)
  • Lcd Functions [//]: <> (LUADOC-BEGIN:lcd)
    • Lcd Functions Overview
    • lcd.clear()
    • lcd.drawChannel(x, y, source, flags)
    • lcd.drawCombobox(x, y, w, list, idx [, flags])
    • lcd.drawFilledRectangle(x, y, w, h [, flags])
    • lcd.drawGauge(x, y, w, h, fill, maxfill)
    • lcd.drawLine(x1, y1, x2, y2, pattern, flags)
    • lcd.drawNumber(x, y, value [, flags])
    • lcd.drawPixmap(x, y, name)
    • lcd.drawPoint(x, y)
    • lcd.drawRectangle(x, y, w, h [, flags])
    • lcd.drawScreenTitle(title, page, pages)
    • lcd.drawSource(x, y, source [, flags])
    • lcd.drawSwitch(x, y, switch, flags)
    • lcd.drawText(x, y, text [, flags])
    • lcd.drawTimer(x, y, value [, flags])
    • lcd.getLastPos()
    • lcd.lock() [//]: <> (LUADOC-END:lcd)
• Part IV - Converting OpenTX 2.0 Scripts
  • General Issues
  • Handling GPS Sensor data
  • Handling Lipo Sensor Data
• Part V - Advanced Topics
  • Lua data sharing across scripts
  • Debugging techniques