Documentation
Management of Variables
.
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
| IPS_GetPresentation | provides comprehensive information about a specific presentation | ||||||||||||||||
| IPS_GetPresentationForm | returns the configuration form of a presentation for a variable type | ||||||||||||||||
| IPS_GetPresentationFormat | returns the format template of a presentation for a variable type | ||||||||||||||||
| IPS_GetPresentations | provides all presentations of the system | ||||||||||||||||
| IPS_GetPresentationValue | returns the preview value of a presentation | ||||||||||||||||
| IPS_PresentationExists | Checks whether a specific presentation exists | ||||||||||||||||
| Management of Templates | Functions in this group are used to manage templates | ||||||||||||||||
| |||||||||||||||||
Variable Profiles
| IPS_CreateVariableProfile | creates a variable profile |
| IPS_DeleteVariableProfile | deletes a variable profile |
| IPS_GetVariableProfile | returns extensive information about a variable profile |
| IPS_GetVariableProfileList | returns a list of all existing variable profiles |
| IPS_GetVariableProfileListByType | returns a list of all existing variable profiles of a specific type |
| IPS_SetVariableProfileAssociation | modifies the association table of a variable profile |
| IPS_SetVariableProfileDigits | sets the number of decimal places of a variable profile |
| IPS_SetVariableProfileIcon | sets the icon for a variable profile |
| IPS_SetVariableProfileText | sets the prefix and suffix of a variable profile |
| IPS_SetVariableProfileValues | sets the minimum value, maximum value, and step size of a variable profile |
| IPS_VariableProfileExists | checks if a variable profile exists |