Logik Kommandos

szenen addexecutorcollectiondto 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! codebeispiele executorcollection mit 3 executoren anlegen { "commandid" "owncommandid", "executorcollection" { "name" "executor room 1", "description" "light and dimmer room1 executor", "executors" \[ { "type" "value", "position" 0, "type" "value", "thingid" "91905b50 bf83 4584 a14b d4c2800cec1e", "channelid" "dimmer", "value" { "type" "raw", "type" "raw", "value" 100 0 } }, { "type" "delay", "position" 1, "type" "delay", "delay" 3000 }, { "type" "state", "position" 2, "type" "state", "thingid" "thingidfud14 2", "channelid" "valve", "state" "open" } ] } } leere executorcollection { "commandid" "owncommandid" } createexecutorthingdto 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 codebeispiele createexecutorthingdto { "commandid" "owncommandid", "id" "9ece616d ffbb 432b bfd7 4362a38f435a", "name" "executorthing 2" } deleteexecutorcollectiondto löschen einer szene feld datentyp beschreibung id string id der executorcollection welche gelöscht werden soll codebeispiele deleteexecutorcollectiondto { "commandid" "owncommandid", "id" "9ece616d ffbb 432b bfd7 4362a38f435a" } executeexecutorcollectiondto einmaliges ausführen einer bestehenden szene feld datentyp beschreibung id string die id einer angelegten szene codebeispiele executeexecutorcollectiondto { "commandid" "owncommandid", "id" "9ece616d ffbb 432b bfd7 4362a38f435a" } executeexecutorcollectionobjectdto 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 codebeispiele executeexecutorcollectionobjectdto { "commandid" "owncommandid", "executorcollection" { "id" "76dd6b1f 3f6a 4c02 b6d7 3539cd03201c", "name" "executor5", "description" "open valve 5 seconds", "executors" \[ { "position" 0, "type" "state", "thingid" "f5a69feb 59f0 4a44 a243 d2420c84f562", "channelid" "valve", "state" "open" }, { "position" 1, "type" "delay", "delay" 5000 }, { "position" 2, "type" "state", "thingid" "f5a69feb 59f0 4a44 a243 d2420c84f562", "channelid" "valve", "state" "close" } ] } } executeexecutorcollectionobjectdto beispiel 2 { "commandid" "owncommandid", "executorcollection" { "id" "76dd6b1f 3f6a 4c02 b6d7 3539cd03201c", "name" "testexecutor", "description" "", "executors" \[ { "position" 0, "type" "value", "thingid" "91905b50 bf83 4584 a14b d4c2800cec1e", "channelid" "dimmer", "value" { "type" "raw", "value" 100 0 } }, { "position" 1, "type" "delay", "delay" 5000 }, { "position" 2, "type" "value", "thingid" "f5a69feb 59f0 4a44 a243 d2420c84f562", "channelid" "dimmer", "value" { "type" "link", "foreignthingid" "91905b50 bf83 4584 a14b d4c2800cec1e", "foreignchannelid" "dimmer" } }, { "position" 3, "type" "delay", "delay" 5000 }, { "position" 4, "type" "value", "thingid" "f5a69feb 59f0 4a44 a243 d2420c84f562", "channelid" "dimmer", "value" { "type" "calculated", "expression" "a+b", "values" { "a" { "type" "raw", "value" 5 0 }, "b" { "type" "raw", "value" 5 0 } } } } ] } } getrunningexecutorcollectionsdto 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 codebeispiele getrunningexecutorcollectionsdto 1 { "commandid" "owncommandid" } getrunningexecutorcollectionsdto 2 { "commandid" "owncommandid", "searchstring" "floor 1" } runningexecutorcollectionsdto wird als rückgabe auf die kommandoanfrage gesendet feld datentyp beschreibung runningexecutorcollections array ein array von aktuell ausgeführten executorcollectiondtos codebeispiele runningexecutorcollectionsdto \[ { "id" "6e092f8b a897 460e af40 d065a5a8d06d", "name" "executortest", "description" "", "executors" \[ { "type" "value", "position" 0, "thingid" "f5a69feb 59f0 4a44 a243 d2420c84f562", "channelid" "dimmer", "value" { "type" "raw", "value" 77 } }, { "type" "delay", "position" 1, "delay" 5000 }, { "type" "value", "position" 2, "thingid" "f5a69feb 59f0 4a44 a243 d2420c84f562", "channelid" "dimmer", "value" { "type" "link", "foreignthingid" "91905b50 bf83 4584 a14b d4c2800cec1e", "foreignchannelid" "dimmer" } } ] }, { "id" "b8563612 6676 4e87 97f6 ac9fc80b8ecb", "name" "executor1", "description" "", "executors" \[ { "type" "random", "position" 0, "thingid" "91905b50 bf83 4584 a14b d4c2800cec1e", "channelid" "dimmer" }, { "type" "delay", "position" 1, "delay" 50000 } ] } ] stopexecutorcollectiondto stoppt die ausführung einer szene feld datentyp beschreibung id string id der executorcollection welche gestoppt werden soll codebeispiele stopexecutorcollectiondto { "commandid" "owncommandid", "id" "9ece616d ffbb 432b bfd7 4362a38f435a" } updateexecutorcollectiondto ändern einer szene feld datentyp beschreibung executorcollection object ein executorcollection dto objekt die id muss korrekt gesetzt sein codebeispiele updateexecutorcollectiondto { "commandid" "owncommandid", "executorcollection" { "id" "76dd6b1f 3f6a 4c02 b6d7 3539cd03201c", "name" "new name", "description" "new description", "executors" \[ { "type" "state", "position" 0, "thingid" "thingidfud14 2", "channelid" "valve", "state" "close" }, { "type" "delay", "position" 1, "delay" 5000 }, { "type" "state", "position" 2, "thingid" "thingidfud14 2", "channelid" "valve", "state" "open" } ] } } refreshexecutorcollectionsdto 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 codebeispiele refreshexecutorcollectionsdto 1 { "commandid" "owncommandid", "executorcollectionids" \[ "252afd4a 56d6 470d ae87 cf0433eb15a5", "971c0c85 8f5d 45b6 894a b8026f09d6ca" ] } refreshexecutorcollectionsdto 2 { "commandid" "owncommandid" } regeln addconditioncollectiondto 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! codebeispiele conditioncollection mit 2 conditions anlegen { "commandid" "owncommandid", "conditioncollection" { "type" "collection", "position" 0, "name" "my collection", "description" "a beautiful condition collection", "conditions" \[ { "type" "state", "position" 0, "comparator" "equal", "thingid" "d5da720e 2ad6 4c86 88c0 f84390f76570", "channelid" "windowhandle", "smartcheck" false, "state" "closed" }, { "type" "operator", "position" 1, "comparator" "and" }, { "type" "value", "position" 2, "comparator" "greater", "thingid" "f5a69feb 59f0 4a44 a243 d2420c84f562", "channelid" "dimmer", "smartcheck" false, "value" 45 0 } ] } } leere conditioncollection anlegen { "commandid" "owncommandid" } deleteconditioncollectiondto löschen einer regel feld datentyp beschreibung id string id der conditioncollection codebeispiele deleteconditioncollectiondto { "commandid" "owncommandid", "id" "7c6ba18c d4ee 4254 91aa 9989bf581f68" } updateconditioncollectiondto ändern einer regel feld datentyp beschreibung conditioncollection object ein conditioncollection dto objekt die id muss korrekt gesetzt sein codebeispiele updateconditioncollectiondto { "commandid" "owncommandid", "conditioncollection" { "type" "collection", "position" 0, "id" "7c6ba18c d4ee 4254 91aa 9989bf581f68", "name" "conditon1", "description" "controls dimmer bathroom", "conditions" \[ { "type" "state", "position" 0, "comparator" "equal", "thingid" "d5da720e 2ad6 4c86 88c0 f84390f76570", "channelid" "windowhandle", "smartcheck" false, "state" "closed" }, { "type" "operator", "position" 1, "comparator" "or" }, { "type" "value", "position" 2, "comparator" "greater", "thingid" "f5a69feb 59f0 4a44 a243 d2420c84f562", "channelid" "dimmer", "smartcheck" false, "value" 45 0 } ] } } refreshconditioncollectionsdto 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 codebeispiele refreshconditioncollectionsdto 1 { "commandid" "owncommandid", "conditioncollectionids" \[ "0809bb46 4ce7 42a3 8c78 04cb7d24a30e", "e37b6aee 2e35 4b64 82a5 8dd7a822e861" ] } refreshconditioncollectionsdto 2 { "commandid" "owncommandid" } verküpfungen addconnectiondto hinzufügen einer verknüpfung feld datentyp beschreibung c onnection 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! codebeispiele connection anlegen { "commandid" "owncommandid", "connection" { "active" true, "conditioncollectionid" "0809bb46 4ce7 42a3 8c78 04cb7d24a30e", "executorcollectionid" "971c0c85 8f5d 45b6 894a b8026f09d6ca", "name" "connection 1", "description" "connects cond1 and exec1" } } leere connection anlegen { "commandid" "owncommandid" } deleteconnectiondto löschen einer verknüpfung feld datentyp beschreibung id string id der connection, welche gelöscht werden soll codebeispiele deleteconditioncollectiondto { "commandid" "owncommandid", "id" "1ff100d2 d3ab 484f b36f 1e84c6a7a4db" } setconnectionenableddto 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 codebeispiele setconnectionenableddto { "commandid" "owncommandid", "id" "1ff100d2 d3ab 484f b36f 1e84c6a7a4db", "enabled" true } updateconnectiondto aktualisieren einer verknüpfung feld datentyp beschreibung connection object ein connection dto objekt die id muss korrekt gesetzt sein codebeispiele updateconnectiondto { "commandid" "owncommandid", "connection" { "id" "2d46cc1b 5780 4d4e b5de 293ec346d6b7", "active" false, "conditioncollectionid" "0809bb46 4ce7 42a3 8c78 04cb7d24a30e", "executorcollectionid" "971c0c85 8f5d 45b6 894a b8026f09d6ca", "name" "connection 1", "description" "connects cond1 and exec1" } } refreshconnectionsdto 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 codebeispiele refreshconnectionsdto 1 { "commandid" "owncommandid", "connectionids" \[ "da12f7c7 4126 46f1 a811 32dac2bbf2c7", "fe742922 ddf1 4ea2 a52d d29435359bfa" ] } refreshconnectionsdto 2 { "commandid" "owncommandid" } timer kommandos createtimerdto einen neuen timer mit dem gewünschten namen erzeugen feld datentyp beschreibung name string der name des neuen timers codebeispiele createtimerdto { "commandid" "owncommandid", "name" "azure timer" } updatetimerdto 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 simple iot core docid\ jn7jdo9xqvfdwxbax40tb beschrieben, unterstützt das "channels" und "parameters" feld wird nicht ausgewertet! codebeispiele updatetimerdto { "commandid" "owncommandid", "timer" { "id" "7c6ba18c d4ee 4254 91aa 9989bf581f68", "type" "timer", "enabled" true, "visible" true, "time" 0, "offset" 0, "period" 15, "selecteddays" \[ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } } settimerenableddto timer aktivieren/deaktivieren feld datentyp beschreibung id string die eindeutige timer id enabled boolean flag ob der timer aktiviert ist oder nicht codebeispiele settimerenableddto { "commandid" "owncommandid", "id" "7c6ba18c d4ee 4254 91aa 9989bf581f68", "enabled" false }