Update configuration description (#5727)

This commit is contained in:
Fabian Affolter 2018-07-09 21:51:12 +02:00 committed by GitHub
parent c8ebaa1525
commit 5d00db97b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 138 additions and 56 deletions

View File

@ -15,28 +15,47 @@ ha_release: "0.50"
The `velbus` binary_sensor allows you to control [Velbus](http://www.velbus.eu) connected wall switches. 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: To use your Velbus wall switches in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
binary_sensor: binary_sensor:
- platform: velbus - platform: velbus
devices: devices:
- name: Wall Switch 1 - name: Wall Switch 1
module: 0xda module: 0xda
channel: 4 channel: 4
- name: Wall Switch 2 - name: Wall Switch 2
module: 0xbc module: 0xbc
channel: 1 channel: 1
is_pushbutton: true is_pushbutton: true
``` ```
Configuration variables: {% configuration %}
- **devices** array (*Required*): The array contains the binary sensors to configure devices:
- **name** (*Required*): Name of the binary sensor. description: The list contains the binary sensors to configure.
- **module** (*Required*): The hexadecimal module address required: true
- **channel** (*Required*): The channel number in the module. type: map
- **is_pushbutton** (*Optional*): Boolean to indicate if a wall switch is a push button or not (default: false) 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/). For hub configuration, see [the Velbus component](/components/velbus/).

View File

@ -15,27 +15,48 @@ ha_release: "0.50"
The `velbus` fan allows you to control [Velbus](http://www.velbus.eu) connected fans. 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: To use your Velbus fans in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
fan: fan:
- platform: velbus - platform: velbus
devices: devices:
- name: Fan 1 - name: Fan 1
module: 0xda module: 0xda
channel_low: 4 channel_low: 4
channel_medium: 3 channel_medium: 3
channel_high: 2 channel_high: 2
``` ```
Configuration variables: {% configuration %}
- **devices** array (*Required*): The array contains the fans to configure devices:
- **name** (*Required*): Name of the fan. description: The list contains the fans to configure.
- **module** (*Required*): The hexadecimal module address required: true
- **channel_low** (*Required*): The channel number in the module for low-speed. type: map
- **channel_medium** (*Required*): The channel number in the module for medium-speed. keys:
- **channel_high** (*Required*): The channel number in the module for high-speed. 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/). For hub configuration, see [the Velbus component](/components/velbus/).

View File

@ -15,26 +15,41 @@ ha_release: "0.50"
The `velbus` light allows you to control [Velbus](http://www.velbus.eu) lights. 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: To use your Velbus lights in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
light: light:
- platform: velbus - platform: velbus
devices: devices:
- name: Light 1 - name: Light 1
module: 0xda module: 0xda
channel: 4 channel: 4
- name: Light 2 - name: Light 2
module: 0xbc module: 0xbc
channel: 1 channel: 1
``` ```
Configuration variables: {% configuration %}
- **devices** array (*Required*): The array contains the lights to configure devices:
- **name** (*Required*): Name of the light. description: The list contains the lights to configure.
- **module** (*Required*): The hexadecimal module address required: true
- **channel** (*Required*): The channel number in the module. 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/). For hub configuration, see [the Velbus component](/components/velbus/).

View File

@ -15,6 +15,8 @@ ha_release: "0.50"
The `velbus` switch allows you to control [Velbus](http://www.velbus.eu) connected switches. 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: To use your Velbus switches in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
@ -23,22 +25,39 @@ To use your Velbus switches in your installation, add the following to your `con
light: light:
- platform: velbus - platform: velbus
devices: devices:
- name: Switch 1 - name: Switch 1
type: single type: single
module: 0xda module: 0xda
channel: 4 channel: 4
- name: Switch 2 - name: Switch 2
type: double type: double
module: 0xbc module: 0xbc
open_channel: 1 open_channel: 1
close_channel: 2 close_channel: 2
``` ```
Configuration variables: {% configuration %}
- **devices** array (*Required*): The array contains the switches to configure devices:
- **name** (*Required*): Name of the switch. description: The list contains the switches to configure.
- **module** (*Required*): The hexadecimal module address required: true
- **type** (*Required*): Either `single` or `double`. If single, only `channel` attribute is required. If double, both `open_channel` and `close_channel` attributes are required type: map
- **channel** (*Required*): The channel number in the module. 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/). For hub configuration, see [the Velbus component](/components/velbus/).

View File

@ -13,13 +13,21 @@ ha_iot_class: "Local Push"
ha_release: "0.50" 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: The gateway needs to be configured by adding the following lines to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
velbus: velbus:
port: '/dev/ttyUSB00' 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 %}