From a3b88645684a9e7c60bea3b611d5b72d18433fcc Mon Sep 17 00:00:00 2001 From: Maikel Punie Date: Fri, 13 Dec 2024 09:23:29 +0100 Subject: [PATCH] Velbus config parameters (#36308) Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/velbus.markdown | 31 ++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/source/_integrations/velbus.markdown b/source/_integrations/velbus.markdown index 1e1ff9fa19c0..b53ec748bca0 100644 --- a/source/_integrations/velbus.markdown +++ b/source/_integrations/velbus.markdown @@ -31,18 +31,24 @@ ha_integration_type: hub The **Velbus** {% term integration %} is used to control [Velbus](https://www.velbus.eu/?lang=en) modules. It supports the Velbus USB, Velbus serial and a TCP/IP gateway. -The pushbutton LEDs of input modules are disabled by default. These can be enabled from the `Devices` panel in the `Configuration` page of the web interface. {% include integrations/config_flow.md %} -The port string used in the user interface or the configuration file can have 2 formats: +### Configuration parameters -- For a serial device: `/dev/ttyUSB00` -- For a TCP/IP device: `127.0.0.1:3678` -- For the VMBSIG module: `tls://192.168.1.9:27015` +The port string used in the user interface or the configuration file can have different formats depending on the type of connection: -## Actions +- For a serial or USB devices: `/dev/ttyUSB00` +- For a TCP/IP devices: `127.0.0.1:3678` +- For Signum devices without authentication: `tls://192.168.1.9:27015` +- For Signum devices with authentication: `tls://password@192.168.1.9:27015` + +{% note %} +The pushbutton LEDs of input modules are disabled by default. These can be enabled from the **Devices** panel in the **Configuration** page of the web interface. +{% endnote %} + +## Actions - `velbus.sync clock`: Synchronize Velbus time to local clock. - `velbus.scan`: Scan the bus for new devices. - `velbus.set_memo_text`: Show memo text on Velbus display modules. @@ -99,8 +105,11 @@ Use this action when you make changes to your configuration via velbuslink. | `interface` | no | The port used to connect to the bus (the same one used during configuration). | | `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. | + ## VMB7IN and the Energy dashboard +The VMB7IN sensor can be integrated with Home Assistant's Energy dashboard to track your utility consumption. + In some cases, the VMB7IN sensor does not report what the counter is counting. If the counter is related to an energy device, everything will work out of the box. But if the VMB7IN sensor is a water or gas counter, you will need to specify this in your configuration.yaml file. @@ -115,6 +124,7 @@ The device_class attribute can have 2 values: - gas: if the counter represents a gas meter - water: if the counter represents a water meter + ## Example automation The Velbus {% term integration %} allows you to link a Velbus button (i.e., a button of a [VMBGPOD](https://www.velbus.eu/products/view/?id=416302&lang=en) module) to a controllable {% term entity %} of Home Assistant. @@ -165,3 +175,12 @@ The actual linking can be realized by two automation rules. One rule to control entity_id: light.led_push_button_10 ``` + +## Removing the integration + +The Velbus integration and its entities can be removed by following these steps: + +{% include integrations/remove_device_service.md %} + +Note: Removing the integration will delete all Velbus devices and their history from Home Assistant. +