Expand description
§zwave-serial
The host side of the Z-Wave Serial API, the protocol between a host and a Z-Wave controller chip (USB sticks and UART modules on the 500, 700 and 800 series), as described in Silicon Labs’ public Z-Wave Host API Specification.
frame: the byte-level frames (SOF, length, type, function, payload, checksum; ACK, NAK and CAN) and a streaming decoder that never panics and never allocates more than one frame.function: the function ids.message: typed requests and parsers for the controller’s responses and callbacks.driver:SerialApi, which owns the port and runs the link layer: one exchange at a time, ACK within 1.6 s, up to three transmissions with back-off, callback ids, response and callback timeouts, and every frame the controller sends on its own handed to the caller.mod@probe: say what controller (if any) answers on a port, with one read-only frame.port: open a serial device or atcp://host:port(ser2net) link.
Part of zwave-bridge, maintained by Pulzar. See the user guide, the library guide and the API documentation.
License: MIT.
Re-exports§
pub use driver::Config;pub use driver::Exchange;pub use driver::Request;pub use driver::SerialApi;pub use driver::SerialError;pub use frame::DataFrame;pub use frame::Frame;pub use frame::FrameType;pub use function::FunctionId;pub use probe::probe;pub use probe::probe_blocking;pub use probe::ControllerIdentity;pub use probe::Series;
Modules§
- driver
- The Serial API link layer.
- frame
- Serial API frames.
- function
- Serial API function ids.
- message
- Typed Serial API messages: request builders and parsers for responses, callbacks and unsolicited frames.
- port
- Opening the link to a controller: a local serial device, or a TCP socket for sticks shared over the network (ser2net, socat, a simulator).
- probe
- Probing a port: is there a Z-Wave controller, and which?
Type Aliases§
- NodeId
- A node id. Classic Z-Wave uses 1 to 232; Long Range uses 256 to 4000.