Difference between revisions of "Z-Wave Details"

From Hubitat Documentation
Jump to: navigation, search
(Update for 2.3.1 and other outdated-ness)
Line 1: Line 1:
 
{{Top}}
 
{{Top}}
  
−
<big>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 Information page. Be sure to read the [[How to Build a Solid Z-Wave Mesh|'''How to Build a Solid Z-Wave Mesh''']] document for tips on building a robust and resilient Z-Wave network.</big>
+
<big>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|'''How to Build a Solid Z-Wave Mesh''']] document for tips on building a robust and resilient Z-Wave network.</big>
−
[[File:Z-Wave Status Page v3.png|none|thumb|603x603px|link=https://docs.hubitat.com/images/1/14/Z-Wave_Status_Page_v3.png|alt=The "Z-Wave Details" page found in the hub settings has the following buttons and settings at the top of the page. [A] The "Z-Wave Exclude" button, [B] the "Repair Z-Wave button", [C] the "Z-Wave logs" button, [D] The "Firmware update" button, which is only used for updating the hub internal Z-Wave radio, and [E] the "Z-Wave topology" button. Above these buttons, you can set the Z-Wave radio for your region, and select whether the Z-Wave radio should be enabled or disabled. Press the "Update" button if you make changes to these fields. Below the buttons, there are information columns. [H] the "Stats" column shows Z-Wave signal and routing information, [I] the "Status" column shows the current status of your device, [J] the "Clusters" column shows Z-Wave command classes supported by the device, [K] the Z-Wave "Security" level column, and lastly, [L] the "Route" column displays the security hops your device is making back to the hub, and the speed it is communicating in kilobits per second.]]
+
[[File:Z-Wave Status Page v3.png|none|thumb|1000x1000px|link=https://docs.hubitat.com/images/1/14/Z-Wave_Status_Page_v3.png|alt=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.]]
−
'''<big>Z-Wave Information</big>'''
 
  
−
*<big>'''Z-Wave Exclude''' ('''A''') - Click here if you need to remove a Z-Wave device. You '''<u>MUST</u>''' run this '''Z-Wave Exclusion''' process to remove the device from your system to prevent errors and allow the device to be used on a different hub.</big>
+
=== '''<big>Z-Wave Operations</big>''' ===
  
−
*<big>'''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 to occasionally run repairs on a Z-Wave plus network to reduce the time required to update the '''neighbor table'''.</big>
+
*<big>'''Repair Z-Wave''' ('''A''') - '''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.</big>
−
**<big>'''NOTE: ''Running a Z-Wave Repair will not revive failed devices'''''</big><nowiki/><big>''. '''Z-Wave repair is very network intensive since every device will be re-routed. We do not recommend running Z-Wave Repair if you are not currently experiencing delays or issues with your Z-Wave network.'''''</big>
+
**<big>'''NOTE: ''Running a Z-Wave Repair will not revive failed devices'''''</big><nowiki/><big>''. '''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.'''''</big>
  
−
*<big>'''Z-Wave Logs''' ('''C''') - View routing, signal and channel information of your Z-Wave devices.</big>
+
*<big>'''Z-Wave Logs''' ('''B''') - 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.)</big>
−
*<big>'''Firmware update''' ('''D''') - Used only to update the firmware of the Z-Wave radio in your hub. To update device firmware, use the [[Device Firmware Updater|'''Device Firmware Updater''']] app.</big>
+
*<big>'''Firmware update''' ('''C''') - 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|'''Device Firmware Updater''']] app.</big>
−
*<big>'''Z-Wave Topology''' ('''E''') - View the map of your Z-Wave network</big>
+
*<big>'''Z-Wave Topology''' ('''D''') - View a map of your Z-Wave network</big>
−
*<big>'''Z-Wave Region''' ('''F''') - Use the drop-down menu to set the applicable region for your country and licensed Z-Wave frequency compatible with your devices.</big>
+
*<big>'''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.</big>
−
*<big>'''Z-Wave Status''' ('''G''') - Use the drop-down menu to enable or disable the Z-Wave radio. When you have selected the status you want, click ''update.''</big>
+
*<big>'''Z-Wave Status''' ('''F''') - Use the drop-down menu to enable or disable the Z-Wave radio. When you have selected the status you want''.''</big>
−
*<big>'''Z-Wave Radio Devices -''' Here you will see a list of your Z-Wave devices with information about them. '''Stats''' ('''H''') shows signal and routing information, '''Status''' ('''I''') shows that current status of your device. If the status shows failed, try selecting ''Refresh''. '''Clusters''' ('''J''') show the Z-Wave command classes the device supports, '''Security''' ('''K''') lists the current Z-Wave security level your device is using, and Route shows the hops your device is making to communicate with the hub, and the routing devices that are taking part. You can also see the last data transmission speed recorded.</big>
+
*<big>'''Update''' ('''G''') - Select '''Update''' after changing the Z-Wave Region or Z-Wave Status (items '''E''' or '''F''', above) to apply those changes.</big>
 +
 
 +
=== <big>Z-Wave Device Information</big> ===
 +
<big>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:</big>
 +
 
 +
* <big>'''Node''' ('''H'''): Shows Z-Wave node ID in hexadecimal and decimal (e.g., 0x14 in hexadecimal is 20 or 020 in decimal)</big>
 +
* <big>'''Stats''' ('''J'''): Shows signal and selected route information, including:</big>
 +
** <big>'''PER''': Packet error rate (lower is better; 0 is good)</big>
 +
** <big>'''Neighbors''': The number of "neighbor nodes" (nodes in direct wireless range) that this node is able to see</big>
 +
** <big>'''Route Changes''': Number of times the route has changed (fewer is generally better)</big>
 +
** <big>'''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)</big>
 +
** <big>'''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)</big>
 +
* <big>'''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'''.</big>
 +
* <big>'''Device Class''' ('''L'''): Shows the Z-Wave specific or generic device class and manufacturer</big>
 +
* <big>'''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</big>
 +
* <big>'''Security''' ('''N'''): Shows the highest Z-Wave security type granted during inclusion: '''S2 Access Control''', '''S2 Authenticated''', '''S2 Unauthenticated''', '''S0''', or '''None'''.</big>
 +
* <big>'''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</big>
 +
 
 +
=== <big>Reset Z-Wave Radio</big> ===
 +
<big>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'''.</big>

Revision as of 03:26, 10 April 2022

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

  • Repair Z-Wave (A) - 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 (B) - 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 (C) - 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. When you have selected the status you want.
  • Update (G) - Select Update after changing the Z-Wave Region or Z-Wave Status (items E or F, above) to apply those changes.

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.

Retrieved from "https://docs.hubitat.com/index.php?title=Z-Wave_Details&oldid=5475"