Documentation
Constants
Require: IP-Symcon >= 5.1
Constants
| Define | Description |
|---|---|
| EVENTCONDITIONCOMPARISON | Comparison conditions for conditional events |
| EVENTCYCLICDATETYPE | Date type for cyclical event |
| EVENTCYCLICTIMETYPE | Time type of the event |
| EVENTTRIGGERTYPE | Trigger type for triggered event |
| EVENTTYPE | Type of event |
| MEDIATYPE | Type of mediainstance |
| MODULETYPE | Type of module |
| OBJECTTYPE | Type of object |
| SCRIPTTYPE | Type of script |
| VARIABLETYPE | Type of variable |
EventConditionComparison
Comparison conditions for conditional events
| Constant | Value | Description |
|---|---|---|
| EVENTCONDITIONCOMPARISON_EQUAL | 0 | Equal |
| EVENTCONDITIONCOMPARISON_NOTEQUAL | 1 | Not equal |
| EVENTCONDITIONCOMPARISON_GREATER | 2 | Greater |
| EVENTCONDITIONCOMPARISON_GREATEROREQUAL | 3 | Greater or equal |
| EVENTCONDITIONCOMPARISON_SMALLER | 4 | Smaller |
| EVENTCONDITIONCOMPARISON_SMALLEROREQUAL | 5 | Smaller or equal |
EventCyclicDateType
Date type for cyclical event
| Constant | Value | Description |
|---|---|---|
| EVENTCYCLICDATETYPE_NONE | 0 | No date type |
| EVENTCYCLICDATETYPE_ONCE | 1 | Once |
| EVENTCYCLICDATETYPE_DAY | 2 | Daily |
| EVENTCYCLICDATETYPE_WEEK | 3 | Weekly |
| EVENTCYCLICDATETYPE_MONTH | 4 | Monthly |
| EVENTCYCLICDATETYPE_YEAR | 5 | Yearly |
EventCyclicTimeType
Time type of the event
| Constant | Value | Description |
|---|---|---|
| EVENTCYCLICTIMETYPE_ONCE | 0 | Once |
| EVENTCYCLICTIMETYPE_SECOND | 1 | Secondly |
| EVENTCYCLICTIMETYPE_MINUTE | 2 | Minutely |
| EVENTCYCLICTIMETYPE_HOUR | 3 | Hourly |
EventTriggerType
Trigger type for triggered event
| Constant | Value | Description |
|---|---|---|
| EVENTTRIGGERTYPE_ONUPDATE | 0 | If the variable is updated |
| EVENTTRIGGERTYPE_ONCHANGE | 1 | If the variable is changed |
| EVENTTRIGGERTYPE_ONLIMITEXCEED | 2 | If the limit value is exceeded |
| EVENTTRIGGERTYPE_ONLIMITDROP | 3 | If the limit value is exceeded |
| EVENTTRIGGERTYPE_ONVALUE | 4 | At a certain value |
EventType
Type of event
| Constant | Value | Description |
|---|---|---|
| EVENTTYPE_TRIGGER | 0 | Triggered event |
| EVENTTYPE_CYCLIC | 1 | Cyclical event |
| EVENTTYPE_SCHEDULE | 2 | Schedule event |
MediaType
Type of mediainstance
| Constant | Value | Description |
|---|---|---|
| MEDIATYPE_IPSVIEW | 0 | IPSView |
| MEDIATYPE_IMAGE | 1 | Image |
| MEDIATYPE_SOUND | 2 | Sound |
| MEDIATYPE_STREAM | 3 | Stream |
| MEDIATYPE_CHART | 4 | Chart |
| MEDIATYPE_DOCUMENT | 5 | Document |
ModuleType
Type of module
| Constant | Value | Description |
|---|---|---|
| MODULETYPE_CORE | 0 | Core |
| MODULETYPE_IO | 1 | I/O |
| MODULETYPE_SPLITTER | 2 | Splitter |
| MODULETYPE_DEVICE | 3 | Device |
| MODULETYPE_CONFIGURATOR | 4 | Configurator |
| MODULETYPE_DISCOVERY | 5 | Discovery |
| MODULETYPE_VISUALIZATION | 6 | Visualization |
ObjectType
Type of object
| Constant | Value | Description |
|---|---|---|
| OBJECTTYPE_CATEGORY | 0 | Category |
| OBJECTTYPE_INSTANCE | 1 | Instance |
| OBJECTTYPE_VARIABLE | 2 | Variable |
| OBJECTTYPE_SCRIPT | 3 | Script |
| OBJECTTYPE_EVENT | 4 | Event |
| OBJECTTYPE_MEDIA | 5 | Media |
| OBJECTTYPE_LINK | 6 | Link |
ScriptType
Type of script
| Constant | Value | Description |
|---|---|---|
| SCRIPTTYPE_PHP | 0 | PHP-Script |
| SCRIPTTYPE_FLOW | 1 | Flow Script |
| SCRIPTTYPE_IPSWORKFLOW | 2 | IPSWorkflow |
VariableType
Type of variable
| Constant | Value | Description |
|---|---|---|
| VARIABLETYPE_BOOLEAN | 0 | Boolean |
| VARIABLETYPE_INTEGER | 1 | Integer |
| VARIABLETYPE_FLOAT | 2 | Float |
| VARIABLETYPE_STRING | 3 | String |