Skip to content

Commit

Permalink
Add docs for LCN binary_sensor platform
Browse files Browse the repository at this point in the history
  • Loading branch information
alengwenus committed Mar 24, 2019
1 parent deaee14 commit ba8b4da
Showing 1 changed file with 51 additions and 3 deletions.
54 changes: 51 additions & 3 deletions source/_components/lcn.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ With this setup sending and receiving commands to and from LCN modules is possib

There is currently support for the following device types within Home Assistant:

- [Binary Sensor](#binary_sensor)
- [Cover](#cover)
- [Light](#light)
- [Switch](#switch)
Expand All @@ -47,6 +48,11 @@ lcn:
username: lcn
password: lcn

binary_sensors:
- name: Kitchen window
address: myhome.s0.m7
source: binsensor1

covers:
- name: Living room cover
address: myhome.s0.m7
Expand Down Expand Up @@ -103,6 +109,24 @@ connections:
default: steps50
type: string
binary_sensors:
description: List of your binary sensors.
required: false
type: map
keys:
name:
description: "Name of the sensor."
required: true
type: string
address:
description: "[Address](/components/lcn#lcn-addresses) of the module/group."
required: true
type: string
source:
description: "Sensor source ([BINSENSOR](/components/lcn#ports), [SETPOINT](/components/lcn#variables-and-units), [KEYS](/components/lcn#keys))."
required: true
type: string
covers:
description: List of your covers.
required: false
Expand Down Expand Up @@ -211,6 +235,7 @@ The platforms and service calls use several predefined constants as parameters.
| OUTPUT_PORT | `output1`, `output2`, `output3`, `output4` |
| RELAY_PORT | `relay1`, `relay2`, `relay3`, `relay4`, `relay5`, `relay6`, `relay7`, `relay8` |
| MOTOR_PORT | `motor1`, `motor2`, `motor3`, `motor4` |
| BINSENSOR_PORT | `binsensor1`, `binsensor2`, `binsensor3`, `binsensor4`, `binsensor5`, `binsensor6`, `binsensor7`, `binsensor8` |

The [MOTOR_PORT](/components/lcn#ports) values specify which hardware relay configuration will be used:

Expand All @@ -221,18 +246,41 @@ The [MOTOR_PORT](/components/lcn#ports) values specify which hardware relay conf
| `motor3` | `relay5` | `relay6` |
| `motor4` | `relay7` | `relay8` |

## {% linkable_title Cover %}
### {% linkable_title Variables and Units %}

| Constant | Values |
| -------- | ------ |
| SETPOINT | `r1varsetpoint`, `r2varsetpoint` |

### {% linkable_title Keys %}:

Whenever a key has to be provided, it is defined by a joint string consisting of the table identifier (`a`, `b`, `c`, `d`) and the corresponding key number.
Examples: `a1`, `a5`, `d8`.

## {% linkable_title Platforms %}

### {% linkable_title Binary Sensor %}

The `lcn` binary sensor platform allows the monitoring of the following [LCN](http://www.lcn.eu) binary data sources:

- Binary hardware sensors
- Lock state of regulator setpoints
- Lock state of keys

The binary sensor can be used in automation scripts or in conjunction with `template` platforms.

### {% linkable_title Cover %}

The `lcn` cover platform allows the control of [LCN](http://www.lcn.eu) relays which have been configured as motor controllers.

## {% linkable_title Light %}
### {% linkable_title Light %}

The `lcn` light platform allows the control of the following [LCN](http://www.lcn.eu) ports:

- (Dimmable) output ports
- Relays

## {% linkable_title Switch %}
### {% linkable_title Switch %}

The `lcn` switch platform allows the control of the following [LCN](http://www.lcn.eu) ports:

Expand Down

0 comments on commit ba8b4da

Please sign in to comment.