What can we improve?

Documentation

(Edit)

Translation is in progress...
Not all topics are available at the moment and content links may be broken.

Command Reference

The Command Reference includes commands that are provided by IP-Symcon and are used for the management of itself. This is a list of IP-Symcon specific commands.

For a list of module-specific commands, refer to the Module Reference.

Accessing Variables

Commands in this group are used to read or write the values of variables.

GetValuereturns the value of an IP-Symcon variable, independent of its type
GetValueBooleanreturns the value of an IP-Symcon variable of the type Boolean
GetValueFloatreturns the value of an IP-Symcon variable of the type Float
GetValueFormattedreturns the value of an IP-Symcon variable and formats it according to its profile
GetValueIntegerreturns the value of an IP-Symcon variable of the type Integer
GetValueStringreturns the value of an IP-Symcon variable of the type String
RequestActionexecute the variable action of an IP-Symcon variable
SetValueset the value of an IP-Symcon variable independent of its type
SetValueBooleanset the value of an IP-Symcon Variable with the type Boolean
SetValueFloatset the value of an IP-Symcon variable with the type Float
SetValueIntegerset the value of an IP-Symcon variable with the type Boolean
SetValueStringset the value of an IP-Symcon variable with the type String

Management of Categories

Commands in this group are used to manage categories.

IPS_CategoryExistschecks if a category exists
IPS_CreateCategorycreates a new category
IPS_DeleteCategorydeletes an existing category
IPS_GetCategoryIDByNamesearches and returns the ID of an existing category by its name
IPS_GetCategoryListreturns a list of all existing categories

Management of Events

Operations can influence the process of events.

IPS_CreateEventcreate a new event
IPS_DeleteEventdeletes an event
IPS_EventExistschecks if an event exists
IPS_GetEventreturns extensive information about an event
IPS_GetEventIDByNamedetermines the ID of an event by its name
IPS_GetEventListreturns a list of all existing events
IPS_GetEventListByTypereturns a list of all events of a given type
IPS_SetEventActionset the executed action
IPS_SetEventActiveactivates/deactivates an event
IPS_SetEventConditionmodifies the conditions of an event
IPS_SetEventConditionVariableRulemodify a condition rule of an event for variable comparison
IPS_SetEventCyclicconfigures a cyclic event
IPS_SetEventCyclicDateBoundsset the start and end date of a cyclic event (deprecated)
IPS_SetEventCyclicDateFromsets the start date
IPS_SetEventCyclicDateTosets the end date
IPS_SetEventCyclicTimeBoundsset the start and end time for a cyclic event (deprecated)
IPS_SetEventCyclicTimeFromset the start time
IPS_SetEventCyclicTimeTosets the end time
IPS_SetEventLimitlimits the amount of event calls
IPS_SetEventScheduleActionmodifies the action table of a schedule event and set the action to "Execute PHP Code"
IPS_SetEventScheduleActionExmodifies the action table of a schedule event
IPS_SetEventScheduleGroupmodifies the grouping of days for a schedule event
IPS_SetEventScheduleGroupPointmodify a switch point of the group of a schedule event
IPS_SetEventScriptset the action to "Execute PHP Code" and define the code to be executed
IPS_SetEventTriggerdefine the trigger for a trigger event
IPS_SetEventTriggerSubSequentExecutiondefine if a trigger event should multiple times fir exceed/drop
IPS_SetEventTriggerValueset the value the trigger variable is compared to

Management of Instances

Commands in this group are used to manage instances.

IPS_CreateInstancecreates an instance
IPS_DeleteInstancedeletes an instance
IPS_GetInstancereturns extensive information about a specific instance
IPS_GetInstanceIDByNamereturns the ID of an instance by its name
IPS_GetInstanceListreturns a list of all existing instances
IPS_GetInstanceListByModuleIDreturns all instances with a specific module ID
IPS_GetInstanceListByModuleTypereturns a list of all instances with a specific type
IPS_InstanceExistschecks if a specific instance exists
Configuration
IPS_ApplyChangesapplies a changed configuration
IPS_GetConfigurationreads a configuration
IPS_GetConfigurationFormreads a configuration form
IPS_GetPropertyreads the current value of a property
IPS_HasChangeschecks if the configuration was changed
IPS_ResetChangesresets the modified configuration to the current configuration
IPS_SetConfigurationset a new configuration
IPS_SetPropertyset a planned value for a property
Connection
IPS_ConnectInstancecreates a (data) connection between two instances
IPS_DisconnectInstancedisconnects a (data) connection between two instances
IPS_GetCompatibleInstancesreturns compatible instances to an instance
IPS_IsInstanceCompatiblechecks if a connection between two instances is possible
Status Variables

Management of Links

Commands from this category are used to manage links.

IPS_CreateLinkcreates a new link
IPS_DeleteLinkdeletes an existing link
IPS_GetLinkretuns extensive information about a link
IPS_GetLinkIDByNamereturns the ID of a link by its name
IPS_GetLinkListreturns a list of all existing links
IPS_LinkExistschecks if a link exists already
IPS_SetLinkTargetIDset the target for a link

Management of Media

Functions from this group are used to manage media

IPS_CreateMediacreates a new media object in the media pool
IPS_DeleteMediaremoves a media object from the media pool
IPS_GetMediareturns extensive information about a specific media object
IPS_GetMediaContentreturns the content of a media object
IPS_GetMediaIDreturns the ID of a media object
IPS_GetMediaIDByFilereturn the ID of a media object by its file
IPS_GetMediaIDByNamereturns the ID of a media object by its name
IPS_GetMediaListreturns a list of all media objects in the media pool
IPS_GetMediaListByTypereturns a list of all media objects of a specific type
IPS_MediaExistschecks if a specific media object is contained within the media pool already
IPS_SendMediaEventsend a notification that a media object was changed
IPS_SetMediaCachedactivates that a media object is only modified in the internal memory
IPS_SetMediaContentset the content of a media object
IPS_SetMediaFilebind a media file to a media object

Management of Modules

Commands from this group are used to manage modules and libraries

IPS_GetCompatibleModulesreturns all modules that are compatible to a specific module
IPS_GetLibraryreturns extensive information about a library
IPS_GetLibraryListreturns a list of all libraries
IPS_GetLibraryModulesreturns a list of modules in a library
IPS_GetModulereturns extensive information about a module
IPS_GetModuleListreturns a list of all modules
IPS_GetModuleListByTypereturns a list of all modules of a given type
IPS_IsModuleCompatiblechecks if two modules are compatible to each other
IPS_LibrarayExistsChecks if the given library exists
IPS_ModuleExistschecks if the given module exists

Management of Objects

Functions from this group are used to manipulate objects

IPS_GetChildrenIDsreturns a list of all children objects
IPS_GetLocationreturns the complete path to an object
IPS_GetNamereturns the name of an object
IPS_GetObjectreturns extensive information about an object
IPS_GetObjectIDByIdentreturns the ID of an object by its ident
IPS_GetObjectIDByNamereturns the ID of an object by its name
IPS_GetObjectListreturns a list of all existing objects
IPS_GetParentreturns the ID of the parent of the object
IPS_HasChildrenchecks if an object has child objects
IPS_IsChildchecks if an object is a child of a parent object
IPS_ObjectExistschecks if a specific object exists
IPS_SetDisabledset an object as disabled for the visualizations
IPS_SetHiddenset the visibility for an object
IPS_SetIconset the icon of an object
IPS_SetIdentset the ident of an object
IPS_SetInfoset extended information of an object
IPS_SetNameset the name of an object
IPS_SetParentset the parent of an object
IPS_SetPositionset the position of an object

Management of Scripts

Functions from this group are used to manage scripts

IPS_CreateScriptcreates a script
IPS_DeleteScriptdeletes a script
IPS_GetScriptreturn extensive information about a script
IPS_GetScriptContentreturns the content of a script
IPS_GetScriptEventListreturns all events that are assigned to a script
IPS_GetScriptFilereturns the file name of a script
IPS_GetScriptIDByFilereturns the ID of a script by its file
IPS_GetScriptIDByNamereturns the ID of a script by its name
IPS_GetScriptListreturns a list of all scripts
IPS_GetScriptTimerreturns the start value of the script timer
IPS_ScriptExistschecks if a script exists
IPS_SetScriptContentset the content of a script
IPS_SetScriptFilesets the file name for a script
IPS_SetScriptTimerset the start value of a script timer

Management of Variables

Functions from this group are used to manipulate variables

IPS_CreateVariablecreates a new variable
IPS_DeleteVariabledeletes a variable
IPS_GetVariableretuns extensive information about a variable
IPS_GetVariableEventListreturns a list of all events that are associated to a variable
IPS_GetVariableIDByNamereturns the ID of a variable by its name
IPS_GetVariableListreturns a list of all existing variables
IPS_SetVariableCustomActionset a user defined action script for a variable
IPS_SetVariableCustomProfilesets a user defined profile for a variable
IPS_VariableExistschecks if a variable exists
Variable Profiles
IPS_CreateVariableProfilecreates a variable profile
IPS_DeleteVariableProfiledeletes a variable profile
IPS_GetVariableProfilereturns extensive information about a variable profile
IPS_GetVariableProfileListreturns a list of all existing variable profiles
IPS_GetVariableProfileListByTypereturns a list of all existing variable profiles of a specific type
IPS_SetVariableProfileAssociationmodifies the association table of a variable profile
IPS_SetVariableProfileDigitssets the digits of a variable profile
IPS_SetVariableProfileIconsets the icon for a variable profile
IPS_SetVariableProfileTextsets prefix and suffix for a variable profile
IPS_SetVariableProfileValuessets the minimal value, maximal value, and stepsize of a variable profile
IPS_VariableProfileExistschecks if a variable profile exists

Process Control

Operations from this group can influence the process of scripts.

IPS_ExecuteStarts an external program
IPS_ExecuteExStarts an external program in the user context
IPS_RunActionexecutes a single action
IPS_RunActionWaitexecutes a single action and waits for the result
IPS_RunScriptstarts another IP-Symcon script
IPS_RunScriptExstarts another IP-Symcon script and passes variables
IPS_RunScriptTextstarts text as IP-Symcon script
IPS_RunScriptTextExstarts a text as IP-Symcon script and passes variablesstartet einen Text als IP-Symcon Skript und übergibt Variablen
IPS_RunScriptTextWaitstarts a text as IP-Symcon script and waits for its execution
IPS_RunScriptTextWaitExstarts a text as IP-Symcon script, passes variables, and waits for the execution of the script
IPS_RunScriptWaitstarts another IP-Symcon script and waits for the result
IPS_RunScriptWaitExstarts another IP-Symcon script, passes variables, and waits for the result
IPS_SemaphoreEnterallows the synchronization with other simultaneously run scripts
IPS_SemaphoreLeaveallows the synchronization with other simultaneously run scripts
IPS_Sleepdelays a script for a specified duration

Program Information

Functions from this group provide information about IP Symcon itself

IPS_FunctionExistschecks if a specific function exists
IPS_GetFunctionreturns extensive information about a function
IPS_GetFunctionListreturns a list of all available functions
IPS_GetKernelDirreturns the path to the IP Symcon program folder
IPS_GetKernelDirExreturns the path to the IP Symcon installation folder
IPS_GetKernelRunlevelreturns the run level of the kernel
IPS_GetKernelStartTimereturns the point of time when IP Symcon was started
IPS_GetKernelVersionreturns the version number of the used kernel
IPS_GetLogDirreturns the path to the IP Symcon log folder
IPS_LogMessageWrites a user defined message into the log file
Deutsche Webseite verfügbar
Go to cart
Any questions?