Dokumentation
IPS_GetEvent
Benötigt: IP-Symcon >= 3.1
array IPS_GetEvent (int $EreignisID)
Parameterliste
| EreignisID | Die zu zeigende EreignisID |
Rückgabewert
Folgende Informationen stehen als key => value Paare zur Verfügung:
| Index | Type | Beschreibung |
|---|---|---|
| CyclicDateDay | integer | Datumstage. Siehe IPS_SetEventCyclic |
| CyclicDateDayValue | integer | Datumstagesintervall. Siehe IPS_SetEventCyclic |
| CyclicDateFrom | array | Startdatum als Array von Tag, Monat, Jahr; 0/0/0 = Immer. Siehe IPS_SetEventCyclicDateFrom |
| CyclicDateTo | array | Enddatum als Array von Tag, Monat, Jahr; 0/0/0 = Nie. Siehe IPS_SetEventCyclicDateTo |
| CyclicDateType | integer | Datumstyp. Siehe IPS_SetEventCyclic |
| CyclicDateValue | integer | Datumsintervall. Siehe IPS_SetEventCyclic |
| CyclicTimeFrom | array | Startzeit als Array von Stunde, Minute, Sekunde; 0/0/0 = Mitternacht. Siehe IPS_SetEventCyclicTimeFrom |
| CyclicTimeTo | array | Endzeit als Array von Stunde, Minute, Sekunde; 0/0/0 = Nie. Siehe IPS_SetEventCyclicTimeTo |
| CyclicTimeType | integer | Zeittyp. Siehe IPS_SetEventCyclic |
| CyclicTimeValue | integer | Zeitintervall. Siehe IPS_SetEventCyclic |
| EventActionID | string | ID der auszuführenden Aktion |
| EventActionParameters | array | Parameter der auszuführenden Aktion |
| EventActive | boolean | TRUE, wenn das Ereignis aktiv ist |
| EventConditions | array | Array von Bedingungen. Siehe IPS_SetEventCondition, IPS_SetEventConditionDateRule, IPS_SetEventConditionDayOfTheWeekRule, IPS_SetEventConditionTimeRule und IPS_SetEventConditionVariableRule |
| EventID | integer | ID des Ereignisses |
| EventLimit | integer | Restliche Anzahl der Ausführungen. 0 = Kein Limit |
| EventScript | string | Immer ein leerer String, da dieses Feld nur noch aus Kompatibilitätsgründen vorhanden ist. Die Ausführung wird immer über die Aktion, welche über IPS_SetEventScheduleAction konfiguriert wird, gesteuert. |
| EventType | integer | Ereignis-Typ: (0: Auslöser, 1: Zyklisch, 2: Wochenplan) |
| LastRun | float | Unix Timestamp der letzten Ausführung, 0 = Nie |
| NextRun | float | Unix Timestamp der nächsten Ausführung, 0 = Nie |
| ScheduleActions | array | Array von Aktionen, welche dem Wochenplan zugehörig sind. Siehe IPS_SetEventScheduleActionEx |
| ScheduleGroups | array | Array von Gruppen mit Schaltpunkten, welche dem Wochenplan zugehörig sind. Siehe IPS_SetEventScheduleGroup und IPS_SetEventScheduleGroupPoint |
| TriggerSubsequentExecution | boolean | Erlaube erneute Ausführung bei Auslösung ohne Wertänderung |
| TriggerType | integer | Wert für den Auslöser-Typ: Siehe IPS_SetEventTrigger |
| TriggerValue | variant | Wert, der für die Prüfung je nach Auslösertyp verwendet wird |
| TriggerVariableID | integer | VariablenID, die als Auslöser genutzt werden soll |
Beschreibung
Die Funktion liefert ein Array mit Informationen über Ereignis mit der ID EreignisID.
Seit IP-Symcon 3.1 sind die Felder CyclicDateFrom, CyclicDateTo, CyclicTimeFrom und CyclicTimeTo jeweils Arrays. Wer Kompatibilität zur Version 3.0 und älter benötigt, kann auf die seit IP-Symcon 3.1 verfügbare Funktion IPS_GetEventCompatibility zurückgreifen, welche die alte Funktionsweise wiederherstellt.
Beispiel
$EreignisID = 46413;
$EreignisInfo = IPS_GetEvent($EreignisID);
print_r($EreignisInfo);
/* liefert z.B.:
Array
(
[EventID] => 41227
[EventType] => 2
[EventActive] => 1
[EventLimit] => 0
[EventConditions] => Array
(
[0] => Array
(
[ID] => 0
[ParentID] => 0
[VariableRules] => Array
(
[0] => Array
(
[ID] => 1
[VariableID] => 29025
[Comparison] => 4
[Value] => 500
)
)
[DateRules] => Array
(
[0] => Array
(
[ID] => 0
[Comparison] => 0
[Value] => Array
(
[Day] => 8
[Month] => 8
[Year] => 2001
)
)
[1] => Array(3)
(
[ID] => 1
[Comparison] => 4
[Value] => Array
(
[Day] => 1
[Month] => 1
[Year] => 2021
)
)
)
[TimeRules] => Array
(
[0] => Array
(
[ID] => 1
[Comparison] => 3
[Value] => Array
(
[Hour] => 9
[Minute] => 0
[Second] => 0
)
)
[1] => Array
(
[ID] => 2
[Comparison] => 5
[Value] => Array
(
[Hour] => 17
[Minute] => 0
[Second] => 0
)
)
)
[DayOfTheWeekRules] => Array
(
[0] => Array
(
[ID] => 0
[Comparison] => 0
[Value] => 3
)
)
[Operation] => 1
)
)
[TriggerType] => 0
[TriggerVariableID] => 0
[TriggerValue] =>
[TriggerSubsequentExecution] =>
[CyclicDateType] => 0
[CyclicDateValue] => 0
[CyclicDateDay] => 0
[CyclicDateDayValue] => 0
[CyclicDateFrom] => Array
(
[Day] => 0
[Month] => 0
[Year] => 0
)
[CyclicDateTo] => Array
(
[Day] => 0
[Month] => 0
[Year] => 0
)
[CyclicTimeType] => 0
[CyclicTimeValue] => 0
[CyclicTimeFrom] => Array
(
[Hour] => 0
[Minute] => 0
[Second] => 0
)
[CyclicTimeTo] => Array
(
[Hour] => 0
[Minute] => 0
[Second] => 0
)
[ScheduleActions] => Array
(
[0] => Array
(
[ID] => 0
[Name] => Kalt
[Color] => 255
[ScriptText] =>
[ActionID] => {3644F802-C152-464A-868A-242C2A3DEC5C}
[ActionParameters] => Array
(
[VALUE] => 2
)
)
[1] => Array
(
[ID] => 1
[Name] => Warm
[Color] => 16711680
[ScriptText] =>
[ActionID] => {3644F802-C152-464A-868A-242C2A3DEC5C}
[ActionParameters] => Array
(
[VALUE] => 0
)
)
)
[ScheduleGroups] => Array
(
[0] => Array
(
[ID] => 0
[Days] => 127
[Points] => Array
(
[0] => Array
(
[ID] => 13
[Start] => Array
(
[Hour] => 0
[Minute] => 0
[Second] => 0
)
[ActionID] => 1
)
[1] => Array
(
[ID] => 14
[Start] => Array
(
[Hour] => 12
[Minute] => 0
[Second] => 0
)
[ActionID] => 0
)
)
)
)
[EventScript] =>
[LastRun] => 0
[NextRun] => 0
)
*/