GET /devices/{deviceId}/profile

<< Click to Display Table of Contents >>

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

GET /devices/{deviceId}/profile

Overview

Get detailed informations of a device that uses one or more EEPs including vendor specific EEP variations.

 

Client to Gateway:

Resource Path

HTTP method

/devices/{deviceId}/profile

GET

necessary additional call parameters:

parameter

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.

 

response Gateway to Client:

parameter

datatype

value / formatting

description

header

object

{}

 

profile

object

{}

 

 

eep

string

xx-xx-xx

EnOcean Equipment Profiles, definition of Enocean radio telegram structure

 

title

string

 

description of eep profile

 

functionGroups

array of objects

[{}]

 

 

direction

string

from | to

direction of transport (from or to device)

 

functions

array of objects

[{}]

 

 

key

string

 

Technical key of function.

 

description
(optional)

string

 

description of function

 

defaultValue
(optional)

string | integer

 

Default value will be taken if no value has been set. Not present on any key.

 

values

array of objects

[{}]

 

 Case: value ranges

 

meaning

(optional)

string

 

meaning of range

 

range

object

{}

 

 

min

float

 

Logical minimal value.

 

 

max

float

 

Logical maximal value.

 

step

float

 

Value stepping.

 

unit
(optional)

string

[unit]

Value unit in English.

 Case: value enumerations

 

value

float

 

Value Constant

 

meaning
(optional)

string

 

meaning of value

 

Example:

The example shows device functionality of a device named Radiator. The result equals to one profile A5-20-01 in this case. If a device uses more than one EEP the functionGroups array would get longer.

 

Basic structure of gateway response:

 

http://hostname:api_port/devices/Radiator/profile

 

{
  "header" : {
    "httpStatus" : 200,
    "content" : "profile",
    "gateway" : "DC-GW/EO-IP v0.99.0",
    "timestamp" : "2016-05-04T14:27:16.280+0200"
  },
  "profile" : {
    "functionGroups" : [ {
      "direction" : "from",
      "functions" : [ {
        "key" : "actuatorObstructed",
        "description" : "Actuator obstructed",
        "values" : [ {
          "value" : "false",
          "meaning" : "Actuator is free"
        }, {
          "value" : "true",
          "meaning" : "Actuator is obstructed"
        } ]
      }, {
        "key" : "batteryLow",
        "description" : "Change battery next days",
        "values" : [ {
          "value" : "false",
          "meaning" : "Battery does not need to be changed"
        }, {
          "value" : "true",
          "meaning" : "Change battery in the next days"
        } ]
      }, {
        "key" : "contact",
        "description" : "Contact or cover",
        "values" : [ {
          "value" : "closed",
          "meaning" : "Contact or cover is closed"
        }, {
          "value" : "open",
          "meaning" : "Contact or cover is open"
        } ]
      }, {
        "key" : "energyInput",
        "description" : "Energy input enabled",
        "values" : [ {
          "value" : "false",
          "meaning" : "Energy input is disabled"
        }, {
          "value" : "true",
          "meaning" : "Energy input is enabled"
        } ]
      }, {
        "key" : "energyStorageCharged",
        "description" : "Energy storage sufficiently charged",
        "values" : [ {
          "value" : "false",
          "meaning" : "Energy storage needs to be charged"
        }, {
          "value" : "true",
          "meaning" : "Energy storage is sufficiently charged"
        } ]
      }, {
        "key" : "serviceMode",
        "description" : "Service On",
        "values" : [ {
          "value" : "off",
          "meaning" : "Service is off"
        }, {
          "value" : "on",
          "meaning" : "Service is on"
        } ]
      }, {
        "key" : "temperature",
        "description" : "Temperature (linear)",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 40,
            "step" : 0.157,
            "unit" : "°C"
          }
        }, {
          "value" : "overRange",
          "meaning" : "Temperature sensor failure or out of range"
        } ]
      }, {
        "key" : "valve",
        "description" : "Current valve position",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 100,
            "step" : 1,
            "unit" : "%"
          }
        } ]
      }, {
        "key" : "window",
        "description" : "Detection, window open",
        "values" : [ {
          "value" : "closed",
          "meaning" : "Normal operation"
        }, {
          "value" : "open",
          "meaning" : "Open window detected"
        } ]
      } ]
    }, {
      "title" : "Control actuator via valve position",
      "direction" : "to",
      "functions" : [ {
        "key" : "setPointInverse",
        "description" : "Valve set point can be sent to the actuator normal or inverted. This function is used in dependence on the type of valve.",
        "values" : [ {
          "value" : "false",
          "meaning" : "Set point is normal"
        }, {
          "value" : "true",
          "meaning" : "Set point is inversed"
        } ],
        "defaultValue" : "false"
      }, {
        "key" : "summerMode",
        "description" : "The radio communication between the actuator and the controller is restricted, sleep mode is extended. This functionality can be used for battery powered actuators.",
        "values" : [ {
          "value" : "false",
          "meaning" : "Summer mode is deactivated"
        }, {
          "value" : "true",
          "meaning" : "Summer mode is activated"
        } ],
        "defaultValue" : "false"
      }, {
        "key" : "valve",
        "description" : "Valve position",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 100,
            "step" : 1,
            "unit" : "%"
          }
        } ]
      } ]
    }, {
      "title" : "Control actuator via temperature",
      "direction" : "to",
      "functions" : [ {
        "key" : "summerMode",
        "description" : "The radio communication between the actuator and the controller is restricted, sleep mode is extended. This functionality can be used for battery powered actuators.",
        "values" : [ {
          "value" : "false",
          "meaning" : "Summer mode is deactivated"
        }, {
          "value" : "true",
          "meaning" : "Summer mode is activated"
        } ],
        "defaultValue" : "false"
      }, {
        "key" : "temperature",
        "description" : "Temperature from room control unit (RCU)",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 40,
            "step" : 0.157,
            "unit" : "°C"
          }
        } ]
      }, {
        "key" : "temperatureSetPoint",
        "description" : "Temperature set point",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 40,
            "step" : 0.157,
            "unit" : "°C"
          }
        } ]
      } ]
    }, {
      "title" : "Service mode",
      "direction" : "to",
      "functions" : [ {
        "key" : "runInitSequence",
        "description" : "The limit switching measures the travel and signals when an end position has been reached. This end position (valve zero point) in the actuator is stored.",
        "values" : [ {
          "value" : "false",
          "meaning" : "Do not run init sequence"
        }, {
          "value" : "true",
          "meaning" : "Run init sequence"
        } ],
        "defaultValue" : "false"
      }, {
        "key" : "runLiftSet",
        "description" : "Initialization, adjustment to the valve stroke. The Initialization is switched after receiving the command. The valve is completely opened and closed during initialization.",
        "values" : [ {
          "value" : "false",
          "meaning" : "Done with initialization"
        }, {
          "value" : "true",
          "meaning" : "Initialization is running"
        } ],
        "defaultValue" : "false"
      }, {
        "key" : "valveMaintenance",
        "description" : "Operate valve in maintenance mode",
        "values" : [ {
          "value" : "close",
          "meaning" : "Close valve"
        }, {
          "value" : "noChange",
          "meaning" : "Do not move valve after init sequence or lift set"
        }, {
          "value" : "open",
          "meaning" : "Open valve"
        } ],
        "defaultValue" : "noChange"
      } ]
    } ]
  }
}