Repository navigation
Releases
v0.3.0
The first release on crates.io.
Changed
zigbee-typesis renamedzigbee-primitives(cratezigbee_primitives),
since crates.io already has azigbee-types. Replace the dependency and
theusepaths; nothing else changes.
Added
- The crates are ready for crates.io: descriptions, docs.rs links, each
crate's README as its crates.io page, and packages that carry only the
sources, README, license and the tests that run from the package. CI dry
runscargo publish --workspaceon every push, and a version tag
publishes the crates in dependency order.
zigbee-bridge 0.2.0
zigbee-bridge 0.2.0 adds Texas Instruments Z-Stack and dresden elektronik ConBee/RaspBee coordinators, channel change, device firmware updates (OTA), and restoring a backup onto a coordinator of another family.
Status: early. Every coordinator family is tested in CI against the coordinator simulator, but no release has been tested on real hardware yet. Keep a backup of your network, and please report how it goes on your coordinator.
New
- Texas Instruments Z-Stack coordinators (ZNP): Z-Stack 3.x.0 on CC2652 and CC1352 sticks (Sonoff ZBDongle-P, SMLIGHT SLZB-06 and others), and Z-Stack 3.0.x on CC2530/CC2531. Z-Stack Home 1.2 is refused;
probestill identifies it. - ConBee II, ConBee III and RaspBee II with deCONZ firmware 0x26580700 or newer.
- The coordinator family is detected. The new
serial.adaptersetting defaults toauto, which probes the port for EZSP, then ZNP, then deCONZ; setezsp,znpordeconzto skip the probe.zigbee-bridge probe PORTnow reports the family and product. - Channel change without pairing devices again: the
change_channelrequest ({"channel": 20}) and achannel_changedevent. The new channel is saved, andbridge/infogainsnetwork.update_id. - Device firmware updates from OTA image files you put in
<data dir>/ota(or[ota] dir):ota_checkandota_updaterequests, withota_available,ota_progressandota_finishedevents. Nothing is offered to a device unless you ask. Tested against the simulator only: try one device first. - Restore across families: a backup restores onto a coordinator of any supported family, and backups written by other hosts in the open coordinator backup format can be read.
What each family cannot do
Readings a coordinator family does not provide are left out rather than guessed:
- Z-Stack reports no signal strength, link key exchanges or ZDO delivery; Z-Stack enforces
join.allow_legacy = falseitself. - deCONZ reports no joins or leaves (the bridge learns of a device from its announce) and keeps one trust center link key, so
join.install_code_onlyis refused andjoin.allow_legacy = falseis not enforced.
For developers
New crates: zigbee-znp and zigbee-deconz. In zigbee-host: ZnpAdapter, DeconzAdapter, AnyAdapter, probe_any, Host::change_channel, Host::active_scan, Host::leave, the OTA server (ota, Host::ota_check, Host::ota_update). Breaking: AdapterEvent and FrameLink carry signal strength as Option, NcpKind is #[non_exhaustive], Host::network returns the network by value, and zigbee-sim's SimConfig names the family with ncp: SimNcp. The simulator plays all three families (zigbee-ncp-sim --ncp ezsp|znp|deconz).
Upgrading
Replace the binary and restart; 0.1.0 configuration files work unchanged. Static binaries for x86_64, aarch64 and mipsel, with SHA256SUMS, are attached below; the quick start and the documentation cover new installs.
Full list of changes: CHANGELOG.md.
zigbee-bridge 0.1.0
The first release of zigbee-bridge: a Zigbee coordinator stack and Zigbee to MQTT bridge in Rust, as one static binary with no runtime, for Silicon Labs EmberZNet coordinators.
Status: early. Everything is tested in CI against a coordinator simulator, but this release has not been tested on real hardware yet. Keep a backup of your network, and please report how it goes on your coordinator.
What you can do with it
- Run a Zigbee network on a Silicon Labs coordinator with EmberZNet 7.4 to 8.x NCP firmware (Home Assistant Connect ZBT-1, Sonoff ZBDongle-E after a firmware update, SMLIGHT SLZB-06M/07, and other EFR32MG21/MG24 sticks), over USB serial or TCP.
- Pair devices with Zigbee 3.0 security: unique link keys, install codes, and a policy to require install codes or turn away pre-3.0 devices.
- See readings from any device that uses the standard clusters (temperature, humidity, pressure, illuminance, CO2, PM2.5, occupancy, contact, leak, smoke, power, energy, battery and more) on MQTT, and in Home Assistant through MQTT discovery.
- Switch lights and plugs, and set brightness and color temperature.
- Keep a backup of the network in the open coordinator backup format, and move it to a new coordinator without pairing devices again.
- Inspect the mesh: topology, neighbor tables, an energy scan.
- Ask a port what coordinator and firmware it has, read-only:
zigbee-bridge probe /dev/ttyUSB0.
Install
Static binaries for x86_64, aarch64 (Raspberry Pi 3 and newer, 64-bit OS) and mipsel (MT7621/MT7628 routers) are attached below, with SHA256SUMS. The quick start goes from download to a device in Home Assistant; the documentation covers installation as a service, configuration, every MQTT topic, and hardware.
Known limitations
- Silicon Labs EmberZNet only in this release. Texas Instruments Z-Stack and ConBee/RaspBee coordinators are done on
mainfor the next release; EmberZNet 7.3 and older is refused with a request to update the firmware. - Standard clusters only: devices that report through manufacturer-specific clusters (common with Tuya and Aqara) do not get state fields yet, though every report is published raw on
<device>/report. - No groups, scenes, binding requests or device firmware updates yet (firmware updates are on
main). - No TLS to the MQTT broker yet.
For developers
The stack is a set of library crates: zigbee-host (the coordinator), zigbee-zcl, zigbee-zdo, zigbee-ezsp, zigbee-ash, zigbee-types, and zigbee-sim, a coordinator simulator for testing without hardware. Depend on them by this tag; see the library guide.
Full list of changes: CHANGELOG.md.