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-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: Z (#33835)

Browse Source
This commit is contained in:
Franck Nijhof 2024-07-17 07:20:51 +02:00 committed by GitHub
parent 0fc9c499df
commit 3761877fef
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 68 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
source/_integrations/zha.markdown
View File

@ -311,13 +311,13 @@ zha:
`{ieee}` is the device hardware address which can be read from the Home Assistant UI when looking at _Device info_. From device info, you can find the `{endpoint_id}` by viewing the _Zigbee device signature_.
## Services
## Actions
### Service `zha.permit`
### Action `zha.permit`
To add new devices to the network, call the `permit` service on the `zha` domain. Do this by clicking the Service icon in Developer tools and typing `zha.permit` in the **Service** dropdown box. Next, follow the device instructions for adding, scanning or factory reset.
To add new devices to the network, call the `permit` action on the `zha` domain. Do this by clicking the **Actions** tab in **Developer tools** and typing `zha.permit` in the **Action** dropdown box. Next, follow the device instructions for adding, scanning or factory reset.
This service opens network for joining new devices.
This action opens network for joining new devices.
| Data | Optional | Description |
| ---------- | -------- | ------------------------------------------------------------------------------ |
@ -342,42 +342,42 @@ from the same group:
- Embrighten
{% endnote %}
### Service `zha.remove`
### Action `zha.remove`
This service removes an existing device from the network. You can find the IEEE address of the device on the device card of Zigbee devices. An example of an IEEE address data parameter format is `00:0d::6f:00:05:7d:2d:34`.
This action removes an existing device from the network. You can find the IEEE address of the device on the device card of Zigbee devices. An example of an IEEE address data parameter format is `00:0d::6f:00:05:7d:2d:34`.
| Data | Optional | Description |
| ------ | -------- | ------------------------------------ |
| `ieee` | no | IEEE address of the device to remove |
### Service `zha.set_lock_user_code`
### Action `zha.set_lock_user_code`
This service sets a lock code on a Zigbee lock.
This action sets a lock code on a Zigbee lock.
| Data | Optional | Description |
| ----------- | -------- | -------------------------------------------------------------------------- |
| `code_slot` | no | Which lock code slot to store the code. Ex. 1-32 will work for Kwikset 954 |
| `user_code` | no | Code to set on the lock. Ex. Kwikset accepts numbers 4-8 digits in length |
### Service `zha.clear_lock_user_code`
### Action `zha.clear_lock_user_code`
This service clears a lock code from a Zigbee lock.
This action clears a lock code from a Zigbee lock.
| Data | Optional | Description |
| ----------- | -------- | ----------------------------- |
| `code_slot` | no | Which lock code slot to clear |
### Service `zha.enable_lock_user_code`
### Action `zha.enable_lock_user_code`
This service enables a lock code on a Zigbee lock.
This action enables a lock code on a Zigbee lock.
| Data | Optional | Description |
| ----------- | -------- | ------------------------------ |
| `code_slot` | no | Which lock code slot to enable |
### Service `zha.disable_lock_user_code`
### Action `zha.disable_lock_user_code`
This service disables a lock code on a Zigbee lock.
This action disables a lock code on a Zigbee lock.
| Data | Optional | Description |
| ----------- | -------- | ------------------------------- |
@ -389,7 +389,7 @@ Tip! It is highly recommended that you read through the two segments under the t
**To add a new Zigbee device:**
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
1. Go to {% my integrations title="**Settings** > **Devices & services**" %}.
2. Select the **Zigbee Home Automation** {% term integration %}. Then, select **Configure**.
3. To start a scan for new devices, on the bottom right corner of the screen, select **Add device**.
4. Reset your Zigbee devices to factory default settings according to the device instructions provided by the manufacturer (e.g., turn on/off lights up to 10 times; switches usually have a reset button/pin). It might take a few seconds for the devices to appear. You can click on **Show logs** for more verbose output.
@ -459,7 +459,7 @@ Follow this guide if you have a Zigbee Home Assistant (ZHA) network running and
### To migrate to a new Zigbee coordinator radio inside ZHA
1. Go to **{% my integrations title="Settings > Devices & Services" %}** and select the ZHA {% term integration %}. Then select **Configure**.
1. Go to **{% my integrations title="Settings > Devices & services" %}** and select the ZHA {% term integration %}. Then select **Configure**.
2. Under **Network settings**, select **Migrate radio**.
3. Reconfiguration of ZHA will start. Select **Submit**.
4. Under **Migrate or re-configure**, select **Migrate to a new radio**.
@ -495,7 +495,7 @@ Note that ZHA only supports connecting a single dedicated Zigbee Coordinator rad
Any Zigbee device can only be connected to a single Zigbee Coordinator (only one Zigbee gateway). This is a limitation in the current (as well as previous) Zigbee protocol specifications, governed by the [CSA (Connectivity Standards Alliance)](https://csa-iot.org/all-solutions/zigbee/). As such, it is a limit that applies to all Zigbee implementations, not just the ZHA implementation.
Support for commissioning Zigbee 3.0 devices via "Install Code" or "QR Code" via the 'zha.permit' service has so far only been implemented for 'ezsp' (Silicon Labs EmberZNet) or 'znp' (Texas Instruments) radio type in ZHA. Other radio types are missing support in their respective [radio libraries for zigpy](https://github.com/zigpy/) or manufacturer's firmware commands/APIs.
Support for commissioning Zigbee 3.0 devices via "Install Code" or "QR Code" via the `zha.permit` action has so far only been implemented for 'ezsp' (Silicon Labs EmberZNet) or 'znp' (Texas Instruments) radio type in ZHA. Other radio types are missing support in their respective [radio libraries for zigpy](https://github.com/zigpy/) or manufacturer's firmware commands/APIs.
ZHA does currently not support devices that can only use the ZGP ("Zigbee Green Power") profile which is used in a few batteryless self-powered or energy harvesting devices, (such as for example; Philips Hue Click, Philips Hue Tap, and some "Friends of Hue" partnership switches).
@ -630,7 +630,7 @@ When reporting potential bugs related to the ZHA integration on the issues track
1. Debug logs for the issue, see [debug logging](#debug-logging).
2. Exact model and firmware of the Zigbee radio (Zigbee Coordinator adapter) being used.
3. If the issue is related to a specific Zigbee device, provide both the **Zigbee Device Signature** and the **Diagnostics** information.
- Both the **Zigbee Device Signature** and the **Diagnostics** information can be found under {% my integrations title="**Settings** > **Devices & Services**" %}. Select the **Zigbee Home Automation** integration. Then, select **Configure** > **Devices** (pick your device). Select **Zigbee Device Signature** and **Download Diagnostics**, respectively.
- Both the **Zigbee Device Signature** and the **Diagnostics** information can be found under {% my integrations title="**Settings** > **Devices & services**" %}. Select the **Zigbee Home Automation** integration. Then, select **Configure** > **Devices** (pick your device). Select **Zigbee Device Signature** and **Download Diagnostics**, respectively.
Note: Please also make sure you give it your best effort to follow the recommended best practices for avoiding both [pairing/connection difficulties](#best-practices-to-avoid-pairingconnection-difficulties) and [Zigbee interference](#zigbee-interference-avoidance-and-network-rangecoverage-optimization), (which helps free up time for developers).

6
source/_integrations/zoneminder.markdown
View File

@ -93,11 +93,11 @@ zoneminder:
password: YOUR_PASSWORD
```
### Service
### Action
Once loaded, the `zoneminder` platform will expose a service (`set_run_state`) that can be used to change the current run state of ZoneMinder.
Once loaded, the `zoneminder` platform will expose an action (`set_run_state`) that can be used to change the current run state of ZoneMinder.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| :--------------------- | :------- | :-------------------------------- |
| `id` | no | Host of the ZoneMinder instance. |
| `name` | no | Name of the new run state to set. |

94
source/_integrations/zwave_js.markdown
View File

@ -76,7 +76,7 @@ Use this My button:
{% my config_flow_start badge domain="zwave_js" %}, or follow these steps:
- Browse to your Home Assistant instance.
- Go to **{% my integrations title="Settings > Devices & Services" %}**.
- Go to **{% my integrations title="Settings > Devices & services" %}**.
- In the bottom right, select the
**{% my config_flow_start icon domain="zwave_js" %}** button.
- From the list, select **Z-Wave**.
@ -100,7 +100,7 @@ While your Z-Wave mesh is permanently stored on your dongle, the additional meta
### Adding a new device to the Z-Wave network
1. In Home Assistant, go to {% my integrations title="**Settings** > **Devices & Services**" %}.
1. In Home Assistant, go to {% my integrations title="**Settings** > **Devices & services**" %}.
2. Select the Z-Wave integration. Then select **Configure**.
3. Select **Add device**.
- The Z-Wave controller is now in inclusion mode.
@ -119,7 +119,7 @@ While your Z-Wave mesh is permanently stored on your dongle, the additional meta
### Removing a device from the Z-Wave network
1. In Home Assistant, go to {% my integrations title="**Settings** > **Devices & Services**" %}.
1. In Home Assistant, go to {% my integrations title="**Settings** > **Devices & services**" %}.
2. Select the **Z-Wave** integration. Then, select **Configure**.
3. Select **Remove device**, then **Start exclusion**.
- The Z-Wave controller is now in exclusion mode.
@ -133,7 +133,7 @@ The Z-Wave integration provides several special entities, some of which are avai
### Entities available for every Z-Wave device
1. **Node status** sensor: This sensor shows the node status for a given Z-Wave device. The sensor is disabled by default. The available node statuses are explained in the [Z-Wave JS documentation](https://zwave-js.github.io/node-zwave-js/#/api/node?id=status). They can be used in state change automations. For example to ping a device when it is dead, or refresh values when it wakes up.
2. **Ping** button: This button can be pressed to ping a device. It is an alternative to the `zwave_js.ping` service.
2. **Ping** button: This button can be pressed to ping a device. It is an alternative to the `zwave_js.ping` action.
3. **Controller/node statistics** sensors: Z-Wave JS collects statistics about communications between [nodes](https://zwave-js.github.io/node-zwave-js/#/api/node?id=quotstatistics-updatedquot) and the [controller](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=quotstatistics-updatedquot). The statistics can be used to troubleshoot RF issues in your environment. These statistics are available in the network configuration and device info panels. But they are also available as sensors which are disabled by default.
### Conditional entities
@ -142,7 +142,7 @@ The Z-Wave integration provides several special entities, some of which are avai
## Using advanced features (UI only)
While the integration aims to provide as much functionality as possible through existing Home Assistant constructs (entities, states, automations, services, etc.), there are some features that are only available through the UI.
While the integration aims to provide as much functionality as possible through existing Home Assistant constructs (entities, states, automations, actions, etc.), there are some features that are only available through the UI.
All of these features can be accessed either in the Z-Wave integration configuration panel or in a Z-Wave device's device panel.
@ -179,7 +179,7 @@ The following features can be accessed from the device panel of any Z-Wave devic
![Z-Wave device panel](/images/integrations/z-wave/z-wave-device-info.png)
- **Configure:** Provides an easy way to look up and update configuration parameters for the device. While there is an existing service for setting configuration parameter values, this UI may sometimes be quicker to use for one-off changes.
- **Configure:** Provides an easy way to look up and update configuration parameters for the device. While there is an existing action for setting configuration parameter values, this UI may sometimes be quicker to use for one-off changes.
- **Re-interview:** Forces the device to go through the interview process again so that Z-Wave-JS can discover all of its capabilities. Can be helpful if you don't see all the expected entities for your device.
- **Rebuild routes:** Forces the device to rediscover its optimal route back to the controller. Use this if you think you are experiencing unexpected delays or RF issues with your device. Your device may be less responsive during this process.
- **Remove failed:** Forces the controller to remove the device from the controller. Can be used when a device has failed and it can't go through the normal exclusion process.
@ -187,13 +187,13 @@ The following features can be accessed from the device panel of any Z-Wave devic
- **Update:** Updates a device's firmware using a manually uploaded firmware file. Only some devices support this feature (controllers and devices with the Firmware Update Metadata Command Class).
- **Download diagnostics:** Exports a JSON file describing the entities of this specific device.
## Services
## Actions
### Service `zwave_js.set_config_parameter`
### Action `zwave_js.set_config_parameter`
This service will update a configuration parameter. To update multiple partial parameters in a single call, use the `zwave_js.bulk_set_partial_config_parameters` service.
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.
| Service Data Attribute | Required | Description |
| 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. |
@ -244,11 +244,11 @@ data:
value: "Blink"
```
### Service `zwave_js.bulk_set_partial_config_parameters`
### Action `zwave_js.bulk_set_partial_config_parameters`
This service will bulk set multiple partial configuration parameters. Be warned that correctly using this service requires advanced knowledge of Z-Wave.
This action will bulk set multiple partial configuration parameters. Be warned that correctly using this action requires advanced knowledge of Z-Wave.
| Service Data Attribute | Required | Description |
| 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. |
@ -261,7 +261,7 @@ This service will bulk set multiple partial configuration parameters. Be warned
Let's use parameter 21 for [this device](https://devices.zwave-js.io/?jumpTo=0x031e:0x000a:0x0001:0.0) as an example to show how partial parameters can be bulk set. In this case, we want to set `0xff` to `127`, `0x7f00` to `10`, and `0x8000` to `1` (or the raw value of `4735`).
{% note %}
When using the dictionary format to map the partial parameter to values, the cached values for the missing partial parameters will be used. So in examples 2, 3, 4, and 5, the service would use the cached value for partial parameters `0xff0000`, `0x3f000000`, and `0x40000000` because new values haven't been specified. If you send the raw integer value, it is assumed that you have calculated the full value, so in example 1, partial parameters `0xff0000`, `0x3f000000`, and `0x40000000` would all be set to `0`.
When using the dictionary format to map the partial parameter to values, the cached values for the missing partial parameters will be used. So in examples 2, 3, 4, and 5, the action would use the cached value for partial parameters `0xff0000`, `0x3f000000`, and `0x40000000` because new values haven't been specified. If you send the raw integer value, it is assumed that you have calculated the full value, so in example 1, partial parameters `0xff0000`, `0x3f000000`, and `0x40000000` would all be set to `0`.
{% endnote %}
Example 1:
@ -331,20 +331,20 @@ data:
"Quick Strip Effect Intensity Scale": "Fine"
```
### Service `zwave_js.refresh_value`
### Action `zwave_js.refresh_value`
This service will refresh the value(s) for an entity. This service 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.
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.
| Service Data Attribute | Required | Description |
| 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. |
### Service `zwave_js.set_value`
### Action `zwave_js.set_value`
This service 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 service requires advanced knowledge of Z-Wave. The service 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` services instead of this one.
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.
| Service Data Attribute | Required | Description |
| 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. |
@ -355,18 +355,18 @@ This service will set a value on a Z-Wave device. It is for advanced use cases w
| `endpoint` | no | ID of Endpoint that you want to set the value for. |
| `value` | yes | The new value that you want to set. |
| `options` | no | Set value options map. Refer to the Z-Wave JS documentation for more information on what options can be set. |
| `wait_for_result` | no | Boolean that indicates whether or not to wait for a response from the node. If not included in the payload, the integration will decide whether to wait or not. If set to `true`, note that the service call can take a while if setting a value on an asleep battery device. |
| `wait_for_result` | no | Boolean that indicates whether or not to wait for a response from the node. If not included in the payload, the integration will decide whether to wait or not. If set to `true`, note that the action can take a while if setting a value on an asleep battery device. |
### Service `zwave_js.multicast_set_value`
### Action `zwave_js.multicast_set_value`
This service 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 service requires advanced knowledge of Z-Wave. The service 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.
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.
| Service Data Attribute | Required | Description |
| 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. |
| `broadcast` | no | Boolean that indicates whether you want the message to be broadcast to all nodes on the network. If you have only one Z-Wave network configured, you do not need to provide a `device_id` or `entity_id` when this is set to true. When you have multiple Z-Wave networks configured, you MUST provide at least one `device_id` or `entity_id` so the service knows which network to target. |
| `broadcast` | no | Boolean that indicates whether you want the message to be broadcast to all nodes on the network. If you have only one Z-Wave network configured, you do not need to provide a `device_id` or `entity_id` when this is set to true. When you have multiple Z-Wave networks configured, you MUST provide at least one `device_id` or `entity_id` so the action knows which network to target. |
| `command_class` | yes | ID of Command Class that you want to set the value for. |
| `property` | yes | ID of Property that you want to set the value for. |
| `property_key` | no | ID of Property Key that you want to set the value for. |
@ -374,11 +374,11 @@ This service will set a value on multiple Z-Wave devices using multicast. It is
| `value` | yes | The new value that you want to set. |
| `options` | no | Set value options map. Refer to the Z-Wave JS documentation for more information on what options can be set. |
### Service `zwave_js.invoke_cc_api`
### Action `zwave_js.invoke_cc_api`
Call this service to use the Command Class API directly. In most cases, the `zwave_js.set_value` service will accomplish what you need to, but some Command Classes have API commands that can't be accessed via that service. 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 service.
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.
| Service Data Attribute | Required | Description |
| 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. |
@ -388,12 +388,12 @@ Call this service to use the Command Class API directly. In most cases, the `zwa
| `method_name` | yes | The name of the method that is being called from the CC API. |
| `parameters` | yes | A list of parameters to pass to the CC API method. |
### Service `zwave_js.refresh_notifications`
### Action `zwave_js.refresh_notifications`
This service will refresh the notifications of a given type on a device that
This action will refresh the notifications of a given type on a device that
supports the Notification Command Class.
| Service Data Attribute | Required | Description |
| 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. |
@ -401,21 +401,21 @@ supports the Notification Command Class.
| `notification_type` | yes | The type of notification to refresh. |
| `notification_event` | no | The notification event to refresh. |
### Service `zwave_js.reset_meter`
### Action `zwave_js.reset_meter`
This service will reset the meters on a device that supports the Meter Command Class.
This action will reset the meters on a device that supports the Meter Command Class.
| Service Data Attribute | Required | Description |
| 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. |
### Service `zwave_js.set_lock_configuration`
### Action `zwave_js.set_lock_configuration`
This service will set the configuration of a lock.
This action will set the configuration of a lock.
| Service Data Attribute | Required | Description |
| 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`. |
@ -425,23 +425,23 @@ This service will set the configuration of a lock.
| `twist_assist` | no | Enable Twist Assist. |
| `block_to_block` | no | Enable block-to-block functionality. |
### Service `zwave_js.set_lock_usercode`
### Action `zwave_js.set_lock_usercode`
This service will set the usercode of a lock to X at code slot Y.
This action will set the usercode of a lock to X at code slot Y.
Valid usercodes are at least 4 digits.
| Service Data Attribute | Required | Description |
| 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. |
### Service `zwave_js.clear_lock_usercode`
### Action `zwave_js.clear_lock_usercode`
This service will clear the usercode of a lock in code slot X.
This action will clear the usercode of a lock in code slot X.
Valid code slots are between 1-254.
| Service Data Attribute | Required | Description |
| 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. |
@ -881,7 +881,7 @@ Your device might not send automatic status updates to the controller. While the
Z-Wave does not automatically poll devices on a regular basis. Polling can quickly lead to network congestion and should be used very sparingly and only where necessary.
- We provide a `zwave_js.refresh_value` service to allow you to manually poll a value, for example from an automation that only polls a device when there is motion in that same room. If you **really** need polling, you can enable this in Z-Wave JS UI but not in the official add-on.
- We provide a `zwave_js.refresh_value` action to allow you to manually poll a value, for example from an automation that only polls a device when there is motion in that same room. If you **really** need polling, you can enable this in Z-Wave JS UI but not in the official add-on.
- Z-Wave JS UI allows you to configure scheduled polling on a per-value basis, which you can use to keep certain values updated. It also allows you to poll individual values on-demand from your automations, which should be preferred over blindly polling all the time if possible.
@ -899,7 +899,7 @@ If the interview is complete, then the device does not yet have a device file fo
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:
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
1. Go to {% my integrations title="**Settings** > **Devices & services**" %}.
2. Select the **Z-Wave** integration. Then, select the three dots.
3. From the dropdown menu, select **Download diagnostics**.
@ -929,11 +929,11 @@ The log level will be reset to its previous value for the integration, library,
##### 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`.
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` action. 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
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.
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.
## Z-Wave terminology