Documentation
Devices
1-Wire
Functions for accessing 1-Wire components
| DS2405 | 1-fach Switch | ||||||||||
| |||||||||||
| DS2406 | 2-fach Switch | ||||||||||
| |||||||||||
| DS2408 | 8-fach Switch | ||||||||||
| |||||||||||
| DS2413 | 2-fach Switch | ||||||||||
| |||||||||||
| DS2438 | Smart Battery Monitor | ||||||||||
| DS2450 | A/D-Wandler 16bit | ||||||||||
| |||||||||||
| DS2890 | Digital-Potentiometer 8 bit | ||||||||||
| |||||||||||
| Device List | Device list 1-Wire | ||||||||||
| OW_RequestStatus | Executes a new read for the device with the ID __InstanceID__. | ||||||||||
ABL
Setup of ABL devices
| Device-List |
Alfen
Alfen device setup
| Device List |
ALLNET
Funktionen zur Ansteuerung von ALLNET Komponenten
| ALL_SetAnalog | sets the analog value of a channel |
| ALL_SwitchActor | switches an ALLNET actuator on/off |
| ALL_SwitchMode | Switches the device with the ID __InstanceID__ to value __Status___ |
| ALL_UpdateValues | Executes a update of the state variables for the device with the ID __InstanceID__. |
| Device list | Device list ALLNET |
BACnet
Functions for controlling BACnet components
| BAC_RelinquishPresetValue | Resetting the preset value |
digitalSTROM
Functions for controlling digitalSTROM components
| DS_CallScene | calls up a scene |
| DS_DimSet | dims a digitalSTROM terminal to a specific value |
| DS_MakeRequest | sends a digitalSTROM command directly to the dSS |
| DS_RequestStatus | retrieves the status |
| DS_ShutterMove | moves the roller shutter to a desired position/stop |
| DS_ShutterMoveDown | moves the roller shutter down to the end position/stop |
| DS_ShutterMoveUp | moves the roller shutter up to the end position/stop |
| DS_ShutterStop | stops a motion |
| DS_SwitchMode | switches a digitalSTROM terminal on/off |
| Device list | DigitalSTROM device list |
DMX / ArtNet
Functions for controlling DMX components
| DMX_FadeChannel | Dims the __Channel__ of the device with ID __InstanceID to __Value__ with a certain __FadeTime__ |
| DMX_FadeChannelDelayed | Dims the __Channel__ of the device with ID __InstanceID to __Value__ with a certain __FadeTime__. You can specify a __DelayTime__ after which the dimming starts. |
| DMX_FadeRGB | dims the RGB channel with a fade time |
| DMX_FadeRGBDelayed | dims the RGB channel with a fade time |
| DMX_RequestInfo | Queries the information of a DMX instance |
| DMX_ResetInterface | Sets the DMX interface back with the ID __InstanceID__. It is recommended that in case of problems, create a script with this command and declare it as startup script. - |
| DMX_SetBlackout | Sets all channels of DMX interfaces with ID __InstanceID__ to value __ Status__. |
| DMX_SetChannel | Switches the channel from the device with the ID __InstanceID__ to value __Wert__ |
| DMX_SetRGB | sets the RGB channel to a certain value |
| Device list | Device list DMX |
EgiGeoZone
Receives data from the EgiGeoZone app for Google Android.
ekey
Functions for controlling ekey components
| Device list | Device list eKey |
ekey bionyx
EnOcean
Functions for accessing EnOcean components
| ENO_DimSet | Dims the device with ID __InstanceID__ to value __Intensity__. |
| ENO_SetActiveMessage | activates a certain message |
| ENO_SetFanStage | sets the FanStage to a certain value |
| ENO_SetIntensity | Dims the device with ID __InstanceID__ to value __Intensity__. The value __Status__ indicates whether the device is to be switched on/ off. |
| ENO_SetLockFanStage | locks the FanStage |
| ENO_SetLockRoomOccupancy | locks the occupancy |
| ENO_SetMode | sets the actuator in a certain mode |
| ENO_SetPosition | sets the position of the actuator |
| ENO_SetRoomOccupancy | sets the occupancy to true/false |
| ENO_SetTemperature | sets the actuator to a certain target temperature |
| ENO_SetTemperature1 | sets the device to a certain temperature |
| ENO_ShutterMoveDown | moves the roller shutter down to the end position/stop |
| ENO_ShutterMoveDownEx | moves the roller shutter for a certain time |
| ENO_ShutterMoveUp | moves the roller shutter up to the end position/stop |
| ENO_ShutterMoveUpEx | moves the roller shutter for a certain time |
| ENO_ShutterStop | stops a motion |
| ENO_SwitchMode | Switches the device with ID __InstanceID__ to value __Status__ |
| ENO_SwitchModeEx | Switches the device with ID __InstanceID__ to value __Status__ |
| Device list | Device list EnOcean/EEP |
FHZ1X00PC
Funktionen zur Ansteuerung von FS20, HMS, FHT Komponenten
| FHT | Funk-Heizungssystem | ||||||||||
| |||||||||||
| FS20 | FunkSystem für digitale Geräte | ||||||||||
| |||||||||||
| Device list | Device list FHZ | ||||||||||
| HMS | HouseMessageSystem for analogue devices | ||||||||||
| |||||||||||
| KS300 | Kombisensor Wetterstation | ||||||||||
FS10 Weather
Wetterstation mit Funk auf 433MHz
GARDENA smart system
Module for adding GARDENA smart system devices
| smart Irrigation Control | A GARDENA irrigation control with 6 valves |
| smart SILENO Mower | A smart SILENO Mower from GARDENA |
| smart Power Socket | A power socket from GARDENA |
| smart Pressure Pump | A GARDENA smart Pump with one valve |
| smart Sensor | A GARDENA smart sensor with various measured values |
| smart Water Control | A GARDENA Irrigation Control with one valve |
Geofency
Receives data from the Geofency app for Apple iOS.
Heating Control
Funktionen zur Ansteuerung vom Heizungsmodul zur Regelung von Raumtemperaturen
| HC_TargetValue | Sends via the instance with the ID __ InstanceID__ a target value to the heating module. |
Home Connect
Module for adding Home Connect devices
| Device list | Device list Home Connect |
| Home Connect Device | The device instance created by the Home Connect configurator |
HomeMatic
| Device list | HomeMatic Device List | ||||||||||||||
| HomeMatic CCU | Functions for controlling HomeMatic components | ||||||||||||||
| |||||||||||||||
| HomeMatic HCU (Beta) | |||||||||||||||
Image Grabber
Module for querying webcam images
| IG_UpdateImage | updates the image of the instance |
IPS-868
Functions for controlling IPS868 components
| AKM-868 | Anwesenheitskontrollmodul mitsamt Tracker | ||||||||||
| ANA-868 | Analog-to-digital converter | ||||||||||
| |||||||||||
| EKM-868 | Ein Energiekontrollmodul mit 4-Kanal-Zählermodul mit je 32 Bit | ||||||||||
| |||||||||||
| FD-868 | Ein Funkdisplay mit einem 2*16-stelligen LC-Display | ||||||||||
| |||||||||||
| Device list | Device list IPS 868 | ||||||||||
| JKM-868 LevelJET | A reader for LevelJET level indicator | ||||||||||
| |||||||||||
| JKM-868 ThermoJET | A reader for individual values of the ThermoJET temperature controller | ||||||||||
| |||||||||||
| LGS-868 | Air quality sensor for room air analysis | ||||||||||
| |||||||||||
| RGBW-868 | Steuergerät für LED-RGBW-Stripes | ||||||||||
| |||||||||||
| SERVO-868 | A 4-way servo control module | ||||||||||
| |||||||||||
| WDT-868 | Ein Watch-Dog-Timer zur Überwachung des Systems | ||||||||||
| |||||||||||
IR Trans
Funktionen zur Ansteuerung von Infrarot Komponenten
| Device list | Device list IR-Trans |
| IRT_SendOnce | sendet einen IR Befehl |
KEBA
| Device List |
KNX
Functions for controlling KNX components
| EIB_Char | Sends a single letter |
| EIB_Counter8Bit | sends an 8-bit counter value |
| EIB_Counter16Bit | sends a 16bit counter value |
| EIB_Counter32bit | sends a 32bit counter value |
| EIB_Date | sends the date value |
| EIB_DimControl | Sends a dim value date __Value__ to the device with the ID __InstanceID__. Depending on the configuration 0..15 (Standard) or -7..7 (Enhanced) can be sent. |
| EIB_DimValue | Sends the dim value __Value__ to the device with the ID __InstanceID__. Depending on configuration 0..255 (Standard) or 0..100 (Percent) will be passed as the value parameter. |
| EIB_DriveBladeValue | Sends the position value __Value__ to the device with the ID __InstanceID__. Depending on configuration 0..255 (Standard) or 0..100 (Percent) will be passed as the value parameter. |
| EIB_DriveMove | Moving the device with ID __InstanceID__ in a particular __Direction__. Depending on configuration the movement direction can be inverted. - |
| EIB_DriveShutterValue | Sends the position value __Vert__ to the device with the ID __InstanceID__. Depending on configuration 0..255 (Standard) or 0..100 (Percent) will be passed as the value parameter. |
| EIB_DriveStep | Moving the device __Stepwise__ with ID __InstanceID__ into a determined __Direction__. Depending on the configuration, the movement direction can be inverted. |
| EIB_FloatValue | sends a float value |
| EIB_Move | moves a roller shutter |
| EIB_Position | moves a roller shutter to a position |
| EIB_PriorityControl | sets a device state |
| EIB_PriorityPosition | Sets the device with ID __InstanceID__ to a certain __Direction__. Depending on configuration the direction can be inverted. |
| EIB_RequestStatus | sends a read request for EIB instances to the bus |
| EIB_Scale | Sends the Value __Value__ to the device with the ID __InstanceID__. Depending on configuration 0..255 (Standard) or 0..100 (Percent) will be passed as the value parameter. |
| EIB_SetRGB | sets an RGB stripe to a specific color |
| EIB_SetRGBW | sets an RGBW stripe to a specific color |
| EIB_Str | sends a text |
| EIB_Switch | Switches the device with the ID __InstanceID__ to value __Status__ |
| EIB_Time | sends a time value |
| EIB_Value | Sends the value __Value__ to the device with ID __InstanceID__. |
| Device list | Device list EIB/KNX |
| KNX_RequestStatus | sends a read request for DPT instances on the bus |
LCN
Functions for controlling LCN components
| Device list | Device list LCN |
| LCN_AddGroup | adds a device to a group |
| LCN_AddIntensity | Dims the device with ID __InstanceID__ brighter by the value __Intensity__. |
| LCN_AddThresholdCurrent | adds threshold to current value |
| LCN_AddThresholdDefined | adds threshold to predefined value |
| LCN_Beep | Lets the instance with the ID __InstanceID__ beep |
| LCN_DeductIntensity | Dims the device with ID __InstanceID__ darker by the value __Intensity__. |
| LCN_DeductThresholdCurrent | deducts threshold from current value |
| LCN_DeductThresholdDefined | deducts threshold from predefined value |
| LCN_FadeOut | Dims the devive with ID __InstanceID__ to value __Intensity__ and dims then with the __Ramp__ seconds down to 0%. |
| LCN_FlipRelay | Switches over the relay with the ID __InstanceID__ |
| LCN_LimitOutput | limits an output for a certain period of time |
| LCN_LoadScene | calls up a scene for an output |
| LCN_LockTargetValue | locks a controller of the device |
| LCN_RampStop | Stops the dimming process of the device with the ID __InstanceID__ |
| LCN_ReleaseTargetValue | unlocks a controller of the device |
| LCN_RemoveGroup | removes a device from a group |
| LCN_RequestLights | queries the LEDs of the panel |
| LCN_RequestRead | queries the values |
| LCN_RequestStatus | queries all statuses of the module |
| LCN_RequestThresholds | queries thresholds and hysteresis |
| LCN_SaveScene | saves a scene for an output |
| LCN_SelectSceneRegister | selects a register |
| LCN_SendCommand | Sends a custom command to the instance with the ID __InstanceID__. For possible commands, refer to the PCHK documentation. If you do not have this, you can possibly refer to your dealer. We do not provide this option. |
| LCN_SetDisplayText | Shows a text on a line of the display |
| LCN_SetDisplayTime | sets the display time of a line in the display |
| LCN_SetIntensity | Dims the device with the ID __InstanceID__ to value __Intensity__ in __Ramp__ seconds. |
| LCN_SetLamp | switching an LED |
| LCN_SetRelay | setzt alle Relais in einem Modul (8Bit) |
| LCN_SetRGBW | sets an instance to an RGBW color value |
| LCN_SetTargetValue | Sets the regulator __Target__ of the instance with the ID __InstanceID__ to the value __Value__ |
| LCN_ShiftTargetValue | Shifts the current target value |
| LCN_ShutterMove | starts shutter movement to percentage position |
| LCN_ShutterMoveDown | starts a shutter movement downwards |
| LCN_ShutterMoveUp | starts a shutter movement upwards |
| LCN_ShutterStop | stops a shutter movement |
| LCN_StartFlicker | Let the device with the ID __InstanceID__ flicker |
| LCN_StopFlicker | Stop flickering of the device with the ID __InstanceID__ immediately |
| LCN_SwitchDurationMin | after how many minutes it should be dimmed down |
| LCN_SwitchDurationSec | after how many seconds it should be dimmed down |
| LCN_SwitchMemory | Switches the device with the ID __InstanceID__to a stored value |
| LCN_SwitchMode | schaltet ein Gerät an/aus |
| LCN_SwitchRelay | Switches the relay with the ID __InstanceID__ to value __Status__ |
| LCN_SwitchRelayTimer | switches a relay on a time factor |
LJQuick
The KNX quick (Lingg&Janke) module supports the setup of KNX instances.
| LJ_SendDateTime | Sends the current date/time to the KNX bus |
M-Bus
Functions for controlling M-Bus components
| Device list | Device list M-Bus |
| MBUS_UpdateValues | updates all device-specific values |
Mennekes
Mennekes device setup
| Device List |
Modbus RTU/TCP
Functions for controlling ModBus RTU/TCP components
| Device list | Device list ModBus RTU/TCP |
| ModBus_RequestRead | Executes a new read for the device with the ID __InstanceID__. |
| ModBus_WriteCoil | Sets address with ID __InstanceID__ to __Value__ |
| ModBus_WriteRegister | writes a value to the write address |
| ModBus_WriteRegisterByte | Sets address with ID __InstanceID__ to __Value__ |
| ModBus_WriteRegisterChar | Sets address with ID __InstanceID__ to __Value__ |
| ModBus_WriteRegisterDWord | Sets address with ID __InstanceID__ to __Value__ |
| ModBus_WriteRegisterInt64 | Sets address with ID __InstanceID__ to __Value__ |
| ModBus_WriteRegisterInteger | Sets address with ID __InstanceID__ to __Value__ |
| ModBus_WriteRegisterReal | Sets address with ID __InstanceID__ to __Value__ |
| ModBus_WriteRegisterReal64 | Sets address with ID __InstanceID__ to __Value__ |
| ModBus_WriteRegisterShort | Sets address with ID __InstanceID__ to __Value__ |
| ModBus_WriteRegisterString | Sets address with ID __InstanceID__ to __Value__ |
| ModBus_WriteRegisterWord | Sets address with ID __InstanceID__ to __Value__ |
Möhlenhoff Alpha 2
Receiving and switching Möhlenhoff Alpha2 data
| MA2_RequestStatus | Gets the values stored in the Alpha2 with the InstanceID and sets the associated variables. |
| MA2_WriteValue | Writes the Value into the variable with the Ident in the Möhlenhoff Alpha 2 with the InstanceID. |
MQTT
Functions for controlling MQTT components
| Device list | Device list MQTT |
| MQTT Client | Functions for controlling MQTT Client |
| MQTT-Server | Functions for controlling MQTT Server |
NEA Smart
Receiving and switching NEA Smart data
| NEAS_RequestStatus | Gets the values stored in the NEA Smart with the InstanceID and sets the associated variables. |
| NEAS_WriteValue | Writes the Value to the variable with the ident in the NEA Smart with the InstanceID. |
OCPP
Über das OCPP Protokoll können Wallboxen bequem über Symcon überwacht und geschaltet werden.
| OCPP_RemoteStartTransaction | If the status is 'Preparing' or 'Finishing', loading can be enabled by this command. |
| OCPP_RemoteStopCurrentTransaction | If the state is 'Charging', this command can be used to stop charging. |
| OCPP_RemoteStopTransaction | If the state is 'Charging', this command can be used to stop charging. |
OPC UA
Functions for controlling OPC UA components
SageGlass (BACnet)
Integrates the SageGlass SIM II (BACnet) with IP-Symcon
Shutter Control
Functions for controlling shutter (roller shutter) components
| SC_Move | bewegt den Rollladen an eine bestimmte Position |
| SC_MoveDown | bewegt den Rollladen bis zu Endposition runter |
| SC_MoveUp | bewegt den Rollladen bis zu Endposition hoch |
| SC_Stop | stoppt einen Bewegungsvorgang |
Siemens OZW
Funktionen zur Ansteuerung von Siemens OZW Komponenten
| Device list | Device list Siemens OZW |
| OZW_RequestStatus | requests the status of a device |
| OZW_WriteDataPoint | writes a specific value to a data point |
SNMP
Show values for any OIDs of a walk. Optionally, these can be created and described as variables.
| SNMP_UpdateValues | Updates the variable values which are below the instance. |
Snom
Integration of Snom IP phones
PLC: Siemens, Vipa, Logo
Functions for controlling Siemens/Vipa/Logo PLC components
| Device list | Device list SPS Siemens/Vipa |
| Logo-VM-Addresses | VM addresses of Logo7/8 |
| S7_RequestRead | performs a read operation on a device |
| S7_Write | writes a value to the configured address |
| S7_WriteBit | Set the address with the ID __InstanceID__ to value status |
| S7_WriteByte | Set the address with the ID __InstanceID__ to __Value__ |
| S7_WriteChar | Set the address with the ID __InstanceID__ to __Value__ |
| S7_WriteDWord | Set the address with the ID __InstanceID__ to __Value__ |
| S7_WriteInteger | Set the address with the ID __InstanceID__ to __Value__ |
| S7_WriteReal | Set the address with the ID __InstanceID__ to __Value__ |
| S7_WriteShort | Set the address with the ID __InstanceID__ to __Value__ |
| S7_WriteWord | Set the address with the ID __InstanceID__ to __Value__ |
PLC: Wago, Beckhoff, ABB
Functions for controlling Wago/Beckhoff PLC components
Sync Remote
Synchronization between two Symcon systems
Technische Alternative
Functions for controlling Technische Alternative components
| Device list | Device list Technische Alternative |
Voice over IP
Functions for controlling VoIP
| Device list | Device list Voice over IP |
| VoIP_AcceptCall | accepts a connection |
| VoIP_Connect | establishes a connection |
| VoIP_Disconnect | terminates a connection |
| VoIP_GetConnection | returns information about a connection |
| VoIP_GetData | returns data of a connection |
| VoIP_PlayWave | plays a wave file |
| VoIP_RejectCall | rejects a connection |
| VoIP_SendDTMF | sends a sequence of characters as DTMF |
| VoIP_SetData | sets the data of a connection |
WinLIRC
Funktionen zum Ansteuern von WinLIRC Komponenten
| WinLIRC_SendOnce | Sends a remote command on the instance with ID __InstanceID__. The values remote control and button specify, which command should be sent. These must be set up accordingly in the client software (WinLIRC/ IRTrans Tray). |
Wireless M-Bus
Functions for controlling wireless M-Bus components
| Device list | Wireless M-Bus device list |
WMRS200
Functions for controlling WMRS200 components
| Device list | Device list WMRS200 |
W&T
Functions for controlling W&T components
| WUT_SwitchMode | Switches the channel with ID __InstanceID__ to value __Status__. |
XBee
Functions for controlling XBee
| XBee_SendBuffer | sends a data string to a specific device |
| XBee_SendCommand | sends a command to a specific XBee-Splitter |
Eaton xComfort
Funktionen zur Ansteuerung von xComfort Komponenten
| Device list | Device list Eaton xComfort |
| MXC_DimBrighter | fängt einen Dimmvorgang auf eine hellere Stufe an |
| MXC_DimDarker | fängt einen Dimmvorgang auf eine dunklere Stufe an |
| MXC_DimSet | dimmt ein xComfort Gerät auf eine bestimmte Stufe |
| MXC_DimStop | hält einen Dimmvorgang an |
| MXC_RequestStatus | sende eine Statusmeldungsanfrage an ein Gerät |
| MXC_SendBoolean | Sends a boolean value to the instance with ID __InstanceID__, which is connected to a room manager. |
| MXC_SendFloat | Sends a float to the instance with ID __InstanceID__, which is connected to a room manager. |
| MXC_SendInteger | Sends a boolean value to the instance with ID __InstanceID__, which is connected to a room manager. |
| MXC_SetTemperature | Sets the new target temperature of the control valve with the ID __InstanceID__ to the new __Temperature__. |
| MXC_ShutterMoveDown | bewegt den Rollladen nach unten bis zur Endposition/Stop |
| MXC_ShutterMoveUp | bewegt den Rollladen nach oben bis zur Endposition/Stop |
| MXC_ShutterStepDown | bewegt den Rollladen ein Stück nach unten |
| MXC_ShutterStepUp | bewegt den Rollladen ein Stück nach oben |
| MXC_ShutterStop | stoppt einen Bewegungsvorgang |
| MXC_SwitchMode | schaltet ein xComfort Gerät an/aus |
Z-Wave
Functions for controlling Z-Wave components
| Device list | Device list Z-Wave |
| ZW_Basic | Turns the basic function of the specified device with InstanceID __InstanceID__ |
| ZW_ColorCW | sets the cold-white channel of a RGBWW Z-Wave device |
| ZW_ColorRGB | sets the color of a Z-Wave device |
| ZW_ColorRGBWW | sets the colors and intensity of an RGBWW Z-Wave device |
| ZW_ColorWW | sets the WarmWhite channel of a Z-Wave device |
| ZW_DimDown | starts dimming down |
| ZW_DimDownEx | starts dimming down with a runtime |
| ZW_DimSet | dimmt ein Z-Wave Gerät auf eine bestimmte Stufe |
| ZW_DimSetEx | dims a Z-Wave device to a specific level within a runtime |
| ZW_DimStop | stops dimming a Z-Wave device |
| ZW_DimUp | starts dimming up |
| ZW_DimUpEx | starts dimming up within a runtime |
| ZW_DoorLockOperation | Sets the door lock operation mode of a Z-Wave device |
| ZW_LockMode | sets the LockMode |
| ZW_MeterReset | resets the meter |
| ZW_Optimize | Starts the wireless network optimization process for a Z-Wave device |
| ZW_ProtectionSet | sets the Protection and its Mode |
| ZW_RequestStatus | Queries the status from the device with the ID __InstanceID__. Only power-operated devices can be queried directly by command, because battery-operated devices do not permanently listen to the queries. |
| ZW_ShutterMoveDown | Moves the shutter with the ID __InstanceID__ downwards until (link: page://f1hDSVmdoBuVvjEW text: MXC_ShutterStop) is running or the end position is reached. |
| ZW_ShutterMoveUp | Moves the shutter with the ID __InstanceID__ upwards until (link: page://f1hDSVmdoBuVvjEW text: MXC_ShutterStop) is running or the end position is reached. |
| ZW_ShutterStop | Stops a current movement of the shutter. |
| ZW_SwitchAllMode | Sets the Switch All mode of a Z-Wave device |
| ZW_SwitchMode | schaltet ein Z-Wave Gerät an/aus |
| ZW_Test | Tests if a connection to a Z-Wave device is working |
| ZW_ThermostatFanModeSet | Sets the FanMode for the thermostat |
| ZW_ThermostatModeSet | Sets the thermostat mode |
| ZW_ThermostatSetPointSet | Sets the PointSet Value |
Zevvy
Sends data to a Zevvy account
| ZY_SendMeasurements | Sends the data of the set up variables to a Zevvy account |