Skip to content

Commit c23c2bc

Browse files
thomasdelaetLandrash
authored andcommitted
add support for Velbus platform (home-assistant#2830)
* add support for Velbus platform * Update light.velbus.markdown * update and extend documentation to be in line with updated pull request for code * rename fan example to 'Fan 1'
1 parent 1628072 commit c23c2bc

File tree

6 files changed

+192
-0
lines changed

6 files changed

+192
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: page
3+
title: "Velbus sensors"
4+
description: "Access and control your Velbus sensors."
5+
date: 2017-06-17 16.58
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: velbus.png
11+
ha_category: Binary Sensor
12+
ha_iot_class: "Local Push"
13+
ha_release: 0.49
14+
---
15+
16+
The `velbus` binary_sensor allows you to control [Velbus](http://www.velbus.eu) connected wall switches.
17+
18+
To use your Velbus wall switches in your installation, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
23+
binary_sensor:
24+
- platform: velbus
25+
devices:
26+
- name: Wall Switch 1
27+
module: 0xda
28+
channel: 4
29+
- name: Wall Switch 2
30+
module: 0xbc
31+
channel: 1
32+
is_pushbutton: true
33+
```
34+
35+
Configuration variables:
36+
- **devices** array (*Required*): The array contains the binary sensors to configure
37+
- **name** (*Required*): Name of the binary sensor.
38+
- **module** (*Required*): The hexadecimal module address
39+
- **channel** (*Required*): The channel number in the module.
40+
- **is_pushbutton** (*Optional*): Booelan to indicate if a wall switch is a push button or not (default: false)
41+
42+
For hub configuration, see [the Velbus component](/components/velbus/).
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: page
3+
title: "Velbus Fans"
4+
description: "Access and control your Velbus fans."
5+
date: 2017-06-17 16.58
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: velbus.png
11+
ha_category: Fan
12+
ha_iot_class: "Local Push"
13+
ha_release: 0.49
14+
---
15+
16+
The `velbus` fan allows you to control [Velbus](http://www.velbus.eu) connected fans.
17+
18+
To use your Velbus fans in your installation, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
23+
fan:
24+
- platform: velbus
25+
devices:
26+
- name: Fan 1
27+
module: 0xda
28+
channel_low: 4
29+
channel_medium: 3
30+
channel_high: 2
31+
```
32+
33+
Configuration variables:
34+
- **devices** array (*Required*): The array contains the fans to configure
35+
- **name** (*Required*): Name of the fan.
36+
- **module** (*Required*): The hexadecimal module address
37+
- **channel_low** (*Required*): The channel number in the module for low-speed.
38+
- **channel_medium** (*Required*): The channel number in the module for medium-speed.
39+
- **channel_high** (*Required*): The channel number in the module for high-speed.
40+
41+
For hub configuration, see [the Velbus component](/components/velbus/).
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: page
3+
title: "Velbus lights"
4+
description: "Access and control your Velbus lights."
5+
date: 2017-06-17 16.58
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: velbus.png
11+
ha_category: Light
12+
ha_iot_class: "Local Push"
13+
ha_release: 0.49
14+
---
15+
16+
The `velbus` light allows you to control [Velbus](http://www.velbus.eu) lights.
17+
18+
To use your Velbus lights in your installation, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
23+
light:
24+
- platform: velbus
25+
devices:
26+
- name: Light 1
27+
module: 0xda
28+
channel: 4
29+
- name: Light 2
30+
module: 0xbc
31+
channel: 1
32+
```
33+
34+
Configuration variables:
35+
- **devices** array (*Required*): The array contains the lights to configure
36+
- **name** (*Required*): Name of the light.
37+
- **module** (*Required*): The hexadecimal module address
38+
- **channel** (*Required*): The channel number in the module.
39+
40+
For hub configuration, see [the Velbus component](/components/velbus/).
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: page
3+
title: "Velbus Switches"
4+
description: "Access and control your Velbus Switches."
5+
date: 2017-06-17 16.58
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: velbus.png
11+
ha_category: Switch
12+
ha_iot_class: "Local Push"
13+
ha_release: 0.49
14+
---
15+
16+
The `velbus` switch allows you to control [Velbus](http://www.velbus.eu) connected switches.
17+
18+
To use your Velbus switches in your installation, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
23+
light:
24+
- platform: velbus
25+
devices:
26+
- name: Switch 1
27+
type: single
28+
module: 0xda
29+
channel: 4
30+
- name: Switch 2
31+
type: double
32+
module: 0xbc
33+
open_channel: 1
34+
close_channel: 2
35+
```
36+
37+
Configuration variables:
38+
- **devices** array (*Required*): The array contains the switches to configure
39+
- **name** (*Required*): Name of the switch.
40+
- **module** (*Required*): The hexadecimal module address
41+
- **type** (*Required*): Either `single` or `double`. If single, only `channel` attribute is required. If double, both `open_channel` and `close_channel` attributes are required
42+
- **channel** (*Required*): The channel number in the module.
43+
44+
For hub configuration, see [the Velbus component](/components/velbus/).

source/_components/velbus.markdown

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: page
3+
title: "Velbus"
4+
description: "Access and control your Velbus devices."
5+
date: 2017-06-17 16.58
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: velbus.png
11+
ha_category: Hub
12+
ha_iot_class: "Local Push"
13+
ha_release: 0.49
14+
---
15+
16+
The `velbus` component supports the Velbus USB and Serial gateways.
17+
18+
The gateway needs to be configured by adding the following lines to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
23+
velbus:
24+
port: '/dev/ttyUSB00'
25+
```
59 KB
Loading

0 commit comments

Comments
 (0)