Repository navigation
Releases
v0.2.1
Changed
- The first release on crates.io. Every crate carries its homepage, docs.rs
link, README, LICENSE and NOTICE, and only its sources and tests. CI
packages the workspace on every push; a release publishes the crates in
dependency order.
zwave-bridge 0.2.0
zwave-bridge 0.2.0 adds Z-Wave Long Range, device firmware updates, Z-Wave JS device files, and NVM restore with conversion between 700 and 800 series controllers.
Status: early. Everything is tested in CI against a Serial API controller simulator, but no release has been tested on real hardware yet. Back up keys.json before upgrading, and please report how it goes. zwave-bridge is not certified by the Z-Wave Alliance.
New
- Z-Wave Long Range. With a Long Range capable 800 series controller, Long Range devices join by SmartStart (provision their QR code or DSK). They get node ids from 256 up and use S2 Authenticated or Access Control keys of their own, which are added to an existing
keys.jsonon first start. - Device firmware updates. Put a firmware file in
<store dir>/firmware/and sendfirmware_updatewith the node and file name. Intel HEX is converted;.gbl,.binand.otafiles are sent as they are. Progress and the result come as events. Tested against the simulator only: try one device first. - Z-Wave JS device files. Point
[devices] dirat theconfig/devicesdirectory of an@zwave-js/configrelease, read as published. Nodes get their device's name, their parameters are published onzwave/nodes/<id>/parameters, and theconfigurerequest sets them by key, partial parameters included. See Device files. - NVM restore. The
restorerequest writes a backup from thebackuprequest onto a controller, converting it between 700 and 800 series and SDKs as Z-Wave JS's NVM migration does. It refuses a backup in a format newer than the controller can read. The bridge then exits for its service manager to restart it on the restored network. - Matching answers to questions. Every response echoes the request's
transaction.
Fixed
- Home Assistant notification sensors now show the notification's state, not the value's name.
- The
zwave-simbinary keeps serving when its standard input closes. - Store writes no longer race when the bridge flushes on shutdown.
For developers
In zwave-host: Controller::replace_failed_node, factory_reset, set_region, configure_raw (settings by parameter key without a device file), close (releases the serial port), queued and last_route; ValueUpdate.rssi; NodeRecord::dsk kept for nodes included with S2 Authenticated or Access Control; and nvm3::convert. In zwave-serial: probe::identify on a running link. The Serial API builders take the node id width (a breaking change, for Long Range).
Upgrading
Replace the binary and restart. Configuration files from 0.1.0 work unchanged; [devices] is optional. Static binaries of zwave-bridge and zwave-sim for x86_64, aarch64 and mipsel, with SHA256SUMS, are attached below; the quick start covers a new install.
Full list of changes: CHANGELOG.md.
zwave-bridge 0.1.0
The first release of zwave-bridge: a Z-Wave controller stack and Z-Wave to MQTT bridge in Rust, as one static binary with no runtime, for Silicon Labs Serial API controllers.
Status: early. Everything, including S2 key exchange, is tested in CI against a Serial API controller simulator, but this release has not been tested on real hardware yet. Back up keys.json, and please report how it goes with your controller. zwave-bridge is not certified by the Z-Wave Alliance.
What you can do with it
- Run a Z-Wave network on a 500, 700 or 800 series USB controller (Zooz, Aeotec, Silicon Labs and others), over USB serial or TCP (ser2net).
- Include and exclude devices, with S2 security (Access Control, Authenticated, Unauthenticated) including DSK and PIN confirmation, S0 for older devices, and SmartStart from QR codes.
- Use switches, dimmers, multilevel and binary sensors, meters, notifications and battery levels: 22 command classes, with Supervision, Multi Channel and Transport Service.
- See every value on MQTT, and in Home Assistant through MQTT discovery.
- Sleeping devices work: requests wait for their next wake-up.
- Back up the controller's memory, and see routes and the mesh topology.
- Ask a port what controller it has, read-only:
zwave-bridge probe /dev/ttyACM0.
Install
Static binaries of zwave-bridge and the zwave-sim controller simulator 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, S2 inclusion, configuration, every MQTT topic, and hardware.
Known limitations
- Command classes beyond the 22 in this release are not supported yet: no thermostats, door locks, color bulbs, window coverings or scene controllers.
- Z-Wave Long Range, device firmware updates, Z-Wave JS device files (named configuration parameters) and NVM restore are done on
mainfor the next release. - No TLS to the MQTT broker yet.
For developers
The stack is a set of library crates: zwave-host (the controller), zwave-cc, zwave-security, zwave-serial, and zwave-sim, a controller simulator whose nodes run real S2. Depend on them by this tag; see the library guide.
Full list of changes: CHANGELOG.md.