# LCN

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/

LCN (Local Control Network) is a wired bus system.

> **Note:** The following devices are supported by IP-Symcon:
>
> [Supported devices](lcn.md)

> **Note:** The new modules with 12 variables (since firmware 160B13) are supported since IP-Symcon 3.0.

### Installation

In order to be able to connect an LCN bus to IP-Symcon, a Bus-Coupler ([LCN-PKU](https://www.lcn.eu/?wpdmdl=8100) ) with coupling program [PCHK](https://www.lcn.eu/?wpdmdl=8106)  or an Ethernet-Coupler ([LCN-VISU](https://www.lcn.eu/?wpdmdl=8100) ) is required.

### Setup video-tutorial
[Video](https://www.youtube.com/embed/tZMETUfw-_M?rel=0&cc_load_policy=1)

### Integration in IP-Symcon

A configurator for the LCN system can be created via the Management Console.
After a configurator has been created, a red message may appear. This indicates an incorrect or incomplete configuration. To correct the error, the user name and password must be specified in the parent instance. The change is saved by clicking on "Apply".

![LCN: Logged-In](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/lcn/0b04a5e3b3-1790424938/lcn-eingeloggt.png)

If it is not possible to log in after applying, the network configuration within the interface must be checked. Also, in the gateway, the output mode can also be selected between 50 and 200 steps.

After successfully logging in, modules can be searched for on the bus in the configurator, created in IP-Symcon and the individual modules can be created as IP-Symcon splitter instances.

![LCN: Configuration](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/lcn/2d9e4bc6a2-1790424938/lcn-konfiguration.png)

### Configure Modules

As soon as a module is created in the configurator and the configuration button is pressed, a new dialog opens.

![LCN: Module-Configuration](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/lcn/eabe442b11-1790424938/lcn-modul-konfiguration.png)

In order to create the individual instances, the desired relays, inputs/outputs, etc. must be selected and "Create" must be clicked on.

New devices are created and sorted within the object tree into the category that matches the name of the module. These created instances can then be renamed accordingly and sorted elsewhere. It is also possible to call up the respective instance configuration via "Configure".

![LCN: Instance-Configuration](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/geraete/lcn/8bfa8c4a6d-1790424938/lcn-instanz.png)

## Device list

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/device-list/

### Supported Gateways

| Gateway                | Description                                                |
| ---------------------- | ---------------------------------------------------------- |
| LCN-PK (via LCN PCHK)  | Serial port, communication via PCHK with IP-Symcon         |
| LCN-PKU (via LCN PCHK) | USB connection, communication via PCHK with IP-Symcon      |
| LCN-PKE                | Ethernet connection, communication directly with IP-Symcon |
| LCN-VISU               | Ethernet connection, communication directly with IP-Symcon |
### Supported Components

IP-Symcon supports all components.

> **Note:** The LCN-HL4 only supports the RGB color model (switch position 2)

## LCN_AddGroup

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-addgroup/

`bool LCN_AddGroup(int $InstanceID, int $Group)`

adds a device to a group

**Parameters**

- `$InstanceID` (int): Instance ID; the ID of the splitter instance, not the device instance
- `$Group` (int): Group number (1..255)

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Group number (1..255)

**Example**

```php
//The device with ID 12345 is added to group 123
LCN_AddGroup(12345, 123);
```

## LCN_AddIntensity

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-addintensity/

`bool LCN_AddIntensity(int $InstanceID, int $Intensity)`

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Intensity` (int): 0-100%

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

0-100%

**Example**

```php
LCN_AddIntensity(12345, 50); // Dim device brighter by 50 percentage points
```

## LCN_AddThresholdCurrent

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-addthresholdcurrent/

`bool LCN_AddThresholdCurrent(int $InstanceID, int $Register, int $Threshold, float $Value)`

adds threshold to current value

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Register` (int): Register of the threshold value to be switched (1x5
- `$Threshold` (int): Threshold to be set (1x5
- `$Value` (float): Threshold value (0..1000)

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Threshold value (0..1000)

**Example**

```php
// 1x5 threshold
// Adds the value 2.5 to the threshold 2 of the instance with ID 12345
LCN_AddThresholdCurrent(12345, 0, 2, 2.5);

// 4x4 threshold
// Adds the value 2.5 to the threshold 2 in register 3 of the instance with ID 12345
LCN_AddThresholdCurrent(12345, 3, 2, 2.5);
```

## LCN_AddThresholdDefined

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-addthresholddefined/

`bool LCN_AddThresholdDefined(int $InstanceID, int $Register, int $Threshold, float $Value)`

adds threshold to predefined value

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Register` (int): Register of the threshold value to be switched (1x5
- `$Threshold` (int): Threshold to be set (1x5
- `$Value` (float): Value of the threshold

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Value of the threshold

**Example**

```php
// 1x5 threshold
// Adds the value 2.5 relative to the programmed value into threshold 2 of the instance with ID 12345
LCN_AddThresholdDefined(12345, 0, 2, 2.5);

// 4x4 threshold
// Adds the value 2.5 relative to the programmed value into threshold 2 in register 3 of the instance with ID 12345
LCN_AddThresholdDefined(12345, 3, 2, 2.5);
```

## LCN_Beep

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-beep/

`bool LCN_Beep(int $InstanceID, bool $SpecialTone, int $Number)`

**Parameters**

- `$InstanceID` (int): ID of the Instance; the ID of the splitter instance, not the device instance
- `$SpecialTone` (bool): __TRUE__ for On, __FALSE__ for Off
- `$Number` (int): Number between 1..15

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Number between 1..15

**Example**

```php
LCN_Beep(12345, true, 1); //Beep once (SpecialTone)
```

## LCN_DeductIntensity

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-deductintensity/

`bool LCN_DeductIntensity(int $InstanceID, int $Intensity)`

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Intensity` (int): 0-100%

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

0-100%

**Example**

```php
LCN_DeductIntensity(12345, 10); //Dim device darker by 10 percentage points
```

## LCN_DeductThresholdCurrent

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-deductthresholdcurrent/

`bool LCN_DeductThresholdCurrent(int $InstanceID, int $Register, int $Threshold, float $Value)`

deducts threshold from current value

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Register` (int): Register of the threshold value to be switched (1x5
- `$Threshold` (int): Threshold to be set (1x5
- `$Value` (float): Threshold value (0..1000)

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Threshold value (0..1000)

**Example**

```php
// 1x5 threshold
// Deducts the value 2.5 from the threshold 2 of the instance with ID 12345
LCN_DeductThresholdCurrent(12345, 0, 2, 2.5);

// 4x4 threshold
// Deducts the value 2.5 from the threshold 2 in register 3 of the instance with ID 12345
LCN_DeductThresholdCurrent(12345, 3, 2, 2.5);
```

## LCN_DeductThresholdDefined

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-deductthresholddefined/

`bool LCN_DeductThresholdDefined(int $InstanceID, int $Register, int $Threshold, float $Value)`

deducts threshold from predefined value

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Register` (int): Register of the threshold value to be switched (1x5
- `$Threshold` (int): Threshold to be set (1x5
- `$Value` (float): Value of the threshold

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Value of the threshold

**Example**

```php
// 1x5 threshold
// Deducts the value 2.5 relative to the programmed value into Threshold 2 of instance with ID 12345
LCN_AddThresholdDefined(12345, 0, 2, 2.5);

// 4x4 threshold
// Deducts the value 2.5 relative to the programmed value into threshold 2 in register 3 of instance with ID 12345
LCN_AddThresholdDefined(12345, 3, 2, 2.5);
```

## LCN_FadeOut

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-fadeout/

`bool LCN_FadeOut(int $InstanceID, int $Intensity, int $Ramp)`

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Intensity` (int): 0-100%
- `$Ramp` (int): 0-200 seconds

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

0-200 seconds

**Example**

```php
LCN_FadeOut(12345, 100, 5); //Dim down device in 5 seconds of 100% to 0%
```

## LCN_FlipRelay

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-fliprelay/

`bool LCN_FlipRelay(int $InstanceID)`

**Parameters**

- `$InstanceID` (int): ID of the Relay to be switched

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the Relay to be switched

**Example**

```php
LCN_FlipRelais(12345, true); //Switch relay
```

## LCN_LimitOutput

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-limitoutput/

`bool LCN_LimitOutput(int $InstanceID, int $Value, int $Time, string $TimeType)`

limits an output for a certain period of time

**Parameters**

- `$InstanceID` (int): ID of the output to be switched
- `$Value` (int): Percentage value to be limited to (0..100)
- `$Time` (int): Period for which the output should be limited
- `$TimeType` (string): Indicates whether the limit should apply to seconds, minutes, hours or days

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Indicates whether the limit should apply to seconds, minutes, hours or days

**Example**

```php
//Limits the output with ID 12345 to 36% for 8 hours
LCN_LimitOutput(12345, 36, 8, 'H');
```

## LCN_LoadScene

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-loadscene/

`bool LCN_LoadScene(int $InstanceID, int $Scene)`

calls up a scene for an output

**Parameters**

- `$InstanceID` (int): ID of the output to be switched
- `$Scene` (int): Which scene should be loaded (0.. 9, 15)

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Which scene should be loaded (0.. 9, 15)

**Example**

```php
//Calls scene 5 of the output with ID 12345
LCN_LoadScene(12345, 5);
```

## LCN_LockTargetValue

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-locktargetvalue/

`bool LCN_LockTargetValue(int $InstanceID, int $Target)`

locks a controller of the device

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Target` (int): Which controller should be locked (0,1,2,3)

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Which controller should be locked (0,1,2,3)

**Example**

```php
//Locks controller 0 of device 12345
LCN_LockTargetValue(12345, 0);
```

## LCN_RampStop

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-rampstop/

`bool LCN_RampStop(int $InstanceID)`

**Parameters**

- `$InstanceID` (int): ID of the device to be switched

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the device to be switched

**Example**

```php
LCN_RampStop(12345);
```

## LCN_ReleaseTargetValue

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-releasetargetvalue/

`bool LCN_ReleaseTargetValue(int $InstanceID, int $Target)`

unlocks a controller of the device

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Target` (int): Which controller to unlock (0,1,2,3)

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Which controller to unlock (0,1,2,3)

**Example**

```php
//Unlocks controller 0 of device 12345
LCN_ReleaseTargetValue(12345, 0);
```

## LCN_RemoveGroup

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-removegroup/

`bool LCN_RemoveGroup(int $InstanceID, int $Group)`

removes a device from a group

**Parameters**

- `$InstanceID` (int): Instance ID; the ID of the splitter instance, not the device instance
- `$Group` (int): Group number (0..255)

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Group number (0..255)

**Example**

```php
//The device with ID 12345 is removed from group 123
LCN_RemoveGroup(12345, 123);
```

## LCN_RequestLights

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-requestlights/

`bool LCN_RequestLights(int $InstanceID)`

queries the LEDs of the panel

**Parameters**

- `$InstanceID` (int): ID of the panel to be queried

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the panel to be queried

**Example**

```php
//The LEDs of the panel with ID 12345 are queried
LCN_RequestLights(12345);
```

## LCN_RequestRead

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-requestread/

`bool LCN_RequestRead(int $InstanceID)`

queries the values

**Parameters**

- `$InstanceID` (int): ID of the device to query

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the device to query

**Example**

```php
//Query the device with ID 12345
LCN_RequestRead(12345);
```

## LCN_RequestStatus

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-requeststatus/

`bool LCN_RequestStatus(int $InstanceID)`

queries all statuses of the module

**Parameters**

- `$InstanceID` (int): ID of the module to query

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the module to query

**Example**

```php
// Get all the statuses of the module with ID 12345
LCN_RequestStatus(12345);
```

## LCN_RequestThresholds

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-requestthresholds/

`bool LCN_RequestThresholds(int $InstanceID)`

queries thresholds and hysteresis

**Parameters**

- `$InstanceID` (int): ID of the threshold to query

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the threshold to query

**Example**

```php
//Get the thresholds and hysteresis of threshold 12345
LCN_RequestThresholds(12345);
```

## LCN_SaveScene

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-savescene/

`bool LCN_SaveScene(int $InstanceID, int $Scene)`

saves a scene for an output

**Parameters**

- `$InstanceID` (int): ID of the output to be switched
- `$Scene` (int): Which scene to save in (0..9, 15)

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Which scene to save in (0..9, 15)

**Example**

```php
// Saves scene 5 of the exit with ID 12345
LCN_SaveScene(12345, 5);
```

## LCN_SelectSceneRegister

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-selectsceneregister/

`bool LCN_SelectSceneRegister(int $InstanceID, int $Register)`

selects a register

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Register` (int): Which register should be selected (0..9)

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Which register should be selected (0..9)

**Example**

```php
// Selects register 2 of device with ID 12345
ULCN_SelectSceneRegister(12345, 2);
```

## LCN_SendCommand

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-sendcommand/

`bool LCN_SendCommand(int $InstanceID, string $Function, string $Data)`

**Parameters**

- `$InstanceID` (int): ID of the Instance; the ID of the splitter instance, not the device instance
- `$Function` (string): The first two (2) signs of PCHK command (e.g. A1)
- `$Data` (string): The remaining characters of PCHK command (e.g. DI000000). Any numbers must be sent in the decimal representation (3 characters).

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

The remaining characters of PCHK command (e.g. DI000000). Any numbers must be sent in the decimal representation (3 characters).

**Example**

```php
LCN_SendCommand(12345, "A1", "DI000000"); //Dim output 1 immediately to 0%.
```

## LCN_SetDisplayText

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-setdisplaytext/

`bool LCN_SetDisplayText(int $InstanceID, int $Line, string $Text)`

Shows a text on a line of the display

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Line` (int): Display line between 1..4
- `$Text` (string): Text with a maximum of 60 characters

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Text with a maximum of 60 characters

**Example**

```php
//Shows "Hello World" on line 1 of the display with the InstanceID 12345.
LCN_SetDisplayText(12345, 1, "Hello World");
```

## LCN_SetDisplayTime

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-setdisplaytime/

`bool LCN_SetDisplayTime(int $InstanceID, int $Line, int $DisplayTime)`

sets the display time of a line in the display

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Line` (int): Display line between 1..4
- `$DisplayTime` (int): Time units between 1..30

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Time units between 1..30

**Example**

```php
//Configure line 1 of display instance 12345 to 30 time units
LCN_SetDisplayTime(12345, 1, 30);
```

## LCN_SetIntensity

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-setintensity/

`bool LCN_SetIntensity(int $InstanceID, int $Intensity, int $Ramp)`

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Intensity` (int): 0-100%
- `$Ramp` (int): 0 = Immediately; n = Seconds

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

0 = Immediately; n = Seconds

**Example**

```php
LCN_SetIntensity(12345, 100, 0); //Dim device to 100% immediately
```

## LCN_SetLamp

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-setlamp/

`bool LCN_SetLamp(int $InstanceID, int $Lamp, string $Action)`

switching an LED

**Parameters**

- `$InstanceID` (int): Instance ID; the ID of the splitter instance, not the device instance
- `$Lamp` (int): Selection of the panel lamps to be switched (1..12)
- `$Action` (string): What action to take.

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

What action to take.

**Example**

```php
// Blink panel light 2 of module with ID 12345.
LCN_SetLamp(12345, 2, 'B');
```

## LCN_SetRelay

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-setrelay/

`bool LCN_SetRelay(int $InstanceID, string $Wert)`

sets all relays in a module (8 bit)

**Parameters**

- `$InstanceID` (int): ID of the Instance; the ID of the splitter instance, not the device instance
- `$Wert` (string): 8 times character combination of the following values

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

8 times character combination of the following values

**Example**

```php
LCN_SetRelay(12345, "--1100UU");
```

## LCN_SetRGBW

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-setrgbw/

`bool LCN_SetRGBW(int $InstanceID, int $Red, int $Green, int $Blue, int $White)`

sets an instance to an RGBW color value

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Red` (int): Intensity between 1..100
- `$Green` (int): Intensity between 1..100
- `$Blue` (int): Intensity between 1..100
- `$White` (int): Intensity between 1..100

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Intensity between 1..100

**Example**

```php
//Set instance 12345 to full intensity red.
LCN_SetRGBW(12345, 100, 0, 0, 100);
```

## LCN_SetTargetValue

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-settargetvalue/

`bool LCN_SetTargetValue(int $InstanceID, int $Target, float $Value)`

**Parameters**

- `$InstanceID` (int): ID of the Instance
- `$Target` (int): 0 = Regulator R1; 1 = Regulator R2; 2 = Regulator S1; 3 = Regulator S2
- `$Value` (float): Value

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Value

**Example**

```php
LCN_SetTargetValue(12345, 2, 24.3); //Set Regulator S1 to 24.3°C
```

## LCN_ShiftTargetValue

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-shifttargetvalue/

`bool LCN_ShiftTargetValue(int $InstanceID, int $Target, float $RelativeValue)`

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Target` (int): Which controller should be shifted (0,1,2,3)
- `$RelativeValue` (float): Value by which to shift

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Value by which to shift

**Example**

```php
// Shifts the target value of the controller 1 by -1.7°C
LCN_ShiftTargetValue(12345, 1, -1.7);
```

## LCN_ShutterMove

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-shuttermove/

`bool LCN_ShutterMove(int $InstanceID, int $Position)`

starts shutter movement to percentage position

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Position` (int): Percentage position of the shutter (0-100%)

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Percentage position of the shutter (0-100%)

**Example**

```php
//Roller shutter movement to 80% (20% closed)
LCN_ShutterMove(12345, 80);
```

## LCN_ShutterMoveDown

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-shuttermovedown/

`bool LCN_ShutterMoveDown(int $InstanceID)`

starts a shutter movement downwards

**Parameters**

- `$InstanceID` (int): ID of the device to be switched

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the device to be switched

**Example**

```php
//Start roller shutter downward movement
LCN_ShutterMoveDown(12345);
```

## LCN_ShutterMoveUp

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-shuttermoveup/

`bool LCN_ShutterMoveUp(int $InstanceID)`

starts a shutter movement upwards

**Parameters**

- `$InstanceID` (int): ID of the device to be switched

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the device to be switched

**Example**

```php
//Start roller shutter upward movement
LCN_ShutterMoveUp(12345);
```

## LCN_ShutterStop

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-shutterstop/

`bool LCN_ShutterStop(int $InstanceID)`

stops a shutter movement

**Parameters**

- `$InstanceID` (int): ID of the device to be switched

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the device to be switched

**Example**

```php
//Stop shutter movement
LCN_ShutterStop(12345);
```

## LCN_StartFlicker

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-startflicker/

`bool LCN_StartFlicker(int $InstanceID, string $Flicker, string $Speed, int $FlickerCount)`

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Flicker` (string): G = Low; M = Medium; S = Start
- `$Speed` (string): L = Slow (ca. 0,5x / Sec); M = Medium (ca. 1x / Sec); S = Fast (ca. 2x / Sec)
- `$FlickerCount` (int): Number between 1..15

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Number between 1..15

**Example**

```php
LCN_StartFlicker(12345, "G", "L", 5);
```

## LCN_StopFlicker

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-stopflicker/

`bool LCN_StopFlicker(int $InstanceID)`

**Parameters**

- `$InstanceID` (int): ID of the device to be switched

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the device to be switched

**Example**

```php
LCN_StopFlicker(12345);
```

## LCN_SwitchDurationMin

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-switchdurationmin/

`bool LCN_SwitchDurationMin(int $InstanceID, int $Minutes, string $DimmingTime, bool $Preserving)`

after how many minutes it should be dimmed down

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Minutes` (int): After how many minutes it should be dimmed down
- `$DimmingTime` (string): How fast to dim down
- `$Preserving` (bool): The device is only shut down after the time elapsed if it has not been on before.

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

The device is only shut down after the time elapsed if it has not been on before.

**Example**

```php
// Slowly dim device 12345 after 10 minutes
LCN_SwitchDurationMin(12345, 10, 'L', false);
```

## LCN_SwitchDurationSec

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-switchdurationsec/

`bool LCN_SwitchDurationSec(int $InstanceID, int $Seconds, string $DimmingTime, bool $Preserving)`

after how many seconds it should be dimmed down

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Seconds` (int): After how many seconds it should be dimmed down
- `$DimmingTime` (string): How fast to dim down
- `$Preserving` (bool): The device is only shut down after the time elapsed if it has not been on before.

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

The device is only shut down after the time elapsed if it has not been on before.

**Example**

```php
// Quickly dim device 12345 after 5 seconds
LCN_SwitchDurationSec(12345, 5, 'K', false);
```

## LCN_SwitchMemory

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-switchmemory/

`bool LCN_SwitchMemory(int $InstanceID, int $Ramp)`

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Ramp` (int): Number of seconds, 0 = Immediately

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Number of seconds, 0 = Immediately

**Example**

```php
LCN_SwitchMemory(12345, 0); //Turn off device immediately
```

## LCN_SwitchMode

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-switchmode/

`bool LCN_SwitchMode(int $InstanceID, int $Ramp)`

switches a device on/off

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Ramp` (int): Number of seconds, 0 = Immediately

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Number of seconds, 0 = Immediately

**Example**

```php
LCN_SwitchMode(12345, 0); //Switch device immediately
```

## LCN_SwitchRelay

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-switchrelay/

`bool LCN_SwitchRelay(int $InstanceID, bool $Status)`

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Status` (bool): __TRUE__ for On, __FALSE__ for Off

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

__TRUE__ for On, __FALSE__ for Off

**Example**

```php
LCN_SwitchRelay(12345, true); //Turn on relay
```

## LCN_SwitchRelayTimer

Source: https://www.symcon.de/en/service/documentation/module-reference/devices/lcn/lcn-switchrelaytimer/

`bool LCN_SwitchRelayTimer(int $InstanceID, int $TimeFactor)`

switches a relay on a time factor

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$TimeFactor` (int): Time factor between 1..255

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Time factor between 1..255

**Example**

```php
//Set relay time factor to 255.
LCN_SwitchRelayTimer(12345, 255);
```