GET /devices/{deviceId}

<< Click to Display Table of Contents >>

Navigation:  The API > JSON Adminstrator API > REST Resources > Devices > GET >

GET /devices/{deviceId}

Overview

Get detailed information of a single device.

 

Client to Gateway:

Resource Path

HTTP method

/devices/{deviceId}

GET

 

Response Gateway to Client:

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

 

physicalDevice
(optional)

string

 

User-assigned name to group actuators and sensors.

 

learnInProcedure

string

manuallyConfigured | UTE | SmartAck | UserInteractionRequired | receivedRps | received1Bs | received4Bs | incompleteEep | internetOfThings

Type of Learn-In Procedure

 

eeps

array of objects

[{}]

 

 

 

eep

string

xx-xx-xx

EnOcean Equipment Profiles, definition of Enocean radio telegram structure

 

 

version

float

 

Version of the API Commands

 

 

direction

string

from | to | both

"from", "to" or "both"

 

 

variation
(optional)

string

manufacturer _ productname

Manufacturer specific variation

 

manufacturer
(optional)

string

 

Manufacturer of the device

 

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

 

secured

boolean

false

Device using Security over air (Not supported at the moment)

 

version

float

 

Version of the API Commands

 

softSmartAck

boolean

 

Device using Soft Smart-Ack

 

transmitModes

array of objects

[{}]

 

 

 

key

string

 

Key of the profile

 

 

transmitOnConnect

boolean

true | false

 

 

 

transmitOnEvent

boolean

true | false

 

 

 

transmitOnDuplicate

boolean

true | false

 

 

states
(optional)

array of objects

[{}]

 

 

 

key

string

 

Technical key of function.

 

 

channel

(optional)

integer

 

Channel if supported by this device.

 

 

value

float 

 

Value of the function.

 

 

unit

(optional)

string

[unit]

Unit ISO.

 

 

meaning

(optional)

string

 

Description of value in English.

 

 

timestamp

string

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

Timestamp function value was received in case of last state functions.

 

 

age

integer

 

Age of function value in case of last state functions in milli seconds.

 

operable

boolean

 

Shows if the device is operable respectively the learn in procedure has been completed.

 

supported

boolean

 

Shows if the device is supported or not.

example:

Basic structure of gateway response:

 

http://hostname:api_port/devices/FFF26803

 

{
  "header" : {
    "httpStatus" : 200,
    "content" : "device",
    "gateway" : "DC-GW/EO-IP v0.99.0b",
    "timestamp" : "2016-05-12T09:50:26.000+0200"
  },
  "device" : {
    "deviceId" : "FFF26803",
    "friendlyId" : "Peha_Ch2",
    "learnInProcedure" : "UTE",
    "eeps" : [ {
      "eep" : "D2-01-08",
      "version" : 1.0,
      "direction" : "both"
    }, {
      "eep" : "A5-04-01",
      "variation" : "alphaEOS_SENSETF-H",
      "version" : 1.0,
      "direction" : "both"
    } ],
    "manufacturer" : "Peha",
    "firstSeen" : "2016-05-09T09:27:05.260+0200",
    "lastSeen" : "2016-05-09T16:46:30.822+0200",
    "secured" : false,
    "softSmartAck" : false,
    "transmitModes" : [ {
      "key" : "overcurrentSwitchOff",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    }, {
      "key" : "power",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    }, {
      "key" : "localControl",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    }, {
      "key" : "energy",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    }, {
      "key" : "errorLevel",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    }, {
      "key" : "switch",
      "transmitOnConnect" : true,
      "transmitOnEvent" : true,
      "transmitOnDuplicate" : true
    } ],
    "operable" : true,
    "supported" : true
  }
}