GET /devices/telegrams

<< Click to Display Table of Contents >>

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

GET /devices/telegrams

Overview

Show the last 1000 available / historic telegrams of all devices in receiving order depending on the direction of transport (from device sent / to device sent / both directions ).

 

Last transmitted telegrams of all known devices

Client to Gateway:

Resource Path

HTTP method

/devices/telegrams?direction={direction}

GET

optional additional call parameters:

parameter

valid values

call option

functionality

direction
(optional)

from | to | both

default: both

direction of transport (from device sent / to device sent / both directions )

 

response Gateway to Client:

parameter

datatype

value / formatting

description

header

object

{}

 

telegrams

array of object

[{}]

 

Case 1/2:   telegram of known device

 

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

(optional)

string

 

User-assigned name to group actuators and sensors.

 

timestamp

string

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

telegram transmission time in UTC format

 

direction

string

from | to

direction of transport (from device sent / to device sent)

 

functions

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.

 

telegramInfo

object

{}

 

 

data

string

x byte hex value

Payload of ERP telegrams or ESP packets

 

status

integer

 

identifies if the subtelegram is transmitted from a repeater and the type of integrity control mechanism used (note: not present in a RPS telegram)

 

dbm

integer

 

signal strength of received / transmitted telegram

 

rorg

string

1 byte hex value

identifier for subtelegram type

Case 2/2:   telegram of unknown device (only if Filtermode is Off)

 

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.

 

timestamp

string

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

telegram transmission time in UTC format

 

direction

string

from

direction of transport (from device sent / to device sent)

 

telegramInfo

object

{}

 

 

data

string

x byte hex value

Payload of ERP telegrams or ESP packets

 

status

integer

 

identifies if the subtelegram is transmitted from a repeater and the type of integrity control mechanism used (note: not present in a RPS telegram)

 

dbm

integer

 

signal strength of received / transmitted telegram

 

rorg

string

1 byte hex value

identifier for subtelegram type

 

 

Example:

Three different telegrams of two devices has been received in history. One of them is not learned-in yet (deviceId = 0187D64B).

Please note that (depending on the settings in the web interface) you will see only functions, where the value has been changed.

Basic structure of gateway response:

 

http://hostname:api_port/devices/telegrams

 
{
  "header" : {
    "httpStatus" : 200,
    "content" : "telegrams",
    "gateway" : "DC-GW/EO-IP v0.99.0",
    "timestamp" : "2016-05-04T10:22:05.162+0200"
  },
  "telegrams" : [ {
    "deviceId" : "0187D64B",
    "timestamp" : "2016-05-04T09:59:28.668+0200",
    "direction" : "from",
    "telegramInfo" : {
      "data" : "00000F5D",
      "status" : "0",
      "dbm" : -77,
      "rorg" : "A5"
    }
  }, {
    "deviceId" : "0187D64B",
    "timestamp" : "2016-05-04T09:59:33.819+0200",
    "direction" : "from",
    "telegramInfo" : {
      "data" : "0000105D",
      "status" : "0",
      "dbm" : -77,
      "rorg" : "A5"
    }
  }, {
    "deviceId" : "0190A078",
    "friendlyId" : "multiFuncAlphaEos",
    "physicalDevice" : "Sense-tf-h",
    "timestamp" : "2016-05-04T09:59:35.758+0200",
    "direction" : "from",
    "functions" : [ {
      "key" : "illumination",
      "value" : 1411.76,
      "unit" : "lx"
    }, {
      "key" : "humidity",
      "value" : 28.80,
      "unit" : "%"
    }, {
      "key" : "temperature",
      "value" : 25.12,
      "unit" : "°C"
    } ],
    "telegramInfo" : {
      "data" : "0C489D0A",
      "status" : "0",
      "dbm" : -76,
      "rorg" : "A5"
    }
  }]

}