Andre Lengwenus f0f99637ca Documentation for LCN component and light platform (#7599)
* Initial documentation for LCN component and light platform

* Light platform integrated into LCN component

* Incorporated LCN lights example and configuration docs into corresponding component.
2018-12-28 17:13:30 -08:00

4.6 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class
layout title description date sidebar comments sharing footer logo ha_category ha_release ha_iot_class
page LCN Instructions on how to integrate LCN components with Home Assistant. 2018-11-01 08:00 true false true true lcn.png Hub 0.85 Local Push

The lcn integration for Home Assistant allows you to connect to LCN hardware devices.

The component requires one unused license of the coupling software LCN-PCHK (version >2.8) and a LCN hardware coupler. Alternatively a LCN-PKE coupler can be used which offers two PCHK licenses. With this setup sending and receiving commands to and from LCN modules is possible.

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

{% linkable_title Configuration %}

To use your LCN system in your installation, add the following lines to your configuration.yaml file. You have to specify at least one ip/port with login credentials for a PCHK host. Consider to store your credentials in a secrets.yaml.

lcn:
  connections:
    - name: myhome
      host: 192.168.2.41
      port: 4114
      username: lcn
      password: lcn
  
  lights:
    - name: Bedroom light
      address: myhome.s0.m7
      output: output1
      dimmable: true
      transition: 5

{% configuration %} connections: description: List of your connections required: true type: map keys: host: description: IP address of the LCN-PCHK host. required: true type: string port: description: Port of the LCN-PCHK host. required: true type: integer username: description: Login username for the LCN-PCHK host. required: true type: string password: description: Login password for the LCN-PCHK host. required: true type: string name: description: Optional connection identifier. If omited, the connections will be named consecutively as pchk, pchk1, pchk2, ... required: false default: pchk type: string sk_num_tries: description: Segment coupler scans. Increase this number if you have at least one segment coupler in your system. required: false default: 0 type: integer dim_mode: description: "Dimming mode for connected modules. The operation mode is programmed into the LCN modules by the LCN-PRO software and depends on their firmware. If you experience unexpected dimming behavior, the connection is probably in the wrong operation mode. Possible values: steps50, steps200" required: false default: steps50 type: string

lights: description: List of your lights. required: true type: map keys: name: description: Name of the light. required: true type: string address: description: "Address of the module/group." required: true type: string output: description: "Light source (OUTPUT_PORT)." required: true type: string dimmable: description: Enable the dimming feature for this light required: false type: bool default: false transition: description: Transition (ramp) time in seconds. required: false type: int default: 0 {% endconfiguration %}

{% linkable_title LCN Addresses %}

LCN hardware devices connected to the LCN bus are called modules. LCN modules are addressed by their numeric id in the range (5..254).

Modules can be arranged in segments. Segments can be addressed by their numeric id (5..128) or 0 (= no segment exist) or 3 (= target all segments).

LCN Modules within the same segment can be grouped by their group id (5..254) or 3 (= target all groups.)

The LCN component allow the connection to more than one hardware coupler. In this case it has to be specified which hardware coupler should be used for addressing the specified module.

Whenever the address of a module or a group has to be specified, it can be addressed using one of the following syntaxes:

Example for modules:

connid.s000.m007
connid.s0.m7
s0.m7
0.7

Example for groups:

connid.s000.g007
connid.s0.g7
s0.g7
0.g7

Leading zeroes in the segment id or module/group id can be omitted. If the connection_id is omitted, the first connection defined in the configuration will be used.

{% linkable_title LCN Constants %}

The platforms and service calls use several predefined constants as parameters.

{% linkable_title Ports %}

Constant Values
OUTPUT_PORT output1, output2, output3, output4