GET /devices/{deviceId}/telegrams

<< Click to Display Table of Contents >>

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

GET /devices/{deviceId}/telegrams

Overview

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

 

Last transmitted telegrams of a single device

Client to Gateway:

Resource Path

HTTP method

/devices/{deviceId}/telegrams?direction={direction}

GET

necessary additional call parameters:

parameter

valid values

call option

functionality

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.

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:

As a example historic telegrams of the weatherstation are shown.

Basic structure of gateway response:

 

http://hostname:api_port/devices/weatherstation/telegrams

 

{
  "header" : {
    "httpStatus" : 200,
    "content" : "telegrams",
    "gateway" : "DC-GW/EO-IP v0.99.0",
    "timestamp" : "2016-05-04T16:01:12.790+0200"
  },
  "telegrams" : [ {
    "deviceId" : "01842329",
    "friendlyId" : "WeatherStation",
    "timestamp" : "2016-05-04T12:17:32.299+0200",
    "direction" : "from",
    "functions" : [ {
      "key" : "sunWest",
      "value" : 588.24,
      "unit" : "lx"
    }, {
      "key" : "sunSouth",
      "value" : 2941.18,
      "unit" : "lx"
    }, {
      "key" : "sunEast",
      "value" : 2941.18,
      "unit" : "lx"
    }, {
      "key" : "hemisphere",
      "value" : "north",
      "meaning" : "North"
    } ],
    "telegramInfo" : {
      "data" : "01050528",
      "status" : "0",
      "dbm" : -83,
      "rorg" : "A5"
    }
  }, {
    "deviceId" : "01842329",
    "friendlyId" : "WeatherStation",
    "timestamp" : "2016-05-04T12:17:32.505+0200",
    "direction" : "from",
    "functions" : [ {
      "key" : "dawnSensor",
      "value" : 999.00,
      "unit" : "lx"
    }, {
      "key" : "temperature",
      "value" : 24.94,
      "unit" : "°C"
    }, {
      "key" : "windSpeed",
      "value" : 0.00,
      "unit" : "m/s"
    }, {
      "key" : "dayNight",
      "value" : "day",
      "meaning" : "Day"
    }, {
      "key" : "rainIndication",
      "value" : "noRain",
      "meaning" : "No rain"
    } ],
    "telegramInfo" : {
      "data" : "FF8A0018",
      "status" : "0",
      "dbm" : -83,
      "rorg" : "A5"
    }
  }, {
    "deviceId" : "01842329",
    "friendlyId" : "WeatherStation",
    "timestamp" : "2016-05-04T12:18:52.629+0200",
    "direction" : "from",
    "functions" : [ {
      "key" : "sunWest",
      "value" : 0.00,
      "unit" : "lx"
    }, {
      "key" : "sunSouth",
      "value" : 1764.71,
      "unit" : "lx"
    }, {
      "key" : "sunEast",
      "value" : 588.24,
      "unit" : "lx"
    }, {
      "key" : "hemisphere",
      "value" : "north",
      "meaning" : "North"
    } ],
    "telegramInfo" : {
      "data" : "00030128",
      "status" : "0",
      "dbm" : -82,
      "rorg" : "A5"
    }
  }]

}