Device

<< Click to Display Table of Contents >>

Navigation:  The API > JSON Adminstrator API > Understanding the admin API > Streaming message types >

Device

Device

 

Anytime a device configuration changes, the gateway sends the full device object.

This happens whenever:

- a device has been created

- a device configuration has been updated

- a device has sent a learn-in telegram during the gateway is in receiveMode = LearnMode:

 - Learn-in not yet completed (Missing Friendly Name, etc): then the Key "operable" is false

 - Learn-In completed: then the Key "operable" is true

- a device has been deleted

 

Example:

 

 

{
  "header" : {
    "content" : "device",
    "gateway" : "DC-GW/EO-IP v0.99.0b",
    "timestamp" : "2016-05-11T11:22:44.771+0200"
  },
  "device" : {
    "deviceId" : "018FBB0B",
    "learnInProcedure" : "UTE",
    "eeps" : [ {
      "eep" : "D2-01-09",
      "version" : 1.0,
      "direction" : "both"
    } ],
    "manufacturer" : "permundo GmbH",
    "firstSeen" : "2016-05-11T11:22:44.744+0200",
    "secured" : false,
    "softSmartAck" : false,
    "transmitModes" : [ {
      "key" : "overcurrentSwitchOff",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : false
    }, {
      "key" : "dimValue",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : false
    }, {
      "key" : "power",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : false
    }, {
      "key" : "localControl",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : false
    }, {
      "key" : "errorLevel",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : false
    }, {
      "key" : "energy",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : false
    } ],
    "operable" : false,
    "supported" : true
  }
}