Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting started with a device

This section is for people who operate ROHI devices. If you write firmware, start with Build Firmware.

1. Check that your device is supported

Look up the board in the support matrix. It says which firmware targets the board and what has been verified on hardware. Today that is the Altruist Urban; the Altruist Insight is not supported by ROHI.

2. Get a firmware onto the device

The reference firmware for the Altruist Urban is in firmwares/altruist-urban. Build and flash it as described in Quick start and First device. This repository does not publish pre-built firmware images.

3. Connect with a client

A flashed device advertises over Bluetooth LE. The rohi desktop application finds it and operates it:

rohi scan          # find the device
rohi status        # health and every service
rohi config        # the settings the device offers
rohi action        # the operations the device offers
WorkflowPage
Find a device and connectDiscovery & connection
Inspect and change settingsConfiguration
Check health, services and issuesStatus & diagnostics
Run device operationsActions
Script all of the aboveAutomation

A shared mobile application is planned but not implemented.

Limits to know about

  • The control link is not encrypted or authenticated yet: anyone in Bluetooth range can configure the device.
  • A device accepts one connection at a time.
  • Keep rohi and the firmware on the same revision: the control protocol is still changing.