Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Velbus servicerework doc sync #36855

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Velbus servicerework doc sync #36855

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions source/_integrations/velbus.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,17 @@ 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). |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration), this is deprecated on 2025.2 and will be removed in 2025.8. |
| `config_entry` | no | The config_entry to send the command to. |

### Action `velbus.scan`

You can use the `velbus.scan` action to synchronize the modules between the bus and Home Assistant. This is the same as the 'scan' button at the VelbusLink software.

| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration). |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration), this is deprecated on 2025.2 and will be removed in 2025.8. |
| `config_entry` | no | The config_entry to send the command to. |


### Action `velbus.set_memo_text`
Expand All @@ -77,7 +79,8 @@ 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). |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration), this is deprecated on 2025.2 and will be removed in 2025.8. |
| `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. |

Expand All @@ -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`
Expand All @@ -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), this is deprecated on 2025.2 and will be removed in 2025.8. |
| `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. |


Expand Down
Loading