Skip to content
Liberated Bread

Device Specs

Machine-readable protocol specifications for the devices we document — Bluetooth LE, WiFi and hub-attached. Each spec describes one device's protocol in a single YAML file: its services and characteristics, the command encodings, and what each value means.

These are published for anyone building against the hardware, and they are consumed directly by tooling rather than read as prose. They are not liberation guides — for those, see the device catalogue.

Schema and index

File What it is
schema.json JSON Schema every spec below validates against
index.json Generated manifest of all specs — the machine entry point
examples/example-bulb.yaml Minimal annotated example to write a new spec from

Device specifications

51 device specifications:

Where these come from

The specs are maintained in liberatedbread-protocol-specs and vendored into this site so they are served from a stable URL under liberatedbread.com. That repository is the place to file corrections or propose a new device — a change made here would be overwritten by the next sync.

Alongside the specs, the subtree carries the cleanroom research notes the protocol work was derived from. Those are served in raw Markdown at /device-specs/research-notes/<device>.md; the rendered, cross-linked versions live upstream, where their links resolve.

Every spec is produced under the project's cleanroom rules: from observation of traffic to and from hardware the author owns, and from published documentation — never from vendor firmware or decompiled application code.