Documentation
Management of Instances
Debug
| IPS_DisableDebug | deactivates the forwarding of debug messages |
| IPS_DisableDebugFile | deactivates the writing of debug logs to a file |
| IPS_EnableDebug | activates the forwarding of debug messages for a specific duration |
| IPS_EnableDebugFile | activates the writing of debug logs to a file |
| IPS_SendDebug | sends a message to the debug output of an object |
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
| IPS_ApplyChanges | applies a changed configuration |
| IPS_GetConfiguration | reads a configuration |
| IPS_GetConfigurationForm | reads a configuration form |
| IPS_GetConfigurationForParent | returns the configuration which an instance specifies for its parent instance |
| IPS_GetProperty | reads the current value of a property |
| IPS_GetVisualizationTile | reads the custom presentation of an instance |
| IPS_HasChanges | checks if the configuration was changed |
| IPS_ResetChanges | resets the modified configuration to the current configuration |
| IPS_SetConfiguration | sets a new configuration |
| IPS_SetProperty | sets a planned value for a property |
References
| IPS_GetReferenceList | returns the IDs of all references |
Search
| IPS_IsSearching | checks whether an instance is in search mode |
| IPS_StartSearch | starts the search mode of an instance |
| IPS_StopSearch | stops the search mode of an instance |
| IPS_SupportsSearching | checks whether an instance supports the search mode |
Timers
| IPS_GetTimer | returns information about a timer |
| IPS_GetTimerList | returns the IDs of all timers |
| IPS_TimerExists | checks whether a specific timer exists |
Connection
| IPS_ConnectInstance | creates a (data) connection between two instances |
| IPS_DisconnectInstance | disconnects a (data) connection between two instances |
| IPS_GetCompatibleInstances | returns compatible instances to an instance |
| IPS_GetCompatibleParents | returns the description of the compatible parent instances |
| IPS_IsInstanceCompatible | checks if a connection between two instances is possible |