From 60b7b7b8ccfaef28b80da89f3e37f3d2d0c9de6b Mon Sep 17 00:00:00 2001 From: Nima A <50554236+Nimzr@users.noreply.github.com> Date: Thu, 15 Oct 2020 11:18:43 -0700 Subject: [PATCH] Zwave documentation update (#14485) Co-authored-by: Nimzr --- source/_docs/z-wave.markdown | 4 ++-- source/_docs/z-wave/adding.markdown | 11 ++++++++--- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/source/_docs/z-wave.markdown b/source/_docs/z-wave.markdown index a76eed6860d..9dffc7e31d7 100644 --- a/source/_docs/z-wave.markdown +++ b/source/_docs/z-wave.markdown @@ -19,7 +19,7 @@ The Z-Wave standard was improved with Z-Wave Plus, and if you only use Z-Wave pl ## What do you need to use Z-Wave -There are 2 basic things you'll need to use Z-Wave, a Z-Wave [controller](/docs/z-wave/controllers/) and one or more [devices](/docs/z-wave/devices/). +There are 2 basic things you'll need to use Z-Wave, a Z-Wave [controller](/docs/z-wave/controllers/) and one or more [devices](/docs/z-wave/devices/). ### Regional differences @@ -33,6 +33,6 @@ You can get more information on the [available services](/docs/z-wave/services/) ## Instant status updates -When you toggle a switch or control a light locally you may find that it takes some time for that to be reflected in Home Assistant. That's because Lutron had patents on the status updates using the *Hail* command class, the traditional way of allowing devices to tell the controller that something happened locally. The same result can be achieved through the *Association* command class, or *Central Scene* command class (though, *Central Scene* isn't [fully supported](https://github.com/OpenZWave/open-zwave/pull/1125) in OpenZWave). +When you toggle a switch or control a light locally you may find that it takes some time for that to be reflected in Home Assistant. That's because Lutron had patents on the status updates using the *Hail* command class, the traditional way of allowing devices to tell the controller that something happened locally. The same result can be achieved through the *Association* command class, or *Central Scene* command class (though, *Central Scene* isn't [fully supported](https://github.com/OpenZWave/open-zwave/pull/1125) in OpenZWave). If you search [the Z-Wave products database](https://products.z-wavealliance.org/) for your product and it lists one of those in the **Controlled** command classes (not the **Supported** command classes), then your device will be able to report state changes when they happen. If it doesn't then updates may either happen eventually, or you may need to (carefully) [enable polling](/docs/z-wave/control-panel/#entities-of-this-node). diff --git a/source/_docs/z-wave/adding.markdown b/source/_docs/z-wave/adding.markdown index 6347e5051e8..72becdec805 100644 --- a/source/_docs/z-wave/adding.markdown +++ b/source/_docs/z-wave/adding.markdown @@ -3,6 +3,10 @@ title: "Z-Wave Devices - Adding and Removing" description: "How to add and remove Z-Wave devices." --- +## Recommendation before adding any devices + +Z-Wave devices behave as a mesh and can store network relationship details on the device itself. This means used devices or even brand new devices could already be enrolled in another network, for example, a test network for a brand new device or a previous network for devices that aren't new. This could cause headaches when you're attempting to add/enrol the device to your network. It is recommended that if possible, perform a factory reset AND device perform exclusion or disenroll for the device you're attempting to add to Home Assistant. Steps can found further below on this page under "Removing Devices". + ## Adding Non-Secure Devices To add (include) a non-secure Z-Wave [device](/docs/z-wave/devices/) to your system: @@ -38,7 +42,8 @@ Each individual value in the defined key can be anywhere from 0x00 to 0xFF. Defi ### Network Key -An easy script to generate a random key: +An easy Linux script to generate a random key: +(remember you can run this in Home Assistant OS or Supervised, you can use the Terminal Add-on) ```bash cat /dev/urandom | tr -dc '0-9A-F' | fold -w 32 | head -n 1 | sed -e 's/\(..\)/0x\1, /g' -e 's/, $//' @@ -77,10 +82,10 @@ Secure devices require additional bandwidth, and too many secure devices can slo To remove (exclude) a Z-Wave device from your system: -1. Go to the Z-Wave control panel in the Home Assistant frontend +1. Go to the Z-Wave control panel in the Home Assistant frontend. (Home Assistant > Configuration > Integrations > Z-Wave > Configure) 2. Click the **Remove Node** button in the *Z-Wave Network Management* card - this will place the controller in exclusion mode 3. Activate your device to be excluded by following the instructions provided with the device -4. The device will now be removed, but that won't show until you restart Home Assistant +4. The device should now be removed, but that won't show until you restart Home Assistant. Look for a confirmation signal on the device if available, or confirm on the Home Assistant logs. 5. Run a *Heal Network* so all the other nodes learn about its removal If your device isn't responding to this process, possibly because you've factory reset it or it has failed, you can remove it using **Remove Failed Node**. This only works for devices marked as `"is_failed": true`, but you can trick the system into thinking that this the case: