Resource Path

HTTP method

/profiles/{eepId}&variation ={variationId}

GET

parameter

valid values

description

eepId

valid EEP

EnOcean Equipment Profile, definition of EnOcean radio telegram structure

variation
(optional)

valid indentifier

Variation identifier. Mainly composed of ManufacturerId and ProductId that uses it.

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

[{}]

followed by:

Per key multiple values including value ranges and/or value enumerations

key

string

key value, as a function identifier

description
(optional)

string

description of function

values

array of objects

[{}]

 value ranges

meaning
(optional)

string

meaning of value

range

object

{}

min

float

Logical minimal value.

max

float

Logical maximal value.

step

float

Value stepping.

unit
(optional)

string

[unit]

Value unit in English.

 value enumerations

value

float

meaning
(optional)

string

defaultValue
(optional)

float | string | integer

for direction to, if defaultValue is specified, the parameter can be omitted when creating a telegram

Basic structure of gateway request & response:

GET http://hostname:api_port/profiles/A5-20-04
 
{
  "header" : {
    "httpStatus" : 200,
    "content" : "profile",
    "gateway" : "DC-GW/EO-IP v0.99.1",
    "timestamp" : "2016-05-09T16:32:04.206+0200"
  },
  "profile" : {
    "eep" : "A5-20-04",
    "title" : "HVAC Components, Heating Radiator Valve Actuating Drive with Feed and Room Temperature Measurement, Local Set Point Control and Display",
    "functionGroups" : [ {
      "direction" : "from",
      "functions" : [ {
        "key" : "errorCode",
        "values" : [ {
          "value" : "batteryEmpty",
          "meaning" : "Battery is empty"
        }, {
          "value" : "blockedValve",
          "meaning" : "Blocked valve"
        }, {
          "value" : "endpointDetectionError",
          "meaning" : "End point detection error"
        }, {
          "value" : "frostProtection",
          "meaning" : "Frost protection"
        }, {
          "value" : "measurementError",
          "meaning" : "Measurement error"
        }, {
          "value" : "noError",
          "meaning" : "No error reported"
        }, {
          "value" : "noReponseFromController",
          "meaning" : "No response from controller"
        }, {
          "value" : "noValve",
          "meaning" : "No valve"
        }, {
          "value" : "notTaughtIn",
          "meaning" : "Not taught in"
        }, {
          "value" : "teachInError",
          "meaning" : "Teach-in error"
        } ]
      }, {
        "key" : "feedTemperature",
        "description" : "Current feed temperature value",
        "values" : [ {
          "range" : {
            "min" : 20,
            "max" : 80,
            "step" : 0.235,
            "unit" : "°C"
          }
        } ]
      }, {
        "key" : "locked",
        "description" : "Shows if all buttons on the actuator are locked",
        "values" : [ {
          "value" : "false",
          "meaning" : "Manual room temperature selection enabled"
        }, {
          "value" : "true",
          "meaning" : "Manual room temperature selection disabled"
        } ]
      }, {
        "key" : "measurement",
        "description" : "Measure feed + room temperature",
        "values" : [ {
          "value" : "off",
          "meaning" : "Measure feed + room temperature is inactive"
        }, {
          "value" : "on",
          "meaning" : "Measure feed + room temperature is active"
        } ]
      }, {
        "key" : "query",
        "description" : "Request for status from the controller",
        "values" : [ {
          "value" : "noChange",
          "meaning" : "No change"
        }, {
          "value" : "status",
          "meaning" : "Status requested"
        } ]
      }, {
        "key" : "roomTemperature",
        "description" : "Current room temperature",
        "values" : [ {
          "range" : {
            "min" : 10,
            "max" : 30,
            "step" : 0.078,
            "unit" : "°C"
          }
        } ]
      }, {
        "key" : "temperatureSetPoint",
        "description" : "Current temperature set point",
        "values" : [ {
          "range" : {
            "min" : 10,
            "max" : 30,
            "step" : 0.078,
            "unit" : "°C"
          }
        } ]
      }, {
        "key" : "valve",
        "description" : "Current valve position",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 100,
            "step" : 1,
            "unit" : "%"
          }
        } ]
      } ]
    }, {
      "direction" : "to",
      "functions" : [ {
        "key" : "command",
        "description" : "Initiates certain temporary service operations",
        "values" : [ {
          "value" : "closeValve",
          "meaning" : "Close valve"
        }, {
          "value" : "noChange",
          "meaning" : "No change"
        }, {
          "value" : "openValve",
          "meaning" : "Open valve"
        }, {
          "value" : "runInit",
          "meaning" : "Run initialisation"
        } ],
        "defaultValue" : "noChange"
      }, {
        "key" : "displayOrientation",
        "description" : "Adjusts the display orientation",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 270,
            "step" : 90,
            "unit" : "°"
          }
        } ],
        "defaultValue" : 0
      }, {
        "key" : "locked",
        "description" : "Set the button lock status",
        "values" : [ {
          "value" : "false",
          "meaning" : "Manual room temperature selection enabled"
        }, {
          "value" : "true",
          "meaning" : "Manual room temperature selection disabled"
        } ],
        "defaultValue" : "false"
      }, {
        "key" : "measurement",
        "description" : "Measure feed + room temperature",
        "values" : [ {
          "value" : "off",
          "meaning" : "Disable measurement for energy saving"
        }, {
          "value" : "on",
          "meaning" : "Enable feed + room temperature measurement"
        } ],
        "defaultValue" : "on"
      }, {
        "key" : "temperatureSetPoint",
        "description" : "Temperature set point",
        "values" : [ {
          "range" : {
            "min" : 10,
            "max" : 30,
            "step" : 0.078,
            "unit" : "°C"
          }
        } ]
      }, {
        "key" : "valve",
        "description" : "Valve position",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 100,
            "step" : 1,
            "unit" : "%"
          }
        } ]
      }, {
        "key" : "wakeUpCycle",
        "description" : "Defines the cyclic wake-up time",
        "values" : [ {
          "meaning" : "Cyclic wake-up time, 30 secs - 25 min in 30 seconds steps",
          "range" : {
            "min" : 30,
            "max" : 1500,
            "step" : 30,
            "unit" : "s"
          }
        }, {
          "meaning" : "Cyclic wake-up time, 3-42 hours in 3 hours steps",
          "range" : {
            "min" : 10800,
            "max" : 151200,
            "step" : 10800,
            "unit" : "s"
          }
        }, {
          "value" : "10",
          "meaning" : "Minimal cyclic wake-up time = 10 seconds"
        } ],
        "defaultValue" : 600
      } ]
    } ]
  }
}