Sensor telemetry

Each output JSON consist of these sections:

  • sensor - stored information about the sensor provided at onboarding via the API
  • telemetry - information interpreted by the engine
    • data - sensor data included in the message and encoded via the EEP
    • signal - meta information about the sensor and encoded as signal telegram
    • meta/stats - meta information about the message added by the engine
  • raw - raw message information
    • rssi - radio signal strength information. Important to track radio quality

telemetry -> data

The data is included in a JSON file as key-value pairs following the EnOcean Alliance IP Specification. Example JSON outputs from selected devices are available below.

EnOcean IoT Multisensor

json { "sensor": { "friendlyId": "Multisensor 1", "id": "04138bb4", "location": "Cloud center" }, "telemetry": { "data": [{ "key": "temperature", "value": 23.9, "unit": "°C" }, { "key": "humidity", "value": 29.0, "unit": "%" }, { "key": "illumination", "value": 67.0, "unit": "lx" }, { "key": "accelerationStatus", "value": "heartbeat", "meaning": "Heartbeat" }, { "key": "accelerationX", "value": -0.13, "unit": "g" }, { "key": "accelerationY", "value": 0.08, "unit": "g" }, { "key": "accelerationZ", "value": -0.97, "unit": "g" }, { "key": "contact", "value": "open", "meaning": "Window opened" }], "signal": [], "meta": { "stats": [{ "egressTime": "1611927479.169171", "notProcessed": 0, "succesfullyProcessed": 6, "totalTelegramCount": 6 }] } }, "raw": { "data": "d29fce800863b502a620", "sender": "04138bb4", "status": "80", "subTelNum": 0, "destination": "ffffffff", "rssi": 77, "securityLevel": 0, "timestamp": "1611927479.166352" } }

json { "sensor": { "friendlyId": "co2_Hardware2", "id": "051b03c9", "location": "Hardware 2" }, "telemetry": { "data": [{ "key": "co2", "value": 627.45, "unit": "ppm" }, { "key": "learn", "value": "notPressed", "meaning": "Data telegram" }, { "key": "powerFailureDetected", "value": "False", "meaning": "Power failure not detected" }], "signal": [], "meta": { "stats": [{ "egressTime": "1611927535.0731573", "notProcessed": 0, "succesfullyProcessed": 6, "totalTelegramCount": 6 }] } }, "raw": { "data": "a500005008", "sender": "051b03c9", "status": "01", "subTelNum": 0, "destination": "ffffffff", "rssi": 80, "securityLevel": 0, "timestamp": "1611927535.0714777" } }

PTM215 battery-less switch module

json { "sensor": { "friendlyId": "switch1", "id": "feee14ab", "location": "Entrance" }, "telemetry": { "data": [{ "key": "energybow", "value": "released", "meaning": "Energy Bow released" }], "signal": [], "meta": { "stats": [{ "egressTime": "1611927462.4711452", "notProcessed": 0, "succesfullyProcessed": 6, "totalTelegramCount": 6 }] } }, "raw": { "data": "f600", "sender": "feee14ab", "status": "20", "subTelNum": 0, "destination": "ffffffff", "rssi": 71, "securityLevel": 0, "timestamp": "1611927462.469978" } }

telemetry -> signal

Selected devices from EnOcean transmit additionally to their data messages also messages about their internal states or events. This messages are known as signal telegrams. Signal telegrams include information about the:

  • percentage of remaining energy available in the energy storage
  • how much energy is provided via the energy harvester
  • availability and status of a back up energy store
  • for additional information see the signal telegrams specification and data sheet of your EnOcean product

Example of an energy MID: 6 signal telegram is below:

json { "sensor": { "friendlyID": "0413D759 D2-14-41 SIMU Multisensor", "id": "0413d759", "location": "Office 265", "eep": "d2-14-41", "customTag": "" }, "telemetry": { "data": [], "signal": [{ "key": "signalIdentifier", "value": "0x6", "meaning": "Energy status of device" }, { "key": "energy", "value": 56.0, "unit": "%" }], "meta": { "stats": [{ "egressTime": "1638876910.137704", "notProcessed": 0, "succesfullyProcessed": 6, "totalTelegramCount": 6 }] } }, "raw": { "uuid": "f521f37c-3a82-42cb-b1cc-c889e946cef3", "data": "d00638", "sender": "0413d759", "status": 128, "subTelNum": 1, "destination": "ffffffff", "rssi": -64, "securityLevel": 0, "timestamp": "1638876903", "subTimestamp": 0, "subtelegrams": [] } }

telemetry -> meta

The meta section is complementary to data and signal. The meta section includes the stats section as provided by the API for the referenced device. Additionally the egress timestamp is included.

Examples are visible with the above examples with data and signal.

raw -> rssi

The raw element includes the radio telegram Information as received by the EnOcean SmartStudio. They are mostly included for tracking and debug purposes. The rssi is the only one of interest.

The rssi radio signal strength information provides important information about connectivity. We recommend to track it and raise and alarm if the level drops or changes significantly.