Thing Commands

system these commands are used for basic management of the learned devices refreshsupportedthingsdto requests the reference ids of the supported devices a system docid\ rt6ksrmvt9tvxrzvhfyzb for each supported device is returned code examples refreshsupportedthingsdto { "commandid" "owncommandid" } createthingdto create a new device based on the reference id field data type description referenceid string unique id of the command, this is assigned by the user name string the name to be used for the new device code examples createthingdto { "commandid" "owncommandid", "referenceid" "dd340905 2c7a 4d57 a702 d3758902d03b", "name" "dimmer bathroom" } setautopairingenableddto automatic pairing can be activated / deactivated using this command optionally, it can be set to be automatically deactivated again after a specified time field data type description enabled boolean flag whether automatic teach in should be activated or deactivated enabledforsec number specifies how many seconds the automatic teach in should be active if the value is 0, automatic teach in remains active until it is deactivated again code examples setautopairingenableddto { "commandid" "owncommandid", "enabled" true, "enabledforsec" 120 } refreshthingsdto request update of one or more devices field data type description thingids array a list of device ids if the field does not exist or is empty, all devices are updated code examples refreshthingsdto 1 { "commandid" "owncommandid", "thingids" \[ "dd340905 2c7a 4d57 a702 d3758902d03b", "8d638845 6270 476f 9878 860dc7ae0bde" ] } refreshthingsdto 2 { "commandid" "owncommandid" } refreshdescriptionsdto request update of one or more value descriptions field data type description descriptionids array a list of description ids if the field does not exist or is empty, all descriptions are updated code examples refreshdescriptionsdto 1 { "commandid" "owncommandid", "descriptionids" \[ "c59cc0096a458b4038e20e7addc70a0d", "e21d6d20c03d05aa9e368dd9f79bec5a" ] } refreshdescriptionsdto 2 { "commandid" "owncommandid" } device specific commands that refer directly to an existing device always require the id of the device the "id" field is therefore present in every device command object field data type description id string unique id of a device deletethingdto only the device id is required to delete a device, so there are no other fields code examples deletethingdto { "commandid" "owncommandid", "id" "dd340905 2c7a 4d57 a702 d3758902d03b" } renamethingdto rename a device field data type description newname string the new name for the device code examples renamethingdto { "commandid" "owncommandid", "id" "da592b04 af82 4d88 a8b2 446d4f21fb80", "newname" "renamed device" } setthingchannelvaluedto sets the channel value of a device to the set value field data type description channelid string unique id of a device channel newvalue string the new value to be set this is always transferred as a string even with numerical values! if the change is successful, the associated device object is updated code examples 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 change device parameters field data type description parameterid string unique parameter id related to a device newvalue string the new value to be set this is always transferred as a string even for numerical values! code examples 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 these are commands that only work with enocean devices assignacknowledgeiddto assignment of an enocean id to a receive channel field data type description eurid string the eurid of the enocean device acknowledgechannelname string one of the possible receive channel names for the device code examples assignacknowledgeiddto { "commandid" "owncommandid", "id" "dd340905 2c7a 4d57 a702 d3758902d03b", "eurid" "0x03245245", "acknowledgechannelname" "default" } sendpairingsignaldto sending a learning signal for actuators the gateway for sending the signal must be specified so that the correct send id can be determined field data type description gatewayid string unique id of an enocean gateway to determine the send id transmissionchannelname string one of the possible transmission channel names for the device secure boolean specifies whether a learning signal is sent with encryption code examples sendpairingsignaldto { "commandid" "owncommandid", "id" "dd340905 2c7a 4d57 a702 d3758902d03b", "gatewayid" "12342648", "transmissionchannelname" "default", "secure" false }