Resource Path

HTTP method

/devices/{deviceId}

GET

parameter

valid values

call option

description

deviceId

deviceId | friendlyId

required

SenderID of Enocean device, EnOcean modules usually send telegrams with their unique 32-bit Chip ID. In the other case, these are the Base ID of the EnOcean device.

parameter

datatype

value / formatting

description

header

object

{}

device

object

{}

deviceId

string

4 byte hex value

SenderID of Enocean device, EnOcean modules usually send telegrams with their unique 32-bit Chip ID. In the other case, these are the Base ID of the EnOcean device.

friendlyId

string

User-assigned name of EnOcean device. Must be unique.

physicalDevice

string

User-assigned name to group actuators and sensors.

eeps

array of objects

[{}]

eep

string

eepId

variation
(optional)

string

manufacturer _ productname

Manufacturer specific variation

version

string

API Version

direction

string

from | to | both

"from", "to" or "both"

firstSeen

string

yyyy-mm-ddT hh:mm:ss.sss+ hhmm

timestamp on which the device has been detected for the first time

lastSeen
(optional)

string

yyyy-mm-ddT hh:mm:ss.sss+ hhmm

timestamp on which the device has been detected for the last time

Basic structure of gateway response:

http://hostname:api_port/devices/multiFuncAlphaEos

{
  "header" : {
    "httpStatus" : 200,
    "content" : "device",
    "gateway" : "DC-GW/EO-IP v0.99.0",
    "timestamp" : "2016-05-04T13:53:28.066+0200"
  },
  "device" : {
    "deviceId" : "0190A078",
    "friendlyId" : "multiFuncAlphaEos",
    "physicalDevice" : "Sense-tf-h",
    "eeps" : [ {
      "eep" : "A5-04-01",
      "variation" : "alphaEOS_SENSETF-H",
      "version" : "1.0",
      "direction" : "from"
    } ],
    "manufacturer" : "alphaEOS",
    "firstSeen" : "2016-03-16T14:38:11.422+0100",
    "lastSeen" : "2016-05-04T13:51:15.810+0200"
  }
}