Installation
DeviceClientConfig
The configuration object passed tonew DeviceClient().
string
required
Agent ID to connect to. Found in
.lua/lua.config.yaml or the Lua dashboard.string
required
API key for authentication. Generate with
lua auth configure.string
required
Unique name for this device. Lowercase with hyphens (e.g.,
label-printer, pico-sensor-01).DeviceCommandDefinition[]
Array of commands this device supports. Sent to the server at connect time so the agent can use them as tools. See Self-Describing Commands.
'socketio' | 'mqtt'
default:"socketio"
Transport protocol. Use
'mqtt' for constrained devices or environments where MQTT is preferred.string
default:"https://api.heylua.ai"
Server URL for Socket.IO transport.
string
default:"wss://mqtt.heylua.ai/mqtt"
MQTT broker URL. Required when
transport is 'mqtt'.string
default:"https://cdn.heylua.ai"
CDN URL for file uploads and downloads.
string
Optional device group name for fan-out commands (e.g.,
'printers', 'sensors-floor-2').DeviceCommandDefinition
Each entry in thecommands array describes one command the device supports.
string
required
Command name. Used by the agent to invoke the command (e.g.,
read_temperature).string
required
Human-readable description. Shown to the AI agent as the tool description. Write it as if explaining to a person what the command does.
Record<string, any>
JSON Schema for command input parameters. The agent uses this to know what arguments to pass.
number
default:"30000"
Command timeout in milliseconds. If the device does not respond within this time, the command fails.
{ maxAttempts: number; backoffMs: number }
Retry configuration for failed commands. The gateway retries with exponential backoff.
Connection Lifecycle
The client automatically reconnects on network failures with jittered exponential backoff (1s to 30s). Call
disconnect() to stop reconnection. The client also registers SIGTERM and SIGINT handlers for graceful shutdown.Handling Commands
Register handlers for commands the agent can send to this device:Firing Triggers
Send events from the device to the agent:CDN Uploads
EveryDeviceClient instance includes a cdn property for uploading and downloading files:
Transport Configuration
- Socket.IO (default)
- MQTT
Complete Example
A device that simulates a smart thermostat with temperature reading, target temperature setting, and a high-temperature alert trigger:Next Steps
MQTT Transport
Deep dive into MQTT configuration and topic structure
CDN Uploads
Upload and download files from your device
Triggers
Send events from your device to the agent
API Reference
Complete class and method documentation

