Brilliant SDK

A multi-platform SDK for building applications that communicate with Brilliant Labs smart glasses — Halo and Frame.

Devices run user scripts in an on-device Lua 5.4 VM and expose the frame.* API for display, Bluetooth, IMU, audio, file I/O, and more. The SDK handles the host side: BLE transport, message framing, and rich data types (images, text, audio, sensor data).

Each implementation has its own README with installation, usage, and development instructions.

Python — PyPI

pip install brilliant-sdk
# or: pip install brilliant-ble  /  pip install brilliant-msg

Flutter — pub.dev

flutter pub add brilliant_sdk
# or: flutter pub add brilliant_ble  /  flutter pub add brilliant_msg

WebBluetooth — npm

npm install brilliant-sdk
# or: npm install brilliant-ble  /  npm install brilliant-msg

All three SDKs share the same two-layer architecture:

┌──────────────────────────────────────────────────────────┐
│  Application (your code)                                 │
├──────────────────────────────────────────────────────────┤
│  brilliant_msg  — rich message types (sprites, text,     │
│               audio, IMU, photos, clicks …)              │
├──────────────────────────────────────────────────────────┤
│  brilliant_ble  — BLE transport (connect, scan, MTU-aware│
│               packet splitting, DFU)                     │
├──────────────────────────────────────────────────────────┤
│  Bluetooth LE                                            │
├──────────────────────────────────────────────────────────┤
│  Device (Halo / Frame)  —  Lua 5.4 VM + frame.* API      │
└──────────────────────────────────────────────────────────┘

brilliant_ble — Low-level BLE layer. Finds and connects to the device, negotiates MTU, splits large payloads into MTU-sized packets, and manages connection state.

brilliant_msg — Application-level messaging. Defines TX (host → device) and RX (device → host) message types for sprites, rasterized text, photos, audio, IMU data, taps, and click events. Each message type is paired with a corresponding Lua library that runs on the device.

Lua on device — Every message type has a matching .lua script (and minified .min.lua) that receives and renders the data on the device side.

The halo-emulator package (PyPI) runs device-side Lua apps in a firmware-faithful Halo emulator — Lua 5.4, real fonts and palette, IMU / tap / microphone event injection — so apps can be developed and tested with no glasses attached:

pip install halo-emulator
halo-emulator ./my_app/   # interactive REPL + display window

The device-side Lua is identical across all three SDKs, so the emulator is useful for validating the Lua half of Flutter and WebBluetooth apps too. See its README for the test-writing API and the supported frame.* surface.

Both Halo and Frame are supported across all SDK implementations. Device type is detected automatically after connecting.

• Brilliant Labs developer docs — device docs, SDK guides, and the on-device Lua API references for Halo and Frame
• Python API reference: brilliant-ble · brilliant-msg
• WebBluetooth examples + TypeDoc
• Example indexes: Python msg · Python ble · Flutter apps · WebBluetooth
• AI coding agents: start at AGENTS.md

All packages in this repository are released under the BSD 3-Clause License.