Velbus servicerework doc sync (#36855)

* Velbus servicerework doc sync

* update comments
This commit is contained in:
Maikel Punie 2025-01-13 16:42:16 +01:00 committed by GitHub
parent c0a8384805
commit 6eea80f3d1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -61,6 +61,7 @@ You can use the `velbus.sync_clock` action to synchronize the clock of the Velbu
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration). |
| `config_entry` | no | The config_entry to send the command to. |
### Action `velbus.scan`
@ -69,6 +70,7 @@ You can use the `velbus.scan` action to synchronize the modules between the bus
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration). |
| `config_entry` | no | The config_entry to send the command to. |
### Action `velbus.set_memo_text`
@ -78,6 +80,7 @@ You can use the `velbus.set_memo_text` action to provide the memo text to be dis
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration). |
| `config_entry` | no | The config_entry to send the command to. |
| `address` | no | The module address in decimal format, which is displayed at the device list at the integration page. |
| `memo_text` | yes | Text to be displayed on module. When no memo text is supplied the memo text will be cleared. |
@ -92,7 +95,7 @@ script:
data:
address: 65
memo_text: "It's trash day"
interface: "tls://192.168.1.9:27015"
config_entry: "01JGE8XB3MNPZFA836TTZ3KZ46"
```
### Action `velbus.clear_cache`
@ -102,7 +105,8 @@ Use this action when you make changes to your configuration via velbuslink.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `interface` | no | The port used to connect to the bus (the same one used during configuration). |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration). |
| `config_entry` | no | The config_entry to send the command to. |
| `address` | no | The module address in decimal format, which is displayed on the device list on the integration page, if provided the service will only clear the cache for this model, without an address, the full velbuscache will be cleared. |