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-15 05:16:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update zwave_js.bulk_set_partial_config_parameters description (#17527)

Browse Source
This commit is contained in:
Raman Gupta 2021-04-25 06:44:10 -04:00 committed by GitHub
parent 649df16fda
commit 464cdf9a53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
source/_integrations/zwave_js.markdown
View File

@ -115,8 +115,8 @@ This service will bulk set multiple partial configuration parameters. Be warned
|------------------------ |----------- |------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Entity (or list of entities) to set the configuration parameter on. At least one `entity_id` or `device_id` must be provided. |
| `device_id` | no | ID of device to set the configuration parameter on. At least one `entity_id` or `device_id` must be provided. |
| `parameter` | yes | The parameter number or the name of the property. The name of the property is case sensitive. |
| `value` | yes | Either the raw integer value that you want to set for the entire parameter, or a dictionary where the keys are the bitmasks (in integer or hex form) and the values are the value you want to set on each partial. Note that when using a dictionary, and bitmasks that are not provided will be set to their currently cached values. |
| `parameter` | yes | The parameter number of the property. The name of the property is case sensitive. |
| `value` | yes | Either the raw integer value that you want to set for the entire parameter, or a dictionary where the keys are either the bitmasks (in integer or hex form) or the partial parameter name and the values are the value you want to set on each partial (either the integer value or a named state when applicable). Note that when using a dictionary, and bitmasks that are not provided will be set to their currently cached values. |
#### Examples of bulk setting partial parameter values
@ -124,7 +124,7 @@ Let's use parameter 21 for [this device](https://devices.zwave-js.io/?jumpTo=0x0
<div class='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 and 3, 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 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`.
</div>
@ -167,6 +167,34 @@ data:
32768: 1
```
Example 4:
```yaml
service: zwave_js.bulk_set_partial_config_parameters
target:
entity_id: switch.fan
data:
parameter: 21
value:
255: 127
32512: 10
32768: "Fine"
```
Example 5:
```yaml
service: zwave_js.bulk_set_partial_config_parameters
target:
entity_id: switch.fan
data:
parameter: 21
value:
"Quick Strip Effect: Hue Color Wheel / Color Temp": 127
"Quick Strip Effect Intensity": 10
"Quick Strip Effect Intensity Scale": "Fine"
```
### Service `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.