Building Apps with the Brilliant SDK

Migrating from the Frame SDK? See the Migration guides for Python, Flutter and Web Bluetooth.

  1. How Do Apps Run on Halo?
  2. Getting Started
  3. Development Options for Halo
  4. Development with the Brilliant SDK
  5. Direct Bluetooth LE Development
  6. Firmware Customization

How Do Apps Run on Halo?

Halo runs a power-efficient System-on-a-Chip (SoC) with relatively limited memory and processing power compared to modern smartphones. Rather than installing apps directly on Halo, it typically functions as a peripheral accessory for “host” apps running on computers or mobile devices. These host apps communicate with Halo via Bluetooth to control features like the camera, microphone, speakers, and display.

While you may write Lua scripts that execute on Halo for specific behaviors, your host app primarily drives the logic while Halo typically runs a simple event handler loop. For example, the Noa mobile app connects to Halo, receives sensor data over Bluetooth, processes it, and sends content back to Halo for display.

Halo doesn’t have its own app launcher or traditional app installation system. To share your Halo apps with others, publish your host app through normal distribution channels like App Store, Google Play, GitHub, or open source repositories. If you build something cool, let us know and we’ll be happy to share it with the community.

Getting Started

For the quickest start:

Development Options for Halo

  1. Use the Brilliant SDK (Recommended)
    • Build with supported platforms:
    • Benefits: common tasks are simplified, many examples to follow, experimental emulator available for Python
  2. Communicate via Bluetooth LE
    • Use any platform with Bluetooth LE capabilities
    • Offers full control but requires Bluetooth LE development experience
    • See the Bluetooth LE API documentation
  3. Customize Firmware (Advanced)
    • Requires hardware development expertise
    • Provides complete control of Halo hardware
    • Find the official firmware on GitHub

The typical development pattern involves creating a Python desktop application or Flutter mobile app that uses the Brilliant SDK to communicate with Halo over Bluetooth Low Energy, abstracting away the Lua and BLE details.

Development with the Brilliant SDK

This recommended approach offers quick and reliable Halo app development for Python, Flutter, and Web Bluetooth platforms, all under active development.

Our platform SDKs simplify the low-level Bluetooth and Lua APIs, eliminating the need to write boilerplate code for device discovery, connection, and communication.

Familiarity with the Lua API remains useful for main application event loops, main.lua scripts that run at wakeup, and custom on-device processing.

Check the Python, Flutter, or Web Bluetooth SDK documentation for implementation details.

Direct Bluetooth LE Development

For developers comfortable with Bluetooth LE, this approach offers maximum flexibility and requires understanding how Bluetooth LE works.

After establishing BLE communication, you’ll use Lua to control Halo’s functions. Halo provides a Lua 5.3 virtual machine where you can execute scripts or use the Lua REPL over the BLE interface.

Refer to the Bluetooth LE API documentation and the full Lua API reference for details on Halo’s capabilities.

Firmware Customization

Halo is developed by hackers for hackers, so even though we don’t recommend it for most users, Halo’s open-source firmware can be customized. Find the official firmware on GitHub (coming soon).

Table of contents