# Function Index

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

One line per function. The description, parameters and examples are found in the linked file.

## [Process Control](functions/process-control.md)

- `bool IPS_Execute(string $ProgramPath, string $Parameter, bool $Dummy, bool $Wait)` – Starts an external program
- `string IPS_ExecuteEx(string $ProgramPath, string $Parameter, bool $ShowWindow, bool $Wait, int $SessionID)` – Starts an external program in the user context
- `bool IPS_RunAction(string $ActionID, array $ActionParameters)` – executes a single action
- `string IPS_RunActionWait(string $ActionID, array $ActionParameters)` – executes a single action and waits for the result
- `bool IPS_RunScript(int $ScriptID)` – starts another IP-Symcon script
- `bool IPS_RunScriptEx(int $ScriptID, array $Parameter)` – starts another IP-Symcon script and passes variables
- `bool IPS_RunScriptText(string $ScriptText)` – starts text as IP-Symcon script
- `bool IPS_RunScriptTextEx(string $ScriptText, array $Parameter)` – starts a text as IP-Symcon script and passes variables
- `string IPS_RunScriptTextWait(string $ScriptText)` – starts a text as IP-Symcon script and waits for its execution
- `string IPS_RunScriptTextWaitEx(string $ScriptText, array $Parameter)` – starts a text as IP-Symcon script, passes variables, and waits for the execution of the script
- `string IPS_RunScriptWait(int $ScriptID)` – starts another IP-Symcon script and waits for the result
- `string IPS_RunScriptWaitEx(int $ScriptID, array $Parameter)` – starts another IP-Symcon script, passes variables, and waits for the result
- `bool IPS_SemaphoreEnter(string $Name, int $WaitingTime)` – allows the synchronization with other simultaneously run scripts
- `bool IPS_SemaphoreLeave(string $Name)` – allows the synchronization with other simultaneously run scripts
- `bool IPS_Sleep(int $WaitingTime)` – delays a script for a specified duration

## [Management of Events](functions/management-events.md)

- `int IPS_CreateEvent(int $EventType)` – create a new event
- `bool IPS_DeleteEvent(int $EventID)` – deletes an event
- `bool IPS_EventExists(int $EventID)` – checks if an event exists
- `array IPS_GetEvent(int $EventID)` – returns extensive information about an event
- `int IPS_GetEventIDByName(string $EventName, int $ParentID)` – determines the ID of an event by its name
- `array IPS_GetEventList()` – returns a list of all existing events
- `array IPS_GetEventListByType(int $EventType)` – returns a list of all events of a given type
- `bool IPS_IsConditionPassing(string $Condition)` – checks if a condition is fulfilled
- `bool IPS_SetEventAction(int $EventID, string $ActionID, array $ActionParameters)` – set the executed action
- `bool IPS_SetEventActive(int $EventID, bool $Active)` – activates/deactivates an event
- `bool IPS_SetEventCondition(int $EventID, int $ConditionID, int $ParentID, int $Operation)` – modifies the conditions of an event
- `bool IPS_SetEventConditionDateRule(int $EventID, int $ConditionID, int $RuleID, int $Comparison, int $Day, int $Month, int $Year)` – modifies the rule of a condition of an event for date comparisons
- `bool IPS_SetEventConditionDayOfTheWeekRule(int $EventID, int $ConditionID, int $RuleID, int $Comparison, int $Weekday)` – modifies the rule of a condition of an event for weekday comparisons
- `bool IPS_SetEventConditionTimeRule(int $EventID, int $ConditionID, int $RuleID, int $Comparison, int $Hour, int $Minute, int $Second)` – modifies the rule of a condition of an event for time comparisons
- `bool IPS_SetEventConditionVariableDynamicRule(int $EventID, int $ConditionID, int $RuleID, int $VariableID, int $Comparison, int $CompareVariableID)` – modify a static condition rule of an event for variable comparison
- `bool IPS_SetEventConditionVariableRule(int $EventID, int $ConditionID, int $RuleID, int $VariableID, int $Comparison, mixed $Value)` – modify a condition rule of an event for variable comparison
- `bool IPS_SetEventConditionVariableStaticRule(int $EventID, int $ConditionID, int $RuleID, int $VariableID, int $Comparison, mixed $Value)` – modify a static condition rule of an event for variable comparison
- `bool IPS_SetEventCyclic(int $EventID, int $DateType, int $DateInterval, int $DateDay, int $DateDayInterval, int $TimeType, int $TimeInterval)` – configures a cyclic event
- `bool IPS_SetEventCyclicDateBounds(int $EventID, float $FromDate, float $ToDate)` – set the start and end date of a cyclic event (deprecated)
- `bool IPS_SetEventCyclicDateFrom(int $EventID, int $Day, int $Month, int $Year)` – sets the start date
- `bool IPS_SetEventCyclicDateTo(int $EventID, int $Day, int $Month, int $Year)` – sets the end date
- `bool IPS_SetEventCyclicTimeBounds(int $EventID, float $FromTime, float $ToTime)` – set the start and end time for a cyclic event (deprecated)
- `bool IPS_SetEventCyclicTimeFrom(int $EventID, int $Hour, int $Minute, int $Second)` – set the start time
- `bool IPS_SetEventCyclicTimeTo(int $EventID, int $Hour, int $Minute, int $Second)` – sets the end time
- `bool IPS_SetEventLimit(int $EventID, int $Number)` – limits the amount of event calls
- `bool IPS_SetEventScheduleAction(int $EventID, int $ScheduleActionID, string $Name, int $Color, string $ScriptContent)` – modifies the action table of a schedule event and set the action to "Execute PHP Code"
- `bool IPS_SetEventScheduleActionEx(int $EventID, int $ScheduleActionID, string $Name, int $Color, string $ActionID, array $ActionParameters)` – modifies the action table of a schedule event
- `bool IPS_SetEventScheduleGroup(int $EventID, int $GroupID, int $Days)` – modifies the grouping of days for a schedule event
- `bool IPS_SetEventScheduleGroupPoint(int $EventID, int $GroupID, int $PointID, int $StartHour, int $StartMinute, int $StartSecond, int $ActionID)` – modify a switch point of the group of a schedule event
- `bool IPS_SetEventScript(int $EventID, string $EventScript)` – set the action to "Execute PHP Code" and define the code to be executed
- `bool IPS_SetEventTrigger(int $EventID, int $TriggerType, int $TriggerVariableID)` – define the trigger for a trigger event
- `bool IPS_SetEventTriggerSubsequentExecution(string $EventID, bool $AllowSubsequentExecutions)` – define if a trigger event should multiple times fir exceed/drop
- `bool IPS_SetEventTriggerValue(int $EventID, mixed $TriggerValue)` – set the value the trigger variable is compared to

## [Management of Instances](functions/management-instances.md)

- `bool IPS_DisableDebugFile(int $InstanceID)` – deactivates the writing of debug logs to a file
- `bool IPS_EnableDebugFile(int $InstanceID)` – activates the writing of debug logs to a file
- `int IPS_CreateInstance(string $ModuleID)` – creates an instance
- `bool IPS_DeleteInstance(int $InstanceID)` – deletes an instance
- `array IPS_GetInstance(int $InstanceID)` – returns extensive information about a specific instance
- `int IPS_GetInstanceIDByName(string $InstanceName, int $ParentID)` – returns the ID of an instance by its name
- `array IPS_GetInstanceList()` – returns a list of all existing instances
- `array IPS_GetInstanceListByModuleID(string $ModuleID)` – returns all instances with a specific module ID
- `array IPS_GetInstanceListByModuleType(int $ModuleType)` – returns a list of all instances with a specific type
- `bool IPS_InstanceExists(int $InstanceID)` – checks if a specific instance exists
- `bool IPS_ApplyChanges(int $InstanceID)` – applies a changed configuration
- `string IPS_GetConfiguration(int $InstanceID)` – reads a configuration
- `string IPS_GetConfigurationForm(int $InstanceID)` – reads a configuration form
- `mixed IPS_GetProperty(int $InstanceID, string $Property)` – reads the current value of a property
- `bool IPS_HasChanges(int $InstanceID)` – checks if the configuration was changed
- `bool IPS_ResetChanges(int $InstanceID)` – resets the modified configuration to the current configuration
- `bool IPS_SetConfiguration(int $InstanceID, string $Configuration)` – set a new configuration
- `bool IPS_SetProperty(int $InstanceID, string $Property, mixed $Value)` – set a planned value for a property
- `array IPS_GetReferenceList(int $InstanceID)` – returns the IDs of all references
- `bool IPS_ConnectInstance(int $InstanceID, int $ParentID)` – creates a (data) connection between two instances
- `bool IPS_DisconnectInstance(int $InstanceID)` – disconnects a (data) connection between two instances
- `bool IPS_GetCompatibleInstances(int $InstanceID)` – returns compatible instances to an instance
- `bool IPS_IsInstanceCompatible(int $InstanceID, int $ParentID)` – checks if a connection between two instances is possible

## [Management of Categories](functions/management-categories.md)

- `bool IPS_CategoryExists(int $CategoryID)` – checks if a category exists
- `int IPS_CreateCategory()` – creates a new category
- `bool IPS_DeleteCategory(int $CategoryID)` – deletes an existing category
- `int IPS_GetCategoryIDByName(string $CategoryName, int $ParentID)` – searches and returns the ID of an existing category by its name
- `array IPS_GetCategoryList()` – returns a list of all existing categories

## [Management of Links](functions/management-links.md)

- `int IPS_CreateLink()` – creates a new link
- `bool IPS_DeleteLink(int $LinkID)` – deletes an existing link
- `array IPS_GetLink(int $LinkID)` – retuns extensive information about a link
- `int IPS_GetLinkIDByName(string $LinkName, int $ParentID)` – returns the ID of a link by its name
- `array IPS_GetLinkList()` – returns a list of all existing links
- `bool IPS_LinkExists(int $LinkID)` – checks if a link exists already
- `bool IPS_SetLinkTargetID(int $LinkID, int $LinkedObject)` – set the target for a link

## [Management of Media](functions/management-media.md)

- `int IPS_CreateMedia(int $MediaType)` – creates a new media object in the media pool
- `bool IPS_DeleteMedia(int $MediaID, bool $DeleteFile)` – removes a media object from the media pool
- `array IPS_GetMedia(int $MediaID)` – returns extensive information about a specific media object
- `string IPS_GetMediaContent(int $MediaID)` – returns the content of a media object
- `int IPS_GetMediaID(string $MediaName)` – returns the ID of a media object
- `int IPS_GetMediaIDByFile(string $MediaPath)` – return the ID of a media object by its file
- `int IPS_GetMediaIDByName(string $MediaName, int $ParentID)` – returns the ID of a media object by its name
- `array IPS_GetMediaList()` – returns a list of all media objects in the media pool
- `array IPS_GetMediaListByType(int $MediaType)` – returns a list of all media objects of a specific type
- `bool IPS_MediaExists(int $MediaID)` – checks if a specific media object is contained within the media pool already
- `bool IPS_SendMediaEvent(int $MediaID)` – send a notification that a media object was changed
- `bool IPS_SetMediaCached(int $MediaID, bool $CacheActivated)` – activates that a media object is only modified in the internal memory
- `bool IPS_SetMediaContent(int $MediaID, string $Content)` – set the content of a media object
- `bool IPS_SetMediaFile(int $MediaID, string $FileName, bool $FileMustExist)` – bind a media file to a media object

## [Management of Modules](functions/management-modules.md)

- `array IPS_GetCompatibleModules(string $ModuleID)` – returns all modules that are compatible to a specific module
- `array IPS_GetLibrary(string $LibraryID)` – returns extensive information about a library
- `array IPS_GetLibraryList()` – returns a list of all libraries
- `array IPS_GetLibraryModules(string $LibraryID)` – returns a list of modules in a library
- `array IPS_GetModule(string $ModuleID)` – returns extensive information about a module
- `array IPS_GetModuleList()` – returns a list of all modules
- `array IPS_GetModuleListByType(int $ModuleType)` – returns a list of all modules of a given type
- `bool IPS_IsModuleCompatible(string $ModuleID, string $ParentModuleID)` – checks if two modules are compatible to each other
- `bool IPS_LibraryExists(string $LibraryID)` – Checks if the given library exists
- `bool IPS_ModuleExists(string $ModuleID)` – checks if the given module exists

## [Management of Objects](functions/management-objects.md)

- `array IPS_GetChildrenIDs(int $ObjectID)` – returns a list of all children objects
- `string IPS_GetLocation(int $ObjectID)` – returns the complete path to an object
- `string IPS_GetName(int $ObjectID)` – returns the name of the object
- `array IPS_GetObject(int $ObjectID)` – returns extensive information about an object
- `int IPS_GetObjectIDByIdent(string $ObjectIdent, int $ParentID)` – returns the ID of an object by its ident
- `int IPS_GetObjectIDByName(string $ObjectName, int $ParentID)` – returns the ID of an object by its name
- `array IPS_GetObjectList()` – returns a list of all existing objects
- `int IPS_GetParent(int $ObjectID)` – returns the ID of the parent of the object
- `bool IPS_HasChildren(int $ObjectID)` – checks if an object has child objects
- `bool IPS_IsChild(int $ObjectID, int $ParentID, bool $Recursive)` – checks if an object is a child of a parent object
- `bool IPS_ObjectExists(int $ObjectID)` – checks if a specific object exists
- `bool IPS_SetDisabled(int $ObjectID, bool $Disabled)` – set an object as disabled for the visualizations
- `bool IPS_SetHidden(int $ObjectID, string $Hidden)` – set the visibility for an object
- `bool IPS_SetHiddenMaximize(int $ObjectID, bool $Hidden)` – sets the visibility of the maximize button of an object
- `bool IPS_SetHiddenTitle(int $ObjectID, bool $Hidden)` – sets the visibility of the title of an object
- `bool IPS_SetIcon(int $ObjectID, string $Icon)` – set the icon of an object
- `bool IPS_SetIdent(int $ObjectID, string $Ident)` – set the ident of an object
- `bool IPS_SetInfo(int $ObjectID, string $Info)` – set extended information of an object
- `bool IPS_SetName(int $ObjectID, string $Name)` – set the name of an object
- `bool IPS_SetParent(int $ObjectID, int $ParentID)` – set the parent of an object
- `bool IPS_SetPosition(int $ObjectID, int $Position)` – set the position of an object

## [Program Information](functions/program-information.md)

- `bool IPS_FunctionExists(int $FunctionName)` – checks if a specific function exists
- `array IPS_GetFunction(int $FunctionName)` – returns extensive information about a function
- `array IPS_GetFunctionList(int $InstanceID)` – returns a list of all available functions
- `array IPS_GetFunctionListByModuleID(string $ModuleID)` – returns a list of all available functions of a module
- `string IPS_GetKernelArchitecture()` – supplies the architecture that IP-Symcon was created for
- `int IPS_GetKernelDate()` – returns the kernel creation date
- `string IPS_GetKernelDir()` – returns the path to the IP Symcon program folder
- `string IPS_GetKernelDirEx()` – returns the path to the IP Symcon installation folder
- `array IPS_GetKernelDirSpace()` – returns the total/free/available/disk space where IP-Symcon has its data
- `string IPS_GetKernelPlatform()` – supplies the operating system which IP-Symcon is running on
- `string IPS_GetKernelRevision()` – supplies a unique revision identifier
- `int IPS_GetKernelRunlevel()` – returns the run level of the kernel
- `int IPS_GetKernelStartTime()` – returns the point of time when IP Symcon was started
- `string IPS_GetKernelVersion()` – returns the version number of the used kernel
- `string IPS_GetLogDir()` – returns the path to the IP Symcon log folder
- `string IPS_GetSystemLanguage()` – returns the system language of the operating system on which IP-Symcon is running
- `string IPS_GetUpdateChannel()` – returns the currently configured update channel
- `bool IPS_LogMessage(string $Sender, string $Message)` – Writes a user defined message into the log file

## [Management of Scripts](functions/management-scripts.md)

- `int IPS_CreateScript(int $SkriptType)` – creates a script
- `bool IPS_DeleteScript(int $ScriptID, bool $DeleteFile)` – deletes a script
- `array IPS_GetScript(int $ScriptID)` – return extensive information about a script
- `string IPS_GetScriptContent(int $ScriptID)` – returns the content of a script
- `array IPS_GetScriptEventList(int $ScriptID)` – returns all events that are assigned to a script
- `string IPS_GetScriptFile(int $ScriptID)` – returns the file name of a script
- `int IPS_GetScriptIDByFile(string $FilePath)` – returns the ID of a script by its file
- `int IPS_GetScriptIDByName(string $ScriptName, int $ParentID)` – returns the ID of a script by its name
- `array IPS_GetScriptList()` – returns a list of all scripts
- `int IPS_GetScriptTimer(int $ScriptID)` – returns the start value of the script timer
- `bool IPS_ScriptExists(int $ScriptID)` – checks if a script exists
- `bool IPS_SetScriptContent(int $ScriptID, string $Content)` – set the content of a script
- `bool IPS_SetScriptFile(int $ScriptID, string $FileName)` – sets the file name for a script
- `bool IPS_SetScriptTimer(int $ScriptID, int $TimerValue)` – set the start value of a script timer

## [Management of Variables](functions/management-variables.md)

- `int IPS_CreateVariable(int $VariableType)` – creates a new variable
- `bool IPS_DeleteVariable(int $VariableID)` – deletes a variable
- `array IPS_GetVariable(int $VariableID)` – retuns extensive information about a variable
- `array IPS_GetVariableEventList(int $VariableID)` – returns a list of all events that are associated to a variable
- `int IPS_GetVariableIDByName(string $VariableName, int $ParentID)` – returns the ID of a variable by its name
- `array IPS_GetVariableList()` – returns a list of all existing variables
- `array IPS_GetVariablePresentation(int $VariablenID)` – Returns all parameters of the currently used presentation
- `bool IPS_SetVariableCustomAction(int $VariableID, int $ScriptID)` – set a user defined action script for a variable
- `bool IPS_SetVariableCustomPresentation(int $VariableID, array $Presentation)` – assigns a user-defined presentation to the variable
- `bool IPS_SetVariableCustomProfile(int $VariableID, string $ProfileName)` – sets a user defined profile for a variable
- `bool IPS_VariableExists(int $VariableID)` – checks if a variable exists
- `array IPS_GetPresentation(string $PresentationID)` – provides comprehensive information about a specific representation
- `string IPS_GetPresentationForm(string $PresentationID, int $VariableType, array $Parameters)` – returns the configuration form of a representation for a variable type
- `string IPS_GetPresentations()` – provides all presentations of the system
- `bool IPS_PresentationExists(string $PresentationID)` – Checks whether a specific presentation exists
- `string IPS_CreateTemplate(string $PresentationID)` – creates a new template for a specific display
- `bool IPS_DeleteTemplate(string $TemplateID)` – Deletes a template
- `array IPS_GetTemplate(string $TemplateID)` – provides comprehensive information about a template
- `array IPS_GetTemplateList()` – provides all available templates
- `array IPS_GetTemplateListByPresentation(string $PresentationID)` – provides a list of the templates of a representation
- `bool IPS_SetTemplateName(string $TemplateID, string $Name)` – sets the name of a template
- `bool IPS_SetTemplateValues(string $TemplateID, array $Values)` – sets the values of a template
- `bool IPS_TemplateExists(string $TemplateID)` – Checks whether a template exists
- `bool IPS_CreateVariableProfile(string $ProfileName, int $VariableType)` – creates a variable profile
- `bool IPS_DeleteVariableProfile(string $ProfileName)` – deletes a variable profile
- `array IPS_GetVariableProfile(string $ProfileName)` – returns extensive information about a variable profile
- `array IPS_GetVariableProfileList()` – returns a list of all existing variable profiles
- `array IPS_GetVariableProfileListByType(int $VariablenTyp)` – returns a list of all existing variable profiles of a specific type
- `bool IPS_SetVariableProfileAssociation(string $ProfileName, mixed $Value, string $Name, string $Icon, int $Color)` – modifies the association table of a variable profile
- `bool IPS_SetVariableProfileDigits(string $ProfileName, int $Digits)` – sets the digits of a variable profile
- `bool IPS_SetVariableProfileIcon(string $ProfileName, string $Icon)` – sets the icon for a variable profile
- `bool IPS_SetVariableProfileText(string $ProfileName, string $Prefix, string $Suffix)` – sets prefix and suffix for a variable profile
- `bool IPS_SetVariableProfileValues(string $ProfileName, float $MinValue, float $MaxValue, float $StepSize)` – sets the minimal value, maximal value, and stepsize of a variable profile
- `bool IPS_VariableProfileExists(string $ProfileName)` – checks if a variable profile exists

## [Accessing Variables](functions/access-variables.md)

- `mixed GetValue(int $VariableID)` – returns the value of an IP-Symcon variable, independent of its type
- `bool GetValueBoolean(int $VariableID)` – returns the value of an IP-Symcon variable of the type Boolean
- `float GetValueFloat(int $VariableID)` – returns the value of an IP-Symcon variable of the type Float
- `string GetValueFormatted(int $VariableID)` – returns the value of an IP-Symcon variable and formats it according to its profile
- `string GetValueFormattedEx(int $VariableID, mixed $value)` – returns a value formatted based on the profile of a variable
- `int GetValueInteger(int $VariableID)` – returns the value of an IP-Symcon variable of the type Integer
- `string GetValueString(int $VariableID)` – returns the value of an IP-Symcon variable of the type String
- `bool HasAction(int $VariableID)` – checks whether an action is defined
- `bool RequestAction(int $VariableID, mixed $Value)` – execute the variable action of an IP-Symcon variable
- `bool RequestActionEx(int $VariableID, mixed $Value, string $Sender)` – execute the action of an IP-Symcon variable with individual sender
- `bool SetValue(int $VariableID, mixed $Value)` – set the value of an IP-Symcon variable independent of its type
- `bool SetValueBoolean(int $VariableID, bool $Value)` – set the value of an IP-Symcon Variable with the type Boolean
- `bool SetValueFloat(int $VariableID, float $Value)` – set the value of an IP-Symcon variable with the type Float
- `bool SetValueInteger(int $VariableID, int $Value)` – set the value of an IP-Symcon variable with the type Boolean
- `bool SetValueString(int $VariableID, string $Value)` – set the value of an IP-Symcon variable with the type String

## [Compatibilityfunctions](developer/compatibility-functions.md)

- `array IPS_GetInstanceChildrenIDs(int $InstanceID)` – returns the InstanceIDs of the children (deprecated)
- `int IPS_GetInstanceParentID(int $InstanceID)` – returns the InstanceID of the parent instance (deprecated)
- `int IPS_GetScriptID(string $ScriptName)` – returns the ID of a script (deprecated)
- `array IPS_GetStatusVariable(int $InstanceID, string $VariableIdent)` – returns extensive information about a specific state variable (deprecated)
- `int IPS_GetStatusVariableID(int $InstanceID, string $VariableIdent)` – returns all status variables for a specific instance (deprecated)
- `array IPS_GetStatusVariableIdents(int $InstanceID)` – returns the VariableIdents of a status variable (deprecated)
- `int IPS_GetUptime()` – returns the point of time when IP Symcon was started (deprecated)
- `int IPS_GetVariableID(string $VariableName)` – returns the ID of a variable (deprecated)
- `bool IPS_HasInstanceChildren(bool $InstanceID)` – checks if an instance is connected to child instances (deprecated)
- `bool IPS_HasInstanceParent(int $InstanceID)` – checks if the instance has a parent instance (deprecated)
- `bool IPS_IsPersistent(int $ObjectID)` – checks if an object is persistent (deprecated)
- `bool IPS_SetLinkChildID(int $LinkID, int $LinkedObject)` – set the target for a link (deprecated)
- `bool IPS_SetStatusVariableUseAction(int $InstanceID, string $VariableIdent, bool $UseAction)` – set if the default action of a status variable should be used (deprecated)
- `bool IPS_StatusVariableExists(int $InstanceID, string $VariableIdent)` – checks if a specific status variable exists (deprecated)

## [SDK (PHP)](developer/sdk-tools/sdk-php.md)

- `void handleMessage(mixed Data)` – This function must be defined to receive messages from the module
- `void openObject(int ObjectID)` – This function opens an object in the visualization.
- `void requestAction(string Ident, mixed Value)` – This function sends a message to the module
- `string translate(string Original)` – Translates text based on localization
- `void translateHTML(object Node)` – Translates the text of HTML elements based on the localization

## [Module](developer/sdk-tools/sdk-php/module.md)

- `void __construct(string $InstanceID)` – Function that is called with every request to the module
- `void ApplyChanges()` – Function which is executed when the configuration is applied
- `bool ConnectParent(string $ParentGUID)` – Connects an instance to a parent instance
- `void Create()` – Function that is called once when the instance is created
- `void Destroy()` – Function that is called when the instance is deleted or the module is updated
- `bool DisableAction(string $Ident)` – Deactivates the default action of the status variable
- `bool EnableAction(string $Ident)` – Activates the default action of the status variable
- `bool ForceParent(string $ModuleID)` – Connects an instance to a parent instance
- `string ForwardData(string $JSONString)` – Function which is called when receiving data from a child instance (e.g. device)
- `string GetBuffer(string $Name)` – Returns the content of a buffer
- `array GetBufferList()` – Returns an array with the names of all buffers
- `string GetCompatibleParents()` – Overwritable function that describes the compatible physically higher-level instances
- `string GetConfigurationForm()` – Extendable function that supplies the content of the configuration page
- `string GetConfigurationForParent()` – Extendable function which partially or completely sets the configuration of the parent instance
- `mixed GetIDForIdent(string $Ident)` – Searches for the object ID for an object via the object identifier
- `array GetMessageList()` – Returns an array of all registered messages
- `array GetReferenceList()` – Returns an array with the IDs of all references
- `int GetStatus()` – Returns the current status of the instance
- `int GetTimerInterval(string $Name)` – Queries the interval of a timer
- `mixed GetValue(string $Ident)` – Returns the value of a status variable
- `string GetVisualizationTile()` – Returns the individual display via HTML SDK
- `bool HasActiveParent()` – Checks whether all physical parent instances are active
- `bool LogMessage(string $Message, int $Type)` – Sends a message with type coding
- `bool MaintainAction(string $Ident, bool $ActivateAction)` – Activates/deactivates the default action depending on the parameter
- `mixed MaintainVariable(string $Ident, string $Name, int $Type, string $ProfileOrPresentation, int $Position, bool $Retain)` – Creates/deletes the status variable depending on the parameter
- `void MessageSink(int $TimeStamp, int $SenderID, int $MessageID, array $Data)` – Extendable function which processes registered messages
- `string Migrate(string $JSONData)` – Function that is called once after the creation of the instance
- `void ProcessHookData()` – Function that is called when the previously registered webhook is called
- `void ProcessOAuthData()` – Function that is called when the OAuth process is completed
- `bool ReadAttributeBoolean(string $Name)` – Reads an attribute of type boolean
- `float ReadAttributeFloat(string $Name)` – Reads an attribute of type float
- `int ReadAttributeInteger(string $Name)` – Reads an attribute of type integer
- `string ReadAttributeString(string $Name)` – Reads an attribute of type string
- `bool ReadPropertyBoolean(string $Name)` – Reads a property of type boolean
- `float ReadPropertyFloat(string $Name)` – Reads a property of type float
- `int ReadPropertyInteger(string $Name)` – Reads a property of type integer
- `string ReadPropertyString(string $Name)` – Reads a property of type string
- `string ReceiveData(string $JSONString)` – Function that is called when data is received from a parent entity (e.g. I/O, splitter)
- `bool RegisterAttributeBoolean(string $Name, bool $DefaultValue)` – Creates an attribute of type boolean
- `bool RegisterAttributeFloat(string $Name, float $DefaultValue)` – Creates an attribute of type float
- `bool RegisterAttributeInteger(string $Name, int $DefaultValue)` – Creates an attribute of type integer
- `bool RegisterAttributeString(string $Name, string $DefaultValue)` – Creates an attribute of type string
- `bool RegisterHook(string $Address)` – Registers a WebHook with the specified address
- `bool RegisterMessage(int $SenderID, int $MessageID)` – Registers a message for a SenderID
- `bool RegisterOAuth(string $Identifier)` – Registers an OAuth handler with the specified identifier
- `bool RegisterOnceTimer(string $Name, string $ScriptContent)` – Creates a one-time timer
- `bool RegisterPropertyBoolean(string $Name, bool $DefaultValue)` – Creates a property of type Boolean
- `bool RegisterPropertyFloat(string $Name, float $DefaultValue)` – Creates a property of type float
- `bool RegisterPropertyInteger(string $Name, int $DefaultValue)` – Creates a property of type Integer
- `bool RegisterPropertyString(string $Name, string $DefaultValue)` – Creates a property of type String
- `bool RegisterReference(int $ID)` – Registers an ID as referenced
- `mixed RegisterScript(string $Ident, string $Name, string $Contents, int $Position)` – Creates a script if it does not already exist
- `bool RegisterTimer(string $Name, int $Interval, string $ScriptContent)` – Creates a timer
- `mixed RegisterVariableBoolean(string $Ident, string $Name, array $Presentation, int $Position)` – Creates a status variable of type Boolean
- `mixed RegisterVariableFloat(string $Ident, string $Name, array $Presentation, int $Position)` – Creates a status variable of type Float
- `mixed RegisterVariableInteger(string $Ident, string $Name, array $Presentation, int $Position)` – Creates a status variable of type integer
- `mixed RegisterVariableString(string $Ident, string $Name, array $Presentation, int $Position)` – Creates a status variable of type String
- `bool ReloadForm()` – Reload the instance configuration
- `void RequestAction(string $Ident, mixed $Value)` – Function that is called when the visualization requests a value change.
- `bool RequireParent(string $ParentGUID)` – Connects an instance to a parent instance
- `array SendDataToChildren(string $Data)` – Sends data to all subordinate instances
- `string SendDataToParent(string $Data)` – Sends data to a higher-level instance
- `bool SendDebug(string $MessageName, string $Data, int $Format)` – Sends a message to the debug output
- `bool SetBuffer(string $Name, string $Data)` – Sets the content of a buffer
- `bool SetForwardDataFilter(string $RequiredRegexRule)` – Sets a “Regular Expression” filter for the ForwardData function
- `bool SetReceiveDataFilter(string $RequiredRegexRule)` – Sets a "Regular Expression"-Filter for the RecieveData function
- `bool SetStatus(int $StatusValue)` – Sets the status of an instance
- `bool SetSummary(string $ShortInfo)` – Sets the short info of an object
- `bool SetTimerInterval(string $Name, int $Interval)` – Sets the interval of a timer
- `bool SetValue(string $Ident, mixed $Value)` – Sets the value of a status variable
- `SetVisualizationType(int $VisualisierungsTyp)` – Sets the visualization type for the instance
- `string Translate(string $Text)` – Translates a section of text
- `bool UnregisterHook(string $Address)` – Unregisters a WebHook with the specified address
- `bool UnregisterMessage(int $SenderID, int $MessageID)` – Deactivates a message for a SenderID
- `bool UnregisterOAuth(string $Identifier)` – Unregisters an OAuth handler with the specified identifier
- `bool UnregisterReference(int $ID)` – Removes an ID as referenced
- `bool UnregisterVariable(string $Ident)` – Deletes a status variable
- `bool UpdateFormField(string $Field, string $Parameters, mixed $Value)` – Changes the parameter of a form field
- `bool UpdateVisualizationValue(mixed $Data)` – Sends a message to the visualization when using the HTML SDK
- `bool WriteAttributeBoolean(string $Name, bool $Value)` – Writes an attribute of the Boolean type
- `bool WriteAttributeFloat(string $Name, float $Value)` – Writes an attribute of the Float type
- `bool WriteAttributeInteger(string $Name, int $Value)` – Writes an attribute of the integer type
- `bool WriteAttributeString(string $Name, string $Value)` – Writes an attribute of the string type

## [1-Wire](modules/1-wire.md)

- `bool OW_SwitchMode(int $InstanceID, bool $Status)` – Sets the state of the device with the ID __InstanceID__ to value __Status__.
- `bool OW_ToggleMode(int $InstanceID)` – Changes the state of the device with the ID __InstanceID__. The current value can be queried in the state variable after the operation. -
- `bool OW_SetPin(int $InstanceID, int $Pin, bool $Status)` – Sets the state of the device with the ID __InstanceID__ to value __Status__
- `bool OW_SetPin(int $InstanceID, int $Pin, bool $Status)` – sets a pin from the DS2408 to on/ off
- `bool OW_SetPort(int $InstanceID, int $Bitmaske)` – Sets the state of all eight pins on the value of __Bitmask__ of the device with ID __InstanceID__
- `bool OW_SetStrobe(int $InstanceID, bool $Status)` – Makes it possible to put the RSTZ-pin of DS2408 of the device with ID __InstanzID__ to value __Status__
- `bool OW_WriteBytes(int $InstanceID, string $Data)` – Sets a sequence of bytes (__Data__) from all pins of the device with the ID __InstanceID__.
- `bool OW_WriteBytesMasked(int $InstanceID, string $Data, int $Mask)` – Sets a sequence of bytes (__Data__) taking into account a bitmask __Mask__ from all pins of the device with the ID __InstanceID__.
- `bool OW_SetPin(int $InstanceID, int $Pin, bool $Status)` – Sets the state of the pin __Pin__ of the device with the ID __InstanceID__ to value __Status__
- `bool OW_SetPin(int $InstanceID, int $Pin, bool $Status)` – Sets the state of the pin __Pin__ of the device with the ID __InstanceID__ to value __Status__
- `bool OW_SetPosition(int $InstanceID, int $Value)` – Sets the device with the ID __InstanceID__ to value __Value__
- `bool OW_RequestStatus(int $InstanceID)` – Executes a new read for the device with the ID __InstanceID__.

## [ALLNET](modules/allnet.md)

- `bool ALL_SetAnalog(int $InstanceID, int $ChannelID, float $Value)` – sets the analog value of a channel
- `bool ALL_SwitchActor(int $InstanceID, int $ChannelID, bool $Status)` – switches an ALLNET actuator on/off
- `bool ALL_SwitchMode(int $InstanceID, bool $Status)` – Switches the device with the ID __InstanceID__ to value __Status___
- `bool ALL_UpdateValues(int $InstanceID)` – Executes a update of the state variables for the device with the ID __InstanceID__.

## [BACnet](modules/bacnet.md)

- `bool BAC_RelinquishPresetValue(int $InstanceID)` – Resetting the preset value

## [Catan](modules/catan.md)

- `bool CATAN_CancelOverride(int $InstanzID)` – Cancels the overwriting of the channel
- `bool CATAN_ResetCounter(int $InstanzID)` – Resets the counter reading

## [digitalSTROM](modules/digitalstrom.md)

- `bool DS_CallScene(int $InstanceID, int $Scene)` – calls up a scene
- `bool DS_DimSet(int $InstanceID, int $Intensity)` – dims a digitalSTROM terminal to a specific value
- `string DS_MakeRequest(int $InstanceID, string $Request, string $Data)` – sends a digitalSTROM command directly to the dSS
- `bool DS_RequestStatus(int $InstanceID)` – retrieves the status
- `bool DS_ShutterMove(int $InstanceID, int $Position)` – moves the roller shutter to a desired position/stop
- `bool DS_ShutterMoveDown(int $InstanceID)` – moves the roller shutter down to the end position/stop
- `bool DS_ShutterMoveUp(int $InstanceID)` – moves the roller shutter up to the end position/stop
- `bool DS_ShutterStop(int $InstanceID)` – stops a motion
- `bool DS_SwitchMode(int $InstanceID, bool $Status)` – switches a digitalSTROM terminal on/off

## [DMX / ArtNet](modules/dmx-artnet.md)

- `bool DMX_FadeChannel(int $InstanceID, int $Channel, int $Value, float $FadeTime)` – Dims the __Channel__ of the device with ID __InstanceID to __Value__ with a certain __FadeTime__
- `bool DMX_FadeChannelDelayed(int $InstanceID, int $Channel, int $Value, float $FadeTime, float $DelyTime)` – 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.
- `bool DMX_FadeRGB(int $InstanceID, int $R, int $G, int $B, float $FadeTime)` – dims the RGB channel with a fade time
- `bool DMX_FadeRGBDelayed(int $InstanceID, int $R, int $G, int $B, float $FadeTime, float $DelayTime)` – dims the RGB channel with a fade time
- `bool DMX_RequestInfo(int $InstanceID)` – Queries the information of a DMX instance
- `bool DMX_ResetInterface(int $InstanceID)` – 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. -
- `bool DMX_SetBlackOut(int $InstanceID, bool $Status)` – Sets all channels of DMX interfaces with ID __InstanceID__ to value __ Status__.
- `bool DMX_SetChannel(int $InstanceID, int $Channel, int $Value)` – Switches the channel from the device with the ID __InstanceID__ to value __Wert__
- `bool DMX_SetRGB(int $InstanceID, int $R, int $G, int $B)` – sets the RGB channel to a certain value

## [EnOcean](modules/enocean.md)

- `bool ENO_DimSet(int $InstanceID, int $Intensity)` – Dims the device with ID __InstanceID__ to value __Intensity__.
- `bool ENO_SetActiveMessage(int $InstanceID, int $Message)` – activates a certain message
- `bool ENO_SetFanStage(int $InstanceID, int $FanStage)` – sets the FanStage to a certain value
- `bool ENO_SetIntensity(int $InstanceID, bool $Status, int $Intensity)` – Dims the device with ID __InstanceID__ to value __Intensity__. The value __Status__ indicates whether the device is to be switched on/ off.
- `bool ENO_SetLockFanStage(int $InstanceID, bool $Locked)` – locks the FanStage
- `bool ENO_SetLockRoomOccupancy(int $InstanceID, bool $Locked)` – locks the occupancy
- `bool ENO_SetMode(int $InstanceID, int $Value)` – sets the actuator in a certain mode
- `bool ENO_SetPosition(int $InstanceID, int $Value)` – sets the position of the actuator
- `bool ENO_SetRoomOccupancy(int $InstanceID, bool $Occupied)` – sets the occupancy to true/false
- `bool ENO_SetTemperature(int $InstanceID, float $Value)` – sets the actuator to a certain target temperature
- `bool ENO_SetTemperature1(int $InstanceID, float $Temperature)` – sets the device to a certain temperature
- `bool ENO_ShutterMoveDown(int $InstanceID)` – moves the roller shutter down to the end position/stop
- `bool ENO_ShutterMoveDownEx(int $InstanceID, float $Runtime)` – moves the roller shutter for a certain time
- `bool ENO_ShutterMoveUp(int $InstanceID)` – moves the roller shutter up to the end position/stop
- `bool ENO_ShutterMoveUpEx(int $InstanceID, float $Runtime)` – moves the roller shutter for a certain time
- `bool ENO_ShutterStop(int $InstanceID)` – stops a motion
- `bool ENO_SwitchMode(int $InstanceID, bool $Status)` – Switches the device with ID __InstanceID__ to value __Status__
- `bool ENO_SwitchModeEx(int $InstanceID, bool $Status, int $SendMode)` – Switches the device with ID __InstanceID__ to value __Status__

## [FHZ1X00PC](modules/fhz1x00pc.md)

- `bool FHT_SetMode(int $InstanceID, float $Mode)` – Sets the new desired mode for the FHT with ID __InstanzID__ to value __Mode__.
- `bool FHT_SetTemperature(int $InstanceID, float $Temperature)` – Sets the new desired temperature for the FHT with ID __InstanzID__ to value __Temperature__.
- `bool FS20_DimDown(int $InstanceID)` – Dims the device with ID __InstanceID__ down a level.
- `bool FS20_DimUp(int $InstanceID)` – Dims the device with ID __InstanceID__ up a level.
- `bool FS20_SetIntensity(int $InstanceID, int $Intensity, int $Duration)` – Dims the device with ID __InstanceID__ to value __Intensity__ in __Duration__ seconds.
- `bool FS20_SwitchDuration(int $InstanceID, bool $Status, int $Duration)` – Switches the device with ID __InstanceID__ to value __Status__ in __Duration__ seconds.
- `bool FS20_SwitchMode(int $InstanceID, bool $Status)` – Switches the device with ID __InstanceID__ to value __Status__.
- `bool HMS_ReleaseFI(int $InstanceID, int $TriggerDelay)` – Triggers the FI over the HMS device with ID __InstanceID__. The __TriggerDelay__ parameter is specified in seconds.

## [Heating Control](modules/heating-control.md)

- `bool HC_TargetValue(int $InstanceID, float $TagetValue)` – Sends via the instance with the ID __ InstanceID__ a target value to the heating module.

## [HomeMatic](modules/homematic.md)

- `array HM_ReadServiceMessages(int $InstanceID)` – Reads the service news of the CCU/ LAN adapter with the ID __InstanceID__.
- `bool HM_RequestStatus(int $InstanceID, string $Parameter)` – R
- `bool HM_WriteValueBoolean(int $InstanceID, string $Parameter, bool $Value)` – Sets the __Parameter__ of the device with ID __InstanceID__ to value __Value__.
- `bool HM_WriteValueFloat(int $InstanceID, string $Parameter, float $Value)` – S
- `bool HM_WriteValueInteger(int $InstanceID, string $Parameter, int $Value)` – Sets the __Parameter__ of the device with ID __InstanceID__ to value __Value__.
- `bool HM_WriteValueString(int $InstanceID, string $Parameter, string $Value)` – S

## [Image Grabber](modules/image-grabber.md)

- `bool IG_UpdateImage(int $InstanceID)` – updates the image of the instance

## [IPS-868](modules/ips-868.md)

- `bool PJ_RequestStatus(int $InstanceID)` – Query the status of variables and set them
- `bool PJ_SetVoltage(int $InstanceID, float $Volt)` – Sets the output to a specific voltage
- `bool PJ_RequestStatus(int $InstanceID)` – Queries the current values ​​for the device with the ID __InstanceID__ and writes it to the appropriate state variables. [
- `bool PJ_Backlight(int $InstanceID, bool $Status)` – turns the display backlight on or off
- `bool PJ_Beep(int $InstanceID, int $TenthsOfSeconds)` – outputs an audio signal
- `bool PJ_LCDText(int $InstanceID, int $Line, string $Text)` – sends a text to the display
- `bool PJ_SwitchLED(int $InstanceID, int $LED, bool $Status)` – switches an LED of the display
- `bool PJ_SwitchMode(int $InstanceID, bool $Status)` – switches an FS20 device on/off
- `bool PJ_RequestStatus(int $InstanceID)` – Query the status of variables and set them
- `bool PJ_RequestStatus(int $InstanceID)` – Query the status of variables and set them
- `bool PJ_RequestStatus(int $InstanceID)` – Query the status of variables and set them
- `bool PJ_SetLEDs(int $InstanceID, bool $Green, bool $Yellow, bool $Red)` – switches LEDs on the AirQualitySensor
- `bool PJ_DimRGBW(int $InstanceID, int $R, int $RTime, int $G, int $GZeit, int $B, int $BZeit, int $W, int $WZeit)` – Sends a dimming command to the RGBW-868 controller of the ID __InstanceID__.
- `bool PJ_RunProgram(int $InstanceID, int $Program)` – Sends a program command to the RGBW-868 controller of the ID __InstanceID__.
- `bool PJ_SetRGBW(int $InstanceID, int $R, int $G, int $B, int $W)` – sets a color value
- `bool PJ_DimServo(int $InstanceID, int $Channel, int $Value, int $Steps)` – incrementally sets a servo value
- `bool PJ_SetServo(int $InstanceID, int $Channel, int $Value)` – sets a servo channel
- `bool PJ_SwitchDuration(int $InstanceID, bool $Status, int $Dauer)` – Switches the relay from the WDT with ID __InstanceID__ to value __Status__ for __Duration__ seconds.
- `bool PJ_SwitchMode(int $InstanceID, bool $Status)` – Sends a switching command to the WDT-868 module of the ID __InstanceID__.

## [IR Trans](modules/irtrans.md)

- `bool IRT_SendOnce(int $InstanceID, string $RemoteControl, string $Button)` – sends an IR command

## [KNX](modules/knx.md)

- `bool EIB_Char(int $InstanceID, string $Letter)` – Sends a single letter
- `bool EIB_Counter8Bit(int $InstanceID, float $Value)` – sends an 8-bit counter value
- `bool EIB_Counter16Bit(int $InstanceID, float $Value)` – sends a 16bit counter value
- `bool EIB_Counter32Bit(int $InstanceID, float $Value)` – sends a 32bit counter value
- `bool EIB_Date(int $InstanceID, string $Date)` – sends the date value
- `bool EIB_DimControl(int $InstanceID, int $Value)` – 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.
- `bool EIB_DimValue(int $InstanceID, int $Value)` – 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.
- `bool EIB_DriveBladeValue(int $InstanceID, int $Value)` – 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.
- `bool EIB_DriveMove(int $InstanceID, bool $Direction)` – Moving the device with ID __InstanceID__ in a particular __Direction__. Depending on configuration the movement direction can be inverted. -
- `bool EIB_DriveShutterValue(int $InstanceID, int $Value)` – 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.
- `bool EIB_DriveStep(int $InstanceID, bool $StepTowards)` – Moving the device __Stepwise__ with ID __InstanceID__ into a determined __Direction__. Depending on the configuration, the movement direction can be inverted.
- `bool EIB_FloatValue(int $InstanceID, float $Value)` – sends a float value
- `bool EIB_Move(int $InstanceID, int $Direction)` – moves a roller shutter
- `bool EIB_Position(int $InstanceID, int $Position)` – moves a roller shutter to a position
- `bool EIB_PriorityControl(int $InstanceID, int $State)` – sets a device state
- `bool EIB_PriorityPosition(int $InstanceID, bool $Direction)` – Sets the device with ID __InstanceID__ to a certain __Direction__. Depending on configuration the direction can be inverted.
- `bool EIB_RequestStatus(int $InstanceID)` – sends a read request for EIB instances to the bus
- `bool EIB_Scale(int $InstanceID, int $Value)` – 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.
- `bool EIB_SetRGB(int $InstanceID, int $Red, int $Green, int $Blue)` – sets an RGB stripe to a specific color
- `bool EIB_SetRGBW(int $InstanceID, int $Red, int $Green, int $Blue, int $White)` – sets an RGBW stripe to a specific color
- `bool EIB_Str(int $InstanceID, string $String)` – sends a text
- `bool EIB_Switch(int $InstanceID, bool $Status)` – Switches the device with the ID __InstanceID__ to value __Status__
- `bool EIB_Time(int $InstanceID, string $Time)` – sends a time value
- `bool EIB_Value(int $InstanceID, float $Value)` – Sends the value __Value__ to the device with ID __InstanceID__.
- `bool KNX_RequestStatus(int $InstanceID)` – sends a read request for DPT instances on the bus

## [LCN](modules/lcn.md)

- `bool LCN_AddGroup(int $InstanceID, int $Group)` – adds a device to a group
- `bool LCN_AddIntensity(int $InstanceID, int $Intensity)` – Dims the device with ID __InstanceID__ brighter by the value __Intensity__.
- `bool LCN_AddThresholdCurrent(int $InstanceID, int $Register, int $Threshold, float $Value)` – adds threshold to current value
- `bool LCN_AddThresholdDefined(int $InstanceID, int $Register, int $Threshold, float $Value)` – adds threshold to predefined value
- `bool LCN_Beep(int $InstanceID, bool $SpecialTone, int $Number)` – Lets the instance with the ID __InstanceID__ beep
- `bool LCN_DeductIntensity(int $InstanceID, int $Intensity)` – Dims the device with ID __InstanceID__ darker by the value __Intensity__.
- `bool LCN_DeductThresholdCurrent(int $InstanceID, int $Register, int $Threshold, float $Value)` – deducts threshold from current value
- `bool LCN_DeductThresholdDefined(int $InstanceID, int $Register, int $Threshold, float $Value)` – deducts threshold from predefined value
- `bool LCN_FadeOut(int $InstanceID, int $Intensity, int $Ramp)` – Dims the devive with ID __InstanceID__ to value __Intensity__ and dims then with the __Ramp__ seconds down to 0%.
- `bool LCN_FlipRelay(int $InstanceID)` – Switches over the relay with the ID __InstanceID__
- `bool LCN_LimitOutput(int $InstanceID, int $Value, int $Time, string $TimeType)` – limits an output for a certain period of time
- `bool LCN_LoadScene(int $InstanceID, int $Scene)` – calls up a scene for an output
- `bool LCN_LockTargetValue(int $InstanceID, int $Target)` – locks a controller of the device
- `bool LCN_RampStop(int $InstanceID)` – Stops the dimming process of the device with the ID __InstanceID__
- `bool LCN_ReleaseTargetValue(int $InstanceID, int $Target)` – unlocks a controller of the device
- `bool LCN_RemoveGroup(int $InstanceID, int $Group)` – removes a device from a group
- `bool LCN_RequestLights(int $InstanceID)` – queries the LEDs of the panel
- `bool LCN_RequestRead(int $InstanceID)` – queries the values
- `bool LCN_RequestStatus(int $InstanceID)` – queries all statuses of the module
- `bool LCN_RequestThresholds(int $InstanceID)` – queries thresholds and hysteresis
- `bool LCN_SaveScene(int $InstanceID, int $Scene)` – saves a scene for an output
- `bool LCN_SelectSceneRegister(int $InstanceID, int $Register)` – selects a register
- `bool LCN_SendCommand(int $InstanceID, string $Function, string $Data)` – 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.
- `bool LCN_SetDisplayText(int $InstanceID, int $Line, string $Text)` – Shows a text on a line of the display
- `bool LCN_SetDisplayTime(int $InstanceID, int $Line, int $DisplayTime)` – sets the display time of a line in the display
- `bool LCN_SetIntensity(int $InstanceID, int $Intensity, int $Ramp)` – Dims the device with the ID __InstanceID__ to value __Intensity__ in __Ramp__ seconds.
- `bool LCN_SetLamp(int $InstanceID, int $Lamp, string $Action)` – switching an LED
- `bool LCN_SetRelay(int $InstanceID, string $Wert)` – sets all relays in a module (8 bit)
- `bool LCN_SetRGBW(int $InstanceID, int $Red, int $Green, int $Blue, int $White)` – sets an instance to an RGBW color value
- `bool LCN_SetTargetValue(int $InstanceID, int $Target, float $Value)` – Sets the regulator __Target__ of the instance with the ID __InstanceID__ to the value __Value__
- `bool LCN_ShiftTargetValue(int $InstanceID, int $Target, float $RelativeValue)` – Shifts the current target value
- `bool LCN_ShutterMove(int $InstanceID, int $Position)` – starts shutter movement to percentage position
- `bool LCN_ShutterMoveDown(int $InstanceID)` – starts a shutter movement downwards
- `bool LCN_ShutterMoveUp(int $InstanceID)` – starts a shutter movement upwards
- `bool LCN_ShutterStop(int $InstanceID)` – stops a shutter movement
- `bool LCN_StartFlicker(int $InstanceID, string $Flicker, string $Speed, int $FlickerCount)` – Let the device with the ID __InstanceID__ flicker
- `bool LCN_StopFlicker(int $InstanceID)` – Stop flickering of the device with the ID __InstanceID__ immediately
- `bool LCN_SwitchDurationMin(int $InstanceID, int $Minutes, string $DimmingTime, bool $Preserving)` – after how many minutes it should be dimmed down
- `bool LCN_SwitchDurationSec(int $InstanceID, int $Seconds, string $DimmingTime, bool $Preserving)` – after how many seconds it should be dimmed down
- `bool LCN_SwitchMemory(int $InstanceID, int $Ramp)` – Switches the device with the ID __InstanceID__to a stored value
- `bool LCN_SwitchMode(int $InstanceID, int $Ramp)` – switches a device on/off
- `bool LCN_SwitchRelay(int $InstanceID, bool $Status)` – Switches the relay with the ID __InstanceID__ to value __Status__
- `bool LCN_SwitchRelayTimer(int $InstanceID, int $TimeFactor)` – switches a relay on a time factor

## [LJQuick](modules/ljquick.md)

- `bool LJ_SendDateTime(int $InstanceID)` – Sends the current date/time to the KNX bus

## [M-Bus](modules/mbus.md)

- `bool MBUS_UpdateValues(int $InstanceID)` – updates all device-specific values

## [Modbus RTU/TCP](modules/modbus-rtu-tcp.md)

- `bool ModBus_RequestRead(int $InstanceID)` – Executes a new read for the device with the ID __InstanceID__.
- `bool ModBus_WriteCoil(int $InstanceID, bool $Status)` – Sets address with ID __InstanceID__ to __Value__
- `bool ModBus_WriteRegister(int $InstanceID, float $Value)` – writes a value to the write address
- `bool ModBus_WriteRegisterByte(int $InstanceID, int $Value)` – Sets address with ID __InstanceID__ to __Value__
- `bool ModBus_WriteRegisterChar(int $InstanceID, int $Value)` – Sets address with ID __InstanceID__ to __Value__
- `bool ModBus_WriteRegisterDWord(int $InstanceID, int $Wert)` – Sets address with ID __InstanceID__ to __Value__
- `bool ModBus_WriteRegisterInt64(int $InstanceID, int $Value)` – Sets address with ID __InstanceID__ to __Value__
- `bool ModBus_WriteRegisterInteger(int $InstanceID, int $Value)` – Sets address with ID __InstanceID__ to __Value__
- `bool ModBus_WriteRegisterReal(int $InstanceID, float $Value)` – Sets address with ID __InstanceID__ to __Value__
- `bool ModBus_WriteRegisterReal64(int $InstanceID, float $Value)` – Sets address with ID __InstanceID__ to __Value__
- `bool ModBus_WriteRegisterShort(int $InstanceID, int $Value)` – Sets address with ID __InstanceID__ to __Value__
- `bool ModBus_WriteRegisterString(int $InstanceID, string $Value)` – Sets address with ID __InstanceID__ to __Value__
- `bool ModBus_WriteRegisterWord(int $InstanceID, int $Value)` – Sets address with ID __InstanceID__ to __Value__

## [Möhlenhoff Alpha 2](modules/moehlenhoff-alpha-2.md)

- `bool MA2_RequestStatus(int $InstanceID)` – Gets the values stored in the Alpha2 with the InstanceID and sets the associated variables.
- `bool MA2_WriteValue(int $InstanceID, string $Ident, mixed $Value)` – Writes the Value into the variable with the Ident in the Möhlenhoff Alpha 2 with the InstanceID.

## [NEA Smart](modules/nea-smart.md)

- `bool NEAS_RequestStatus(int $InstanceID)` – Gets the values stored in the NEA Smart with the InstanceID and sets the associated variables.
- `bool NEAS_WriteValue(int $InstanceID, string $Ident, mixed $Value)` – Writes the Value to the variable with the ident in the NEA Smart with the InstanceID.

## [OCPP](modules/ocpp.md)

- `bool OCPP_RemoteStartTransaction(int $InstanceID, int $ConnectorID)` – If the status is 'Preparing' or 'Finishing', loading can be enabled by this command.
- `bool OCPP_RemoteStopCurrentTransaction(int $InstanzID, int $ConnectorID)` – If the state is 'Charging', this command can be used to stop charging.
- `bool OCPP_RemoteStopTransaction(int $InstanzID, int $TransactionID)` – If the state is 'Charging', this command can be used to stop charging.

## [Shutter Control](modules/shutter-control.md)

- `bool SC_Move(int $InstanceID, int $Position)` – moves the shutter to a specific position
- `bool SC_MoveDown(int $InstanceID, int $Duration)` – moves the shutter down to the end position
- `bool SC_MoveUp(int $InstanceID, int $Duration)` – moves the shutter up to the end position
- `bool SC_Stop(int $InstanceID)` – stops a movement

## [Siemens OZW](modules/siemens-ozw.md)

- `bool OZW_RequestStatus(int $InstanceID)` – requests the status of a device
- `bool OZW_WriteDataPoint(int $InstanceID, mixed $Value)` – writes a specific value to a data point

## [SNMP](modules/snmp.md)

- `bool SNMP_UpdateValues(int $InstanzID)` – Updates the variable values which are below the instance.

## [PLC: Siemens, Vipa, Logo](modules/sps-siemens-vipa-logo.md)

- `bool S7_RequestRead(int $InstanceID)` – performs a read operation on a device
- `bool S7_Write(int $InstanceID, float $Value)` – writes a value to the configured address
- `bool S7_WriteBit(int $InstanceID, bool $Value)` – Set the address with the ID __InstanceID__ to value status
- `bool S7_WriteByte(int $InstanceID, int $Value)` – Set the address with the ID __InstanceID__ to __Value__
- `bool S7_WriteChar(int $InstanceID, int $Value)` – Set the address with the ID __InstanceID__ to __Value__
- `bool S7_WriteDWord(int $InstanceID, int $Value)` – Set the address with the ID __InstanceID__ to __Value__
- `bool S7_WriteInteger(int $InstanceID, int $Value)` – Set the address with the ID __InstanceID__ to __Value__
- `bool S7_WriteReal(int $InstanceID, float $Value)` – Set the address with the ID __InstanceID__ to __Value__
- `bool S7_WriteShort(int $InstanceID, int $Value)` – Set the address with the ID __InstanceID__ to __Value__
- `bool S7_WriteWord(int $InstanceID, int $Value)` – Set the address with the ID __InstanceID__ to __Value__

## [Door Intercom](modules/door-intercom.md)

- `void DoorIP_Accept(int $InstanceID)` – accepts the current call.
- `void DoorIP_Accept(int $InstanceID)` – rejects the current call.
- `void DoorIP_SendDTMF(int $InstanceID, string $Digits)` – sends DTMF characters on the current connection.

## [Voice over IP](modules/voip.md)

- `bool VoIP_AcceptCall(int $InstanceID, int $ConnectionID)` – accepts a connection
- `int VoIP_Connect(int $InstanceID, string $Number)` – establishes a connection
- `bool VoIP_Disconnect(int $InstanceID, int $ConnectionID)` – terminates a connection
- `array VoIP_GetConnection(int $InstanceID, int $ConnectionID)` – returns information about a connection
- `string VoIP_GetData(int $InstanceID, int $ConnectionID)` – returns data of a connection
- `bool VoIP_PlayWave(int $InstanceID, int $ConnectionID, string $Filename)` – plays a wave file
- `bool VoIP_RejectCall(int $InstanceID, int $ConnectionID)` – rejects a connection
- `bool VoIP_SendDTMF(int $InstanceID, int $ConnectionID, string $DTMF)` – sends a sequence of characters as DTMF
- `bool VoIP_SetData(int $InstanceID, int $ConnectionID, string $Data)` – sets the data of a connection

## [WinLIRC](modules/winlirc.md)

- `bool WinLIRC_SendOnce(int $InstanceID, string $RemoteControl, string $Button)` – 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).

## [W&T](modules/wut.md)

- `bool WUT_SwitchMode(int $InstanceID, bool $Status)` – Switches the channel with ID __InstanceID__ to value __Status__.

## [XBee](modules/xbee.md)

- `bool XBee_SendBuffer(int $InstanceID, int $TargetDevice, string $Buffer)` – sends a data string to a specific device
- `bool XBee_SendCommand(int $InstanceID, string $Command)` – sends a command to a specific XBee-Splitter

## [Eaton xComfort](modules/xcomfort.md)

- `bool MXC_DimBrighter(int $InstanceID)` – starts dimming to a brighter level
- `bool MXC_DimDarker(int $InstanceID)` – starts dimming to a darker level
- `bool MXC_DimSet(int $InstanceID, int $Intensity)` – dims an xComfort device to a specific level
- `bool MXC_DimStop(int $InstanceID)` – stops a dimming process
- `bool MXC_RequestStatus(int $InstanceID)` – sends a status request to a device
- `bool MXC_SendBoolean(int $InstanceID, bool $Value)` – Sends a boolean value to the instance with ID __InstanceID__, which is connected to a room manager.
- `bool MXC_SendFloat(int $InstanceID, float $Value)` – Sends a float to the instance with ID __InstanceID__, which is connected to a room manager.
- `bool MXC_SendInteger(int $InstanceID, int $Value)` – Sends a boolean value to the instance with ID __InstanceID__, which is connected to a room manager.
- `bool MXC_SetTemperature(int $InstanceID, float $Temperature)` – Sets the new target temperature of the control valve with the ID __InstanceID__ to the new __Temperature__.
- `bool MXC_ShutterMoveDown(int $InstanceID)` – moves the shutter down to the end position/stop
- `bool MXC_ShutterMoveUp(int $InstanceID)` – moves the shutter up to the end position/stop
- `bool MXC_ShutterStepDown(int $InstanceID)` – moves the shutter down a step
- `bool MXC_ShutterStepUp(int $InstanceID)` – moves the shutter up a step
- `bool MXC_ShutterStop(int $InstanceID)` – stops a movement
- `bool MXC_SwitchMode(int $InstanceID, bool $Status)` – switches an xComfort device on/off

## [Z-Wave](modules/z-wave.md)

- `bool ZW_Basic(int $InstanceID, int $Value)` – Turns the basic function of the specified device with InstanceID __InstanceID__
- `bool ZW_ColorCW(int $InstanceID, int $ColdWhite)` – sets the cold-white channel of a RGBWW Z-Wave device
- `bool ZW_ColorRGB(int $InstanceID, int $Red, int $Green, int $Blue)` – sets the color of a Z-Wave device
- `bool ZW_ColorRGBWW(int $InstanceID, int $Red, int $Green, int $Blue, int $WarmWhite, int $ColdWhite)` – sets the colors and intensity of an RGBWW Z-Wave device
- `bool ZW_ColorWW(int $InstanceID, int $WarmWhite)` – sets the WarmWhite channel of a Z-Wave device
- `bool ZW_DimDown(int $InstanceID)` – starts dimming down
- `bool ZW_DimDownEx(int $InstanceID, int $Duration)` – starts dimming down with a runtime
- `bool ZW_DimSet(int $InstanceID, int $Intensity)` – dims a Z-Wave device to a specific level
- `bool ZW_DimSetEx(int $InstanceID, int $Intensity, int $Duration)` – dims a Z-Wave device to a specific level within a runtime
- `bool ZW_DimStop(int $InstanceID)` – stops dimming a Z-Wave device
- `bool ZW_DimUp(int $InstanceID)` – starts dimming up
- `bool ZW_DimUpEx(int $InstanceID, int $Duration)` – starts dimming up within a runtime
- `bool ZW_DoorLockOperation(int $InstanceID, int $Mode)` – Sets the door lock operation mode of a Z-Wave device
- `bool ZW_LockMode(int $InstanceID, int $Value)` – sets the LockMode
- `bool ZW_MeterReset(int $InstanceID)` – resets the meter
- `bool ZW_Optimize(int $InstanceID)` – Starts the wireless network optimization process for a Z-Wave device
- `bool ZW_ProtectionSet(int $InstanceID, int $Mode)` – sets the Protection and its Mode
- `bool ZW_RequestStatus(int $InstanceID)` – 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.
- `bool ZW_ShutterMoveDown(int $InstanceID)` – Moves the shutter with the ID __InstanceID__ downwards until (link: page://f1hDSVmdoBuVvjEW text: MXC_ShutterStop) is running or the end position is reached.
- `bool ZW_ShutterMoveUp(int $InstanceID)` – Moves the shutter with the ID __InstanceID__ upwards until (link: page://f1hDSVmdoBuVvjEW text: MXC_ShutterStop) is running or the end position is reached.
- `bool ZW_ShutterStop(int $InstanceID)` – Stops a current movement of the shutter.
- `bool ZW_SwitchAllMode(int $InstanceID, int $Mode)` – Sets the Switch All mode of a Z-Wave device
- `bool ZW_SwitchMode(int $InstanceID, bool $Status)` – switches a Z-Wave device on/off
- `bool ZW_Test(int $InstanceID)` – Tests if a connection to a Z-Wave device is working
- `bool ZW_ThermostatFanModeSet(int $InstanceID, int $FanMode)` – Sets the FanMode for the thermostat
- `bool ZW_ThermostatModeSet(int $InstanceID, int $Mode)` – Sets the thermostat mode
- `bool ZW_ThermostatSetPointSet(int $InstanceID, int $SetPoint, float $Value)` – Sets the PointSet Value

## [Zevvy](modules/zevvy.md)

- `bool ZY_SendMeasurements(int $InstanzID)` – Sends the data of the set up variables to a Zevvy account

## [Active List](modules/active-list.md)

- `bool AL_SwitchOff(int $InstanzID)` – Switches all active variables in the list to inactive.

## [Presence Simulation](modules/presence-simulation.md)

- `bool AS_SetSimulation(int $InstanceID, bool $SetActive)` – De-/Activate the presence simulation

## [Image Archive](modules/image-archive.md)

- `bool BA_AddImage(int $InstanceID)` – Copies the current source image to the "Images" category of the "ImageArchive" module with the InstanceID.

## [CSV ZIP Export](modules/csv-zip-export.md)

- `bool CSV_DeleteZip(int $InstanceID)` – Removes the generated file.
- `string CSV_Export(int $InstanceID, int $ArchiveVariable, int $AggregationStage, int $AggregationStart, int $AggregationEnd)` – Creates a zip archive based on the given parameters.
- `bool CSV_SendMail(int $InstanceID)` – Sends a mail through an SMTP instance with a generated zip file

## [Computation Module](modules/computation-module.md)

- `bool RM_Update(int $InstanceID)` – Updates the calculated values
- `float UMR_Calculate(int $InstanceID, float $Value)` – Calculates the return of the formula for the Value and returns it.
- `float UMG_Calculate(int $InstanceID, float $Value)` – Calculates the return of the formula for the value __Value__ and returns it.
- `bool VRC_Scale(int $InstanceID)` – Scales the input variable value

## [RGBMultiplexer](modules/rgbmultiplexer.md)

- `bool RGBM_RequestStatus(int $InstanceID)` – Determines the value of the individual R, G, B channels and sets the color variable.
- `bool RGBM_SetRGB(int $InstanceID, int $Red, int $Green, int $Blue)` – Sends the R, G, B values to the individual channels and updates the color variable

## [DragPointer](modules/dragpointer.md)

- `bool SZ_Reset(int $InstanceID)` – Resets the drag pointer

## [Game Collection](modules/game-collection.md)

- `bool ZR_Generate(int $InstanceID)` – Generates a new number that can be guessed

## [Scene Control](modules/scene-control.md)

- `bool SZS_CallScene(int $InstanceID, int $SceneNumber)` – Calls the scene and sets it associated variables
- `int SZS_GetActiveScene(int $InstanceID)` – Returns the number of the scene that is currently active.
- `bool SZS_SaveScene(int $InstanceID, int $SceneNumber)` – Saves the values of the variables present in the list in the corresponding scene.

## [Staircase Light Controls](modules/staircase-light-controls.md)

- `bool THL_SetActive(int $InstanceID, bool $Value)` – Activates or deactivates the staircase lighting control.
- `bool THL_Start(int $InstanceID)` – Activates the light in the staircase and starts the timer, which deactivates the light again.
- `bool THL_Stop(int $InstanceID)` – Deactivates the light in the staircase and the timer.

## [Rain Central](modules/rain-central.md)

- `bool UWZ_RequestInfo(int $InstanceID)` – Calculates the variable rain value of the rain central module

## [Variable Comparison](modules/variable-comparison.md)

- `void LR_Download(int $InstanceID)` – Regenerates the graph and outputs an address
- `array LR_GenerateChart(int $InstanceID)` – Regenerates the chart and returns it as SVG and PNG.
- `void LR_UpdateChart(int $InstanceID)` – Regenerates the diagram

## [Random Lighting](modules/random-lighting.md)

- `bool ZB_ChangeLight(int $InstanceID)` – Selects random colors and sets the selected variables to them

## [Work Efficiency](modules/work-efficiency.md)

- `bool ARZ_Calculation(int $InstanceID)` – Calculates the efficiency

## [Operating Hours Counter](modules/operating-hours-counter.md)

- `void BSZ_Calculate(int $InstanceID)` – The operating hours variable is set to the calculated value

## [Energy Counter](modules/energy-counter.md)

- `bool EZI_Update(int $InstanceID)` – Updates the calculated values of the 'Energy Counter Pulse'-module with the InstanceID InstanceID.
- `bool EZS_Update(int $InstanceID)` – Updates the calculated values of the Energy Counter Power module with the InstanceID.

## [Power Billing Module](modules/power-billing-module.md)

- `bool SAM_UpdateCalculations(int $InstanceID)` – Calculates all values

## [Power price](modules/power-price.md)

- `bool SPX_Update(int $InstanceID)` – Updates the data

## [Consumption per Category](modules/consumption-per-category.md)

- `bool VIK_CalculateConsumption(int $InstanceID)` – Recalculates the categories

## [Consumption within Timespan](modules/consumption-within-timespan.md)

- `bool VIZ_Calculate(int $InstanceID)` – Recalculates consumption between start and end dates

## [Consumption Behaviour](modules/consumption-behaviour.md)

- `bool VBV_UpdateCalculation(int $InstanceID)` – The function updates the predicted values

## [Calculated Counter](modules/calculated-counter.md)

- `bool VM_Update(int $InstanceID, float $PrimaryDelta)` – Berechnet die Steigung der sekundären Messstellen und addiert dieses mit dem Ergebnis

## [Virtual Counter](modules/virtual-counter.md)

- `void VZ_WriteNewCounterValue(int $InstanceID)` – After checking, sets the current counter reading

## [Reading (Day)](modules/reading-day.md)

- `bool ZST_Calculate(int $InstanceID)` – Recalculates the value for the selected date

## [Tile Visualization](modules/tile-visualization.md)

- `void VISU_OpenObject(int $InstanzID, int $ObjektID, string $TokenList)` – opens a specific object in the Tile Visualization.
- `mixed VISU_PostNotification(int $InstanceID, string $Title, string $Text, string $Type, int $TargetID)` – sends a push notification to the tile visualization
- `mixed VISU_PostNotificationEx(int $InstanceID, string $Title, string $Text, string $Icon, string $Sound, int $TargetID)` – sends a push notification to the tile visualization

## [WebFront Visualization](modules/webfront-visualization.md)

- `bool WFC_AudioNotification(int $InstanceID, string $Title, int $MediaID)` – sends an audio message to the WebFront
- `bool WFC_OpenCategory(int $InstanceID, int $CategoryID)` – Opens a category as a popup in the WebFront
- `bool WFC_PushNotification(int $InstanceID, string $Title, string $Text, string $Sound, int $TargetID)` – sends a push message to the mobile apps
- `bool WFC_Reload(int $InstanceID)` – reloads the WebFront on the client computer
- `bool WFC_SendNotification(int $InstanceID, string $Title, string $Text, string $Icon, int $Timeout)` – sends a small message to the WebFront
- `bool WFC_SendPopup(int $InstanceID, string $Title, string $Text)` – sends a large message to the WebFront
- `bool WFC_SwitchPage(int $InstanceID, string $PageName)` – switches the tab in the WebFront

## [Alerting](modules/alerting.md)

- `int ARM_GetLastAlertID(int $InstanceID)` – Returns the ID of the variable that last triggered an alarm.
- `bool ARM_SetActive(int $InstanceID, bool $Value)` – Switches the alarming module with the InstanceID __InstanceID__ to the value __Value__ (true = On; false = Off).
- `bool ARM_SetAlert(int $InstanceID, bool $Value)` – Switches the alarm with the InstanceID __InstanceID__ to the value __Value__ (true = On; false = Off).

## [Notification](modules/notification.md)

- `bool BN_IncreaseLevel(int $InstanceID)` – Increases the level and performs the action
- `bool BN_Reset(int $InstanceID)` – Resets the notification level and disables the chain
- `bool BN_SetNotifyLevel(int $InstanceID, int $Level)` – Sets the notification to a specified level

## [Announcement](modules/announcement.md)

- `bool DS_Play(int $InstanceID, string $Text)` – Plays the text as an announcement.

## [Dynamic Mail](modules/dynamic-mail.md)

- `bool DM_SendMail(int $InstanceID)` – Use the subject and text to send an e-mail.

## [IMAP](modules/imap.md)

- `bool IMAP_DeleteMail(int $InstanceID, string $UID)` – deletes a mail with a specific e-mail(UID)
- `array IMAP_GetCachedMails(int $InstanceID)` – The 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.
- `array IMAP_GetMailEx(int $InstanceID, string $UID)` – This 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.

## [MediaPlayer](modules/mediaplayer.md)

- `bool WAC_AddFile(int $InstanceID, string $Filename)` – adds a music file to the playlist
- `bool WAC_ClearPlaylist(int $InstanceID)` – clears the playlist
- `int WAC_GetPlaylistLength(int $InstanceID)` – returns the length of the playlist
- `int WAC_GetPlaylistPosition(int $InstanceID)` – returns the current position in the playlist
- `bool WAC_Next(int $InstanceID)` – plays the next title of the playlist
- `bool WAC_Pause(int $InstanceID)` – pauses the playback
- `bool WAC_Play(int $InstanceID)` – plays the playlist
- `bool WAC_PlayFile(int $InstanceID, string $Filename)` – plays a music file directly
- `bool WAC_Prev(int $InstanceID)` – plays the previous title of the playlist
- `bool WAC_SetPlaylistPosition(int $InstanceID)` – sets the position in the playlist
- `bool WAC_SetPosition(int $InstanceID, int $Seconds)` – Sets the position marker in the media player with the ID __InstanceID__ to the specified __Seconds__. The title must be played at execution time already.
- `bool WAC_SetRepeat(int $InstanceID, bool $Repeat)` – switches the repetition of the playlist on/off
- `bool WAC_SetShuffle(int $InstanceID, bool $Shuffle)` – switches the shuffle playback on/off
- `bool WAC_SetVolume(int $InstanceID, int $Volume)` – sets the volume
- `bool WAC_Stop(int $InstanceID)` – stops the playback

## [POP3](modules/pop3.md)

- `bool POP3_DeleteMail(int $InstanceID, string $UID)` – deletes a mail with a specific e-mail(UID)
- `array POP3_GetCachedMails(int $InstanceID)` – The 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.
- `array POP3_GetMailEx(int $InstanceID, string $UID)` – returns an array with information for a specific e-mail (UID)

## [SMS](modules/sms.md)

- `bool SMS_Send(int $InstanceID, string $Number, string $Text)` – sends an SMS to a number

## [SMTP](modules/smtp.md)

- `bool SMTP_SendMail(int $InstanceID, string $Subject, string $Body)` – sends an e-mail to the default address
- `bool SMTP_SendMailAttachment(int $InstanceID, string $Subject, string $Body, string $FilePath)` – sends an e-mail with attachment to the default address
- `bool SMTP_SendMailAttachmentEx(int $InstanceID, string $Recipient, string $Subject, string $Body, string $FilePath)` – sends an email with an attachment to any address
- `bool SMTP_SendMailEx(int $InstanceID, string $Receiver, string $Subject, string $Body)` – sends an e-mail to any address
- `bool SMTP_SendMailMedia(int $InstanceID, string $Subject, string $Body, int $MediaID)` – sends an email with an attachment of a media object of type "image/sound" to the default address
- `bool SMTP_SendMailMediaEx(int $InstanceID, string $Recipient, string $Subject, string $Body, int $MediaID)` – sends an e-mail with an attachment of a media object of the "image/sound" type to any address

## [Spotify](modules/spotify.md)

- `string SPO_MakeAPIRequest(int $InstanceID, string $Method, string $Url, string $Body)` – Makes a request to the Spotify web API with the specified parameters
- `bool SPO_NextTrack(int $InstanceID)` – If a current playback exists, the next song will be played.
- `bool SPO_Pause(int $InstanceID)` – If a current playback exists, it will be paused.
- `bool SPO_Play(int $InstanceID)` – If a current, possibly paused, playback exists, it will be continued.
- `bool SPO_PlayURI(int $InstanceID, string $URI)` – Plays the Spotify resource with the URI __URI__ on the currently selected device.
- `bool SPO_PreviousTrack(int $InstanceID)` – If a current playback exists, the previous song will be played.
- `bool SPO_ResetToken(int $InstanceID)` – Resets the OAuth-token and thus the link to the Spotify account.
- `bool SPO_SetRepeat(int $InstanceID, string $Repeat)` – Sets the repeat to the value Repeat.
- `bool SPO_SetShuffle(int $InstanceID, bool $Shuffle)` – If Shuffle is true, random playback is enabled, otherwise disabled.

## [SymconReport](modules/symconreport.md)

- `bool MR_SendInfo(int $InstanceID)` – Sends an info mail about the last completed time interval
- `bool MR_SetActive(int $InstanceID, bool $Active)` – Enables or disables the module
- `bool RAC_GenerateEnergyReport(int $InstanceID)` – Generates a PDF with the values specified in the module with the InstanceID
- `bool RAC_GenerateReport(int $InstanceID)` – Generates a PDF with the values specified in the module with the InstanceID
- `bool RAC_GenerateReport(int $InstanceID)` – Generates a PDF with the values specified in the module with the InstanceID

## [Phone Announcement](modules/phone-announcement.md)

- `void TA_StartCall(int $InstanceID)` – Starts a call based on the current setting.
- `void TA_StartCallEx(int $InstanzID, string $Telefonnummer, string $Text)` – Starts a call to a phone number and outputs the text

## [Text to Speech](modules/text-to-speech.md)

- `bool TTS_GenerateFile(int $InstanceID, string $Text, string $Filename, int $Format)` – generates a WAV file with the desired text
- `bool TTS_Speak(int $InstanceID, string $Text, bool $Waiting)` – speaks any text on the selected sound card

## [TTSAWSPolly](modules/ttsawspolly.md)

- `string TTSAWSPOLLY_GenerateData(int $InstanceID, string $Text)` – Queries the text via AWS and returns the speech data in the return.
- `string TTSAWSPOLLY_GenerateFile(int $InstanceID, string $Text)` – Queries the text via AWS and returns the file name to the vocie data.

## [Consumption Alert](modules/consumption-alert.md)

- `void VBA_CheckAlert(int $InstanceID, string $BorderValue, string $OldValue)` – Checks whether a limit value is exceeded

## [Water Alert](modules/water-alert.md)

- `bool WAA_CheckAlert(int $InstanzID, string $BorderValue, string $OldValue)` – Checks whether the limit values ​​have been exceeded

## [Watchdog](modules/watchdog.md)

- `array WD_GetAlertTargets(int $InstanzID)` – returns an array with the overdue variables
- `bool WD_SetActive(int $InstanzID, bool $SetActive)` – de-/activate the instance

## [Archive Control](modules/archive-control.md)

- `bool AC_AddLoggedValues(int $InstanceID, int $VariableID, array $Datasets)` – adds further data records to a logged variable
- `bool AC_ChangeVariableID(int $InstanceID, int $OldVariableID, int $NewVariableID)` – migrates the data of a variable into a variable that has not yet been logged
- `int AC_DeleteVariableData(int $InstanceID, int $VariableID, int $StartTime, int $EndTime)` – deletes all data records of a logged variable in a certain period of time
- `array AC_GetAggregatedValues(int $InstanceID, int $VariableID, int $AggregationLevel, int $StartTime, int $EndTime, int $Limit)` – gets aggregated data from the archive
- `int AC_GetAggregationType(int $InstanceID, int $VariableID)` – indicates the aggregation type of a variable
- `array AC_GetAggregationVariables(int $InstanceID, bool $DatabaseQuery)` – returns an array of all logged variables
- `array AC_GetCompaction(int $InstanceID, int $VariableID)` – returns the compaction entries of a variable
- `bool AC_GetCounterIgnoreZeros(int $InstanceID, int $VariableID)` – gets the status whether zeros and negative values are ignored
- `bool AC_GetGraphStatus(int $InstanceID, int $VariableID)` – asks whether a variable is being visualized
- `array AC_GetLoggedValues(int $InstanceID, int $VariableID, int $StartTime, int $End time, int $Limit)` – gets raw data from the Archive Control
- `bool AC_GetLoggingStatus(int $InstanceID, int $VariableID)` – asks whether a variable is logged
- `bool AC_ReAggregateVariable(int $InstanceID, int $VariableID)` – starts the re-aggregation of a variable
- `bool AC_SetAggregationType(int $InstanceID, int $VariableID, int $Aggregation_Type)` – sets the aggregation type of a variable
- `bool AC_SetCompaction(int $InstanceID, int $VariableID, int $MonthOffset, int $CompactionType)` – Configures the compression of the variable
- `bool AC_SetCounterIgnoreZeros(int $InstanceID, int $VariableID, bool $IgnoreZeros)` – sets the status whether zeros and negative values are ignored
- `bool AC_SetGraphStatus(int $InstanceID, int $VariableID, bool $Active)` – sets the property for the visualization of a variable
- `bool AC_SetLoggingStatus(int $InstanceID, int $VariableID, bool $Active)` – sets the property for logging a variable

## [Cutter](modules/cutter.md)

- `bool Cutter_ClearBuffer(int $InstanceID)` – clears the buffer of the cutter instance

## [DNS-SD Control](modules/dns-sd-control.md)

- `array ZC_QueryService(int $InstanceID, string $Name, string $RegType, string $Domain)` – requests information from a single service
- `array ZC_QueryServiceType(int $InstanceID, string $RegType, string $Domain (optional))` – requests information from services of a certain type
- `array ZC_QueryServiceTypes(int $InstanceID)` – Queries all the services that have been set up

## [Presence Control](modules/presence-control.md)

- `bool PC_Enter(int $InstanceID)` – sets presence to true
- `bool PC_Leave(int $InstanceID)` – sets presence to false

## [RegisterVariable](modules/registervariable.md)

- `bool RegVar_GetBuffer(int $InstanceID)` – reads the internal buffer
- `bool RegVar_SendEvent(int $InstanceID, int $ReportID, string $Text)` – sends an event to the parent HID instance
- `bool RegVar_SendPacket(int $InstanceID, string $Text, string $ClientIP, string $ClientPort)` – sends a data packet to the specified IP address
- `bool RegVar_SendText(int $InstanceID, string $Text)` – sends data to the parent instance
- `bool RegVar_SetBuffer(int $InstanceID, string $Buffer)` – sets the internal buffer

## [SSDP Control](modules/ssdp-control.md)

- `array YC_SearchDevices(int $InstanceID, string $SearchTarget)` – sends a request to the local network

## [System Information](modules/system-information.md)

- `array Sys_GetBattery()` – displays information about the battery
- `array Sys_GetCPUInfo()` – shows the CPU usage
- `array Sys_GetHardDiskInfo()` – shows the hard disk space/usage
- `array Sys_GetMemoryInfo()` – shows the memory usage
- `array Sys_GetNetworkInfo()` – shows information about the network adapters
- `array Sys_GetProcessInfo()` – lists all processes
- `array Sys_GetSpooler()` – displays information about the printer queues
- `string Sys_GetURLContent(string $URL)` – reads the content from an URL as String
- `string Sys_GetURLContentEx(string $URL, array $Parameter)` – Reads the contents of the __URL__ and returns it as a return value. Here, some __Parameter__ for timeouts, authentication and proxy are made. -
- `bool Sys_Ping(string $Host, int $Timeout)` – sends a ping to a network device

## [WebHook Control](modules/webhook-control.md)

- `bool WC_PushMessage(int $InstanceID, string $HookPath, string $Message)` – sends a WebSocket message to all connected clients
- `bool WC_PushMessageEx(int $InstanceID, string $HookPath, string $Text, string $DestinationAddress, int $DestinationPort)` – sends a WebSocket message to a specific client

## [Client Socket](modules/clientsocket.md)

- `bool CSCK_SendText(int $InstanceID, string $Text)` – sends a string to the I/O

## [HID](modules/hid.md)

- `bool HID_SendEvent(int $InstanceID, int $ReportID, string $Text)` – sends a string to the I/O

## [HTTP Client](modules/httpclient.md)

- `bool WWW_UpdatePage(int $InstanceID)` – lets you query the configured URL

## [Multicast Socket](modules/multicastsocket.md)

- `bool MSCK_SendText(int $InstanceID, string $Text)` – sends a string to the I/O

## [Serial Port](modules/serialport.md)

- `bool SPRT_SendText(int $InstanceID, string $Text)` – sends a string to the I/O
- `bool SPRT_SetBreak(int $InstanceID, bool $OnOff)` – switches the break of a serial port instance
- `bool SPRT_SetDTR(int $InstanceID, bool $OnOff)` – switches the DTR of a serial port instance
- `bool SPRT_SetRTS(int $InstanceID, bool $OnOff)` – switches the RTS of a serial port instance

## [Server Socket](modules/serversocket.md)

- `bool SSCK_SendPacket(int $InstanceID, string $Text, string $ClientIP, int $ClientPort)` – sends a string to the I/O
- `bool SSCK_SendText(int $InstanceID, string $Text)` – sends a string to the I/O

## [UDP Socket](modules/udpsocket.md)

- `bool USCK_SendPacket(int $InstanceID, string $Text, string $ClientIP, int $ClientPort)` – sends a string to the I/O
- `bool USCK_SendText(int $InstanceID, string $Text)` – sends a string to the I/O

## [Virtual I/O](modules/virtualio.md)

- `bool VIO_Connect(int $InstanceID, string $ClientIP, int $ClientPort)` – sends a Connect Data-Packet
- `bool VIO_Disconnect(int $InstanceID, string $ClientIP, int $ClientPort)` – sends a Disconnect Data-Packet
- `array VIO_GetPacketList(int $InstanceID)` – supplies an array of extended Data-Packets
- `array VIO_GetTextList(int $InstanceID)` – returns an array of simple Data-Packets
- `bool VIO_PushPacket(int $InstanceID, string $Text, string $ClientIP, int $ClientPort)` – sends an extended Data-Packet
- `bool VIO_PushPacketHEX(int $InstanceID, string $Text, string $ClientIP, int $ClientPort)` – sends an extended Data-Packet
- `bool VIO_PushText(int $InstanceID, string $Text)` – sends a simple Data-Packet
- `bool VIO_PushTextHEX(int $InstanceID, string $Text)` – sends a simple Data-Packet
- `bool VIO_SendPacket(int $InstanceID, string $Text, string $ClientIP, int $ClientPort)` – sends an extended Data-Packet to itself
- `bool VIO_SendText(int $InstanceID, string $Text)` – sends a simple Data-Packet to itself

## [WebSocket Client](modules/websocketclient.md)

- `bool WSC_SendMessage(int $InstanceID, string $Message)` – sends a message using the WebSocket

## [Backup](modules/backup.md)

- `bool SB_CreateBackup(int $InstanceID)` – Creates or updates a backup

## [RRDTool](modules/rrdtool.md)

- `bool RRD_Execute(int $InstanceID, string $Command)` – Directs a command to the RRD Tool Library and executes it. Once the command has been executed, the execution will be proceed.

## [Shutter Control (legacy)](modules/shutter-control-legacy.md)

- `bool SC_Move(int $InstanceID, int $Position)` – moves the shutter to a specific position
- `bool SC_MoveDown(int $InstanceID, int $Duration)` – moves the shutter down to the end position
- `bool SC_MoveUp(int $InstanceID, int $Duration)` – moves the shutter up to the end position
- `bool SC_Stop(int $InstanceID)` – stops a motion

## [USBMapper](modules/usbmapper.md)

- `bool USBM_FixPorts(int $InstanceID)` – Checks whether the USB ports are still configured correctly

## [Wunderground Weather](modules/wunderground-weather.md)

- `bool WGW_UpdateStormWarningData(int $InstanceID)` – Updates the severe weather warnings of the Weatherground module
- `bool WGW_UpdateWeatherData(int $InstanceID)` – Updates the weather data (current/hourly/daily) of the Weatherground module