Documentation
Messages
Require: IP-Symcon >= 4.1
Description
All messages have their own ID, which describes the type of message.
This is a five-digit number and is made up as follows:
Base + category + type = total value
With version 5.0 and above the values are available as constants automatically
Overview of all MessageIDs
Message base
Messages from IP-Symcon have the value base 10000, those from module instances (still undocumented) have the value base 20000.
| Define | Value | Description |
|---|---|---|
| IPS_BASE | 10000 | Value base for the kernel |
| IPS_MODULBASE | 20000 | Value base for modules |
Message Categories
| Define | Value | Description |
|---|---|---|
| IPS_BASE | 0 | Service messages |
| IPS_KERNELMESSAGE | 100 | Kernel Manager |
| IPS_LOGMESSAGE | 200 | Message Manager |
| IPS_MODULEMESSAGE | 300 | Module Manager |
| IPS_OBJECTMESSAGE | 400 | Object Manager |
| IPS_INSTANCEMESSAGE | 500 | Instance Manager |
| IPS_SEARCHMESSAGE | 510 | Search Manager |
| IPS_VARIABLEMESSAGE | 600 | Variable Manager |
| IPS_SCRIPTMESSAGE | 700 | Script Manager |
| IPS_EVENTMESSAGE | 800 | Event Manager |
| IPS_MEDIAMESSAGE | 900 | Media Manager |
| IPS_LINKMESSAGE | 1000 | Link Manager |
| IPS_FLOWMESSAGE | 1100 | Flow Manager |
| IPS_ENGINEMESSAGE | 1200 | Script Engine |
| IPS_PROFILEMESSAGE | 1300 | Profile Pool |
| IPS_TIMERMESSAGE | 1400 | Timer Pool |
| IPS_ACTIONMESSAGE | 1500 | Action Pool |
| IPS_LICENSEMESSAGE | 1600 | License Pool |
Message types
IPS_BASE
Value base 0
| Define | Value | Total value | Description |
|---|---|---|---|
| IPS_KERNELSTARTED (ab 4.2) | 1 | 10001 | Is sent after KR_READY and processed synchronously |
| IPS_KERNELSHUTDOWN (ab 4.2) | 2 | 10002 | Is sent before KR_UNINIT and processed synchronously |
IPS_KERNELMESSAGE
Value base 100
| Define | Value | Total value | Description |
|---|---|---|---|
| KR_CREATE | 1 | 10101 | Kernel was created |
| KR_INIT | 2 | 10102 | Kernel components are initialized, modules are loaded and settings are read |
| KR_READY | 3 | 10103 | Kernel is ready and running |
| KR_UNINIT | 4 | 10104 | "Shutdown"-command received, finalize everything loaded |
| KR_SHUTDOWN | 5 | 10105 | Finalization complete, remove kernel |
IPS_LOGMESSAGE
Value base 200
| Define | Value | Total value | Description |
|---|---|---|---|
| KL_MESSAGE | 1 | 10201 | Normal message |
| KL_SUCCESS | 2 | 10202 | Success |
| KL_NOTIFY | 3 | 10203 | Change Notification |
| KL_WARNING | 4 | 10204 | Warning |
| KL_ERROR | 5 | 10205 | Error Message |
| KL_DEBUG | 6 | 10206 | Debug Information |
| KL_CUSTOM | 7 | 10207 | Other Messages |
IPS_MODULEMESSAGE
Value base 300
| Define | Value | Total value | Description |
|---|---|---|---|
| ML_LOAD | 1 | 10301 | Module loaded |
| ML_UNLOAD | 2 | 10302 | Module unloaded |
IPS_OBJECTMESSAGE
Value base 400
| Define | Value | Total value | Description |
|---|---|---|---|
| OM_REGISTER | 1 | 10401 | Object created |
| OM_UNREGISTER | 2 | 10402 | Object removed |
| OM_CHANGEPARENT | 3 | 10403 | Parent object has changed |
| OM_CHANGENAME | 4 | 10404 | Name has changed |
| OM_CHANGEINFO | 5 | 10405 | Description has changed |
| OM_CHANGETYPE | 6 | 10406 | Type has changed |
| OM_CHANGESUMMARY | 7 | 10407 | Short information has changed |
| OM_CHANGEPOSITION | 8 | 10408 | Type has changed |
| OM_CHANGEREADONLY | 9 | 10409 | "Read-only" status has changed |
| OM_CHANGEHIDDEN | 10 | 10410 | Visibility has changed |
| OM_CHANGEICON | 11 | 10411 | Icon has changed |
| OM_CHILDADDED | 12 | 10412 | Child added |
| OM_CHILDREMOVED | 13 | 10413 | Child removed |
| OM_CHANGEIDENT | 14 | 10414 | Ident has changed |
| OM_CHANGEDISABLED | 15 | 10415 | Usability has changed |
| OM_CHANGELOCKED | 16 | 10416 | Locked was Changed |
IPS_INSTANCEMESSAGE
Value base 500
| Define | Value | Total value | Description |
|---|---|---|---|
| IM_CREATE | 1 | 10501 | Instance created |
| IM_DELETE | 2 | 10502 | Instance removed |
| IM_CONNECT | 3 | 10503 | Instance interface available |
| IM_DISCONNECT | 4 | 10504 | Instance interface no longer available |
| IM_CHANGESTATUS | 5 | 10505 | Status has changed |
| IM_CHANGESETTINGS | 6 | 10506 | Settings have changed |
| IM_CHANGEATTRIBUTE | 7 | 10507 | Attribute has changed |
| IM_ADDATTRIBUTE | 8 | 10508 | Attribute added |
| IM_REMOVEATTRIBUTE | 9 | 10509 | Attribute removed |
IPS_SEARCHMESSAGE
Value base 510
| Define | Value | Total value | Description |
|---|---|---|---|
| IM_SEARCHSTART | 1 | 10511 | Search started |
| IM_SEARCHSTOP | 2 | 10512 | Search stopped |
| IM_SEARCHUPDATE | 3 | 10513 | Search has new results |
IPS_FORMMESSAGE
Value base 520
| Define | Value | Total value | Description |
|---|---|---|---|
| IM_FORMFIELDCREATE | 1 | 10521 | Create new form field |
| IM_FORMFIELDDELETE | 2 | 10522 | Delete existing form field |
| IM_FORMFIELDUPDATE | 3 | 10523 | Updating existing form field |
| IM_FORMRELOAD | 4 | 10524 | Reload form |
IPS_VARIABLEMESSAGE
Value base 600
| Define | Value | Total value | Description |
|---|---|---|---|
| VM_CREATE | 1 | 10601 | Variable was created |
| VM_DELETE | 2 | 10602 | Variable was removed |
| VM_UPDATE | 3 | 10603 | Variable was updated |
| VM_CHANGEPROFILENAME | 4 | 10604 | Variable profile name has been changed |
| VM_CHANGEPROFILEACTION | 5 | 10605 | Variable profile action was changed |
| VM_CHANGEDLOCKED | 6 | 10606 | Locked was Changed |
IPS_SCRIPTMESSAGE
Value base 700
| Define | Value | Total value | Description |
|---|---|---|---|
| SM_CREATE | 1 | 10701 | Script was created |
| SM_DELETE | 2 | 10702 | Script was removed |
| SM_CHANGEFILE | 3 | 10703 | Script was attached to file |
| SM_BROKEN | 4 | 10704 | Script error status has changed |
| SM_UPDATE | 5 | 10704 | Script was updated |
IPS_EVENTMESSAGE
Value base 800
| Define | Value | Total value | Description |
|---|---|---|---|
| EM_CREATE | 1 | 10801 | Event was created |
| EM_DELETE | 2 | 10802 | Event was removed |
| EM_UPDATE | 3 | 10803 | Event was updated |
| EM_CHANGEACTIVE | 4 | 10804 | Event activation has changed |
| EM_CHANGELIMIT | 5 | 10805 | Event call limit has changed |
| EM_CHANGESCRIPT | 6 | 10806 | Event script content has changed |
| EM_CHANGETRIGGER | 7 | 10807 | Event trigger has changed |
| EM_CHANGETRIGGERVALUE | 8 | 10808 | Event limit has changed |
| EM_CHANGETRIGGEREXECUTION | 9 | 10809 | Event limit triggering has changed |
| EM_CHANGECYCLIC | 10 | 10810 | Cyclic event has changed |
| EM_CHANGECYCLICDATEFROM | 11 | 10811 | Start date has changed |
| EM_CHANGECYCLICDATETO | 12 | 10812 | End date has changed |
| EM_CHANGECYCLICTIMEFROM | 13 | 10813 | Start time has changed |
| EM_CHANGECYCLICTIMETO | 14 | 10814 | End time has changed |
| EM_ADDSCHEDULEACTION | 15 | 10815 | Entry in the action table of the schedule has been added |
| EM_REMOVESCHEDULEACTION | 16 | 10816 | Entry in the action table of the schedule has been removed |
| EM_CHANGESCHEDULEACTION | 17 | 10817 | Entry in the action table of the schedule has changed |
| EM_ADDSCHEDULEGROUP | 18 | 10818 | Group of the schedule days was added |
| EM_REMOVESCHEDULEGROUP | 19 | 10819 | Group of the schedule days has been removed |
| EM_CHANGESCHEDULEGROUP | 20 | 10820 | Group of the schedule days has changed |
| EM_ADDSCHEDULEGROUPPOINT | 21 | 10821 | Switching point of a group has been added |
| EM_REMOVESCHEDULEGROUPPOINT | 22 | 10822 | Switching point of a group has been removed |
| EM_CHANGESCHEDULEGROUPPOINT | 23 | 10823 | The switching point of a group has changed |
| EM_ADDCONDITION | 24 | 10824 | Condition was added |
| EM_REMOVECONDITION | 25 | 10825 | Condition was removed |
| EM_CHANGECONDITION | 26 | 10826 | Condition has changed |
| EM_ADDCONDITIONVARIABLERULE | 27 | 10827 | Condition variable rule has been added |
| EM_REMOVECONDITIONVARIABLERULE | 28 | 10828 | Variable rule of the condition has been removed |
| EM_CHANGECONDITIONVARIABLERULE | 29 | 10829 | Variable rule of the condition has changed |
| EM_ADDCONDITIONDATERULE | 30 | 10830 | Date rule of condition was added |
| EM_REMOVECONDITIONDATERULE | 31 | 10831 | Date rule of condition was added |
| EM_CHANGECONDITIONDATERULE | 32 | 10832 | Condition date rule has changed |
| EM_ADDCONDITIONTIMERULE | 33 | 10833 | Condition time rule was added |
| EM_REMOVECONDITIONTIMERULE | 34 | 10834 | Time rule of the condition has been removed |
| EM_CHANGECONDITIONTIMERULE | 35 | 10835 | Time rule of the condition has changed |
| EM_ADDCONDITIONDAYOFTHEWEEKRULE | 36 | 10836 | Day of the week rule was added |
| EM_REMOVECONDITIONDAYOFTHEWEEKRULE | 37 | 10837 | Day of the week rule of the condition has been removed |
| EM_CHANGECONDITIONDAYOFTHEWEEKRULE | 38 | 10838 | Day of the week rule of the condition has changed |
IPS_MEDIAMESSAGE
Value base 900
| Define | Value | Total value | Description |
|---|---|---|---|
| MM_CREATE | 1 | 10901 | Media object was created |
| MM_DELETE | 2 | 10902 | Media object has been removed |
| MM_CHANGEFILE | 3 | 10903 | Media asset file has changed |
| MM_AVAILABLE | 4 | 10904 | The availability of the media asset has changed |
| MM_UPDATE | 5 | 10905 | Media asset has been updated |
| MM_CHANGECACHED | 6 | 10906 | Media object cache option has changed |
IPS_LINKMESSAGE
Value base 1000
| Define | Value | Total value | Description |
|---|---|---|---|
| LM_CREATE | 1 | 11001 | Link was created |
| LM_DELETE | 2 | 11002 | Link was removed |
| LM_CHANGETARGET | 3 | 11003 | The destination of the link has changed |
IPS_FLOWMESSAGE
Value base 1100
| Define | Value | Total value | Description |
|---|---|---|---|
| FM_CONNECT | 1 | 11101 | Instance has been connected |
| FM_DISCONNECT | 2 | 11102 | Instance was disconnected |
| FM_CHILDADDED | 3 | 11103 | Child instance was connected to this instance |
| FM_CHILDREMOVED | 4 | 11104 | Child instance was separated from this instance |
IPS_ENGINEMESSAGE
Value base 1200
| Define | Value | Total value | Description |
|---|---|---|---|
| SE_UPDATE | 1 | 11201 | Script engine was reloaded |
| SE_EXECUTE | 2 | 11202 | Script was executed |
| SE_RUNNING | 3 | 11203 | Script is running |
| SE_FLOWSCRIPT | 4 | 11204 | On FlowScript Status (either all steps finished or was aborted) |
IPS_PROFILEMESSAGE
Value base 1300
| Define | Value | Total value | Description |
|---|---|---|---|
| PM_CREATE | 1 | 11301 | Profile was created |
| PM_DELETE | 2 | 11302 | Profile has been removed |
| PM_CHANGETEXT | 3 | 11303 | Profile prefix/ profile suffix has changed |
| PM_CHANGEVALUES | 4 | 11304 | Profile values have changed |
| PM_CHANGEDIGITS | 5 | 11305 | Profile decimal places have changed |
| PM_CHANGEICON | 6 | 11306 | Profile icon has changed |
| PM_ASSOCIATIONADDED | 7 | 11307 | Profile association was added |
| PM_ASSOCIATIONREMOVED | 8 | 11308 | Profile association was removed |
| PM_ASSOCIATIONCHANGED | 9 | 11309 | Profile association has changed |
IPS_TIMERMESSAGE
Value base 1400
| Define | Value | Total value | Description |
|---|---|---|---|
| TM_REGISTER | 1 | 11401 | Timer was created |
| TM_UNREGISTER | 2 | 11402 | Timer has been removed |
| TM_CHANGEINTERVAL | 3 | 11403 | Timer interval has changed |
IPS_ACTIONMESSAGE
Value base 1500
| Define | Value | Total value | Description |
|---|---|---|---|
| AM_FORMFIELDCREATE | 1 | 11501 | Currently unused |
| AM_FORMFIELDDELETE | 2 | 11502 | Currently unused |
| AM_FORMFIELDUPDATE | 3 | 11503 | Form element needs an update |
| AM_FORMRELOAD | 4 | 11504 | Reload configuration form |
IPS_LICENSEMESSAGE
Value base 1600
| Define | Value | Total value | Description |
|---|---|---|---|
| LP_UPDATELICENSE | 1 | 11601 | On license update |
| LP_UPDATESUBSCRIPTION | 2 | 11602 | On subscription update |
Message parameters
Values of various message parameters
Search Handling
| Define | Value | Total value | Description |
|---|---|---|---|
| IF_UNKNOWN | 0 | 0 | Unknown value |
| IF_NEW | 1 | 1 | Device is created but not configured |
| IF_OLD | 2 | 2 | Device is configured and should have an InstanceID |
| IF_CURRENT | 3 | 3 | The device is configured and the InstanceID belongs to the searching device |
| IF_UNSUPPORTED | 4 | 4 | Device is not supported by the module |
Status Codes
| Define | Value | Total value | Description |
|---|---|---|---|
| IS_SBASE | 100 | 100 | Value base for status codes |
| IS_CREATING | 1 | 101 | Instance is creating |
| IS_ACTIVE | 2 | 102 | Instance is active |
| IS_DELETING | 3 | 103 | Instance is deleting |
| IS_INACTIVE | 4 | 104 | Instance is inactive |
| IS_NOTCREATED | 5 | 105 | Instance was not created |
Error Codes
| Define | Value | Total value | Description |
|---|---|---|---|
| IS_EBASE | 200 | 200 | General error |