IoT Export
...
IoT Core Datenmodell
IoT Command Core
Thing Kommandos
19 min
system über diese kommandos wird die grundlegende verwaltung der angelernten geräte durchgeführt refreshsupportedthingsdto aktualisiert die informationen über die unterstützten geräte es wird ein system docid\ yd6iamvhzhfwy dawfxz0 für jedes unterstütze gerät zurückgeliefert codebeispiele refreshsupportedthingsdto { "commandid" "owncommandid" } createthingdto erzeugt ein neues gerät basierend auf der referenz id feld datentyp beschreibung referenceid string eindeutige id des kommandos, diese wird selbst vergeben name string der für das neue gerät zu verwendente name codebeispiele createthingdto { "commandid" "owncommandid", "referenceid" "dd340905 2c7a 4d57 a702 d3758902d03b", "name" "dimmer bathroom" } setautopairingenableddto das automatische anlernen kann über dieses kommando aktiviert / deaktiviert werden optional lässt sich einstellen das dieses nach einer vorgegebenen zeit automatisch wieder deaktiviert wird feld datentyp beschreibung enabled boolean flag ob das automatische anlernen aktiviert oder deaktiviert werden soll enabledforsec number angabe wie viele sekunden das automatische anlernen aktiv sein soll bei einem wert von 0 bleibt das automatische anlernen so lange aktiv bis es wieder deaktiviert wird codebeispiele setautopairingenableddto { "commandid" "owncommandid", "enabled" true, "enabledforsec" 120 } refreshthingsdto aktualisierung von einem oder mehreren geräten anfordern feld datentyp beschreibung thingids array eine auflistung von geräte ids ist das feld nicht vorhanden oder leer, werden alle geräte aktualisiert codebeispiele refreshthingsdto 1 { "commandid" "owncommandid", "thingids" \[ "dd340905 2c7a 4d57 a702 d3758902d03b", "8d638845 6270 476f 9878 860dc7ae0bde" ] } refreshthingsdto 2 { "commandid" "owncommandid" } refreshdescriptionsdto aktualisierung aller wertbeschreibungen feld datentyp beschreibung descriptionids array eine auflistung von wertbeschreibung s ids ist das feld nicht vorhanden oder leer, werden alle wertbeschreibung sen aktualisiert codebeispiele refreshdescriptionsdto 1 { "commandid" "owncommandid", "descriptionids" \[ "c59cc0096a458b4038e20e7addc70a0d", "e21d6d20c03d05aa9e368dd9f79bec5a" ] } refreshdescriptionsdto 2 { "commandid" "owncommandid" } gerätespezifisch kommandos die sich direkt auf ein existierendes gerät beziehen, benötigen immer die id des gerätes daher ist das feld "id" in jedem geräte kommando objekt vorhanden feld datentyp beschreibung id string eindeutige id eines gerätes deletethingdto zum löschen eines gerätes wird nur die geräte id benötigt, daher gibt es keine weiteren felder codebeispiele deletethingdto { "commandid" "owncommandid", "id" "dd340905 2c7a 4d57 a702 d3758902d03b" } renamethingdto umbenennen eines gerätes feld datentyp beschreibung newname string der neue name für das gerät codebeispiele renamethingdto { "commandid" "owncommandid", "id" "da592b04 af82 4d88 a8b2 446d4f21fb80", "newname" "renamed device" } setthingchannelvaluedto stellt den kanalwert eines geräts auf den eingestellten wert ein feld datentyp beschreibung channelid string eindeutige id eines gerätekanals newvalue string der neue zu setzende wert dieser wird immer als string übertragen auch bei zahlenwerten! bei erfolgreicher änderung wird das zugehörige geräteobjekt aktualisiert codebeispiele setthingchannelvaluedto 1 { "commandid" "owncommandid", "id" "295d0951 ff6b 4cf4 9b86 add3f7d2808f", "channelid" "switch", "newvalue" "on" } setthingchannelvaluedto 2 { "commandid" "owncommandid", "id" "dd340905 2c7a 4d57 a702 d3758902d03b", "channelid" "dimmer", "newvalue" "80" } setthingparameterdto ändern von geräteparametern feld datentyp beschreibung parameterid string eindeutige parameter id bezogen auf ein gerät newvalue string der neue zu setzende wert dieser wird immer als string übertragen auch bei zahlenwerten! codebeispiele setthingparameterdto 1 { "commandid" "owncommandid", "id" "295d0951 ff6b 4cf4 9b86 add3f7d2808f", "parameterid" "shutdowntime", "newvalue" "60" } setthingparameterdto 2 { "commandid" "owncommandid", "id" "295d0951 ff6b 4cf4 9b86 add3f7d2808f", "parameterid" "dynamiceupdate", "newvalue" "false" } enocean hierbei handelt es sich um kommandos welche nur mit enocean geräten funktionieren assignacknowledgeiddto zuweisung einer enocean id zu einem empfangskanal feld datentyp beschreibung eurid string die eurid des enocean gerätes acknowledgechannelname string einer der für das gerät möglichen empfangskanalnamen codebeispiele assignacknowledgeiddto { "commandid" "owncommandid", "id" "dd340905 2c7a 4d57 a702 d3758902d03b", "eurid" "0x03245245", "acknowledgechannelname" "default" } sendpairingsignaldto senden eines lernsignals für aktoren das gateway für das senden des signals muss angegeben werden, damit die korrekte sende id bestimmt werden kann feld datentyp beschreibung gatewayid string eindeutige id eines enocean gateways zur bestimmung der sende id transmissionchannelname string einer der für das gerät möglichen sendekanalnamen secure boolean angabe ob ein lernsignal mit verschlüsselung gesendet wird codebeispiele sendpairingsignaldto { "commandid" "owncommandid", "id" "dd340905 2c7a 4d57 a702 d3758902d03b", "gatewayid" "12342648", "transmissionchannelname" "default", "secure" false }