jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-26 02:37:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Z-Wave: add section on Z-Wave functionality that isn't supported in HA (#34696)

Browse Source 
* Z-Wave: add section on Z-Wave functionality that isn't supported in HA

* Update source/_integrations/zwave_js.markdown

Co-authored-by: AlCalzone <dominic.griesel@nabucasa.com>

* Move term definition to terminology section

* Clarify that the Z-Wave controller cannot join another network

* replace device by controller to remove ambiguity

---------

Co-authored-by: AlCalzone <dominic.griesel@nabucasa.com>
This commit is contained in:
c0ffeeca7 2024-09-12 13:10:31 +02:00 committed by GitHub
parent 93e23446f2
commit 1052318910
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 103 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
source/_integrations/zwave_js.markdown
View File

@ -58,13 +58,17 @@ This sections shows you how to set up a Z-Wave JS server how to add your first Z
Throughout this documentation, Home Assistant terminology is used. For some of the concepts, the terminology does not correspond to the terminology used in Z-Wave documentation. The table below provides equivalents for some of those terms.
| Z-Wave functionality | Home Assistant |
| -------------------- | --------------------------------------------------------------- |
| -------------------- | ------------------------------------------------------ |
| inclusion | add |
| exclusion | remove |
| barrier operator | cover |
| window covering | cover |
| multilevel switch | represented by different entity types: light, fan etc. |
#### Classic inclusion versus SmartStart
Home Assistant supports both _classic inclusion_ and _SmartStart_. _Classic inclusion_ means you set both the hub and the device to be included into the corresponding mode. The alternative is _SmartStart_, where the hub is constantly listening for inclusion requests from devices that want to join the network.
### Prerequisites
To run a Z-Wave network, you need the following elements:
@ -210,7 +214,7 @@ The following features can be accessed from the device panel of any Z-Wave devic
This action will update a configuration parameter. To update multiple partial parameters in a single call, use the `zwave_js.bulk_set_partial_config_parameters` action.
| Data attribute | Required | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Entity (or list of entities) to set the configuration parameter on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
| `device_id` | no | Device ID (or list of device IDs) to set the configuration parameter on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
| `area_id` | no | Area ID (or list of area IDs) for devices/entities to set the configuration parameter on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
@ -265,7 +269,7 @@ data:
This action will bulk set multiple partial configuration parameters. Be warned that correctly using this action requires advanced knowledge of Z-Wave.
| Data attribute | Required | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Entity (or list of entities) to bulk set partial configuration parameters on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
| `device_id` | no | Device ID (or list of device IDs) to bulk set partial configuration parameters on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
| `area_id` | no | Area ID (or list of area IDs) for devices/entities to bulk set partial configuration parameters on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
@ -352,7 +356,7 @@ data:
This action will refresh the value(s) for an entity. This action will generate extra traffic on your Z-Wave network and should be used sparingly. Updates from devices on battery may take some time to be received.
| Data attribute | Required | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `entity_id` | yes | Entity or list of entities to refresh values for. |
| `refresh_all_values` | no | Whether all values should be refreshed. If `false`, only the primary value will be refreshed. If `true`, all watched values will be refreshed. |
@ -361,7 +365,7 @@ This action will refresh the value(s) for an entity. This action will generate e
This action will set a value on a Z-Wave device. It is for advanced use cases where you need to modify the state of a node and can't do it using native Home Assistant entity functionality. Be warned that correctly using this action requires advanced knowledge of Z-Wave. The action provides minimal validation and blindly calls the Z-Wave JS API, so if you are having trouble using it, it is likely because you are providing an incorrect value somewhere. To set a config parameter, you should use the `zwave_js.set_config_parameter` or `zwave_js.bulk_set_partial_config_parameters` action instead of this one.
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Entity (or list of entities) to set the value on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
| `device_id` | no | Device ID (or list of device IDs) to set the value on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
| `area_id` | no | Area ID (or list of area IDs) for devices/entities to set the value on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
@ -378,7 +382,7 @@ This action will set a value on a Z-Wave device. It is for advanced use cases wh
This action will set a value on multiple Z-Wave devices using multicast. It is for advanced use cases where you need to set the same value on multiple nodes simultaneously. Be warned that correctly using this action requires advanced knowledge of Z-Wave. The action provides minimal validation beyond what is necessary to properly call the Z-Wave JS API, so if you are having trouble using it, it is likely because you are providing an incorrect value somewhere.
| Data attribute | Required | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Entity (or list of entities) to set the value on via multicast. At least two `entity_id` or `device_id` must be resolved if not broadcasting the command. |
| `device_id` | no | Device ID (or list of device IDs) to set the value on via multicast. At least two `entity_id` or `device_id` must be resolved if not broadcasting the command. |
| `area_id` | no | Area ID (or list of area IDs) for devices/entities to set the value on via multicast. At least two `entity_id` or `device_id` must be resolved if not broadcasting the command. |
@ -395,7 +399,7 @@ This action will set a value on multiple Z-Wave devices using multicast. It is f
Leverage this action to use the Command Class API directly. In most cases, the `zwave_js.set_value` action will accomplish what you need to, but some Command Classes have API commands that can't be accessed via that action. Refer to the [Z-Wave JS Command Class documentation](https://zwave-js.github.io/node-zwave-js/#/api/CCs/index) for the available APIs and arguments. Be sure to know what you are doing when calling this action.
| Data attribute | Required | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Entity (or list of entities) to ping. At least one `entity_id`, `device_id`, or `area_id` must be provided. If `endpoint` is specified, that endpoint will be used to make the CC API call for all devices, otherwise the primary value endpoint will be used for each entity. |
| `device_id` | no | Device ID (or list of device IDs) to ping. At least one `entity_id`, `device_id`, or `area_id` must be provided. If `endpoint` is specified, that endpoint will be used to make the CC API call for all devices, otherwise the root endpoint (0) will be used for each device. |
| `area_id` | no | Area ID (or list of area IDs) for devices/entities to ping. At least one `entity_id`, `device_id`, or `area_id` must be provided. If `endpoint` is specified, that endpoint will be used to make the CC API call for all devices, otherwise the root endpoint (0) will be used for each `zwave_js` device in the area. |
@ -410,7 +414,7 @@ This action will refresh the notifications of a given type on a device that
supports the Notification Command Class.
| Data attribute | Required | Description |
| ---------------------- | -------- | ------------------------------------------------------ |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `entity_id` | no | Entity (or list of entities) to refresh notifications for. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
| `device_id` | no | Device ID (or list of device IDs) to refresh notifications for. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
| `area_id` | no | Area ID (or list of area IDs) for devices/entities to refresh notifications for. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
@ -422,7 +426,7 @@ supports the Notification Command Class.
This action will reset the meters on a device that supports the Meter Command Class.
| Data attribute | Required | Description |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| -------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | Entity (or list of entities) for the meters you want to reset. |
| `meter_type` | no | If supported by the device, indicates the type of meter to reset. Not all devices support this option. |
| `value` | no | If supported by the device, indicates the value to reset the meter to. Not all devices support this option. |
@ -432,7 +436,7 @@ This action will reset the meters on a device that supports the Meter Command Cl
This action will set the configuration of a lock.
| Data attribute | Required | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| ----------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Lock entity or list of entities to set the usercode. |
| `operation_type` | yes | Lock operation type, one of `timed` or `constant`. |
| `lock_timeout` | no | Seconds until lock mode times out. Should only be used if operation type is `timed`. |
@ -447,7 +451,7 @@ This action will set the usercode of a lock to X at code slot Y.
Valid usercodes are at least 4 digits.
| Data attribute | Required | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| -------------- | -------- | ---------------------------------------------------- |
| `entity_id` | no | Lock entity or list of entities to set the usercode. |
| `code_slot` | yes | The code slot to set the usercode into. |
| `usercode` | yes | The code to set in the slot. |
@ -458,7 +462,7 @@ This action will clear the usercode of a lock in code slot X.
Valid code slots are between 1-254.
| Data attribute | Required | Description |
| ---------------------- | -------- | ------------------------------------------------------ |
| -------------- | -------- | ------------------------------------------------------ |
| `entity_id` | no | Lock entity or list of entities to clear the usercode. |
| `code_slot` | yes | The code slot to clear the usercode from. |
@ -950,3 +954,15 @@ Set the log level for `zwave_js_server` to `debug`. This can either be done in y
##### 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` action. 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.
## Unsupported functionality
This sections lists functionality that is available in Z-Wave but that is not currently supported in Home Assistant.
### Setting the controller into learn mode to receive network information
In Home Assistant, it is currently not possible to set the Z-Wave controller into learn mode to receive network information from another controller.
### Including / excluding a controller in an existing network using [classic inclusion](#classic-inclusion-versus-smartstart)
A Z-Wave controller that manages an empty network can also join a different network and act as a secondary controller there. However, with Home Assistant, this is not possible. Home Assistant does not allow the Z-Wave controller to join another network, because Home Assistant acts as the central hub.