« Back to Product

Documentation

Send feedback!

Constants

Require: 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 Room 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

InstanceStatus

The status of an instance

Constant Value Description
IS_CREATING 101 Instance is being created
IS_ACTIVE 102 Instance is active
IS_DELETING 103 Instance is being deleted
IS_INACTIVE 104 Instance is inactive
IS_NOTCREATED 105 Instance was not created
IS_STANDBY 106 Instance is in standby

Visualization Types

since 9.1

Constant Value Description
INSTANCE_VISUALIZATION_TYPE_NONE 0 The instance does not use its own visualization
INSTANCE_VISUALIZATION_TYPE_HTML 1 The instance uses an HTML visualization
INSTANCE_VISUALIZATION_TYPE_HTML_FULLSCREEN 2 The instance uses an HTML visualization for normal and opened tile
INSTANCE_VISUALIZATION_TYPE_FORM 3 The instance uses a form as visualization

DebugFormat

Format of a debug message (IPS_SendDebug, SendDebug)

Constant Value Description
DEBUG_FORMAT_TEXT 0 Text
DEBUG_FORMAT_BINARY 1 Binary (displayed as hex)

EventConditionOperation

Combination of the rules of a condition (IPS_SetEventCondition)

Constant Value Description
EVENT_CONDITION_OPERATION_AND 0 All rules must be met (AND)
EVENT_CONDITION_OPERATION_OR 1 At least one rule must be met (OR)

EventDay

Weekdays as bitmask (IPS_SetEventCyclic, IPS_SetEventScheduleGroup). Multiple days are added.

Constant Value Description
EVENT_DAY_MONDAY 1 Monday
EVENT_DAY_TUESDAY 2 Tuesday
EVENT_DAY_WEDNESDAY 4 Wednesday
EVENT_DAY_THURSDAY 8 Thursday
EVENT_DAY_FRIDAY 16 Friday
EVENT_DAY_SATURDAY 32 Saturday
EVENT_DAY_SUNDAY 64 Sunday
EVENT_DAY_ALL 127 All weekdays

ColorEncoding

Encoding of the presentation Color (parameter ENCODING)

Constant Value Description
COLOR_ENCODING_RGB 0 RGB
COLOR_ENCODING_CMYK 1 CMYK
COLOR_ENCODING_HSV 2 HSV
COLOR_ENCODING_HSL 3 HSL
COLOR_ENCODING_XY 4 xy (CIE)

Color

Special color values

Constant Value Description
COLOR_TRANSPARENT -1 Transparent or no color

UserType

Type of a user (IPS_CreateUser)

Constant Value Description
USER_TYPE_LOCAL 0 Local user account
USER_TYPE_LDAP 1 LDAP user account

ReplicationMode

Mode of the replication (IPS_GetReplicationMode)

Constant Value Description
REPLICATION_MODE_PARALLEL 0 Parallel
REPLICATION_MODE_STANDBY 1 Standby

VariableAction

Special values for the custom action of a variable (IPS_SetVariableCustomAction)

Constant Value Description
VARIABLE_ACTION_NONE 0 No custom action, the default action is used
VARIABLE_ACTION_DISABLED 1 Default action disabled
Any questions?