Z-Wave Details

From Hubitat Documentation
Revision as of 03:11, 29 June 2022 by RobertM (talk | contribs)
Jump to: navigation, search
Go to the top of the page

Managing your Z-Wave devices properly is very important to maintaining a solid Z-Wave mesh network. Much of that management is done here on the Z-Wave Details page. Be sure to read the How to Build a Solid Z-Wave Mesh document for tips on building a robust and resilient Z-Wave network.

The Z-Wave Details page (this is a screenshot) has options for a hub-wide Z-Wave Repair, Z-Wave Logs viewing, Z-Wave Topology viewing, region and radio enable/disable setting, as well as a list of connected Z-Wave devices and some information about them. The radio can also be reset from this page.

Z-Wave Operations

  • Z-Wave Exclude (A) - Places the hub in general Z-Wave exclusion mode, which can be used to exclude a device previously joined to any hub/controller. (If the device is currently included on this hub, it is recommended to remove the device from the Device Detail page instead.)
  • Repair Z-Wave (B) - Z-Wave Plus is designed to not require repair, and will self-heal. It is generally unnecessary to manually repair Z-Wave Plus devices thanks to Explorer Frames. However, it can help in specific circumstances to run a repair on a Z-Wave Plus network to reduce the time required to update the neighbor table or when dealing with "classic" Z-Wave devices.
    • NOTE: Running a Z-Wave Repair will not revive failed devices. Z-Wave repair is very network intensive since the hub will attempt to ping and possibly re-route every device (except sleeping nodes). We do not recommend running Z-Wave Repair if you are not currently experiencing delays or issues with your Z-Wave network.
  • Z-Wave Logs (C) - View routing, signal and channel information of your Z-Wave devices; logs only packets sent from hub. (Regular Logs may be more helpful for general device troubleshooting.)
  • Firmware Update (R) - Appears if optional hub Z-Wave radio firmware update is available (this button will not appear if firmware is up-to-date). Note that this is hub radio firmware only; to update device firmware, use the Device Firmware Updater app.
  • Z-Wave Topology (D) - View a map of your Z-Wave network
  • Z-Wave Region (E) - Use the drop-down menu to set the applicable region for your country and licensed Z-Wave frequency compatible with your devices.
  • Z-Wave Status (F) - Use the drop-down menu to enable or disable the Z-Wave radio.
  • Update (G) - Select Update after changing the Z-Wave Region or Z-Wave Status (items E or F, above) to apply those changes.

NOTE: A Z-Wave Exclusion option was previously available on this page to initiate a general Z-Wave exclusion; this functionality has been consolidated into the Devices > Add Device > Z-Wave > Start Z-Wave Exclusion feature. See Discovering Your Devices for more.

Z-Wave Device Information

The Z-Wave Radio Devices table (with columns labeled H through P above) shows a list of your Z-Wave devices with information about them:

  • Node (H): Shows Z-Wave node ID in hexadecimal and decimal (e.g., 0x14 in hexadecimal is 20 or 020 in decimal)
  • Stats (J): Shows signal and selected route information, including:
    • PER: Packet error rate (lower is better; 0 is good)
    • Neighbors: The number of "neighbor nodes" (nodes in direct wireless range) that this node is able to see
    • Route Changes: Number of times the route has changed (fewer is generally better)
    • RTT Avg: Round trip time average (the elapsed time between the sending of a packet and the receipt of an acknowledgment packet from the device; shorter is better)
    • LWR RSSI: Calculated value of the RSSI (relative signal strength index) for the last working route (LWR) over each hop, compared to the background noise sampling (higher values above 0 are better)
  • Status (K): Shows OK, UNKNOWN, or FAILED. Devices that are not responding may be marked as FAILED, though this could also happen with battery devices that are sleeping but functioning normally. Refresh will attempt to ping the device. Repair will attempt a per-node repair (recommended over a full network Repair Z-Wave when possible). If Replace is offered, will initiate a Z-Wave Replace operation where the existing node can be replaced with a new node (pair like a regular device; the selected node ID will be re-used for the new device, effectively replacing the old device with the new device from a Z-Wave perspective). If Replace is not offered but you believe the node is dead, attempt a Refresh once or twice; if Repair does not appear, the node is likely OK and the hub was able to hear back from it, and you will be unable to Replace.
  • Device Class (L): Shows the Z-Wave specific or generic device class and manufacturer
  • Device (M): Provides a link to the Hubitat device corresponding to this Z-Wave node, or a Discover button that will create one if no such node exists
  • Security (N): Shows the highest Z-Wave security type granted during inclusion: S2 Access Control, S2 Authenticated, S2 Unauthenticated, S0, or None.
  • Route (P): Shows the hops the Z-Wave signal takes from the hub to the device (using hexadecimal node IDs) and the speed of the link

Reset Z-Wave Radio

The Reset Z-Wave Radio option (labeled Q above) can be used to clear the Z-Wave radio contents, which will erase all device pairings. You will need to re-add all Z-Wave devices like new in order to use these devices with your hub again. Proceed with caution. To reset, type "reset" (without quotes) into the text box, then select Reset.