GET /device/{deviceId}/profile

<< Click to Display Table of Contents >>

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

GET /device/{deviceId}/profile

Profile detail

Get detailed profile informations of a device

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

functions

otransmitOnConnect

otransmitOnEvent

otransmitOnDuplicate

otestExists

 

Client to Gateway:

Resource Path

HTTP method

/devices/{deviceID}/profile

GET

 

response Gateway to Client:

parameter

datatype

value / formatting

description

header

object

{}

 

profile

object

{}

 

 

functionGroups

array of objects

[{}]

 

 

 

title
(optional)

string

 

description of function group

 

 

direction

string

from | to | both

 

 

 

functions

array of objects

[{}]

 

 

 

 

key

string

 

 

 

 

 

transmitOnConnect

boolean

 

 

 

 

 

transmitOnEvent

boolean

 

 

 

 

 

transmitOnDuplicate

boolean

 

 

 

 

 

testExists

boolean

 

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

 

 

 

defaultValue

string | float

 

 

 

 

 

values

array of objects

 

 

 

 

 


range
(optional)

object

 

{}

 

 

 



min

float

 

Logical minimal value.

 

 

 

 



max

float

 

Logical maximal value.

 

 

 



step

float

 

Value stepping.

 

 

 



unit
(optional)

string

[unit]

Value unit in English.

 

 

 


value
(optional)

float | string

 

 

 

 

 


meaning
(optional)

string

 

 

 

example:

Basic structure of gateway response:

 

http://hostname:api_port/devices/FFF26803/profile
 
 

{
  "header" : {
    "httpStatus" : 200,
    "content" : "profile",
    "gateway" : "DC-GW/EO-IP v0.99.0b",
    "timestamp" : "2016-05-12T10:42:36.937+0200"
  },
  "profile" : {
    "functionGroups" : [ {
      "title" : "Actuator Set Output",
      "direction" : "to",
      "functions" : [ {
        "key" : "switch",
        "values" : [ {
          "value" : "off",
          "meaning" : "Output value OFF"
        }, {
          "value" : "on",
          "meaning" : "Output value ON"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "testExists" : true
      } ]
    }, {
      "title" : "Configure Actuator",
      "direction" : "to",
      "functions" : [ {
        "key" : "defaultState",
        "values" : [ {
          "value" : "off",
          "meaning" : "Default state: OFF"
        }, {
          "value" : "on",
          "meaning" : "Default state: ON"
        }, {
          "value" : "previousState",
          "meaning" : "Default state: remember previous state"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : "previousState"
      }, {
        "key" : "localControl",
        "values" : [ {
          "value" : "off",
          "meaning" : "Disable local control"
        }, {
          "value" : "on",
          "meaning" : "Enable local control"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : "on"
      }, {
        "key" : "overcurrentSwitchOffMode",
        "values" : [ {
          "value" : "restart",
          "meaning" : "automatic restart"
        }, {
          "value" : "staticOff",
          "meaning" : "static off"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : "staticOff"
      }, {
        "key" : "overcurrentSwitchOffReset",
        "values" : [ {
          "value" : "false",
          "meaning" : "Reset over current shut down: not active"
        }, {
          "value" : "true",
          "meaning" : "Reset over current shut down: trigger signal"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : "false"
      }, {
        "key" : "taughtInDevices",
        "values" : [ {
          "value" : "off",
          "meaning" : "Disable taught-in devices (with different EEP)"
        }, {
          "value" : "on",
          "meaning" : "Enable taught-in devices (with different EEP)"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : "on"
      }, {
        "key" : "userInterfaceIndication",
        "values" : [ {
          "value" : "day",
          "meaning" : "User interface indication: day operation"
        }, {
          "value" : "night",
          "meaning" : "User interface indication: night operation"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : "day"
      } ]
    }, {
      "title" : "Actuator Status Response",
      "direction" : "from",
      "functions" : [ {
        "key" : "errorLevel",
        "values" : [ {
          "value" : "failure",
          "meaning" : "Error level 2: hardware failure"
        }, {
          "value" : "noError",
          "meaning" : "Error level 0: hardware OK"
        }, {
          "value" : "notSupported",
          "meaning" : "Error level not supported"
        }, {
          "value" : "warning",
          "meaning" : "Error level 1: hardware warning"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "localControl",
        "values" : [ {
          "value" : "off",
          "meaning" : "Local control disabled / not supported"
        }, {
          "value" : "on",
          "meaning" : "Local control enabled"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "overcurrentSwitchOff",
        "values" : [ {
          "value" : "false",
          "meaning" : "Over current switch off: ready / not supported"
        }, {
          "value" : "true",
          "meaning" : "Over current switch off: executed"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "switch",
        "values" : [ {
          "value" : "off",
          "meaning" : "Output value OFF"
        }, {
          "value" : "on",
          "meaning" : "Output value ON"
        } ],
        "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" : "queryAndAuto",
          "meaning" : "Report measurement: query / auto reporting"
        }, {
          "value" : "queryOnly",
          "meaning" : "Report measurement: query only"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : "queryAndAuto"
      }, {
        "key" : "resetMeasurement",
        "values" : [ {
          "value" : "false",
          "meaning" : "Reset measurement: not active"
        }, {
          "value" : "true",
          "meaning" : "Reset measurement: trigger signal"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : "false"
      } ]
    }, {
      "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" : "queryAndAuto",
          "meaning" : "Report measurement: query / auto reporting"
        }, {
          "value" : "queryOnly",
          "meaning" : "Report measurement: query only"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : "queryAndAuto"
      }, {
        "key" : "resetMeasurement",
        "values" : [ {
          "value" : "false",
          "meaning" : "Reset measurement: not active"
        }, {
          "value" : "true",
          "meaning" : "Reset measurement: trigger signal"
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false,
        "defaultValue" : "false"
      } ]
    }, {
      "title" : "Actuator Query",
      "direction" : "to",
      "functions" : [ {
        "key" : "query",
        "values" : [ {
          "value" : "energy",
          "meaning" : "Query energy"
        }, {
          "value" : "power",
          "meaning" : "Query power"
        }, {
          "value" : "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
      } ]
    }, {
      "direction" : "from",
      "functions" : [ {
        "key" : "humidity",
        "description" : "Rel. Humidity (linear)",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 100,
            "step" : 0.4,
            "unit" : "%"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "illumination",
        "description" : "Illumination (linear)",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 30000,
            "step" : 117.647,
            "unit" : "lx"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      }, {
        "key" : "temperature",
        "description" : "Temperature (linear)",
        "values" : [ {
          "range" : {
            "min" : 0,
            "max" : 40,
            "step" : 0.16,
            "unit" : "°C"
          }
        } ],
        "transmitOnConnect" : true,
        "transmitOnEvent" : true,
        "transmitOnDuplicate" : false
      } ]
    } ]
  }
}