Dokumentation
Nachrichten
Benötigt: IP-Symcon >= 4.1
Beschreibung
Alle Nachrichten haben eine eigene ID, welche die Art der Nachricht beschreibt.
Dies ist eine fünfstellige Zahl und setzt sich wiefolgt zusammen:
Basis + Kategorie + Typ = Gesamtwert
Ab Version 5.0 stehen die Werte automatisch als Konstante zur Verfügung
Übersicht aller NachrichtIDs
Nachrichtenbasis
Nachrichten von IP-Symcon haben die Wertebasis 10000, solche von Modulinstanzen (noch undokumentiert) die Wertebasis 20000.
| Define | Wert | Beschreibung |
|---|---|---|
| IPS_BASE | 10000 | Wertebasis für Kernel |
| IPS_MODULBASE | 20000 | Wertebasis für Module |
Nachrichtenkategorien
| Define | Wert | Beschreibung |
|---|---|---|
| IPS_BASE | 0 | Service Nachrichten |
| IPS_KERNELMESSAGE | 100 | Kernel Manager |
| IPS_LOGMESSAGE | 200 | Meldungen Manager |
| IPS_MODULEMESSAGE | 300 | Modul Manager |
| IPS_OBJECTMESSAGE | 400 | Objekt Manager |
| IPS_INSTANCEMESSAGE | 500 | Instanz Manager |
| IPS_SEARCHMESSAGE | 510 | Such Manager |
| IPS_VARIABLEMESSAGE | 600 | Variablen Manager |
| IPS_SCRIPTMESSAGE | 700 | Script Manager |
| IPS_EVENTMESSAGE | 800 | Event Manager |
| IPS_MEDIAMESSAGE | 900 | Medien 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_LICENSENMESSAGE | 1600 | License Pool |
Nachrichtentypen
IPS_BASE
Wertebasis 0
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| IPS_KERNELSTARTED (ab 4.2) | 1 | 10001 | Wird nach KR_READY gesendet und synchron abgearbeitet |
| IPS_KERNELSHUTDOWN (ab 4.2) | 2 | 10002 | Wird vor KR_UNINIT gesendet und synchron abgearbeitet |
IPS_KERNELMESSAGE
Wertebasis 100
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| KR_CREATE | 1 | 10101 | Kernel wurde erstellt |
| KR_INIT | 2 | 10102 | Kernel Komponenten werden initialisiert, Module geladen und Settings eingelesen |
| KR_READY | 3 | 10103 | Kernel ist bereit und läuft |
| KR_UNINIT | 4 | 10104 | "Shutdown"-Befehl erhalten, finalisiere alles geladene |
| KR_SHUTDOWN | 5 | 10105 | Finalisierung abgeschlossen, entferne Kernel |
IPS_LOGMESSAGE
Wertebasis 200
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| KL_MESSAGE | 1 | 10201 | Normale Nachricht |
| KL_SUCCESS | 2 | 10202 | Erfolg |
| KL_NOTIFY | 3 | 10203 | Änderungsbenachrichtung |
| KL_WARNING | 4 | 10204 | Warnung |
| KL_ERROR | 5 | 10205 | Fehlermeldung |
| KL_DEBUG | 6 | 10206 | Debug Information |
| KL_CUSTOM | 7 | 10207 | Sonstige Nachrichten |
IPS_MODULEMESSAGE
Wertebasis 300
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| ML_LOAD | 1 | 10301 | Modul geladen |
| ML_UNLOAD | 2 | 10302 | Modul entladen |
IPS_OBJECTMESSAGE
Wertebasis 400
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| OM_REGISTER | 1 | 10401 | Objekt erstellt |
| OM_UNREGISTER | 2 | 10402 | Objekt entfernt |
| OM_CHANGEPARENT | 3 | 10403 | Übergeordnetes Objekt hat sich geändert |
| OM_CHANGENAME | 4 | 10404 | Name hat sich geändert |
| OM_CHANGEINFO | 5 | 10405 | Beschreibung hat sich geändert |
| OM_CHANGETYPE | 6 | 10406 | Typ hat sich geändert |
| OM_CHANGESUMMARY | 7 | 10407 | Kurzinfo hat sich geändert |
| OM_CHANGEPOSITION | 8 | 10408 | Position hat sich geändert |
| OM_CHANGEREADONLY | 9 | 10409 | "Nur-Lesen"-Status hat sich geändert |
| OM_CHANGEHIDDEN | 10 | 10410 | Sichtbarkeit hat sich geändert |
| OM_CHANGEICON | 11 | 10411 | Icon hat sich geändert |
| OM_CHILDADDED | 12 | 10412 | Untergeordnetes Objekt hinzugefügt |
| OM_CHILDREMOVED | 13 | 10413 | Untergeordnetes Objekt entfernt |
| OM_CHANGEIDENT | 14 | 10414 | Ident hat sich geändert |
| OM_CHANGEDISABLED | 15 | 10415 | Bedienbarkeit hat sich geändert |
| OM_CHANGELOCKED | 16 | 10416 | Sperre hat sich geändert |
IPS_INSTANCEMESSAGE
Wertebasis 500
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| IM_CREATE | 1 | 10501 | Instanz erstellt |
| IM_DELETE | 2 | 10502 | Instanz entfernt |
| IM_CONNECT | 3 | 10503 | Instanzinterface verfügbar |
| IM_DISCONNECT | 4 | 10504 | Instanzinterface nicht mehr verfügbar |
| IM_CHANGESTATUS | 5 | 10505 | Status hat sich geändert |
| IM_CHANGESETTINGS | 6 | 10506 | Einstellungen haben sich geändert |
| IM_CHANGEATTRIBUTE | 7 | 10507 | Attribut hat sich geändert |
| IM_ADDATTRIBUTE | 8 | 10508 | Attribut wurde hinzugefügt |
| IM_REMOVEATTRIBUTE | 9 | 10509 | Attribut wurde entfernt |
IPS_SEARCHMESSAGE
Wertebasis 510
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| IM_SEARCHSTART | 1 | 10511 | Suche wurde gestartet |
| IM_SEARCHSTOP | 2 | 10512 | Suche wurde gestoppt |
| IM_SEARCHUPDATE | 3 | 10513 | Suche hat neue Ergebnisse |
IPS_FORMMESSAGE
Wertebasis 520
| Define | Value | Total value | Description |
|---|---|---|---|
| IM_FORMFIELDCREATE | 1 | 10521 | Formularfeld erstellt |
| IM_FORMFIELDDELETE | 2 | 10522 | Formularfeld entfernt |
| IM_FORMFIELDUPDATE | 3 | 10523 | Formularfeld hat sich geändert |
| IM_FORMRELOAD | 4 | 10524 | Lade Formularfeld erneut |
IPS_VARIABLEMESSAGE
Wertebasis 600
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| VM_CREATE | 1 | 10601 | Variable wurde erstellt |
| VM_DELETE | 2 | 10602 | Variable wurde entfernt |
| VM_UPDATE | 3 | 10603 | Variable wurde aktualisiert |
| VM_CHANGEPROFILENAME | 4 | 10604 | Variablenprofilname wurde geändert |
| VM_CHANGEPROFILEACTION | 5 | 10605 | Variablenprofilaktion wurde geändert |
| VM_CHANGEDLOCKED | 6 | 10606 | Sperre wurde geändert |
IPS_SCRIPTMESSAGE
Wertebasis 700
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| SM_CREATE | 1 | 10701 | Skript wurde erstellt |
| SM_DELETE | 2 | 10702 | Skript wurde entfernt |
| SM_CHANGEFILE | 3 | 10703 | Skript wurde Datei angehangen |
| SM_BROKEN | 4 | 10704 | Skript Fehlerstatus hat sich geändert |
| SM_UPDATE | 5 | 10704 | Skript wurde aktualisiert |
IPS_EVENTMESSAGE
Wertebasis 800
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| EM_CREATE | 1 | 10801 | Ereignis wurde erstellt |
| EM_DELETE | 2 | 10802 | Ereignis wurde entfernt |
| EM_UPDATE | 3 | 10803 | Ereignis wurde aktualisiert |
| EM_CHANGEACTIVE | 4 | 10804 | Ereignisaktivierung hat sich geändert |
| EM_CHANGELIMIT | 5 | 10805 | Ereignisaufruflimit hat sich geändert |
| EM_CHANGESCRIPT | 6 | 10806 | Ereignisskriptinhalt hat sich geändert |
| EM_CHANGETRIGGER | 7 | 10807 | Ereignisauslöser hat sich geändert |
| EM_CHANGETRIGGERVALUE | 8 | 10808 | Ereignisgrenzwert hat sich geändert |
| EM_CHANGETRIGGEREXECUTION | 9 | 10809 | Ereignisgrenzwertauslösung hat sich geändert |
| EM_CHANGECYCLIC | 10 | 10810 | zyklisches Ereignis hat sich geändert |
| EM_CHANGECYCLICDATEFROM | 11 | 10811 | Startdatum hat sich geändert |
| EM_CHANGECYCLICDATETO | 12 | 10812 | Enddatum hat sich geändert |
| EM_CHANGECYCLICTIMEFROM | 13 | 10813 | Startzeit hat sich geändert |
| EM_CHANGECYCLICTIMETO | 14 | 10814 | Endzeit hat sich geändert |
| EM_ADDSCHEDULEACTION | 15 | 10815 | Eintrag in der Aktionstabelle des Wochenplans wurde hinzugefügt |
| EM_REMOVESCHEDULEACTION | 16 | 10816 | Eintrag in der Aktionstabelle des Wochenplans wurde entfernt |
| EM_CHANGESCHEDULEACTION | 17 | 10817 | Eintrag in der Aktionstabelle des Wochenplans hat sich geändert |
| EM_ADDSCHEDULEGROUP | 18 | 10818 | Gruppierung der Wochenplantage wurde hinzugefügt |
| EM_REMOVESCHEDULEGROUP | 19 | 10819 | Gruppierung der Wochenplantage wurde entfernt |
| EM_CHANGESCHEDULEGROUP | 20 | 10820 | Gruppierung der Wochenplantage hat sich geändert |
| EM_ADDSCHEDULEGROUPPOINT | 21 | 10821 | Schaltpunkt einer Gruppierung wurde hinzugefügt |
| EM_REMOVESCHEDULEGROUPPOINT | 22 | 10822 | Schaltpunkt einer Gruppierung wurde entfernt |
| EM_CHANGESCHEDULEGROUPPOINT | 23 | 10823 | Schaltpunkt einer Gruppierung hat sich geändert |
| EM_ADDCONDITION | 24 | 10824 | Bedingung wurde hinzugefügt |
| EM_REMOVECONDITION | 25 | 10825 | Bedingung wurde entfernt |
| EM_CHANGECONDITION | 26 | 10826 | Bedingung hat sich geändert |
| EM_ADDCONDITIONVARIABLERULE | 27 | 10827 | Variablenregel der Bedingung wurde hinzugefügt |
| EM_REMOVECONDITIONVARIABLERULE | 28 | 10828 | Variablenregel der Bedingung wurde entfernt |
| EM_CHANGECONDITIONVARIABLERULE | 29 | 10829 | Variablenregel der Bedingung hat sich geändert |
| EM_ADDCONDITIONDATERULE | 30 | 10830 | Datumsregel der Bedingung wurde hinzugefügt |
| EM_REMOVECONDITIONDATERULE | 31 | 10831 | Datumsregel der Bedingung wurde entfernt |
| EM_CHANGECONDITIONDATERULE | 32 | 10832 | Datumsregel der Bedingung hat sich geändert |
| EM_ADDCONDITIONTIMERULE | 33 | 10833 | Zeitregel der Bedingung wurde hinzugefügt |
| EM_REMOVECONDITIONTIMERULE | 34 | 10834 | Zeitregel der Bedingung wurde entfernt |
| EM_CHANGECONDITIONTIMERULE | 35 | 10835 | Zeitregel der Bedingung hat sich geändert |
| EM_ADDCONDITIONDAYOFTHEWEEKRULE | 36 | 10836 | Wochentagsregel der Bedingung wurde hinzugefügt |
| EM_REMOVECONDITIONDAYOFTHEWEEKRULE | 37 | 10837 | Wochentagsregel der Bedingung wurde entfernt |
| EM_CHANGECONDITIONDAYOFTHEWEEKRULE | 38 | 10838 | Wochentagsregel der Bedingung hat sich geändert |
IPS_MEDIAMESSAGE
Wertebasis 900
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| MM_CREATE | 1 | 10901 | Medienobjekt wurde erstellt |
| MM_DELETE | 2 | 10902 | Medienobjekt wurde entfernt |
| MM_CHANGEFILE | 3 | 10903 | Datei des Medienobjekts wurde geändert |
| MM_AVAILABLE | 4 | 10904 | Verfügbarkeit des Medienobjekts hat sich geändert |
| MM_UPDATE | 5 | 10905 | Medienobjekt wurde aktualisiert |
| MM_CHANGECACHED | 6 | 10906 | Cacheoption vom Medienobjekt hat sich geändert |
IPS_LINKMESSAGE
Wertebasis 1000
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| LM_CREATE | 1 | 11001 | Link wurde erstellt |
| LM_DELETE | 2 | 11002 | Link wurde entfernt |
| LM_CHANGETARGET | 3 | 11003 | Ziel des Links hat sich geändert |
IPS_FLOWMESSAGE
Wertebasis 1100
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| FM_CONNECT | 1 | 11101 | Instanz wurde verbunden |
| FM_DISCONNECT | 2 | 11102 | Instanz wurde getrennt |
| FM_CHILDADDED | 3 | 11103 | Untergeordnete Instanz wurde mit dieser Instanz verbunden |
| FM_CHILDREMOVED | 4 | 11104 | Untergeordnete Instanz wurde von dieser Instanz getrennt |
IPS_ENGINEMESSAGE
Wertebasis 1200
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| SE_UPDATE | 1 | 11201 | Scriptengine wurde neu geladen |
| SE_EXECUTE | 2 | 11202 | Script wurde ausgeführt |
| SE_RUNNING | 3 | 11203 | Script wird ausgeführt |
| SE_FLOWSCRIPT | 4 | 11204 | Bei Ablaufplan Status (entweder alle Schritte abgeschlossen oder abgebrochen) |
IPS_PROFILEMESSAGE
Wertebasis 1300
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| PM_CREATE | 1 | 11301 | Profil wurde erstellt |
| PM_DELETE | 2 | 11302 | Profil wurde entfernt |
| PM_CHANGETEXT | 3 | 11303 | Profilprefix/Profilsuffix hat sich geändert |
| PM_CHANGEVALUES | 4 | 11304 | Profilwerte haben sich geändert |
| PM_CHANGEDIGITS | 5 | 11305 | Profilnachkommastellen haben sich geändert |
| PM_CHANGEICON | 6 | 11306 | Profilicon hat sich geändert |
| PM_ASSOCIATIONADDED | 7 | 11307 | Profilassoziation wurde hinzugefügt |
| PM_ASSOCIATIONREMOVED | 8 | 11308 | Profilassoziation wurde entfernt |
| PM_ASSOCIATIONCHANGED | 9 | 11309 | Profilassoziation hat sich geändert |
IPS_TIMERMESSAGE
Wertebasis 1400
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| TM_REGISTER | 1 | 11401 | Timer wurde erstellt |
| TM_UNREGISTER | 2 | 11402 | Timer wurde entfernt |
| TM_CHANGEINTERVAL | 3 | 11403 | Timer Interval hat sich geändert |
IPS_ACTIONMESSAGE
Wertebasis 1500
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| AM_FORMFIELDCREATE | 1 | 11501 | Aktuell ungenutzt |
| AM_FORMFIELDDELETE | 2 | 11502 | Aktuell ungenutzt |
| AM_FORMFIELDUPDATE | 3 | 11503 | Form-Element benötigt ein Update |
| AM_FORMRELOAD | 4 | 11504 | Konfigurationsformular neuladen |
IPS_LICENSEMESSAGE
Wertebasis 1600
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| LP_UPDATELICENSE | 1 | 11601 | Lizenz wurde geändert |
| LP_UPDATESUBSCRIPTION | 2 | 11602 | Subskription wurde aktualisiert |
Nachrichtenparameter
Werte von verschiedenen Nachrichtenparametern
Search Handling
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| IF_UNKNOWN | 0 | 0 | Unbekannter Wert |
| IF_NEW | 1 | 1 | Gerät ist erstellt aber nicht konfiguriert |
| IF_OLD | 2 | 2 | Gerät ist konfiguriert und sollte eine InstanzID haben |
| IF_CURRENT | 3 | 3 | Gerät ist konfiguriert und die InstanzID gehört dem suchenden Gerät |
| IF_UNSUPPORTED | 4 | 4 | Gerät wird vom Modul nicht unterstützt |
Status Codes
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| IS_SBASE | 100 | 100 | Wertebasis für Status Codes |
| IS_CREATING | 1 | 101 | Instanz wird erstellt |
| IS_ACTIVE | 2 | 102 | Instanz ist aktiv |
| IS_DELETING | 3 | 103 | Instanz wird gelöscht |
| IS_INACTIVE | 4 | 104 | Instanz ist inaktiv |
| IS_NOTCREATED | 5 | 105 | Instanz wurde nicht erstelltv |
Error Codes
| Define | Wert | Gesamtwert | Beschreibung |
|---|---|---|---|
| IS_EBASE | 200 | 200 | Allgemeiner Fehlerfall |