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 |
Presentations
| GUID | Konstante | Name |
|---|---|---|
| {6B9CAEEC-5958-C223-30F7-BD36569FC57A} | VARIABLE_PRESENTATION_SLIDER | Slider |
| {4153A8D4-5C33-C65F-C1F3-7B61AAF99B1C} | VARIABLE_PRESENTATION_LEGACY | Legacy-Profile |
| {3319437D-7CDE-699D-750A-3C6A3841FA75} | VARIABLE_PRESENTATION_VALUE_PRESENTATION | Value Presentation |
| {6F477326-1683-A2FD-D2E7-477F366ECB62} | VARIABLE_PRESENTATION_VALUE_INPUT | Value Input |
| {9DE1D610-5106-97FB-714D-1AADEDF8377A} | VARIABLE_PRESENTATION_WEB_CONTENT | Web Content |
| {05CC3CC2-A0B2-5837-A4A7-A07EA0B9DDFB} | VARIABLE_PRESENTATION_COLOR | Color |
| {497C4845-27FA-6E4F-AE37-5D951D3BDBF9} | VARIABLE_PRESENTATION_DATE_TIME | Date/Time |
| {60AE6B26-B3E2-BDB1-A3A1-BE232940664B} | VARIABLE_PRESENTATION_SWITCH | Switch |
| {6075FC22-69AF-B110-3749-C24138883082} | VARIABLE_PRESENTATION_SHUTTER | Shuttere |
| {52D9E126-D7D2-2CBB-5E62-4CF7BA7C5D82} | VARIABLE_PRESENTATION_ENUMERATION | Enumeration |
| {08A6AF76-394E-D354-48D5-BFC690488E4E} | VARIABLE_PRESENTATION_DURATION | Duration |
Templates
| GUID | Konstante | Name |
|---|---|---|
| {B4C70F3E-6613-DA1A-7279-5DEE8DEB1B24} | VARIABLE_TEMPLATE_DATE | Date |
| {362DA268-56A2-E771-5E53-17E38B5D82E6} | VARIABLE_TEMPLATE_TIME | Time |
| {BB0E9933-0403-BD3A-D1C9-255646934B00} | VARIABLE_TEMPLATE_DATE_TIME | Datum/Uhrzeit |
| {868B087E-A38D-2155-EBE0-157AFBBF9E8C} | VARIABLE_TEMPLATE_SLIDER_ROOM_TEMPERATURE | Room Temperature |
| {66062309-21A9-26C0-213F-775C52E1473B} | VARIABLE_TEMPLATE_SLIDER_COLOR_TEMPERATURE | Color Temperature |
| {BC799412-0C66-551F-CAEC-7566F5D52BD9} | VARIABLE_TEMPLATE_SLIDER_ENERGY | Energy |
| {8EC19DF0-89FB-A77E-ED7D-047A949CF292} | VARIABLE_TEMPLATE_SLIDER_POWER | Power |
| {3BE75DE9-7D84-C082-2E77-9ED3AEE04D63} | VARIABLE_TEMPLATE_SHUTTER_LAMELLA_RIGHT | Lamella right |
| {22A0DF9C-C200-154A-641B-3A3CB096DB6D} | VARIABLE_TEMPLATE_SHUTTER_LAMELLA_LEFT | Lamella left |
| {90AF8F8F-183F-BBFD-E078-35FAB6DCFE4F} | VARIABLE_TEMPLATE_VALUE_PRESENTATION_ROOM_TEMPERATURE | Color Temperature |
| {2FED3D39-073D-6037-901B-2586A1AB5569} | VARIABLE_TEMPLATE_VALUE_PRESENTATION_POWER | Power |
| {C899FCFA-063E-897E-9DA4-28ADD278EED5} | VARIABLE_TEMPLATE_VALUE_PRESENTATION_ENERGY | Energy |
| {7BD38CF5-07F2-5B5B-8F7F-15398B823BFC} | VARIABLE_TEMPLATE_VALUE_PRESENTATION_BATTERY | Battery |
| {C90EF36A-165E-D0B0-032C-F468F483D42B} | VARIABLE_TEMPLATE_VALUE_PRESENTATION_BATTERY_COLOR | Battery (Color) |
| {0C711895-2F8E-DBFE-1700-84173491D229} | VARIABLE_TEMPLATE_COLOR_RAINBOW | Rainbow |
| {A7467E68-5C39-5BD9-C0C8-BCE6004FEEAA} | VARIABLE_TEMPLATE_COLOR_FOREST | Forest |