mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 16:27:19 +00:00
Update configuration description (#5727)
This commit is contained in:
parent
c8ebaa1525
commit
5d00db97b2
@ -15,28 +15,47 @@ ha_release: "0.50"
|
||||
|
||||
The `velbus` binary_sensor allows you to control [Velbus](http://www.velbus.eu) connected wall switches.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your Velbus wall switches in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
binary_sensor:
|
||||
- platform: velbus
|
||||
devices:
|
||||
- name: Wall Switch 1
|
||||
module: 0xda
|
||||
channel: 4
|
||||
- name: Wall Switch 2
|
||||
module: 0xbc
|
||||
channel: 1
|
||||
is_pushbutton: true
|
||||
- name: Wall Switch 1
|
||||
module: 0xda
|
||||
channel: 4
|
||||
- name: Wall Switch 2
|
||||
module: 0xbc
|
||||
channel: 1
|
||||
is_pushbutton: true
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
- **devices** array (*Required*): The array contains the binary sensors to configure
|
||||
- **name** (*Required*): Name of the binary sensor.
|
||||
- **module** (*Required*): The hexadecimal module address
|
||||
- **channel** (*Required*): The channel number in the module.
|
||||
- **is_pushbutton** (*Optional*): Boolean to indicate if a wall switch is a push button or not (default: false)
|
||||
{% configuration %}
|
||||
devices:
|
||||
description: The list contains the binary sensors to configure.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name to use in the frontend.
|
||||
required: true
|
||||
type: string
|
||||
module:
|
||||
description: The hexadecimal module address.
|
||||
required: true
|
||||
type: string
|
||||
channel:
|
||||
description: The channel number in the module.
|
||||
required: true
|
||||
type: string
|
||||
is_pushbutton:
|
||||
description: Set to indicate if a wall switch is a push button or not.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
For hub configuration, see [the Velbus component](/components/velbus/).
|
||||
|
@ -15,27 +15,48 @@ ha_release: "0.50"
|
||||
|
||||
The `velbus` fan allows you to control [Velbus](http://www.velbus.eu) connected fans.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your Velbus fans in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
fan:
|
||||
- platform: velbus
|
||||
devices:
|
||||
- name: Fan 1
|
||||
module: 0xda
|
||||
channel_low: 4
|
||||
channel_medium: 3
|
||||
channel_high: 2
|
||||
- name: Fan 1
|
||||
module: 0xda
|
||||
channel_low: 4
|
||||
channel_medium: 3
|
||||
channel_high: 2
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
- **devices** array (*Required*): The array contains the fans to configure
|
||||
- **name** (*Required*): Name of the fan.
|
||||
- **module** (*Required*): The hexadecimal module address
|
||||
- **channel_low** (*Required*): The channel number in the module for low-speed.
|
||||
- **channel_medium** (*Required*): The channel number in the module for medium-speed.
|
||||
- **channel_high** (*Required*): The channel number in the module for high-speed.
|
||||
{% configuration %}
|
||||
devices:
|
||||
description: The list contains the fans to configure.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name to use in the frontend.
|
||||
required: true
|
||||
type: string
|
||||
module:
|
||||
description: The hexadecimal module address.
|
||||
required: true
|
||||
type: string
|
||||
channel_low:
|
||||
description: The channel number in the module for low-speed.
|
||||
required: true
|
||||
type: string
|
||||
channel_medium:
|
||||
description: The channel number in the module for medium-speed.
|
||||
required: true
|
||||
type: string
|
||||
channel_high:
|
||||
description: The channel number in the module for high-speed.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
For hub configuration, see [the Velbus component](/components/velbus/).
|
||||
|
@ -15,26 +15,41 @@ ha_release: "0.50"
|
||||
|
||||
The `velbus` light allows you to control [Velbus](http://www.velbus.eu) lights.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your Velbus lights in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
light:
|
||||
- platform: velbus
|
||||
devices:
|
||||
- name: Light 1
|
||||
module: 0xda
|
||||
channel: 4
|
||||
- name: Light 2
|
||||
module: 0xbc
|
||||
channel: 1
|
||||
- name: Light 1
|
||||
module: 0xda
|
||||
channel: 4
|
||||
- name: Light 2
|
||||
module: 0xbc
|
||||
channel: 1
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
- **devices** array (*Required*): The array contains the lights to configure
|
||||
- **name** (*Required*): Name of the light.
|
||||
- **module** (*Required*): The hexadecimal module address
|
||||
- **channel** (*Required*): The channel number in the module.
|
||||
{% configuration %}
|
||||
devices:
|
||||
description: The list contains the lights to configure.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name to use in the frontend.
|
||||
required: true
|
||||
type: string
|
||||
module:
|
||||
description: The hexadecimal module address.
|
||||
required: true
|
||||
type: string
|
||||
channel:
|
||||
description: The channel number in the module.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
For hub configuration, see [the Velbus component](/components/velbus/).
|
||||
|
@ -15,6 +15,8 @@ ha_release: "0.50"
|
||||
|
||||
The `velbus` switch allows you to control [Velbus](http://www.velbus.eu) connected switches.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your Velbus switches in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -23,22 +25,39 @@ To use your Velbus switches in your installation, add the following to your `con
|
||||
light:
|
||||
- platform: velbus
|
||||
devices:
|
||||
- name: Switch 1
|
||||
type: single
|
||||
module: 0xda
|
||||
channel: 4
|
||||
- name: Switch 2
|
||||
type: double
|
||||
module: 0xbc
|
||||
open_channel: 1
|
||||
close_channel: 2
|
||||
- name: Switch 1
|
||||
type: single
|
||||
module: 0xda
|
||||
channel: 4
|
||||
- name: Switch 2
|
||||
type: double
|
||||
module: 0xbc
|
||||
open_channel: 1
|
||||
close_channel: 2
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
- **devices** array (*Required*): The array contains the switches to configure
|
||||
- **name** (*Required*): Name of the switch.
|
||||
- **module** (*Required*): The hexadecimal module address
|
||||
- **type** (*Required*): Either `single` or `double`. If single, only `channel` attribute is required. If double, both `open_channel` and `close_channel` attributes are required
|
||||
- **channel** (*Required*): The channel number in the module.
|
||||
{% configuration %}
|
||||
devices:
|
||||
description: The list contains the switches to configure.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name to use in the frontend.
|
||||
required: true
|
||||
type: string
|
||||
module:
|
||||
description: The hexadecimal module address.
|
||||
required: true
|
||||
type: string
|
||||
channel:
|
||||
description: The channel number in the module.
|
||||
required: true
|
||||
type: string
|
||||
type:
|
||||
description: "Either `single` or `double`. If single, only `channel` attribute is required. If `double`, both `open_channel:` and `close_channel:` keys are required."
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
For hub configuration, see [the Velbus component](/components/velbus/).
|
||||
|
@ -13,13 +13,21 @@ ha_iot_class: "Local Push"
|
||||
ha_release: "0.50"
|
||||
---
|
||||
|
||||
The `velbus` component supports the Velbus USB and Serial gateways.
|
||||
The `velbus` component supports the Velbus USB and serial gateways.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
The gateway needs to be configured by adding the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
velbus:
|
||||
port: '/dev/ttyUSB00'
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
port:
|
||||
description: The port where your board is connected to your Home Assistant host. The port will be most likely named `ttyUSB*`.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
Loading…
x
Reference in New Issue
Block a user