« Back to Product

Documentation

Module Reference

Warning

The Product Page describes what IP-Symcon is.
A table with all supported systems is listed at Interfaces.

In the Module Reference, natively supported modules are shown. In the corresponding module references, tutorials, examples, and Tips & Tricks for the respective system.
Furthermore, the module specific commands are listed.

Warning

For a list of IP Symcon specific commands, see the Command Reference.

1-Wire

Functions for accessing 1-Wire components

DS24051-fach Switch
OW_SwitchModeSets the state of the device with the ID __InstanceID__ to value __Status__.
OW_ToggleModeChanges the state of the device with the ID __InstanceID__. The current value can be queried in the state variable after the operation. -
DS24062-fach Switch
OW_SetPinSets the state of the device with the ID __InstanceID__ to value __Status__
DS24088-fach Switch
OW_SetPinsets a pin from the DS2408 to on/ off
OW_SetPortSets the state of all eight pins on the value of __Bitmask__ of the device with ID __InstanceID__
OW_SetStrobeMakes it possible to put the RSTZ-pin of DS2408 of the device with ID __InstanzID__ to value __Status__
OW_WriteBytesSets a sequence of bytes (__Data__) from all pins of the device with the ID __InstanceID__.
OW_WriteBytesMaskedSets a sequence of bytes (__Data__) taking into account a bitmask __Mask__ from all pins of the device with the ID __InstanceID__.
DS24132-fach Switch
OW_SetPinSets the state of the pin __Pin__ of the device with the ID __InstanceID__ to value __Status__
DS2438Smart Battery Monitor
DS2450A/D-Wandler 16bit
OW_SetPinSets the state of the pin __Pin__ of the device with the ID __InstanceID__ to value __Status__
DS2890Digital-Potentiometer 8 bit
OW_SetPositionSets the device with the ID __InstanceID__ to value __Value__
Device ListDevice list 1-Wire
OW_RequestStatusExecutes a new read for the device with the ID __InstanceID__.

ABL

Setup of ABL devices

Device-List

Active List

Overview of all active variables in the WebFront

AL_SwitchOffSwitches all active variables in the list to inactive.

Alerting

Triggers an alarm when one of the sensor variables becomes active.

ARM_GetLastAlertID
ARM_SetActive
ARM_SetAlert

Alfen

Alfen device setup

Device List

ALLNET

Funktionen zur Ansteuerung von ALLNET Komponenten

ALL_SetAnalogsets the analog value of a channel
ALL_SwitchActorswitches an ALLNET actuator on/off
ALL_SwitchModeSwitches the device with the ID __InstanceID__ to value __Status___
ALL_UpdateValuesExecutes a update of the state variables for the device with the ID __InstanceID__.
Device listDevice list ALLNET

Amazon Alexa

Module to connect Amazon Alexa

Expert OptionsExpert Options of Amazon Alexa
TelevisionSpeaker in Amazon Alexa
Generic SwitchGeneric Switches in Amazon Alexa
Generic SliderGeneric Sliders in Amazon Alexa
SpeakerSpeaker in Amazon Alexa
Speaker (Muteable)Speaker in Amazon Alexa
Light (Dimmer)Light in Amazon Alexa, that can be dimmed
Light (Expert)Expert light in Amazon Alexa
Light (Color)Colored Light in Amazon Alexa
Light (Switch)Light in Amazon Alexa, that can be switched on or off
MediaplayerMediaplayer in Amazon Alexa
ShuttersShutters in Amazon Alexa
LockLocks in Amazon Alexa
ScenesScenes in Amazon Alexa
Scenes (deactivatable)Deactivatable Scenes in Amazon Alexa
Temperature SensorTemperature Sensors in Amazon Alexa
ThermostatThermostats in Amazon Alexa

Presence Simulation

Simulate presence via logged values

AS_SetSimulationDe-/Activate the presence simulation

Work Efficiency

Efficiency calculation

ARZ_CalculationCalculates the efficiency

Archive Control

Funktionen zur Verwaltung des Datenloggings

AC_SetCompaction
AC_AddLoggedValuesadds further data records to a logged variable
AC_ChangeVariableIDmigrates the data of a variable into a variable that has not yet been logged
AC_DeleteVariableDatadeletes all data records of a logged variable in a certain period of time
AC_GetAggregatedValuesgets aggregated data from the archive
AC_GetAggregationTypeindicates the aggregation type of a variable
AC_GetAggregationVariablesreturns an array of all logged variables
AC_GetCounterIgnoreZerosgets the status whether zeros and negative values are ignored
AC_GetGraphStatusasks whether a variable is being visualized
AC_GetLoggedValuesgets raw data from the Archive Control
AC_GetLoggingStatusasks whether a variable is logged
AC_ReAggregateVariablestarts the re-aggregation of a variable
AC_SetAggregationTypesets the aggregation type of a variable
AC_SetCounterIgnoreZerossets the status whether zeros and negative values are ignored
AC_SetGraphStatussets the property for the visualization of a variable
AC_SetLoggingStatussets the property for logging a variable
Data Format

Backup

Creates a backup via SFTP, FTP or FTPS

SB_CreateBackupCreates or updates a backup

BACnet

Functions for controlling BACnet components

Notification

Enables multi-level notification, with the level increasing after a defined time and resetting when acknowledged.

BN_IncreaseLevel
BN_Reset
BN_SetNotifyLevel

Operating Hours Counter

Determines and displays the operating time of a device

BSZ_Calculate

Image Archive

The module copies an image when triggered by a selected variable.

BA_AddImageCopies the current source image to the "Images" category of the "ImageArchive" module with the InstanceID.

Calendar Control

Calendar module

Connect Control

Connection module used to enable a secure connection from the outside

Countdown

CSV ZIP Export

Exports aggregated values of a variable as a CSV file in a ZIP archive

CSV_DeleteZipRemoves the generated file.
CSV_ExportCreates a zip archive based on the given parameters.
CSV_SendMailSends a mail through an SMTP instance with a generated zip file

Cutter

Cutter_ClearBufferclears the buffer of the cutter instance

digitalSTROM

Functions for controlling digitalSTROM components

DS_CallScenecalls up a scene
DS_DimSetdims a digitalSTROM terminal to a specific value
DS_MakeRequestsends a digitalSTROM command directly to the dSS
DS_RequestStatusretrieves the status
DS_ShutterMovemoves the roller shutter to a desired position/stop
DS_ShutterMoveDownmoves the roller shutter down to the end position/stop
DS_ShutterMoveUpmoves the roller shutter up to the end position/stop
DS_ShutterStopstops a motion
DS_SwitchModeswitches a digitalSTROM terminal on/off
Device listDigitalSTROM device list

DMX / ArtNet

Functions for controlling DMX components

DMX_FadeChannelDims the __Channel__ of the device with ID __InstanceID to __Value__ with a certain __FadeTime__
DMX_FadeChannelDelayedDims 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_FadeRGBdims the RGB channel with a fade time
DMX_FadeRGBDelayeddims the RGB channel with a fade time
DMX_RequestInfoQueries the information of a DMX instance
DMX_ResetInterfaceSets 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_SetBlackoutSets all channels of DMX interfaces with ID __InstanceID__ to value __ Status__.
DMX_SetChannelSwitches the channel from the device with the ID __InstanceID__ to value __Wert__
DMX_SetRGBsets the RGB channel to a certain value
Device listDevice list DMX

DNS-SD Control

manages established Bonjour services

ZC_QueryServicerequests information from a single service
ZC_QueryServiceTyperequests information from services of a certain type
ZC_QueryServiceTypesQueries all the services that have been set up

Dummy Module

Platzhalter Modul zur Darstellung als Instanz im WebFront

Announcement

The 'Announcement' Module provides the ability to play audio generated by AWS Polly through Sonos or Media Player.

DS_PlayPlays the text as an announcement.

EgiGeoZone

Receives data from the EgiGeoZone app for Google Android.

Egg Timer

An egg timer that runs for a certain amount of time and can be rewound at any time. Ideal for use in events and scripts.

ekey

Functions for controlling ekey components

Device listDevice list eKey

ekey bionyx

Energy Consumption Optimizer

Modules, which switches the loads on and off when energy is left.

Energy Distribution

Energy Counter

Calculates the consumption

Energy Counter PulseConverts meter values to instantaneous consumption.
EZI_UpdateUpdates the calculated values of the 'Energy Counter Pulse'-module with the InstanceID InstanceID.
Energy Counter PowerCalculates instantaneous and cumulative power consumption from current/power.
EZS_UpdateUpdates the calculated values of the Energy Counter Power module with the InstanceID.

EnOcean

Functions for accessing EnOcean components

ENO_DimSetDims the device with ID __InstanceID__ to value __Intensity__.
ENO_SetActiveMessageactivates a certain message
ENO_SetFanStagesets the FanStage to a certain value
ENO_SetIntensityDims the device with ID __InstanceID__ to value __Intensity__. The value __Status__ indicates whether the device is to be switched on/ off.
ENO_SetLockFanStagelocks the FanStage
ENO_SetLockRoomOccupancylocks the occupancy
ENO_SetModesets the actuator in a certain mode
ENO_SetPositionsets the position of the actuator
ENO_SetRoomOccupancysets the occupancy to true/false
ENO_SetTemperaturesets the actuator to a certain target temperature
ENO_SetTemperature1sets the device to a certain temperature
ENO_ShutterMoveDownmoves the roller shutter down to the end position/stop
ENO_ShutterMoveDownExmoves the roller shutter for a certain time
ENO_ShutterMoveUpmoves the roller shutter up to the end position/stop
ENO_ShutterMoveUpExmoves the roller shutter for a certain time
ENO_ShutterStopstops a motion
ENO_SwitchModeSwitches the device with ID __InstanceID__ to value __Status__
ENO_SwitchModeExSwitches the device with ID __InstanceID__ to value __Status__
Device listDevice list EnOcean/EEP

Event Control

Module to start scripts on set events

Done Notifier

Reports after a dead time, after a device has fallen below a certain consumption.

FHZ1X00PC

Funktionen zur Ansteuerung von FS20, HMS, FHT Komponenten

FHTFunk-Heizungssystem
FHT_SetModeSets the new desired mode for the FHT with ID __InstanzID__ to value __Mode__.
FHT_SetTemperatureSets the new desired temperature for the FHT with ID __InstanzID__ to value __Temperature__.
FS20FunkSystem für digitale Geräte
FS20_DimDownDims the device with ID __InstanceID__ down a level.
FS20_DimUpDims the device with ID __InstanceID__ up a level.
FS20_SetIntensityDims the device with ID __InstanceID__ to value __Intensity__ in __Duration__ seconds.
FS20_SwitchDurationSwitches the device with ID __InstanceID__ to value __Status__ in __Duration__ seconds.
FS20_SwitchModeSwitches the device with ID __InstanceID__ to value __Status__.
Device listDevice list FHZ
HMSHouseMessageSystem for analogue devices
HMS_ReleaseFITriggers the FI over the HMS device with ID __InstanceID__. The __TriggerDelay__ parameter is specified in seconds.
KS300Kombisensor Wetterstation

FS10 Weather

Wetterstation mit Funk auf 433MHz

GARDENA smart system

Module for adding GARDENA smart system devices

smart Irrigation ControlA GARDENA irrigation control with 6 valves
smart SILENO MowerA smart SILENO Mower from GARDENA
smart Power SocketA power socket from GARDENA
smart Pressure PumpA GARDENA smart Pump with one valve
smart SensorA GARDENA smart sensor with various measured values
smart Water ControlA GARDENA Irrigation Control with one valve

Geofency

Receives data from the Geofency app for Apple iOS.

Google Assistant

Module to connect Google Assistant

Expert OptionsExpert Options of Google Assistant
Generic SwitchGeneric Switches in Google Assistant
Light (Dimmer)Light in Google Assistant, that can be dimmed
Light (Expert)Expert light in Google Assistant
Light (Color)Colored Light in Google Assistant
Light (Switch)Light in Google Assistant, that can be switched on or off
ShutterShutters in Google Assistant
ScenesScenes in Google Assistant
Scenes (deactivatable)Deactivatable Scenes in Google Assistant
ThermostatThermostats in Google Assistant

Group Control

With the help of the 'Group Control', variables can be switched together in groups.

Heating Control

Funktionen zur Ansteuerung vom Heizungsmodul zur Regelung von Raumtemperaturen

HC_TargetValueSends via the instance with the ID __ InstanceID__ a target value to the heating module.

Home Connect

Module for adding Home Connect devices

Device listDevice list Home Connect
Home Connect DeviceThe device instance created by the Home Connect configurator

HomeMatic

Functions for controlling HomeMatic components

BidCos ServiceBidCos Service Setup
Device listHomeMatic Device List
HM_ReadServiceMessagesReads the service news of the CCU/ LAN adapter with the ID __InstanceID__.
HM_RequestStatusR
HM_WriteValueBooleanSets the __Parameter__ of the device with ID __InstanceID__ to value __Value__.
HM_WriteValueFloatS
HM_WriteValueIntegerSets the __Parameter__ of the device with ID __InstanceID__ to value __Value__.
HM_WriteValueStringS

Image Grabber

Module for querying webcam images

IG_UpdateImageupdates the image of the instance

IMAP

Funktionen zum IMAP-Modul zur Abfrage von E-Mails

IMAP_DeleteMaildeletes a mail with a specific e-mail(UID)
IMAP_GetCachedMailsThe command returns an array containing information about the cached emails of an IMAP instance with ID __InstanceID__. Should the instance not exist, an alert is generated.
IMAP_GetMailExThis command loads an email with the UID __UID__ from the IMAP instance with ID __InstanceID__ and returns an array containing the data of the e-mail. Should the instance or an e-mail with the given UID not exist, an alert is generated.

I/O

Functions for managing I/O Instances

Client SocketTCP interface
CSCK_SendTextsends a string to the I/O
HIDHID interface
HID_SendEventsends a string to the I/O
HTTP ClientInterface for reading websites out
WWW_UpdatePagelets you query the configured URL
Multicast SocketMulticast interface
MSCK_SendTextsends a string to the I/O
Serial PortSerial interface
SPRT_SendTextsends a string to the I/O
SPRT_SetBreakswitches the break of a serial port instance
SPRT_SetDTRswitches the DTR of a serial port instance
SPRT_SetRTSswitches the RTS of a serial port instance
Server Sent Event ClientTCP interface
Server Socketopens a port for the network
SSCK_SendPacketsends a string to the I/O
SSCK_SendTextsends a string to the I/O
UDP SocketUDP interface
USCK_SendPacketsends a string to the I/O
USCK_SendTextsends a string to the I/O
Virtual I/OVirtual I/O interface
VIO_Connectsends a Connect Data-Packet
VIO_Disconnectsends a Disconnect Data-Packet
VIO_GetPacketListsupplies an array of extended Data-Packets
VIO_GetTextListreturns an array of simple Data-Packets
VIO_PushPacketsends an extended Data-Packet
VIO_PushPacketHEXsends an extended Data-Packet
VIO_PushTextsends a simple Data-Packet
VIO_PushTextHEXsends a simple Data-Packet
VIO_SendPacketsends an extended Data-Packet to itself
VIO_SendTextsends a simple Data-Packet to itself
WebSocket ClientTCP interface
WSC_SendMessagesends a message using the WebSocket

IPS-868

Functions for controlling IPS868 components

AKM-868Anwesenheitskontrollmodul mitsamt Tracker
ANA-868Analog-to-digital converter
PJ_RequestStatusQuery the status of variables and set them
PJ_SetVoltageSets the output to a specific voltage
EKM-868Ein Energiekontrollmodul mit 4-Kanal-Zählermodul mit je 32 Bit
PJ_RequestStatusQueries the current values ​​for the device with the ID __InstanceID__ and writes it to the appropriate state variables. [
FD-868Ein Funkdisplay mit einem 2*16-stelligen LC-Display
PJ_Backlightturns the display backlight on or off
PJ_Beepgibt ein Tonsignal aus
PJ_LCDTextsendet einen Text an das Display
PJ_SwitchLEDschaltet einen LED vom Display
PJ_SwitchModeschaltet ein FS20 Gerät ein/aus
Device listDevice list IPS 868
JKM-868 LevelJETA reader for LevelJET level indicator
PJ_RequestStatusQuery the status of variables and set them
JKM-868 ThermoJETA reader for individual values of the ThermoJET temperature controller
PJ_RequestStatusQuery the status of variables and set them
LGS-868Air quality sensor for room air analysis
PJ_RequestStatusQuery the status of variables and set them
PJ_SetLEDsswitches LEDs on the AirQualitySensor
RGBW-868Steuergerät für LED-RGBW-Stripes
PJ_DimRGBWSends a dimming command to the RGBW-868 controller of the ID __InstanceID__.
PJ_RunProgramSends a program command to the RGBW-868 controller of the ID __InstanceID__.
PJ_SetRGBWsets a color value
SERVO-868A 4-way servo control module
PJ_DimServoincrementally sets a servo value
PJ_SetServosets a servo channel
WDT-868Ein Watch-Dog-Timer zur Überwachung des Systems
PJ_SwitchDurationSwitches the relay from the WDT with ID __InstanceID__ to value __Status__ for __Duration__ seconds.
PJ_SwitchModeSends a switching command to the WDT-868 module of the ID __InstanceID__.

IR Trans

Funktionen zur Ansteuerung von Infrarot Komponenten

Device listDevice list IR-Trans
IRT_SendOncesendet einen IR Befehl

JSON Decoder

Decodes JSON and makes the content available in variables

JSONExporter

Exports any variable in a user-defined structure via an HTTP endpoint.

Tile Visualization

Functions to control the tile visualization on the client devices

VISU_PostNotificationsends a push notification to the tile visualization
VISU_PostNotificationExsends a push notification to the tile visualization

KEBA

KNX

Functions for controlling KNX components

EIB_CharSends a single letter
EIB_Counter8Bitsends an 8-bit counter value
EIB_Counter16Bitsends a 16bit counter value
EIB_Counter32bitsends a 32bit counter value
EIB_Datesends the date value
EIB_DimControlSends 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_DimValueSends 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_DriveBladeValueSends 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_DriveMoveMoving the device with ID __InstanceID__ in a particular __Direction__. Depending on configuration the movement direction can be inverted. -
EIB_DriveShutterValueSends 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_DriveStepMoving the device __Stepwise__ with ID __InstanceID__ into a determined __Direction__. Depending on the configuration, the movement direction can be inverted.
EIB_FloatValuesends a float value
EIB_Movemoves a roller shutter
EIB_Positionmoves a roller shutter to a position
EIB_PriorityControlsets a device state
EIB_PriorityPositionSets the device with ID __InstanceID__ to a certain __Direction__. Depending on configuration the direction can be inverted.
EIB_RequestStatussends a read request for EIB instances to the bus
EIB_ScaleSends 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_SetRGBsets an RGB stripe to a specific color
EIB_SetRGBWsets an RGBW stripe to a specific color
EIB_Strsends a text
EIB_SwitchSwitches the device with the ID __InstanceID__ to value __Status__
EIB_Timesends a time value
EIB_ValueSends the value __Value__ to the device with ID __InstanceID__.
Device listDevice list EIB/KNX
KNX_RequestStatussends a read request for DPT instances on the bus

LCN

Functions for controlling LCN components

Device listDevice list LCN
LCN_AddGroupadds a device to a group
LCN_AddIntensityDims the device with ID __InstanceID__ brighter by the value __Intensity__.
LCN_AddThresholdCurrentadds threshold to current value
LCN_AddThresholdDefinedadds threshold to predefined value
LCN_BeepLets the instance with the ID __InstanceID__ beep
LCN_DeductIntensityDims the device with ID __InstanceID__ darker by the value __Intensity__.
LCN_DeductThresholdCurrentdeducts threshold from current value
LCN_DeductThresholdDefineddeducts threshold from predefined value
LCN_FadeOutDims the devive with ID __InstanceID__ to value __Intensity__ and dims then with the __Ramp__ seconds down to 0%.
LCN_FlipRelaySwitches over the relay with the ID __InstanceID__
LCN_LimitOutputlimits an output for a certain period of time
LCN_LoadScenecalls up a scene for an output
LCN_LockTargetValuelocks a controller of the device
LCN_RampStopStops the dimming process of the device with the ID __InstanceID__
LCN_ReleaseTargetValueunlocks a controller of the device
LCN_RemoveGroupremoves a device from a group
LCN_RequestLightsqueries the LEDs of the panel
LCN_RequestReadqueries the values
LCN_RequestStatusqueries all statuses of the module
LCN_RequestThresholdsqueries thresholds and hysteresis
LCN_SaveScenesaves a scene for an output
LCN_SelectSceneRegisterselects a register
LCN_SendCommandSends 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_SetDisplayTextShows a text on a line of the display
LCN_SetDisplayTimesets the display time of a line in the display
LCN_SetIntensityDims the device with the ID __InstanceID__ to value __Intensity__ in __Ramp__ seconds.
LCN_SetLampswitching an LED
LCN_SetRelaysetzt alle Relais in einem Modul (8Bit)
LCN_SetRGBWsets an instance to an RGBW color value
LCN_SetTargetValueSets the regulator __Target__ of the instance with the ID __InstanceID__ to the value __Value__
LCN_ShiftTargetValueShifts the current target value
LCN_ShutterMovestarts shutter movement to percentage position
LCN_ShutterMoveDownstarts a shutter movement downwards
LCN_ShutterMoveUpstarts a shutter movement upwards
LCN_ShutterStopstops a shutter movement
LCN_StartFlickerLet the device with the ID __InstanceID__ flicker
LCN_StopFlickerStop flickering of the device with the ID __InstanceID__ immediately
LCN_SwitchDurationMinafter how many minutes it should be dimmed down
LCN_SwitchDurationSecafter how many seconds it should be dimmed down
LCN_SwitchMemorySwitches the device with the ID __InstanceID__to a stored value
LCN_SwitchModeschaltet ein Gerät an/aus
LCN_SwitchRelaySwitches the relay with the ID __InstanceID__ to value __Status__
LCN_SwitchRelayTimerswitches a relay on a time factor

LJQuick

The KNX quick (Lingg&Janke) module supports the setup of KNX instances.

LJ_SendDateTimeSends the current date/time to the KNX bus

Location Control

calculates twilight times based on latitude and longitude

Logik Gate

Links variables by logical operations

M-Bus

Functions for controlling M-Bus components

Device listDevice list M-Bus
MBUS_UpdateValuesupdates all device-specific values

MediaPlayer

Funktionen zur Ansteuerung von Mediaplayer-Instanzen

WAC_AddFilefügt Musikdatei zur Playlist hinzu
WAC_ClearPlaylistlöscht die Playlist
WAC_GetPlaylistLengthlöscht die Playlist
WAC_GetPlaylistPositionlöscht die Playlist
WAC_Nextspielt den nächsten Titel der Playlist ab
WAC_Pausepausiert die Wiedergabe
WAC_Playspielt die Playlist ab
WAC_PlayFilespielt eine Musikdatei direkt ab
WAC_Prevspielt den vorherigen Titel der Playlist ab
WAC_SetPlaylistPositionlöscht die Playlist
WAC_SetPositionSets the position marker in the media player with the ID __InstanceID__ to the specified __Seconds__. The title must be played at execution time already.
WAC_SetRepeatschaltet die Wiederholung der Playlist ein/aus
WAC_SetShuffleschaltet die Zufallswiedergabe ein/aus
WAC_SetVolumesetzt die Lautstärke
WAC_Stopstoppt die Wiedergabe

Mennekes

Mennekes device setup

Device List

Modbus RTU/TCP

Functions for controlling ModBus RTU/TCP components

Device listDevice list ModBus RTU/TCP
ModBus_RequestReadExecutes a new read for the device with the ID __InstanceID__.
ModBus_WriteCoilSets address with ID __InstanceID__ to ___Value__
ModBus_WriteRegisterwrites a value to the write address
ModBus_WriteRegisterByteSets address with ID __InstanceID__ to __Value__
ModBus_WriteRegisterChar[w]This function was named __ModBus_WriteRegisterShortInt__ up to and including Version 4.3[/w]
ModBus_WriteRegisterDWordSets address with ID __InstanceID__ to __Value__
ModBus_WriteRegisterInt64Sets address with ID __InstanceID__ to __Value__
ModBus_WriteRegisterIntegerSets address with ID __InstanceID__ to __Value__
ModBus_WriteRegisterRealSets address with ID __InstanceID__ to __Value__
ModBus_WriteRegisterReal64Sets address with ID __InstanceID__ to __Value__
ModBus_WriteRegisterShort[w]This function was named __ModBus_WriteRegisterSmallInt__ up to and including Version 4.3[/w]
ModBus_WriteRegisterStringSets address with ID __InstanceID__ to __Value__
ModBus_WriteRegisterWordSets address with ID __InstanceID__ to __Value__

Module Control

manages external and added PHP modules

Möhlenhoff Alpha 2

Receiving and switching Möhlenhoff Alpha2 data

MA2_RequestStatusGets the values stored in the Alpha2 with the InstanceID and sets the associated variables.
MA2_WriteValueWrites the Value into the variable with the Ident in the Möhlenhoff Alpha 2 with the InstanceID.

MQTT

Functions for controlling MQTT components

Device listDevice list MQTT
MQTT ClientFunctions for controlling MQTT Client
MQTT-ServerFunctions for controlling MQTT Server

NEA Smart

Receiving and switching NEA Smart data

NEAS_RequestStatusGets the values stored in the NEA Smart with the InstanceID and sets the associated variables.
NEAS_WriteValueWrites the Value to the variable with the ident in the NEA Smart with the InstanceID.

Notification Control

a module for sending push notifications

OCPP

Über das OCPP Protokoll können Wallboxen bequem über Symcon überwacht und geschaltet werden.

OCPP_RemoteStartTransactionIf the status is 'Preparing' or 'Finishing', loading can be enabled by this command.
OCPP_RemoteStopCurrentTransactionIf the state is 'Charging', this command can be used to stop charging.
OCPP_RemoteStopTransactionIf the state is 'Charging', this command can be used to stop charging.

OPC UA

Functions for controlling OPC UA components

POP3

Funktionen zum POP3-Modul zur Abfrage von E-Mails

POP3_DeleteMaildeletes a mail with a specific e-mail(UID)
POP3_GetCachedMailsThe command returns an array containing information about the cached e-mails of a POP3 instance with ID __InstanceID__. Should the instance not exist, an alert is generated.
POP3_GetMailExreturns an array with information for a specific e-mail (UID)

Popup Module

Stylistic module for display in WebFront

Presence Control

Functions for detecting presence within an area

PC_Entersets presence to true
PC_Leavesets presence to false

Computation Module

Modules, which enables various calculations within IP-Symcon

Computation ModuleCalculation of different auxiliary values based on a group of variables, e.g. buzzer or average.
RM_Update
ConverterConverts a variable using a self-defined formula.
UMR_CalculateCalculates the return of the formula for the Value and returns it.
ConvertMultiBoundariesConverts a variable within set limits using a self-defined formula.
UMG_CalculateCalculates the return of the formula for the value __Value__ and returns it.
ValueRangeScaleSkalierung eines Wertes innerhalb eines Wertebereiches
VRC_ScaleScales the input variable value

RegisterVariable

RegisterVariablen dienen als eine Datenweiterleitungs- und -verarbeitungsschnittstelle

RegVar_GetBufferliest den internen Puffer
RegVar_SendEventsends an event to the parent HID instance
RegVar_SendPacketsends a data packet to the specified IP address
RegVar_SendTextsendet Daten an die übergeordnete Instanz
RegVar_SetBuffersetzt den internen Puffer

RGBMultiplexer

Connects individual R, G, B channels to a variable, which can be controlled with the color wheel.

RGBM_RequestStatusDetermines the value of the individual R, G, B channels and sets the color variable.
RGBM_SetRGBSends the R, G, B values to the individual channels and updates the color variable

RRDTool

Direkteinbindung des RRDTool

RRD_ExexuteDirects a command to the RRD Tool Library and executes it. Once the command has been executed, the execution will be proceed.

SageGlass (BACnet)

Integrates the SageGlass SIM II (BACnet) with IP-Symcon

DragPointer

A variable that remains at the highest or lowest value until reset.

SZ_ResetResets the drag pointer

Shutter Control

Functions for controlling shutter (roller shutter) components

SC_Movebewegt den Rolladen an eine bestimmte Position
SC_MoveDownbewegt den Rolladen bis zu Endposition runter
SC_MoveUpbewegt den Rolladen bis zu Endposition hoch
SC_Stopstoppt einen Bewegungsvorgang

Shutter Control (legacy)

Functions for controlling shutter components (legacy)

SC_Movemoves the shutter to a specific position
SC_MoveDownmoves the shutter down to the end position
SC_MoveUpmoves the shutter up to the end position
SC_Stopstops a motion

Siemens OZW

Funktionen zur Ansteuerung von Siemens OZW Komponenten

Device listDevice list Siemens OZW
OZW_RequestStatusrequests the status of a device
OZW_WriteDataPointwrites a specific value to a data point

Skin Control

manages external and uploaded skins

SMS

Functions for sending SMS via SMS module

SMS_Sendversendet eine E-Mail an die Standardadresse

SMTP

Functions for the SMTP module for sending e-mails

SMTP_SendMailversendet eine E-Mail an die Standardadresse
SMTP_SendMailAttachmentsends an e-mail with attachment to the default address
SMTP_SendMailAttachmentExsends an email with an attachment to any address
SMTP_SendMailExversendet eine E-Mail an eine beliebige Adresse
SMTP_SendMailMediasends an email with an attachment of a media object of type "image/sound" to the default address
SMTP_SendMailMediaExsends an e-mail with an attachment of a media object of the "image/sound" type to any address

SNMP

Show values for any OIDs of a walk. Optionally, these can be created and described as variables.

SNMP_UpdateValuesUpdates the variable values which are below the instance.

Game Collection

A collection of simple games which can be played via the WebFront.

ScissorsRockPaperA way to play rock paper scissors on WebFront.
Number GuessingA little game where a random number has to be guessed.
ZR_Generate

Spotify

Controls the playback of Spotify

SPO_MakeAPIRequestMakes a request to the Spotify web API with the specified parameters
SPO_NextTrackIf a current playback exists, the next song will be played.
SPO_PauseIf a current playback exists, it will be paused.
SPO_PlayIf a current, possibly paused, playback exists, it will be continued.
SPO_PlayURIPlays the Spotify resource with the URI __URI__ on the currently selected device.
SPO_PreviousTrackIf a current playback exists, the previous song will be played.
SPO_ResetTokenResets the OAuth-token and thus the link to the Spotify account.
SPO_SetRepeatSets the repeat to the value Repeat.
SPO_SetShuffleIf Shuffle is true, random playback is enabled, otherwise disabled.

PLC: Siemens, Vipa, Logo

Functions for controlling Siemens/Vipa/Logo PLC components

Device listDevice list SPS Siemens/Vipa
Logo-VM-AddressesVM addresses of Logo7/8
S7_RequestReadperforms a read operation on a device
S7_Writewrites a value to the configured address
S7_WriteBitSet the address with the ID __InstanceID__ to value status
S7_WriteByteSet the address with the ID __InstanceID__ to __Value__
S7_WriteChar[w]This function was named __S7_WriteShortInt__ up to and including Version 4.3[/w]
S7_WriteDWordSet the address with the ID __InstanceID__ to __Value__
S7_WriteIntegerSet the address with the ID __InstanceID__ to __Value__
S7_WriteRealSet the address with the ID __InstanceID__ to __Value__
S7_WriteShort[w]This function was named __S7_WriteSmallInt__ up to and including Version 4.3[/w]
S7_WriteWordSet the address with the ID __InstanceID__ to __Value__

PLC: Wago, Beckhoff, ABB

Functions for controlling Wago/Beckhoff PLC components

SSDP Control

enables the search for UPnP devices

YC_SearchDevicessends a request to the local network

Fault Manager

Indicates when selected variables are active and can acknowledge them depending on the setting.

Power Billing Module

The module provides a cost statement similar to the annual statement from the energy provider.

SAM_UpdateCalculations

SymconReport

Creates a report as CSV or PDF depending on the modules

MailReportCreates a CSV report of archive values and sends it by e-mail(SMTP)
MR_SendInfoSends an info mail about the last completed time interval
MR_SetActiveEnables or disables the module
PDFReport (Energy)Creates a report of archive values of two variables of a time span as PDF
RAC_GenerateEnergyReportGenerates a PDF with the values specified in the module with the InstanceID
PDFReport (Multi)Creates a report of archive values of several variables of a time span as PDF
RAC_GenerateReportGenerates a PDF with the values specified in the module with the InstanceID
PDFReport (Single)Creates a report of archive values of a variable with min/max/avg of a time span as PDF
RAC_GenerateReportGenerates a PDF with the values specified in the module with the InstanceID

System Information

Funktionen zum Abfragen von Systeminformationen und -hardware

Sys_GetBatterydisplays information about the battery
Sys_GetCPUInfozeigt die CPU Auslastung an
Sys_GetHardDiskInfozeigt den Festplattenspeicherplatz/-verbrauch an
Sys_GetMemoryInfozeigt den Speicherverbrauch an
Sys_GetNetworkInfozeigt Informationen zu den Netzwerkadaptern
Sys_GetProcessInfolistet alle Prozesse auf
Sys_GetSpoolerdisplays information about the printer queues
Sys_GetURLContentreads the content from an URL as String
Sys_GetURLContentExReads the contents of the __URL__ and returns it as a return value. Here, some __Parameter__ for timeouts, authentication and proxy are made. -
Sys_Pingsendet einen Ping an ein Netzwerkgerät

SceneControll

Stores the state of any number of actuators and makes them available via WebFront/PHP function.

SZS_CallSceneCalls the scene and sets it associated variables
SZS_GetActiveSceneReturns the number of the scene that is currently active.
SZS_SaveSceneSaves the values of the variables present in the list in the corresponding scene.

Dew Point Temperature Calculation

Calculation of the dew point temperature

Technische Alternative

Functions for controlling Technische Alternative components

Device listDevice list Technische Alternative

Phone Announcement

The Telephone Announcement Module enables the convenient linking of a VoIP instance and a text-to-speech instance (AWS Polly) to call a phone number and output a text when the call is answered. In addition, the module can respond to DTMF tones and output other texts.

TA_StartCallStarts a call based on the current setting.
TA_StartCallExStarts a call to a phone number and outputs the text

Phone Chain

The 'Phone Chain' module allows to call a list of telephone numbers one after another.

TelegramBot

Allows to send messages and perform actions

Text to Speech

Functions for controlling a TTS module

TTS_GenerateFilegeneriert eine WAV Datei mit dem gewünschten Text
TTS_Speakspricht einen beliebigen Text auf der gewählten Soundkarte

TextParser

provides text snippets from websites/files

Staircase Light Controls

When activated, the light in the staircase is switched on and is switched off again shortly after leaving the staircase.

THL_SetActiveActivates or deactivates the staircase lighting control.
THL_StartActivates the light in the staircase and starts the timer, which deactivates the light again.
THL_StopDeactivates the light in the staircase and the timer.

TTSAWSPolly

Can generate sound files in various formats

TTSAWSPOLLY_GenerateDataQueries the text via AWS and returns the speech data in the return.
TTSAWSPOLLY_GenerateFileQueries the text via AWS and returns the file name to the vocie data.

Renamer

Enables renaming of selected objects via WebFront

Rain Central

Fetches the current rain radar image from Wetteronline and evaluates the color pixels of the rain amount.

UWZ_RequestInfoCalculates the variable rain value of the rain central module

USBMapper

Automatically sets the correct USB port to the entered serial ports.

USBM_FixPorts

Util Control

dient als Schnittstelle mit erweiterten Funktionen zwischen dem IP-Symcon Dienst und der Verwaltungskonsole

VaraibleComparison

The VariablenVergleich module allows you to create a point cloud from two variables and compare them using linear regression.

LR_Download
LR_GenerateChart
LR_UpdateChart

Consumption per Category

Shows the consumption in percent in category.

VIK_CalculationConsumptionRecalculates the categories

VerbrauchsAlarm

Monitors a counter variable for unusual consumption.

VBA_CheckAlert

ConsumptionBehaviour

The consumption behavior module displays the expected consumption.

VBV_UpdateCalculation

Consumption within Timespan

Calculates the consumption between a start and end date

VIZ_Calculate

Virtuelle Devices

Modules for simulating various devices

E-Car (Simulation)Simulates the charging process of an electric car
Heater (Simulation)Simulates a heater
Light (Simulation)Simulates a light
Mediaplayer (Simulation)Simulates a MediaPlayer
PV-System (Simulation)Simulation of a PV system
Shutter (Simulation)Simulates a roller shutter
Thermostat (Simulation)Simulates a thermostat
Consumption/CostsCalculates the costs according to consumption
Counter (Simulation)Simulates an adjustable number of counters.

Calculated Counter

Adds positive variable changes according to adjustable rules with changes of a main variable and adds this to the value of a variable.

VM_Update

Virtual Counter

Input mask for manually read meter readings.

VZ_WriteNewCounterValue

Voice over IP

Functions for controlling VoIP

Device listDevice list Voice over IP
VoIP_AcceptCallaccepts a connection
VoIP_Connectestablishes a connection
VoIP_Disconnectterminates a connection
VoIP_GetConnectionreturns information about a connection
VoIP_GetDatareturns data of a connection
VoIP_PlayWaveplays a wave file
VoIP_RejectCallrejects a connection
VoIP_SendDTMFsends a sequence of characters as DTMF
VoIP_SetDatasets the data of a connection

Water Alert

Monitors a meter variable for unnatural water consumption (leak/break).

WAA_CheckAlert

Watchdog

Monitors variables and triggers an alarm if they have not been updated or changed for too long.

WD_GetAlertTargets
WD_SetActive

Web Graph

Any graphs can be displayed independently via the WebHook

WebFront Visualization

Funktionen zum Ansteuern des WebFronts auf den Client-Rechnern

WFC_AudioNotificationsends an audio message to the WebFront
WFC_OpenCategoryOpens a category as a popup in the WebFront
WFC_PushNotificationsends a push message to the mobile apps
WFC_Reloadlädt das WebFront auf dem Client-Rechner neu
WFC_SendNotificationsendet eine kleine Meldung auf das WebFront
WFC_SendPopupsendet eine große Meldung an das WebFront
WFC_SwitchPagewechselt den Reiter im WebFront

WebHook Control

Module for calling scripts via browser

WC_PushMessagesends a WebSocket message to all connected clients
WC_PushMessageExsends a WebSocket message to a specific client

WebServer

Module which makes the WebFront accessible via port

WinLIRC

Funktionen zum Ansteuern von WinLIRC Komponenten

WinLIRC_SendOnceSends 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).

WMRS200

Functions for controlling WMRS200 components

Device listDevice list WMRS200

Wunderground Weather

Gets weather data (current/hourly/12-hourly/weather warning) via API from www.wunderground.com

WGW_UpdateStormWarningData
WGW_UpdateWeatherData

W&T

Functions for controlling W&T components

WUT_SwitchModeSwitches the channel with ID __InstanceID__ to value __Status__.

XBee

Functions for controlling XBee

XBee_SendBuffersends a data string to a specific device
XBee_SendCommandsends a command to a specific XBee-Splitter

Eaton xComfort

Funktionen zur Ansteuerung von xComfort Komponenten

Device listDevice list Eaton xComfort
MXC_DimBrighterfängt einen Dimmvorgang auf eine hellere Stufe an
MXC_DimDarkerfängt einen Dimmvorgang auf eine dunklere Stufe an
MXC_DimSetdimmt ein xComfort Gerät auf eine bestimmte Stufe
MXC_DimStophält einen Dimmvorgang an
MXC_RequestStatussende eine Statusmeldungsanfrage an ein Gerät
MXC_SendBooleanSends a boolean value to the instance with ID __InstanceID__, which is connected to a room manager.
MXC_SendFloatSends a float to the instance with ID __InstanceID__, which is connected to a room manager.
MXC_SendIntegerSends a boolean value to the instance with ID __InstanceID__, which is connected to a room manager.
MXC_SetTemperatureSets the new target temperature of the control valve with the ID __InstanceID__ to the new __Temperature__.
MXC_ShutterMoveDownbewegt den Rolladen nach unten bis zur Endposition/Stop
MXC_ShutterMoveUpbewegt den Rolladen nach oben bis zur Endposition/Stop
MXC_ShutterStepDownbewegt den Rolladen ein Stück nach unten
MXC_ShutterStepUpbewegt den Rolladen ein Stück nach oben
MXC_ShutterStopstoppt einen Bewegungsvorgang
MXC_SwitchModeschaltet ein xComfort Gerät an/aus

Z-Wave

Functions for controlling Z-Wave components

Device listDevice list Z-Wave
ZW_BasicTurns the basic function of the specified device with InstanceID __InstanceID__
ZW_ColorCWsets the cold-white channel of a RGBWW Z-Wave device
ZW_ColorRGBsets the color of a Z-Wave device
ZW_ColorRGBWWsets the colors and intensity of an RGBWW Z-Wave device
ZW_ColorWWsets the WarmWhite channel of a Z-Wave device
ZW_DimDownstarts dimming down
ZW_DimDownExstarts dimming down with a runtime
ZW_DimSetdimmt ein Z-Wave Gerät auf eine bestimmte Stufe
ZW_DimSetExdims a Z-Wave device to a specific level within a runtime
ZW_DimStopstops dimming a Z-Wave device
ZW_DimUpstarts dimming up
ZW_DimUpExstarts dimming up within a runtime
ZW_DoorLockOperationSets the door lock operation mode of a Z-Wave device
ZW_LockModesets the LockMode
ZW_MeterResetresets the meter
ZW_OptimizeStarts the wireless network optimization process for a Z-Wave device
ZW_ProtectionSetsets the Protection and its Mode
ZW_RequestStatusQueries 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_ShutterMoveDownMoves the shutter with the ID __InstanceID__ downwards until (link: /service/dokumentation/modulreferenz/xcomfort/mxc-shutterstop text: MXC_ShutterStop) is running or the end position is reached.
ZW_ShutterMoveUpMoves the shutter with the ID __InstanceID__ upwards until (link: /service/dokumentation/modulreferenz/xcomfort/mxc-shutterstop text: MXC_ShutterStop) is running or the end position is reached.
ZW_ShutterStopStops a current movement of the shutter.
ZW_SwitchAllModeSets the Switch All mode of a Z-Wave device
ZW_SwitchModeschaltet ein Z-Wave Gerät an/aus
ZW_TestTests if a connection to a Z-Wave device is working
ZW_ThermostatFanModeSetSets the FanMode for the thermostat
ZW_ThermostatModeSetSets the thermostat mode
ZW_ThermostatSetPointSetSets the PointSet Value

Reading (Day)

The meter reading can be displayed for a selected date

ZST_Calculate

Meter Overflow

Meters which can overflow can be displayed as meters.

Zevvy

Sends data to a Zevvy account

ZY_SendMeasurementsSends the data of the set up variables to a Zevvy account

Random Lighting

The module enables one to switch the color value of lamps randomly between different colors.

ZB_ChangeLight
Any questions?