GET /profiles/{eepId}

<< Click to Display Table of Contents >>

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

GET /profiles/{eepId}

Profile detail

Get detailed informations of a standard or a vendor specific EEP variation functionality / functions

In the Admin API, the call "GET /profiles/{eepID}" delivers basically the same content as "GET /profiles{eepID}" from the User API but with the following additional information:

Array of TransmitModes

testExists

 

Client to Gateway:

Resource Path

HTTP method

/profiles/{eepId}

GET

Necessary and optional additional call parameters:

parameter

datatype

valid values

call option

description

eep

string

valid EEP

required

EnOcean Equipment Profile, definition of Enocean radio telegram structure

manufacturer

string

valid manufacturer

optional

eepVariation and manufacturer, by wich the eep profile variation is supported

eepVariation

string

valid device

optional

 

 

response Gateway to Client:

parameter

datatype

value / formatting

description

header

object

{}

standard header object with content = profile

profile

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

[{}]

array of functionGroup objects

 

direction

string

from | to

direction of transport (from or to device)

 

functions

array of objects

[{}]

array of function objects

followed by:

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

 

key

string

 

key value, as a function identifier

optional

description

string

 

description of function

 

values

array of objects

[{}]

array of value objects

 value ranges

optional

valueKey

string

 

corresponding constant of this value

optional

meaning

string

 

meaning of value

 

range

object

{}

range object

 

min

float

 

Representation of the valid range of values with increment and, where appropriate, the corresponding unit

 

 

max

float

 

 

step

float

 

optional

unit

string

[unit]

 value enumerations

 

value

float

 

valid value and additional optional parameters are represented by: valuekey (instead of a number a corresponding constant of this function), meaning (Impact of the value)

optional

valueKey

string

 

optional

meaning

string

 

 

transmitOnConnect

string


True/False

 

transmitOnEvent

string


True/False

 

transmitOnDuplicate

string


True/False

 

testExists

string


Specifies whether a test for the device exists in the database or not. The test can be used to identify a device.

optional

defaultValue

float


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

 

example:

The example shows the profile D2-01-09 “Electronic switches and dimmers with Energy Measurement and Local Control”.

 

Basic structure of gateway response:

 

http://hostname:api_port/profiles/D2-01-09
 
 

{
  "header" : {
    "httpStatus" : 200,
    "content" : "profile",
    "gateway" : "DC-GW/EO-IP v0.98.22",
    "timestamp" : "2015-12-11T17:08:04.939+0100"
  },
  "profile" : {
    "eep" : "D2-01-09",
    "title" : "Electronic switches and dimmers with Energy Measurement and Local Control",
    "functionGroups" : [ {
      "title" : "Actuator Set Output",
      "direction" : "to",
      "functions" : [ {
        "key" : "dimValue",
        "values" : [ {
          "value" : 0,
          "valueKey" : "off",
          "meaning" : "Output value 0% or OFF"
        }, {
          "valueKey" : "on",
          "meaning" : "Output value 1% to 100% or ON",
          "range" : {
            "min" : 1,
            "max" : 100,
            "step" : 1,
            "unit" : "%"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "testExists" : true
      }, {
        "key" : "rampingMode",
        "values" : [ {
          "value" : 0,
          "valueKey" : "switch",
          "meaning" : "Switch to new output value"
        }, {
          "value" : 1,
          "valueKey" : "rampingTime1",
          "meaning" : "Dim to new output value using rampingTime1"
        }, {
          "value" : 2,
          "valueKey" : "rampingTime2",
          "meaning" : "Dim to new output value using rampingTime2"
        }, {
          "value" : 3,
          "valueKey" : "rampingTime3",
          "meaning" : "Dim to new output value using rampingTime3"
        }, {
          "value" : 4,
          "valueKey" : "stop",
          "meaning" : "Stop dimming"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "testExists" : true,
        "defaultValue" : 0
      } ]
    }, {
      "title" : "Configure Actuator",
      "direction" : "to",
      "functions" : [ {
        "key" : "defaultState",
        "values" : [ {
          "value" : 0,
          "valueKey" : "off",
          "meaning" : "Default state: 0% or OFF"
        }, {
          "value" : 1,
          "valueKey" : "on",
          "meaning" : "Default state: 100% or ON"
        }, {
          "value" : 2,
          "valueKey" : "previousState",
          "meaning" : "Default state: remember previous state"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 2
      }, {
        "key" : "overcurrentSwitchOffReset",
        "values" : [ {
          "value" : 0,
          "valueKey" : "false",
          "meaning" : "Reset over current shut down: not active"
        }, {
          "value" : 1,
          "valueKey" : "true",
          "meaning" : "Reset over current shut down: trigger signal"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 0
      }, {
        "key" : "rampingTime1",
        "values" : [ {
          "meaning" : "Dim timer 1",
          "range" : {
            "min" : 0.5,
            "max" : 7.5,
            "step" : 0.5,
            "unit" : "s"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 1
      }, {
        "key" : "rampingTime2",
        "values" : [ {
          "meaning" : "Dim timer 2",
          "range" : {
            "min" : 0.5,
            "max" : 7.5,
            "step" : 0.5,
            "unit" : "s"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 4
      }, {
        "key" : "rampingTime3",
        "values" : [ {
          "meaning" : "Dim timer 3",
          "range" : {
            "min" : 0.5,
            "max" : 7.5,
            "step" : 0.5,
            "unit" : "s"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 7.5
      }, {
        "key" : "taughtInDevices",
        "values" : [ {
          "value" : 0,
          "valueKey" : "off",
          "meaning" : "Disable taught-in devices (with different EEP)"
        }, {
          "value" : 1,
          "valueKey" : "on",
          "meaning" : "Enable taught-in devices (with different EEP)"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 1
      } ]
    }, {
      "title" : "Actuator Status Response",
      "direction" : "from",
      "functions" : [ {
        "key" : "dimValue",
        "values" : [ {
          "value" : 0,
          "valueKey" : "off",
          "meaning" : "Output value 0% or OFF"
        }, {
          "valueKey" : "on",
          "meaning" : "Output value 1% to 100% or ON",
          "range" : {
            "min" : 1,
            "max" : 100,
            "step" : 1,
            "unit" : "%"
          }
        }, {
          "value" : 127,
          "valueKey" : "invalid",
          "meaning" : "output value not valid / not set"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "errorLevel",
        "values" : [ {
          "value" : 0,
          "valueKey" : "noError",
          "meaning" : "Error level 0: hardware OK"
        }, {
          "value" : 1,
          "valueKey" : "warning",
          "meaning" : "Error level 1: hardware warning"
        }, {
          "value" : 2,
          "valueKey" : "failure",
          "meaning" : "Error level 2: hardware failure"
        }, {
          "value" : 3,
          "valueKey" : "notSupported",
          "meaning" : "Error level not supported"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "localControl",
        "values" : [ {
          "value" : 0,
          "valueKey" : "off",
          "meaning" : "Local control disabled / not supported"
        }, {
          "value" : 1,
          "valueKey" : "on",
          "meaning" : "Local control enabled"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "overcurrentSwitchOff",
        "values" : [ {
          "value" : 0,
          "valueKey" : "false",
          "meaning" : "Over current switch off: ready / not supported"
        }, {
          "value" : 1,
          "valueKey" : "true",
          "meaning" : "Over current switch off: executed"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      } ]
    }, {
      "title" : "Actuator Set Measurement",
      "direction" : "to",
      "functions" : [ {
        "key" : "energyDelta",
        "description" : "Delta of energy to be reported",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 4095000,
            "step" : 0.000278,
            "unit" : "Wh"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "maxTimeBetweenReports",
        "description" : "Measurement Response messages",
        "values" : [ {
          "range" : {
            "min" : 10,
            "max" : 2550,
            "step" : 10,
            "unit" : "s"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 60
      }, {
        "key" : "minTimeBetweenReports",
        "description" : "Measurement Response messages",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 255,
            "step" : 1,
            "unit" : "s"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 10
      }, {
        "key" : "reportMeasurement",
        "values" : [ {
          "value" : 0,
          "valueKey" : "queryOnly",
          "meaning" : "Report measurement: query only"
        }, {
          "value" : 1,
          "valueKey" : "queryAndAuto",
          "meaning" : "Report measurement: query / auto reporting"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 1
      }, {
        "key" : "resetMeasurement",
        "values" : [ {
          "value" : 0,
          "valueKey" : "false",
          "meaning" : "Reset measurement: not active"
        }, {
          "value" : 1,
          "valueKey" : "true",
          "meaning" : "Reset measurement: trigger signal"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 0
      } ]
    }, {
      "title" : "Actuator Set Measurement",
      "direction" : "to",
      "functions" : [ {
        "key" : "maxTimeBetweenReports",
        "description" : "Measurement Response messages",
        "values" : [ {
          "range" : {
            "min" : 10,
            "max" : 2550,
            "step" : 10,
            "unit" : "s"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 60
      }, {
        "key" : "minTimeBetweenReports",
        "description" : "Measurement Response messages",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 255,
            "step" : 1,
            "unit" : "s"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 10
      }, {
        "key" : "powerDelta",
        "description" : "Delta of power to be reported",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 4095000,
            "step" : 1,
            "unit" : "W"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "reportMeasurement",
        "values" : [ {
          "value" : 0,
          "valueKey" : "queryOnly",
          "meaning" : "Report measurement: query only"
        }, {
          "value" : 1,
          "valueKey" : "queryAndAuto",
          "meaning" : "Report measurement: query / auto reporting"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 1
      }, {
        "key" : "resetMeasurement",
        "values" : [ {
          "value" : 0,
          "valueKey" : "false",
          "meaning" : "Reset measurement: not active"
        }, {
          "value" : 1,
          "valueKey" : "true",
          "meaning" : "Reset measurement: trigger signal"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : 0
      } ]
    }, {
      "title" : "Actuator Query",
      "direction" : "to",
      "functions" : [ {
        "key" : "query",
        "values" : [ {
          "value" : 0,
          "valueKey" : "energy",
          "meaning" : "Query energy"
        }, {
          "value" : 1,
          "valueKey" : "power",
          "meaning" : "Query power"
        }, {
          "value" : 2,
          "valueKey" : "status",
          "meaning" : "Query status"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      } ]
    }, {
      "title" : "Actuator Measurement Response",
      "direction" : "from",
      "functions" : [ {
        "key" : "energy",
        "description" : "Cumulative electricity value from meter",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 4294967295000,
            "step" : 0.000278,
            "unit" : "Wh"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "power",
        "description" : "Current power value from meter",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 4294967295000,
            "step" : 1,
            "unit" : "W"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      } ]
    } ]
  }
}