Logik Kommandos
Hinzufügen einer Szene.
Feld | Datentyp | Beschreibung |
---|---|---|
executorCollection | Object | Ein ExecutorCollection DTO Objekt. |
Die ID der ExecutorCollection wird vom Server nach Erstellung des internen Objekts vergeben. Falls bereits eine ID gesetzt wurde, wird diese im erstellten Objekt nicht verwendet!
Erzeugen eines virtuellen Geräts, das zum Steuern und Anzeigen der verbundenen Szenen verwendet werden kann.
Feld | Datentyp | Beschreibung |
---|---|---|
id | String | ID der ExecutorCollection für welche ein virtuelles Gerät erzeugt werden soll. |
name | String | Der Name für das zu erzeugende Gerät. |
Es können mehere virtuelle Geräte für eine Szene angelegt werden.
Löschen einer Szene.
Feld | Datentyp | Beschreibung |
---|---|---|
id | String | ID der ExecutorCollection welche gelöscht werden soll. |
Einmaliges Ausführen einer bestehenden Szene.
Feld | Datentyp | Beschreibung |
---|---|---|
id | String | Die ID einer angelegten Szene. |
Einmaliges Ausführen einer bestehenden oder temporären Szene.
Feld | Datentyp | Beschreibung |
---|---|---|
executorCollection | Object | Ein ExecutorCollection DTO Objekt, welches ausgeführt werden soll. |
Das ExecutorCollection-DTO-Objekt für das Feld "executorCollection" muss vorher nicht dem System hinzugefügt werden. Es wird einmalig ausgeführt und nicht gespeichert.
Anfage der momentan laufenden Szenen.
Feld | Datentyp | Beschreibung |
---|---|---|
searchString | String | Optionales Feld zum Filtern der Szenen. Es wird der Name und die Beschreibung durchsucht. Ist das Feld nicht vorhanden oder leer, wird kein Filter angewendet. |
Wird als Rückgabe auf die Kommandoanfrage gesendet.
Feld | Datentyp | Beschreibung |
---|---|---|
runningExecutorCollections | Array | Ein Array von aktuell ausgeführten ExecutorCollectionDTOs. |
Stoppt die Ausführung einer Szene.
Feld | Datentyp | Beschreibung |
---|---|---|
id | String | ID der ExecutorCollection welche gestoppt werden soll. |
Ändern einer Szene.
Feld | Datentyp | Beschreibung |
---|---|---|
executorCollection | Object | Ein ExecutorCollection DTO Objekt. Die ID muss korrekt gesetzt sein. |
Die Daten der angegebenen Szenen werden erneut versendet.
Feld | Datentyp | Beschreibung |
---|---|---|
executorCollectionIds | Array | Eine Auflistung von ExecutorCollection IDs welche aktualisiert werden sollen. Ist das Feld nicht vorhanden oder leer, werden alle ExecutorCollections aktualisiert. |
Hinzufügen einer Regel.
Feld | Datentyp | Beschreibung |
---|---|---|
conditionCollection | Object | Ein ConditionCollection DTO Objekt. |
Die ID der ConditionCollection wird vom Server nach Erstellung des internen Objekts vergeben. Falls bereits eine ID gesetzt wurde, wird diese im erstellten Objekt nicht verwendet!
Löschen einer Regel.
Feld | Datentyp | Beschreibung |
---|---|---|
id | String | ID der ConditionCollection |
Ändern einer Regel.
Feld | Datentyp | Beschreibung |
---|---|---|
conditionCollection | Object | Ein ConditionCollection DTO Objekt. Die ID muss korrekt gesetzt sein. |
Die Daten der angegebenen Regeln werden erneut versendet.
Feld | Datentyp | Beschreibung |
---|---|---|
conditionCollectionIds | Array | Eine Auflistung von ConditionCollection IDs welche aktualisiert werden sollen. Ist das Feld nicht vorhanden oder leer, werden alle ConditionCollections aktualisiert. |
Hinzufügen einer Verknüpfung.
Feld | Datentyp | Beschreibung |
---|---|---|
connection | Object | Ein Connection DTO Objekt. |
Die ID der Connection wird vom Server nach Erstellung des internen Objekts vergeben. Falls bereits eine ID gesetzt wurde, wird diese im erstellten Objekt nicht verwendet!
Löschen einer Verknüpfung.
Feld | Datentyp | Beschreibung |
---|---|---|
id | String | ID der Connection, welche gelöscht werden soll. |
Aktiviert oder deaktiviert eine Verknüpfung ohne diese zu löschen.
Feld | Datentyp | Beschreibung |
---|---|---|
id | String | ID der Connection. |
enabled | Boolean | Flag ob die Verknüpfung aktiv sein soll oder nicht. |
Aktualisieren einer Verknüpfung.
Feld | Datentyp | Beschreibung |
---|---|---|
connection | Object | Ein Connection DTO Objekt. Die ID muss korrekt gesetzt sein. |
Die Daten der angegebenen Verknüpfungen werden erneut versendet.
Feld | Datentyp | Beschreibung |
---|---|---|
connectionIds | Array | Eine Auflistung von Connections IDs welche aktualisiert werden sollen. Ist das Feld nicht vorhanden oder leer, werden alle Connections aktualisiert. |
Einen neuen Timer mit dem gewünschten Namen erzeugen.
Feld | Datentyp | Beschreibung |
---|---|---|
name | String | Der Name des neuen Timers. |
Timer Einstellungen ändern.
Feld | Datentyp | Beschreibung |
---|---|---|
timer | Object | Ein SimpleIoTCoreTimer DTO Objekt. Die ID muss korrekt gesetzt sein. |
Es werden nur die timerspezifischen Felder wie in SimpleIoTCoreTimerDTO beschrieben, unterstützt. Das "channels" und "parameters" Feld wird nicht ausgewertet!
Timer aktivieren/deaktivieren.
Feld | Datentyp | Beschreibung |
---|---|---|
id | String | Die eindeutige Timer ID. |
enabled | Boolean | Flag ob der Timer aktiviert ist oder nicht. |