LCN

The LCN integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] for Home Assistant allows you to connect to LCN hardware devices.

Prerequisites

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

The lcn integration allows connections to more than one hardware coupler. For each coupler, a new integration entry needs to be created.

Configuration

To add the LCN integration to your Home Assistant instance, use this My button:

Supported device types

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

• Binary sensor
• Climate
• Cover
• Light
• Scene
• Sensor
• Switch

Setting up devices and entites

The lcn hardware modules and groups are represented by Home Assistant devices. The periphery of each lcn module is represented by Home Assistant entities. Peripheries are, for example, the output ports, relays, and variables of a module. Refer to the description of each platform to learn about which entity should be used for which periphery.

The configuration of the lcn devices and entities is completely done using a web user interface (configuration panel).

Once the integration is added to Home Assistant, you can access the lcn configuration panel by selecting the Configure button next to the respective integration entry on the LCN integration page.

Configuration panel

From the LCN Configuration Panel, you can configure your LCN modules, groups, and entities within Home Assistant.

Configuring devices

You can add and remove modules and groups directly from the configuration panel. Once added, they will appear in Home Assistant as devices, which can be used to trigger specific actions within scripts or automations. For examples, refer to the Performing actions page.

The Modules / Groups tab provides an overview of your configured LCN modules and groups, showing their name, ID, and segment ID. The LCN Configuration Panel attempts to derive names from the LCN modules; if a module has no name or is part of a group, a standard name is assigned.

Scanning modules

To initiate a scan for LCN modules on the bus, in the top-right corner, select the three dots menu and select Scan Modules.

• Result: This process polls each module for its name and serial number.
• When all module responses have been received, they will be listed in the device list.
• Scanning modules may take several seconds. The pop-up dialog will close automatically once the process is complete.

Adding devices

If module scanning fails or a module is unavailable on the bus, you can manually add it. Groups can also be created manually.

1. To add a module or group manually, select the Create Module/Group button.

2. Select whether you want to add a module or group and enter the desired segment id and module/group id.

   

3. To add the new device, select Create.

Deleting devices

To delete a single device, select the trash can icon next to it.

• Result: This will remove the device from the device list and from Home Assistant, including any associated entities.

To delete multiple devices at once, enable selection mode. Select the desired entries, then, in the top-right corner, select Delete Selected.

Configuring entities

Entities configured for all devices are listed on the Entities tab.

To view entities for a specific device (module or group), in the Modules / Groups tab, select the device entry.

• Result: The Entities tab opens, showing entities of the selected device.
• To apply custom filters, enable the filter option.

Adding entities

1. To create a new entity, select Create Entity.
2. From the dropdown menu, select the module or group for which to create the entity.

   • If a single module or group filter is applied, it will be pre-selected.

     

3. Choose the domain (platform) for the entity and enter a name.
   • You can change this name later within the Home Assistant entity settings.
4. Depending on the selected domain, additional options will be shown. To add the entity to the list and to Home Assistant, enter the required information and select Create .

Deleting entities

To delete a single entity, select the trash can icon next to it.

• Result: This removes the entity from the list and from Home Assistant.

To delete multiple entities, enable selection mode, select the desired entries, and select Delete Selected in the upper right.

Displaying entity properties

Once an entity is created, you can view and configure its properties.

Select the entity in the entity list.

• This opens the Home Assistant dialog for entity properties, allowing you to configure the entity as you would from the general Home Assistant entity configuration panel.

Platforms

Binary sensor

The lcn binary sensor platform allows the monitoring of the following LCN binary data sources:

• Binary hardware sensors

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

Climate

The lcn climate platform allows the control of the LCN climate regulators. This platform depends on the correct configuration of the module’s regulators, which has to be done in the LCN-PRO programming software. You need to specify at least the variable for the current temperature and a setpoint variable for the target temperature. If the control is set lockable, the regulator can be turned on/off.

Cover

The lcn cover platform allows the control of LCN relays and output ports which have been configured as motor controllers. Refer to the motors table to learn about which motor uses which module periphery.

Only for the module with firmware earlier than 190C:
The configuration allows the optional definition of reverse time. This is the time which is waited during the switching of the motor currents. The reverse time should only be defined when using the module’s output ports for driving the cover. For all other configuration, the reverse time has to be defined in the LCN Pro software. For the reverse time, you may choose one of the following constants: RT70 (70ms), RT600 (600ms), RT1200 (1,2s).

Light

The lcn light platform allows the control of the following LCN ports:

• (Dimmable) output ports
• Relays

Scene

The lcn scene platform allows the activation of previously programmed LCN scenes.

Sensor

The lcn sensor platform allows the monitoring of the following LCN data sources:

• Variables
• Regulator setpoints
• Thresholds
• S0 inputs
• LED states
• Logic operation states

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

Switch

The lcn switch platform allows the control of the following LCN ports:

• Output ports
• Relays
• Lock state of regulators
• Lock state of keys

Additional features

Transponder, fingerprint sensor and code lock

To use LCN transponders, fingerprint sensors or code locks ensure that the corresponding module’s I-port property is enabled in the LCN-PRO software and properly configured. LCN transponders, fingerprints and code locks are identified by a six value hexadecimal code (e.g. 123abc). If a code is received a corresponding event (transponder event, fingerprint event, codelock event) is fired and can be used to trigger an automation. Alternatively, you can use the corresponding device triggers.

Example:

This example shows how the event_data can be extracted and used in a condition using Home Assistant’s templating engine. Trigger on a transponder event and ensure that the received code is in the given list:

automation:
  triggers:
    - trigger: event
      event_type: lcn_transponder
  conditions: "{{ trigger.event.data.code in ['aabbcc', 'ddeeff', '112233'] }}"
  actions:
    ...

Further examples can be found in the event section.

Remote control

To use LCN remote controls (e.g., LCN-RT or LCN-RT16) ensure that the corresponding module’s I-port property is enabled in the LCN-PRO software and its behavior is properly configured as “IR access control”. With this configuration each remote control is identified by a six value hexadecimal code (e.g. 123abc). If a command from a remote control is received a corresponding event (transponder event) is fired and can be used to trigger an automation. Along with the transmitted code, the pressed key and the key action are transmitted. Alternatively, you can use the corresponding device triggers.

Examples can be found in the event section.

LCN commands addressed to PCHK host (Home Assistant)

A LCN module can not only be programmed to send commands to other modules/groups but also to the PCHK host configured in the LCN integration. These commands are directly passed to Home Assistant and can be evaluated. Only the send keys (former) command is supported.

Within LCN-PRO program the send keys command (only “A-C former command” is supported) to a key. For the target address manually enter the PCHK host id (default: 4). Select the keys and key actions as desired.

When a send keys command is received, the LCN integration will fire a send keys event for each key configured. These events can be used to trigger an automation. Alternatively, you can use the corresponding device triggers.

Examples can be found in the event section.

Events

There are several functionalities of the LCN system which are not exposed as regular entities by the integration, but as events. Examples are button presses from remote controls (transmitters), transponder findings, fingerprint sensors and so called send keys events.

All events have some common attributes in their event_data which identify the sending LCN hardware module (e.g., the module the transponder is connected to):

In addition, every event has its own special attributes which are described below. All special attributes are optional and can be used as supplementary filters.

Event: lcn_transmitter

The lcn_transmitter event is fired if a LCN remote control command is received.

Example:

The trigger will fire if any key on the remote control with code 123abc is hit as long as the receiver hardware is connected to module 7 in segment 0.

automation:
  triggers:
    - trigger: event
      event_type: lcn_transmitter
      event_data:
        segment_id: 0
        module_id: 7
        code: 123abc
        action: hit

Event: lcn_transponder

The lcn_transponder event is fired if a LCN transponder command is received.

Example:

The trigger will fire if the transponder with code 123abc was detected at any hardware module.

automation:
  triggers:
    - trigger: event
      event_type: lcn_transponder
      event_data:
        code: 123abc

Event: lcn_fingerprint

The lcn_fingerprint event is fired if a LCN fingerprint command is received.

Example:

The trigger will fire if the fingerprint with code 123abc was detected at any hardware module.

automation:
  triggers:
    - trigger: event
      event_type: lcn_fingerprint
      event_data:
        code: 123abc

Event: lcn_codelock

The lcn_codelock event is fired if a LCN code lock command is received.

Example:

The trigger will fire if the code lock with code 123abc was activated at any hardware module.

automation:
  triggers:
    - trigger: event
      event_type: lcn_codelock
      event_data:
        code: 123abc

Event: lcn_send_keys

The lcn_send_keys event is fired if the PCHK host receives a send keys command.

Example:

The trigger will fire if the PCHK host receives a command that issues a hit of key a1.

automation:
  triggers:
    - trigger: event
      event_type: lcn_send_keys
      event_data:
        key: a1
        action: hit

Device triggers

To simplify using events in automations the LCN integration exposes them as device triggers. Those device triggers can be selected from the automation editor within Home Assistant.

After creating a new automation select Device as trigger type and search for the module which is supposed to cause the event in the device list. You may select the trigger type and configure its attributes. If an attribute is optional it is considered as a supplementary filter for the trigger. For an explanation of the attributes refer to the corresponding events.

Actions

In order to directly interact with the LCN system, and invoke commands which are not covered by the implemented platforms, the following actions can be used. Refer to the Performing actions page for examples on how to use them.

Action: output_abs

Set absolute brightness of output port in percent.

Example:

action: lcn.output_abs
data:
  address: myhome.0.7
  output: output1
  brightness: 100
  transition: 0

Action: output_rel

Set relative brightness of output port in percent.

Example:

action: lcn.output_rel
data:
  address: myhome.0.7
  output: output1
  brightness: 30

Action: output_toggle

Toggle output port.

Example:

action: lcn.output_toggle
data:
  address: myhome.0.7
  output: output1
  transition: 0

Action: relays

Set the relays status. The relays states are defined as a string with eight characters. Each character represents the state change of a relay (1=on, 0=off, t=toggle, -=nochange).

Example states: t---001-

Example:

action: lcn.relays
data:
  address: myhome.0.7
  state: t---001-

Action: led

Set the LED status.

Example:

action: lcn.led
data:
  address: myhome.0.7
  led: led6
  state: blink

Action: var_abs

Set the absolute value of a variable or setpoint. If value is not defined, it is assumed to be 0. If unit_of_measurement is not defined, it is assumed to be native.

Example:

action: lcn.var_abs
data:
  address: myhome.0.7
  variable: var1
  value: 75
  unit_of_measurement: %

Action: var_rel

Set the relative value of a variable or setpoint. If value is not defined, it is assumed to be 0. If unit_of_measurement is not defined, it is assumed to be native.

Example:

action: lcn.var_rel
data:
  address: myhome.0.7
  variable: var1
  value: 10
  unit_of_measurement: %

Action: var_reset

Reset value of variable or setpoint.

Example:

action: lcn.var_reset
data:
  address: myhome.0.7
  variable: var1

Action: lock_regulator

Locks a regulator setpoint. If state is not defined, it is assumed to be False.

Example:

action: lcn.lock_regulator
data:
  address: myhome.0.7
  setpoint: r1varsetpoint
  state: true

Action: send_keys

Send keys (which executes bound commands). The keys attribute is a string with one or more key identifiers. Example: a1a5d8 If state is not defined, it is assumed to be hit. The command allows the sending of keys immediately or deferred. For a deferred sending the attributes time and time_unit have to be specified. For deferred sending, the only key state allowed is hit. If time_unit is not defined, it is assumed to be seconds.

Examples:

Send keys immediately:

action: lcn.send_keys
data:
  address: myhome.0.7
  keys: a1a5d8
  state: hit

Send keys deferred:

action: lcn.send_keys
data:
  address: myhome.0.7
  keys: a1a5d8
  time: 5
  time_unit: s

Action: lock_keys

Locks keys. If the table is not defined, it is assumed to be table a. The key lock states are defined as a string with eight characters. Each character represents the state change of a key lock (1=on, 0=off, t=toggle, -=nochange). The command allows the locking of keys for a specified time period. For a time period, the attributes time and time_unit have to be specified. For a time period, only table a is allowed. If time_unit is not defined, it is assumed to be seconds.

Examples:

Lock keys forever:

action: lcn.lock_keys
data:
  address: myhome.0.7
  table: a
  state: 1---t0--

Lock keys for a specified time period:

action: lcn.lock_keys
data:
  address: myhome.0.7
  state: 1---t0--
  time: 10
  time_unit: s

Action: dyn_text

Send dynamic text to LCN-GTxD displays. The displays support four rows for text messages. Each row can be set independently and can store up to 60 characters (encoded in UTF-8).

Example:

action: lcn.dyn_text
data:
  address: myhome.0.7
  row: 1
  text: "text in row 1"

Action: pck

Send arbitrary PCK command. Only the command part of the PCK command has to be specified in the pck string.

Example:

action: lcn.pck
data:
  address: myhome.0.7
  pck: PIN4

LCN constants

The actions use several predefined constants as parameters.

Ports

Motors

The motor values specify which hardware relay or outputs configuration will be used:

Variables and units

States

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.