Documentation version: v0.6.2

Features and version requirements¶

Device applicability

This document applies to OpenZilo Q.

Check the ring's firmware version and supported features before choosing an API. The SDK, firmware and communication protocol have separate version numbers.

Check versions and features¶

Run these commands from the repository:

uv run openzilo --version
uv run openzilo device use
uv run openzilo info
uv run openzilo device capabilities

--version shows the SDK version. info shows the device model and firmware. device capabilities lists supported features and recording parameter limits.

import asyncio
import openzilo as sdk

ADDRESS = "AA:BB:CC:DD:EE:FF"  # Replace with the scanned device address

async def main():
    ring = await sdk.connect_ring(address=ADDRESS)
    try:
        info = await sdk.get_system_info(ring)
        print("Firmware:", info.firmware_version)
        if ring.capabilities.supports("recording_control"):
            print("Recording configuration:", await sdk.get_audio_recording_config(ring))
        else:
            print("No compatible remote recording interface is available")
    finally:
        await ring.disconnect()

asyncio.run(main())

supports() checks that the device and SDK share a compatible feature interface version. See SDK and firmware compatibility.

Requirements by feature¶

Connection requirements

Your computer needs Bluetooth Low Energy (BLE). The SDK communicates with the ring through NUS and supports protocol v4.

Available since SDK v0.6.1

connect_ring() discovers features automatically. When using OpenZiloClient, call get_device_capabilities() explicitly.

Firmware version

This usage requires firmware V2.001.0002.0001 or later. V2.001.0002.0000 does not provide remote start, stop, status or recording configuration APIs.

Firmware version

This usage requires firmware V2.001.0002.0001 or later. V2.001.0002.0000 transfers files after recording has been saved and does not provide live audio. Live PCM also requires the pcm extra.

Firmware version

Starting capture directly with start_sensor_report() without switching modes requires firmware V2.001.0002.0001 or later. V2.001.0002.0000 requires entering gesture mode with the button first.

Update requirements

Use the official OTA package specified in the release notes. Match the device model, hardware revision and starting firmware version. The SDK updates application firmware only, not the bootloader.

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.

Reading version notes¶

Supported since firmware XXX identifies the firmware that introduced a feature.
Available since SDK XXX identifies the SDK that introduced its API.
This page applies to firmware XXX identifies the device behavior described by the page.

Remote recording, recording settings and live audio are available starting with V2.001.0002.0001. The relevant usages state their minimum firmware version. See version migration for other changes from V2.001.0002.0000 to V2.001.0002.0001.

Firmware downloads¶

Read the supported model, hardware revisions and starting versions in official firmware releases, then follow the firmware update guide.