From 7aa1e919fbb2e078fad932abfe1ad306aff1445e Mon Sep 17 00:00:00 2001 From: Andre Lengwenus Date: Thu, 28 Mar 2019 23:34:57 +0100 Subject: [PATCH] Add docs for LCN binary_sensor platform (#9010) --- source/_components/lcn.markdown | 40 +++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/source/_components/lcn.markdown b/source/_components/lcn.markdown index 7cccc34de997..06e66c3d8938 100644 --- a/source/_components/lcn.markdown +++ b/source/_components/lcn.markdown @@ -29,6 +29,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) - [Sensor](#sensor) @@ -49,6 +50,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 @@ -111,6 +117,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 @@ -244,6 +268,7 @@ The platforms and service calls use several predefined constants as parameters. | MOTOR_PORT | `motor1`, `motor2`, `motor3`, `motor4` | | LED_PORT | `led1`, `led2`, `led3`, `led4`, `led5`, `led6`, `led7`, `led8`, `led9`, `led10`, `led11`, `led12` | | LOGICOP_PORT | `logicop1`, `logicop2`, `logicop3`, `logicop4` | +| 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: @@ -271,8 +296,23 @@ The [MOTOR_PORT](/components/lcn#ports) values specify which hardware relay conf | LED_STATE | `on`. `off`, `blink`, `flicker` | | LOGICOP_STATE | `not`. `or`, `and` | +### {% 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.