Documentation
Command Reference
The Command Reference includes commands that are provided by IP-Symcon and are used for its own management.
This is a list of IP-Symcon specific commands.
For a list of module-specific commands, refer to the Module Reference.
Process Control
Functions in this group allow influencing the flow of a script.
| IPS_AbortScript | aborts all running and queued executions of a flow script |
| IPS_Execute | Starts an external program |
| IPS_ExecuteEx | Starts an external program in the user context |
| IPS_RunAction | executes a single action |
| IPS_RunActionWait | executes a single action and waits for the result |
| IPS_RunScript | starts another IP-Symcon script |
| IPS_RunScriptEx | starts another IP-Symcon script and passes variables |
| IPS_RunScriptText | starts text as IP-Symcon script |
| IPS_RunScriptTextEx | starts a text as IP-Symcon script and passes variables |
| IPS_RunScriptTextWait | starts a text as IP-Symcon script and waits for its execution |
| IPS_RunScriptTextWaitEx | starts a text as IP-Symcon script, passes variables, and waits for the execution of the script |
| IPS_RunScriptWait | starts another IP-Symcon script and waits for the result |
| IPS_RunScriptWaitEx | starts another IP-Symcon script, passes variables, and waits for the result |
| IPS_SemaphoreEnter | allows the synchronization with other simultaneously running scripts |
| IPS_SemaphoreLeave | allows the synchronization with other simultaneously running scripts |
| IPS_Sleep | delays a script for a specified duration |
Management of Permissions
Functions in this group are used to manage users, roles and permissions.
| Users | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
| IPS_GetLoggedInUser | returns the name of the user in whose context the current execution runs | ||||||||||||||||||||||||||||||||||||
| IPS_HasPermission | checks whether the currently logged in user may perform an operation on an object | ||||||||||||||||||||||||||||||||||||
| IPS_IsAdministrator | checks whether the currently logged in user is an administrator | ||||||||||||||||||||||||||||||||||||
| IPS_IsUnknown | checks whether the current execution runs without a logged in user | ||||||||||||||||||||||||||||||||||||
| Roles | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
Management of Events
Functions in this group are used to manage events.
| IPS_CreateEvent | create a new event |
| IPS_DeleteEvent | deletes an event |
| IPS_EventExists | checks if an event exists |
| IPS_GetEvent | returns extensive information about an event |
| IPS_GetEventIDByName | determines the ID of an event by its name |
| IPS_GetEventList | returns a list of all existing events |
| IPS_GetEventListByType | returns a list of all events of a given type |
| IPS_IsConditionPassing | checks if a condition is fulfilled |
| IPS_SetEventAction | set the executed action |
| IPS_SetEventActive | activates/deactivates an event |
| IPS_SetEventCondition | modifies the conditions of an event |
| IPS_SetEventConditionDateRule | modifies the rule of a condition of an event for date comparisons |
| IPS_SetEventConditionDayOfTheWeekRule | modifies the rule of a condition of an event for weekday comparisons |
| IPS_SetEventConditionTimeRule | modifies the rule of a condition of an event for time comparisons |
| IPS_SetEventConditionVariableDynamicRule | modifies a dynamic condition rule of an event for variable comparison |
| IPS_SetEventConditionVariableRule | modifies a condition rule of an event for variable comparison |
| IPS_SetEventConditionVariableStaticRule | modifies a static condition rule of an event for variable comparison |
| IPS_SetEventCyclic | configures a cyclic event |
| IPS_SetEventCyclicDateFrom | sets the start date |
| IPS_SetEventCyclicDateTo | sets the end date |
| IPS_SetEventCyclicTimeFrom | set the start time |
| IPS_SetEventCyclicTimeTo | sets the end time |
| IPS_SetEventLimit | limits the number of event executions |
| IPS_SetEventScheduleAction | modifies the action table of a schedule event and sets the action to "Execute PHP Code" |
| IPS_SetEventScheduleActionEx | modifies the action table of a schedule event |
| IPS_SetEventScheduleGroup | modifies the grouping of days for a schedule event |
| IPS_SetEventScheduleGroupPoint | modifies a switch point of the group of a schedule event |
| IPS_SetEventScript | sets the action to "Execute PHP Code" and define the code to be executed |
| IPS_SetEventTrigger | defines the trigger for a triggered event |
| IPS_SetEventTriggerSubsequentExecution | defines whether a triggered event is executed again on the same value |
| IPS_SetEventTriggerValue | set the value the trigger variable is compared to |
Management of Instances
Functions in this group are used to manage instances.
| Debug | |||||||||||||||||||||
| |||||||||||||||||||||
| IPS_CreateInstance | creates an instance | ||||||||||||||||||||
| IPS_DeleteInstance | deletes an instance | ||||||||||||||||||||
| IPS_GetInstance | returns extensive information about a specific instance | ||||||||||||||||||||
| IPS_GetInstanceIDByName | returns the ID of an instance by its name | ||||||||||||||||||||
| IPS_GetInstanceList | returns a list of all existing instances | ||||||||||||||||||||
| IPS_GetInstanceListByModuleID | returns all instances with a specific module ID | ||||||||||||||||||||
| IPS_GetInstanceListByModuleType | returns a list of all instances with a specific type | ||||||||||||||||||||
| IPS_InstanceExists | checks if a specific instance exists | ||||||||||||||||||||
| IPS_RequestAction | calls the RequestAction method of an instance by ident | ||||||||||||||||||||
| IPS_Translate | translates a text with the translations of the module of an instance | ||||||||||||||||||||
| Configuration | |||||||||||||||||||||
| |||||||||||||||||||||
| References | |||||||||||||||||||||
| |||||||||||||||||||||
| Search | |||||||||||||||||||||
| |||||||||||||||||||||
| Timers | |||||||||||||||||||||
| |||||||||||||||||||||
| Connection | |||||||||||||||||||||
| |||||||||||||||||||||
Management of Categories
Functions in this group are used to manage categories.
| IPS_CategoryExists | checks if a category already exists |
| IPS_CreateCategory | creates a new category |
| IPS_DeleteCategory | deletes an existing category |
| IPS_GetCategory | returns information about a category |
| IPS_GetCategoryIDByName | searches and returns the ID of an existing category by its name |
| IPS_GetCategoryList | returns a list of all existing categories |
Management of Links
Functions in this group are used to manage links.
| IPS_CreateLink | creates a new link |
| IPS_DeleteLink | deletes an existing link |
| IPS_GetLink | returns extensive information about a link |
| IPS_GetLinkIDByName | returns the ID of a link by its name |
| IPS_GetLinkList | returns a list of all existing links |
| IPS_LinkExists | checks if a link exists already |
| IPS_SetLinkTargetID | sets the target of a link |
Management of Media
Functions from this group are used to manage media
| IPS_CreateMedia | creates a new media object in the media pool |
| IPS_DeleteMedia | removes a media object from the media pool |
| IPS_GetMedia | returns extensive information about a specific media object |
| IPS_GetMediaContent | returns the content of a media object |
| IPS_GetMediaIDByFile | returns the ID of a media object by its file |
| IPS_GetMediaIDByName | returns the ID of a media object by its name |
| IPS_GetMediaList | returns a list of all media objects in the media pool |
| IPS_GetMediaListByType | returns a list of all media objects of a specific type |
| IPS_MediaExists | checks if a specific media object is contained within the media pool already |
| IPS_SendMediaEvent | send a notification that a media object was changed |
| IPS_SetMediaCached | activates that a media object is only modified in the internal memory |
| IPS_SetMediaContent | set the content of a media object |
| IPS_SetMediaFile | bind a media file to a media object |
Management of Modules
Functions from this group are used to manage modules and libraries
| IPS_GetCompatibleModules | returns all modules that are compatible to a specific module |
| IPS_GetLibrary | returns extensive information about a library |
| IPS_GetLibraryList | returns a list of all libraries |
| IPS_GetLibraryModules | returns a list of modules in a library |
| IPS_GetModule | returns extensive information about a module |
| IPS_GetModuleList | returns a list of all modules |
| IPS_GetModuleListByType | returns a list of all modules of a given type |
| IPS_IsModuleCompatible | checks if two modules are compatible to each other |
| IPS_LibraryExists | Checks if the given library exists |
| IPS_ModuleExists | checks if the given module exists |
Management of Objects
Functions from this group are used to manipulate objects.
| IPS_FindObjectIDByIdent | searches the ID of an object by its ident without failing if nothing is found |
| IPS_FindObjectIDByName | searches the ID of an object by its name without failing if nothing is found |
| IPS_GetChildrenIDs | returns a list of all child objects |
| IPS_GetLocation | returns the complete path to an object |
| IPS_GetName | returns the name of the object |
| IPS_GetObject | returns extensive information about an object |
| IPS_GetObjectIDByIdent | returns the ID of an object by its ident |
| IPS_GetObjectIDByName | returns the ID of an object by its name |
| IPS_GetObjectList | returns a list of all existing objects |
| IPS_GetParent | returns the ID of the parent of the object |
| IPS_HasChildren | checks if an object has child objects |
| IPS_IsChild | checks if an object is a child of a parent object |
| IPS_ObjectExists | checks if a specific object exists |
| IPS_SetDisabled | sets an object as disabled for the visualizations |
| IPS_SetHidden | sets the visibility for an object |
| IPS_SetHiddenMaximize | sets the visibility of the maximize button of an object |
| IPS_SetHiddenTitle | sets the visibility of the title of an object |
| IPS_SetIcon | sets the icon of an object |
| IPS_SetIdent | sets the ident of an object |
| IPS_SetInfo | sets extended information of an object |
| IPS_SetName | sets the name of an object |
| IPS_SetParent | sets the parent of an object |
| IPS_SetPosition | sets the position of an object |
Program Information
Functions from this group provide information about IP Symcon itself
| IPS_FunctionExists | checks if a specific function exists |
| IPS_GetAvailableUpdates | returns an available update for the configured update channel |
| IPS_GetFunction | returns extensive information about a function |
| IPS_GetFunctionList | returns a list of all available functions |
| IPS_GetFunctionListByModuleID | returns a list of all available functions of a module |
| IPS_GetKernelArchitecture | returns the architecture that IP-Symcon was created for |
| IPS_GetKernelDate | returns the kernel creation date |
| IPS_GetKernelDir | returns the path to the IP Symcon program folder |
| IPS_GetKernelDirEx | returns the path to the IP Symcon installation folder |
| IPS_GetKernelDirSpace | returns the total/free/available disk space of the drive on which all data of IP-Symcon is stored |
| IPS_GetKernelPlatform | returns the operating system which IP-Symcon is running on |
| IPS_GetKernelRevision | returns a unique revision identifier |
| IPS_GetKernelRunlevel | returns the run level of the kernel |
| IPS_GetKernelStartTime | returns the point in time when IP-Symcon was started |
| IPS_GetKernelVersion | returns the version number of the used kernel |
| IPS_GetLiveUpdateVersion | returns a version identifier made of the build date and revision of the kernel |
| IPS_GetLogDir | returns the path to the IP Symcon log folder |
| IPS_GetSystemLanguage | returns the system language of the operating system on which IP-Symcon is running |
| IPS_GetUpdateChannel | returns the currently configured update channel |
| IPS_LogMessage | Writes a user defined message into the log file |
Management of Scripts
Functions from this group are used to manage scripts.
| Actions | Functions in this group are used to manage actions. | ||||||||||||
| |||||||||||||
| IPS_CreateScript | creates a script | ||||||||||||
| IPS_DeleteScript | deletes a script | ||||||||||||
| IPS_GetScript | returns extensive information about a script | ||||||||||||
| IPS_GetScriptContent | returns the content of a script | ||||||||||||
| IPS_GetScriptEventList | returns all events that are assigned to a script | ||||||||||||
| IPS_GetScriptFile | returns the file name of a script | ||||||||||||
| IPS_GetScriptIDByFile | returns the ID of a script by its file | ||||||||||||
| IPS_GetScriptIDByName | returns the ID of a script by its name | ||||||||||||
| IPS_GetScriptList | returns a list of all scripts | ||||||||||||
| IPS_GetScriptTimer | returns the start value of the script timer | ||||||||||||
| IPS_ScriptExists | checks if a script exists | ||||||||||||
| IPS_SetScriptContent | sets the content of a script | ||||||||||||
| IPS_SetScriptFile | sets the file name for a script | ||||||||||||
| IPS_SetScriptTimer | sets the start value of a script timer | ||||||||||||
| Threads | |||||||||||||
| |||||||||||||
Management of Traces
Functions in this group are used to read traces.
| IPS_GetTraceIDList | returns the IDs of the trace entries of an object |
| IPS_GetTraceList | returns a trace entry with its cause chain |
Management of Variables
Functions in this group are used to manage variables and change their values
| IPS_CreateVariable | creates a new variable | ||||||||||||||||||||||
| IPS_DeleteVariable | deletes a variable | ||||||||||||||||||||||
| IPS_GetVariable | returns extensive information about a variable | ||||||||||||||||||||||
| IPS_GetVariableEventList | returns a list of all events that are associated with a variable | ||||||||||||||||||||||
| IPS_GetVariableIDByName | returns the ID of a variable by its name | ||||||||||||||||||||||
| IPS_GetVariableList | returns a list of all existing variables | ||||||||||||||||||||||
| IPS_GetVariablePresentation | Returns all parameters of the currently used presentation | ||||||||||||||||||||||
| IPS_SetVariableCustomAction | sets a user-defined action script for a variable | ||||||||||||||||||||||
| IPS_SetVariableCustomPresentation | assigns a user-defined presentation to the variable | ||||||||||||||||||||||
| IPS_SetVariableCustomProfile | sets a user-defined profile for a variable | ||||||||||||||||||||||
| IPS_VariableExists | checks if a variable exists | ||||||||||||||||||||||
| Variable Presentation | Functions in this group are used to manage variable presentations | ||||||||||||||||||||||
| |||||||||||||||||||||||
| Variable Profiles | |||||||||||||||||||||||
| |||||||||||||||||||||||
Accessing Variables
Functions in this group are used to read or write the values of variables.
| GetValue | returns the value of an IP-Symcon variable, independent of its type |
| GetValueBoolean | returns the value of an IP-Symcon variable of the type Boolean |
| GetValueColor | returns the value of a color variable as integer in the format 0xRRGGBB |
| GetValueFloat | returns the value of an IP-Symcon variable of the type Float |
| GetValueFormatted | returns the value of an IP-Symcon variable and formats it according to its profile |
| GetValueFormattedEx | returns a value formatted based on the profile of a variable |
| GetValueInteger | returns the value of an IP-Symcon variable of the type Integer |
| GetValueString | returns the value of an IP-Symcon variable of the type String |
| HasAction | checks whether an action is defined |
| RequestAction | executes the variable action of an IP-Symcon variable |
| RequestActionColor | executes the action of a color variable with a color value in the format 0xRRGGBB |
| RequestActionEx | executes the action of an IP-Symcon variable with individual sender |
| SetValue | sets the value of an IP-Symcon variable independent of its type |
| SetValueBoolean | sets the value of an IP-Symcon variable of the type Boolean |
| SetValueColor | sets the value of a color variable from a color value in the format 0xRRGGBB |
| SetValueFloat | sets the value of an IP-Symcon variable of the type Float |
| SetValueInteger | sets the value of an IP-Symcon variable of the type Integer |
| SetValueString | sets the value of an IP-Symcon variable of the type String |