zwave-serial 0.2.1

Z-Wave Serial API host side: frames, ACK/NAK/CAN, retransmits, callbacks, typed controller messages and a controller probe
Documentation

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 a tcp://host:port (ser2net) link.

Part of zwave-bridge, maintained by Pulzar. See the user guide, the library guide and the API documentation.

License: MIT.