Documentation version: stable (v0.6.2)
OpenZilo Python SDK¶
Device applicability
This document applies to OpenZilo Q.
Connect an OpenZilo ring from Python, read device information, recordings and motion data, and integrate them into your application. Public APIs are provided by the openzilo package; the CLI is installed with the SDK.
Start here¶
- Installation and requirements: install the SDK and configure Bluetooth and audio dependencies.
- Quick start: run a complete example to connect and read device information.
- SDK and firmware compatibility: discover features and check which APIs are available.
To operate a device from a terminal first, use the CLI guide.
Use SDK features¶
| Your task | Guide |
|---|---|
| Scan, connect, disconnect or manage notifications | Scan and connect |
| Read firmware, model, battery and storage | Read device information |
| Respond to device time requests | Synchronize device time |
| Configure, start or stop recording remotely | Remote recording and configuration |
| Download stored recordings or receive newly saved recordings | Download and receive saved recordings |
| Receive live Opus or PCM | Live audio |
| Preserve original files and convert to WAV | Decode and save audio |
| Collect accelerometer and gyroscope samples | Collect IMU data |
| Wait for button or tap events | Button and tap events |
| Read device logs in chunks | Read device logs |
| Update firmware from an application | Update firmware with the SDK |
Each feature guide explains call order, arguments, results and error handling, with relevant examples.
Look up APIs and troubleshoot¶
- API index: public functions and signatures grouped by feature.
- Data types: connection, recording, audio and IMU result fields.
- Exceptions and troubleshooting: connection failures, timeouts, decoding errors and busy devices.
- Feature requirements and version migration: feature conditions and upgrade changes.
Device and protocol¶
See the ring user guide for physical device operation. For custom clients or communication debugging, read the protocol reference, architecture and data flow, and protocol debugging utilities.