mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Z-Wave integration: remove 1 level of hierarchy (#29409)
* Z-Wave integration: remove 1 level of hierarchy - in the FAQ section - This allows titles to be displayed in the asides - which improves navigation - Apply sentence-style capitalization in headers * FAQ: shorten titles so that they fit better in aside * Fix typo
This commit is contained in:
c0ffeeca7
GitHub
parent
bec3ac5e6e
commit
20018665c1
@ -429,9 +429,9 @@ trigger:
|
||||
event_label: "Keypad unlock operation"
|
||||
```
|
||||
|
||||
#### Notification Command Class
|
||||
#### Notification command class
|
||||
|
||||
These are notification events fired by devices using the Notification command class. The `parameters` attribute in the example below is optional, and when it is included, the keys in the attribute will vary depending on the event.
|
||||
These are notification events fired by devices using the notification command class. The `parameters` attribute in the example below is optional, and when it is included, the keys in the attribute will vary depending on the event.
|
||||
|
||||
```json
|
||||
{
|
||||
@ -450,11 +450,11 @@ These are notification events fired by devices using the Notification command cl
|
||||
}
|
||||
```
|
||||
|
||||
#### Multilevel Switch Command Class
|
||||
#### Multilevel switch command class
|
||||
|
||||
These are notification events fired by devices using the Multilevel Switch command class. There are events for start level change and stop level change. These would typically be used in a device like the Aeotec Nano Dimmer with an external switch to respond to long button presses.
|
||||
These are notification events fired by devices using the multilevel switch command class. There are events for start level change and stop level change. These would typically be used in a device like the Aeotec Nano Dimmer with an external switch to respond to long button presses.
|
||||
|
||||
##### Start Level Change
|
||||
##### Start level change
|
||||
|
||||
```json
|
||||
{
|
||||
@ -471,7 +471,7 @@ These are notification events fired by devices using the Multilevel Switch comma
|
||||
},
|
||||
```
|
||||
|
||||
##### Stop Level Change
|
||||
##### Stop level change
|
||||
|
||||
```json
|
||||
{
|
||||
@ -488,9 +488,9 @@ These are notification events fired by devices using the Multilevel Switch comma
|
||||
},
|
||||
```
|
||||
|
||||
#### Entry Control Command Class
|
||||
#### Entry control command class
|
||||
|
||||
These are notification events fired by devices using the Entry Control command class.
|
||||
These are notification events fired by devices using the entry control command class.
|
||||
|
||||
```json
|
||||
{
|
||||
@ -612,7 +612,7 @@ trigger:
|
||||
to: "opened"
|
||||
```
|
||||
|
||||
#### Available Trigger Data
|
||||
#### Available trigger data
|
||||
|
||||
In addition to the [standard automation trigger data](/docs/automation/templating/#all), the `zwave_js.value_updated` trigger platform has additional trigger data available for use.
|
||||
|
||||
@ -660,7 +660,7 @@ trigger:
|
||||
partial_dict_match: true # defaults to false
|
||||
```
|
||||
|
||||
#### Available Trigger Data
|
||||
#### Available trigger data
|
||||
|
||||
In addition to the [standard automation trigger data](/docs/automation/templating/#all), the `zwave_js.event` trigger platform has additional trigger data available for use.
|
||||
|
||||
@ -731,9 +731,7 @@ If you're running full Home Assistant with supervisor, you will be presented wit
|
||||
|
||||
If you're not running the supervisor or you've unchecked the above-mentioned box, you will be asked to enter a WebSocket URL (defaults to ws://localhost:3000). It is very important that you fill in the correct (Docker) IP/hostname here. For example for the Z-Wave JS UI add-on this is `ws://a0d7b954-zwavejs2mqtt:3000`.
|
||||
|
||||
## Frequently Asked Questions
|
||||
|
||||
### Supported Devices and Command Classes
|
||||
## FAQ: Supported devices and command classes
|
||||
|
||||
See the [Z-Wave JS device database](https://devices.zwave-js.io/).
|
||||
|
||||
@ -741,15 +739,15 @@ While there is support for the most common devices, some command classes are not
|
||||
|
||||
You can also keep track of the road map for the Z-Wave integration [here](https://github.com/home-assistant-libs/zwave-js-server-python/issues/56).
|
||||
|
||||
### Installation and Configuration
|
||||
## FAQ: Installation and configuration
|
||||
|
||||
#### Which Z-Wave controller should I buy?
|
||||
### Which Z-Wave controller should I buy?
|
||||
|
||||
Z-Wave supports all known 500 and 700 series Z-Wave controllers. If you are just starting out, we recommend that you purchase a 700 series controller (with firmware updated to >=7.17.2).
|
||||
|
||||
For more information, see [Supported Z-Wave dongles](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules)
|
||||
|
||||
#### Why was I (or why was I not) automatically prompted to install Z-Wave?
|
||||
### Why was I (not) automatically prompted to install Z-Wave?
|
||||
|
||||
Some Z-Wave USB sticks can be auto-discovered, which can simplify the Z-Wave setup process. The following devices have been tested with discovery, and offer a quick setup experience; however, these are **not** all of the devices supported by Z-Wave:
|
||||
|
||||
@ -762,15 +760,15 @@ Some Z-Wave USB sticks can be auto-discovered, which can simplify the Z-Wave set
|
||||
|
||||
Additional devices may be discoverable, however only devices that have been confirmed discoverable are listed above.
|
||||
|
||||
#### What happened to Zwavejs2Mqtt or the Z-Wave JS to MQTT add-on?
|
||||
### What happened to Zwavejs2Mqtt or the Z-Wave JS to MQTT add-on?
|
||||
|
||||
Zwavejs2Mqtt was renamed Z-Wave JS UI in September 2022. They are synonymous with no difference between their capabilities.
|
||||
|
||||
#### Can I switch between the Official Z-Wave JS add-on and the Z-Wave JS UI add-on?
|
||||
### Can I switch between the official Z-Wave JS add-on and the Z-Wave JS UI add-on?
|
||||
|
||||
You can, but you cannot run them both at the same time. Only one of them can be active at the same time.
|
||||
|
||||
#### How do I switch between the Official Z-Wave JS add-on and the Z-Wave JS UI add-on?
|
||||
### How do I switch between the official Z-Wave JS add-on and the Z-Wave JS UI add-on?
|
||||
|
||||
Switching does not require renaming your devices.
|
||||
|
||||
@ -786,27 +784,27 @@ Switching does not require renaming your devices.
|
||||
|
||||
6. Enable the Z-Wave integration.
|
||||
|
||||
#### What's the benefit of using Z-Wave JS UI add-on over the official add-on?
|
||||
### What's the benefit of using Z-Wave JS UI add-on over the official add-on?
|
||||
|
||||
The official add-on provides the Z-Wave Server in its bare minimum variant, just enough to serve the Home Assistant integration.
|
||||
|
||||
The Z-Wave JS UI project includes the Z-Wave JS Server for convenience but also provides a Z-Wave Control panel and the ability to serve your Z-Wave network to MQTT. This allows you to use the control panel, and if you so choose, to also use MQTT at the same time. For example, some users may use MQTT to interact with Z-Wave from other devices, while the Home Assistant integration still works (as long as you keep the WS Server enabled in Z-Wave JS UI).
|
||||
The Z-Wave JS UI project includes the Z-Wave JS Server for convenience but also provides a Z-Wave control panel and the ability to serve your Z-Wave network to MQTT. This allows you to use the control panel, and if you so choose, to also use MQTT at the same time. For example, some users may use MQTT to interact with Z-Wave from other devices, while the Home Assistant integration still works (as long as you keep the WS Server enabled in Z-Wave JS UI).
|
||||
|
||||
#### Z-Wave JS UI seems to provide discovery of Home Assistant devices on its own too, now I'm confused
|
||||
### Z-Wave JS UI seems to provide discovery of Home Assistant devices on its own too, now I'm confused
|
||||
|
||||
Correct, the Z-Wave JS UI project existed before Home Assistant had plans to move to the Z-Wave JS Driver. You should use the integration for device discovery and _not_ the MQTT discovery provided by Z-Wave JS UI.
|
||||
|
||||
#### Can I run Z-Wave JS UI only for the control panel and nothing else?
|
||||
### Can I run Z-Wave JS UI only for the control panel and nothing else?
|
||||
|
||||
Sure, in the settings of Z-Wave JS UI, make sure to enable "WS Server" and disable "Gateway".
|
||||
|
||||
#### Should I name my devices in Home Assistant, or in Z-Wave JS UI?
|
||||
### Should I name my devices in Home Assistant, or in Z-Wave JS UI?
|
||||
|
||||
Ultimately, this is a personal decision. If you provide a name or location for a device in the Z-Wave JS UI, that name will be imported into Home Assistant when the integration is reloaded or Home Assistant is restarted. Any entity names, however, will not change if the device has already been set up by Home Assistant. Names set in Z-Wave JS UI _will not_ overwrite changes that have already been made in Home Assistant.
|
||||
|
||||
Names set in Home Assistant will not import into Z-Wave JS UI.
|
||||
|
||||
#### Should I use `Secure Inclusion`?
|
||||
### Should I use `Secure Inclusion`?
|
||||
|
||||
That depends. There are two generations of Z-Wave security, S0, and S2.
|
||||
|
||||
@ -814,13 +812,13 @@ S0 security imposes significant additional traffic on your mesh and is recommend
|
||||
|
||||
S2 security does not impose additional network traffic and provides additional benefits, such as detecting packet corruption. By default, Z-Wave attempts S2 security during inclusion if supported, falling back to S0 security only when necessary.
|
||||
|
||||
#### Where can I see the security keys in the Z-Wave JS add-on?
|
||||
### Where can I see the security keys in the Z-Wave JS add-on?
|
||||
|
||||
After the initial setup of the Z-Wave controller, you can view the security keys in the Z-Wave JS add-on. Go to {% my supervisor_addon addon="core_zwave_js" title="**Settings** > **Add-ons** > **Z-Wave JS**" %} and open the **Configuration** tab. You can now see the three S2 keys and the S0 key. The network security key is a legacy configuration setting, identical to the S0 key.
|
||||
|
||||
### Troubleshooting
|
||||
## FAQ: Troubleshooting topics
|
||||
|
||||
#### I'm having a problem, what should I do first?
|
||||
### I'm having a problem, what to do first?
|
||||
|
||||
_Many_ reported issues result from RF interference caused by the system's USB ports. This can manifest in many ways, including devices that won't include at all, devices that won't include securely, sensors with erroneous values (packets corrupted), delayed control of devices, or no ability to control devices.
|
||||
|
||||
@ -830,17 +828,17 @@ After ensuring you are using an extension cable, rebuild network routes.
|
||||
|
||||
The combination of these two steps corrects a large number of reported difficulties.
|
||||
|
||||
#### I have an Aeotec Gen5 controller, and it isn't detected on my Raspberry Pi 4?
|
||||
### I have an Aeotec Gen5 controller, and it isn't detected on my Raspberry Pi 4?
|
||||
|
||||
The first-generation Gen5 controller has a known bug when plugged into a Pi 4 and possibly other systems. Aeotec released the Gen5+ stick to correct this bug. Gen5 users can plug their sticks into a USB 2.0 hub in order to overcome the issue.
|
||||
|
||||
#### I do not see any entities created for my device in Home Assistant
|
||||
### I do not see any entities created for my device in Home Assistant
|
||||
|
||||
Entities will be created only after the node is ready (the interview is completed). Also, note that some devices (like button remotes) do not create any entities but will only provide events when a button is pressed. See the events section on how to handle those events in your automations.
|
||||
|
||||
If you are certain that your device should have entities and you do not see them (even after a restart of Home Assistant Core), create an issue about your problem on the GitHub issue tracker.
|
||||
|
||||
#### My device does not automatically update its status in HA if I control it manually
|
||||
### My device does not automatically update its status in HA if I control it manually
|
||||
|
||||
Your device might not send automatic status updates to the controller. While the best advice would be to update to recent Z-Wave Plus devices, there is a workaround with active polling (request the status).
|
||||
|
||||
@ -854,13 +852,13 @@ Z-Wave does not automatically poll devices on a regular basis. Polling can quick
|
||||
Polling should only be used as a last resort. You must use it with care and accept the negative impact on your network. Z-Wave is a very low speed network and poll requests can easily flood your network and slow down your commands.
|
||||
</div>
|
||||
|
||||
#### My device is recognized as Unknown Manufacturer and/or some of its functionalities do not work with the Z-Wave integration
|
||||
### My device is recognized as Unknown Manufacturer and/or some functions don't work with the Z-Wave integration
|
||||
|
||||
When your device is not yet fully interviewed, this info will not yet be present. So make sure your device is interviewed at least once.
|
||||
|
||||
If the interview is complete, then the device does not yet have a device file for Z-Wave JS. Unlike other Z-Wave drivers, your device may very well work as intended even without such a file. If your device not fully supported, consider [contributing the device configuration file](https://zwave-js.github.io/node-zwave-js/#/config-files/contributing-files).
|
||||
|
||||
#### How do I get a dump of the current network state?
|
||||
### How do I get a dump of the current network state?
|
||||
|
||||
When trying to determine why something isn't working as you expect, or when reporting an issue with the integration, it is helpful to know what Z-Wave JS sees as the current state of your Z-Wave network. To get a dump of your current network state, follow these steps:
|
||||
|
||||
@ -868,35 +866,35 @@ When trying to determine why something isn't working as you expect, or when repo
|
||||
2. Select the **Z-Wave** integration. Then, select the three dots.
|
||||
3. From he dropdown menu, select **Download diagnostics**.
|
||||
|
||||
#### How do I address interference issues?
|
||||
### How do I address interference issues?
|
||||
|
||||
Many users have reported issues with interference when the USB stick was directly connected to the machine (proximity). If you are having issues, try to use a short USB 2.0 A (male to female) extension cord.
|
||||
|
||||
#### How do I access the Z-Wave logs?
|
||||
### How do I access the Z-Wave logs?
|
||||
|
||||
##### The easy way
|
||||
#### The easy way
|
||||
|
||||
###### Enable Z-Wave JS logging
|
||||
##### Enable Z-Wave JS logging
|
||||
|
||||
1. Go to the Z-Wave integration panel: {% my integration badge domain="zwave_js" %}
|
||||
2. Select `Enable debug logging` on the left-hand side of the screen.
|
||||
|
||||
The log level will be set to `debug` for the integration, library, and optionally the driver (if the driver log level is not already set to `verbose`, `debug`, or `silly`), and all Z-Wave JS logs will be added to the Home Assistant logs.
|
||||
|
||||
###### Disable Z-Wave JS logging
|
||||
##### Disable Z-Wave JS logging
|
||||
|
||||
1. Go to the Z-Wave integration panel: {% my integration badge domain="zwave_js" %}
|
||||
2. Select `Disable debug logging` on the left-hand side of the screen.
|
||||
|
||||
The log level will be reset to its previous value for the integration, library, and driver, and the Home Assistant frontend will automatically send you the Z-Wave logs generated during that time period for download.
|
||||
|
||||
##### The advanced way
|
||||
#### The advanced way
|
||||
|
||||
###### Enable Z-Wave JS logging manually, or via an automation
|
||||
##### Enable Z-Wave JS logging manually, or via an automation
|
||||
|
||||
Set the log level for `zwave_js_server` to `debug`. This can either be done in your `configuration.yaml` in the `logger` section, or using the `logger.set_level` service. When the integration detects that the log level has been set to `debug`, it will also set the Z-Wave JS logs to `debug` if the level isn't already `verbose`, `debug`, or `silly` and will include those logs in the Home Assistant logs. The Z-Wave JS logs can be found under the logger name `zwave_js_server.server`.
|
||||
|
||||
###### Disable Z-Wave JS logging manually, or via an automation
|
||||
##### Disable Z-Wave JS logging manually, or via an automation
|
||||
|
||||
Set the log level for `zwave_js_server` to a level higher than `debug`. This can either be done in your `configuration.yaml` in the `logger` section, or using the `logger.set_level` service. The Z-Wave JS logs will no longer be included in the Home Assistant logs, and if the log level of Z-Wave JS was changed by the integration, it will automatically change back to its original level.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user