Skip to main content

Lua API Reference

📚 API Modules​

Device Control​

control - Remote Control Operations​

Control TV devices using standard remote control commands like navigation, volume, number keys, and app shortcuts.

keyboard - Virtual Keyboard Input​

Create and interact with on-screen keyboards for text input and navigation.

Screen & Vision​

screen - Screen Capture & Interaction​

Capture screenshots, interact with UI elements, and manage screen state.

vision - Computer Vision​

Vision functions for brightness detection, text reading, and image comparison.

AI & Automation​

ai - AI-Powered Automation​

Interact with AI for intelligent automation, natural language navigation, and screen analysis.

Regions & Layout​

region - Screen Regions​

Define and work with screen regions for targeted operations and UI element detection.

Device Management​

device - Device Operations​

Control device power states and retrieve device information.

navigateTo - Smart Navigation​

High-level navigation functions with device-specific logic for common scenarios.

Testing & Quality​

qoe - Quality of Experience​

Measure and analyze video quality and performance metrics.

Network & Communication​

network - HTTP Requests​

Make HTTP requests and handle network operations.

Assets & Files​

asset - Asset Management​

Import and upload images and other assets for testing.

Admin & Device Pairing​

devicePairing - Device Pairing​

Handle device pairing and connection management.

global - Global Functions​

Core global functions available throughout your scripts.

Global Functions​

Available everywhere in your scripts:

Logging & Output​

  • print(...) - Print messages (info level)
  • warn(...) - Print warnings
  • error(message) - Raise error and stop execution

Time & Utilities​

  • wait(milliseconds) - Wait/sleep
  • seconds(secs) - Convert seconds to milliseconds
  • minutes(mins) - Convert minutes to milliseconds
  • getDateTime() - Get current timestamp

Error Handling​

  • excall(function) - Protected function call
  • assert(condition, message) - Assertion with custom message