Documentation version: stable (v0.6.2)

Ring user guide¶

Device applicability

This document applies to OpenZilo Q.

Firmware versions

This guide covers device operation in V2.001.0002.0000 and V2.001.0002.0001. V2.001.0002.0001 removes recording/gesture mode switching; the relevant sections identify the changes.

Start here¶

First use: charge, connect, record and download audio.
Buttons and modes: recording, mode changes and button events.
LED indicators: colors and patterns, with suggested actions.
Firmware updates: package selection, updates and recovery.

Build an application¶

Use the CLI guide to operate the device, or the Python SDK guide to write an application. Check feature requirements before choosing an API.

Hardware, firmware and SDK versions are managed separately. Use the interfaces supported by your device. The Python SDK does not currently expose PPG data APIs.

Get help¶

When reporting an issue, include SDK and firmware versions, steps to reproduce, and error messages. Remove device addresses, serial numbers and private audio. Report security issues privately as described in the security policy.