-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rewriting the Z-Wave documentation #3467
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very good rewrite!
Only small changes needed.
|
||
### {% linkable_title Node config options %} | ||
|
||
You can set the *wakeup* interval (in seconds) of the device, this is shown for all devices, but only applies to battery powered devices. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is only shown for devices reporting back the wakeup command class. Thus should only be battery powered devices.
|
||
## {% linkable_title Polling %} | ||
|
||
Where a device doesn't send updates on status changes to the controller, you can work around this by using a thing called Polling. That causes the controller to ask the device to provide an update on all its sensors and states. This will cause a lot of traffic on the network, and if you poll too many devices too quickly, you can effectively break your Z-Wave network. Polling should only be used where there is no other choice, and you should use as large a polling interval as possible. Ideally you should replace the device. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add an example here to how this works:
If polling_interval=60000
(which is default) and you have 10 values that are being polled, if a device can receive and aknowledge the poll within a second, it takes 10 seconds to complete the polling list, which leaves 50 seconds left for normal traffic. So the more polling are done, the less bandwidth is available.
Or something similar to that :)
--- | ||
|
||
<p class='note'> | ||
This is a work in progress, based upon reports in the forum, the author's own devices, and reading of various documentation. It will be incomplete, so if you have a device that isn't reported here, or have a device that reports a different value, please provide a report in the [Z-Wave section](https://community.home-assistant.io/c/configuration/zwave) of the forum or the #zwave channel on [Discord](https://discord.gg/RkajcgS). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you want to have the complete spec you can find it here: http://zwavepublic.com/sites/default/files/SDS10242-29%20-%20Z-Wave%20Device%20Class%20Specification.pdf
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. I'll use that for the next round of updates
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be great if this doc was linked from the main zwave page. I just found it after using zwave since day one and its a treasure trove of in information! Great job!
source/_docs/z-wave/events.markdown
Outdated
basic_level: 255 | ||
``` | ||
|
||
The *object_id* and *basic_level* of all triggered events can be seen in the console output. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
entity_id not object_id
source/_docs/z-wave/events.markdown
Outdated
scene_data: 3 | ||
``` | ||
|
||
The *object_id* and *scene_id* of all triggered events can be seen in the console output. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
entity_id
Note that it only applies to devices that can be battery powered (for example, my Aeotec sensor is USB powered, but as it supports Wake the option is shown)
Example of what the impact of polling can be
Perfect! Just some conflicts that needs to be resolved before we can merge. |
Anything I can do to help this further along? |
Yes, there are conflicting changes that needs to be resolved before we are able to merge. |
Thanks, first time with conflicts on Github so didn't know if it was something I could fix, or not. |
Thanks💃 |
--- | ||
|
||
<p class='note'> | ||
This is a work in progress, based upon reports in the forum, the author's own devices, and reading of various documentation. It will be incomplete, so if you have a device that isn't reported here, or have a device that reports a different value, please provide a report in the [Z-Wave section](https://community.home-assistant.io/c/configuration/zwave) of the forum or the #zwave channel on [Discord](https://discord.gg/RkajcgS). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be great if this doc was linked from the main zwave page. I just found it after using zwave since day one and its a treasure trove of in information! Great job!
sensor_class: opening | ||
friendly_name: "Friendly name here" | ||
value_template: >- | ||
{%- if is_state('sensor.YOUR_SENSOR_access_control', '22') -%} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think access_control should have the if state written to 23 - closed. This was if it's not 23, it's not closed.
Otherwise, either 254 or 255 would show as closed
This is a starting point for rewriting the Z-Wave documentation, to reflect all the undocumented changes, addition of the control panel, etc.
Discussion and feedback appreciated ;)