EnOcean IoT Connector¶

The EnOcean IoT Connector (IoTC) allows for the easy processing of the super-optimized EnOcean radio telegrams. The IoTC is distributed as a group of Docker containers. All containers are hosted in the Docker Hub.

The IoTC is composed of the following containers:

1. enocean/iotconnector_ingress
2. enocean/iotconnector_engine
3. enocean/iotconnector_api
4. Redis
5. NGINX

Deploying the IoTC is simple using docker compose. For convenience, docker-compose.yml files are provided to easily deploy locally (i.e. with Docker) or to Azure Containers Instances (Microsoft Azure cloud account and subscription required).

The IoTC can either be deployed in:

• a public cloud (eg. Azure)
• private cloud
• on-site

IoTC containers are built for linux/arm/v7, linux/arm64 and linux/amd64

This guide will explain the basic functionality and cover the basic deployment steps and configuration options.

Documentation Version/Tag/SHA¶

1.1.0 / 2022-01-28 23:32:42+01:00 / 8150882

Features¶

Ingress¶

The ingress controls all incoming traffic from ingress gateways.

• The IoTC currently supports Aruba Access Points as ingress gateways.
• Communication is executed via secure web sockets only. Secure web sockets use SSL encryption. A manual how to add a certificate to an Aruba AP is listed here.
• It detects duplicates - i.e. filter if two or more ingress gateways received the same radio signal, and makes sure each signal is processed only once.
• Processes the ESP3 Protocol. Packet Type 01 & 10 is currently supported.

Engine¶

The IoTC engine completely supports the EnOcean radio protocol standards as defined by the EnOcean Alliance. Including:

• addressing encapsulation
• chaining
• decryption & validation of secure messages
• EEP processing

Additionally the IoTC evaluates sensor health information:

• information included in signal telegram
• telegram statistics

See the Output format description for more details on what the engine can provide.

Built-in end-points¶

Available end-points are MQTT and the Azure IoT Hub. The output data format is JSON, in accordance to the key-value pairs defined by the EnOcean Alliance IP Specification.

Supported EnOcean Equipment Profiles (EEP)¶

The following EEPs are supported:

A complete description and a list of all existing EEPs can be found here: EEP Viewer.

If you are missing an EEP for your application please let us know.

API¶

The API is used to onboard EnOcean Devices into the IoTC and get additional runtime information.

NGINX¶

NGINX is used as a proxy to protect the interface of the IoTC. The user is required to provide a certificate for usage.

A Dockerfile / azure.dockerfile and corresponding dependencies (start.sh and nginx.conf ) are provided at /deploy/nginx/ in case the proxy needs to be rebuilt or customized.

redis¶

Redis is used as a message broker & cache for communication between different containers.

The API¶

The full API Specification is available here or via the web Interface, once the IoTC has been deployed.

The most important features are:

• onboard / update / remove enocean devices
• get most recent data and signal telegrams of a device
• telegram statistic (e.g. count, last seen) for a device and per gateway
• list of connected ingress gateways
• persistent storage of onboarded device - if you specified a volume storage at deployment
• Open API Standard 3 supporting the automatic generation of clients in several languages.

The API container exposes a Web UI for your convenience to see the full documentation and to have a simple client interaction.

Web UI¶

To use the Web UI follow these steps.

1. Opening the API url on a browser will display the API reference. The URL is https://<hostname of the container group or IP address>:443. Example: https://192.167.1.1:443 or https://myiotc.eastus.azurecontainer.io:443

   Note

   If you used a self-signed certificate and did not add it to your browser you will see a warning, please continue according to your web browser.

2. Login using the BASIC_AUTH_USERNAME & BASIC_AUTH_PASSWORD you specified in environmental variables.

Use the web client¶

You can use the Try it out function to execute any of the available commands for learning and debugging purposes.

Generate API client code.¶

1. Download the API Specification as JSON

   

2. Go to the editor e.g. online here and generate your client code.

   

Onboard Sensors¶

Use POST /device to add the devices one by one or POST /backup all at once. Minimum parameters are:

{
  "eep": "A5-04-05",
  "friendlyID": "Room Panel 02",
  "location": "Level 2 / Room 221",
  "sourceEurid": "a1b2c3d4"
}

Check the API Documentation for the complete schema.

Get telegram statistics¶

The API provides telegram statistics of the individual enocean device and per ingress gateway.

[
    {
    "device": {
      "hardwareDescriptor": "AP-305",
      "mac": "d01546c204a2",
      "softwareVersion": "8.7.1.1-8.7.1.1"
    },
    "stats": {
      "lastSeen": "1619210924",
      "notProcessed": 0,
      "succesfullyProcessed": 78662,
      "totalTelegramCount": 78662
    }
  },
  {
    "device": {
      "hardwareDescriptor": "AP-305",
      "mac": "24f27f551bf4",
      "softwareVersion": "8.7.1.0-8.7.1.0"
    },
    "stats": {
      "lastSeen": "1619210928",
      "notProcessed": 0,
      "succesfullyProcessed": 91526,
      "totalTelegramCount": 91526
    }
  }
]

[
  {
    "device": {
      "activeFlag": "true",
      "customTag": "",
      "destinationEurid": "ffffffff",
      "eep": "a5-09-09",
      "friendlyID": "co2_Hardware2",
      "isPTM": "false",
      "location": "Hardware 2",
      "sourceEurid": "051b03c9"
    },
    "stats": {
      "lastSeen": "1619210854",
      "notProcessed": 0,
      "succesfullyProcessed": 1057,
      "totalTelegramCount": 1057
    }
  }
]

The stats section is defined as:

TelegramStatistics:
      properties:
        lastSeen:
          description: Timestamp of last valid telegram from device in UTC seconds.
          type: string
        notProcessed:
          description: Count of not processed telegrams due to various reasons & NOT forwarded on egress.
          type: integer
        succesfullyProcessed:
          description: Count of succesfully processed telegrams & forwarded on egress.
          type: integer
        totalTelegramCount:
          description: Total count of received telegrams.
          type: integer

General operation can be checked by the lastSeen parameter. Some devices have a periodic communication pattern. Checking deviations / fluctuations in the pattern can help to detect issues.

Most recent telegrams¶

Use GET /devices/telemetry/most-recent to get most recent telemetry messages and GET /devices/signals/most-recent to get most recent signal telegrams.

This is feature is provided to confirm most recent telegrams in case of connection errors or restarts. It should not be used to get regular updates.

MQTT Topics¶

Using the MQTT end-point publishes these topics:

Customize MQTT¶

The above described topic PATHs can be customized to fit the target topic space. Customization is done via ENV variables at deployment time.

JSON Output Format¶

All Schemas of all JSON outputs can be found in the download section.

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.

{
    "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"
    }
}

{
    "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"
    }
}

{
    "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:

{
    "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 IoTC. 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.

Sensor meta¶

event¶

The IoT Connector provides important information about events that were detected in regard to the sensor status, data transmission or behavior.

There are these types of events:

Example of an Health FIRST_TIME_SEND message is below:

{
  "sensor": {
    "friendlyID": "Multisensor 1",
    "id": "04138d23",
    "location": "Cloud center",
    "eep": "d2-14-41",
    "customTag": ""
  },
  "meta": {
    "events": {
      "security": [],
      "health": [
        {
          "code": "FIRST_TIME_SEND",
          "message": "First time send of device with id=04138d23."
        }
      ],
      "transcoding": []
    },
     "stats": {
         "timestamp": "1637770981"
    }
  }
}

stats¶

The telegrams stats of individual EnOcean devices are posted periodically. This should indicate their operational status and additionally provide operational updates.

Example of an stats message is listed below:

{
  "sensor": {
    "friendlyID": "Multisensor 1",
    "id": "04138d23",
    "location": "Cloud center",
    "eep": "d2-14-41",
    "customTag": ""
  },
  "meta": {
     "stats": {
      "lastSeen": "1637827538",
      "notProcessed": 1,
      "succesfullyProcessed": 6,
      "totalTelegramCount": 0
      }
    }
  }
}

The content of the stats section corresponds to the response of the device telegram statics API request.

Gateway meta¶

event¶

Selected AP (e.g. Aruba AP) transmits meta information about their internal states referenced as Gateway Health Updates. The content is similar to the console log messages.

The purpose of this message includes these two use cases: - Still-alive message from the gateway. Know the gateway is operation. - EnOcean USB Dongle information of the gateway. Know the USB Dongle is correctly operating.

Example of an meta event of gateways is listed below:

{
  "gateway_info": {
    "mac": "aabbccddeeff",
    "softwareVersion": "8.8.0.0",
    "hardwareDescriptor": "AP-505"
  },
  "stats": {
    "timestamp": "1639039720"
  },
  "usb_info": [
    {
      "usb_identifier": "ENOCEAN_USB:deb480d77718bbbe5253896b9300acfd",
      "usb_health": "healthy"
    }
  ]
}

stats¶

The telegrams stats of individual gateways are posted periodically. This should indicate their operational status and additionally provide operational updates.

Example of an stats message is listed below:

{
  "gateway_info": {
    "mac": "aabbccddeeff",
    "softwareVersion": "8.8.0.0",
    "hardwareDescriptor": "AP-505"
  },
  "stats": {
      "lastSeen": "1637827538",
      "notProcessed": 0,
      "succesfullyProcessed": 6,
      "totalTelegramCount": 6
  }

}

The content of the stats section corresponds to the response of the gateway telegram statics API request.

Technical Requirements¶

The different containers of the IoTC require the Docker environment to run. Specific requirements (i.e. RAM, CPU) depend on the number of connected end points to the IoTC at runtime and their communication frequency. Typical installations (e.g. 100 connected AP, 500 EnOcean end points) can be run at common embedded platforms on the market e.g. RPi gen 4.

The IoTC was load tested in laboratory conditions with 200 Gateways / APs with trasnfering in total 2000 EnOcean Messages within 10 seconds. No issues or message lose was detected.

For Azure Cloud deployments we recommend to use the docker-compose.yml file listed in azure_deployment directory.

Used 3rd party components and libraries, OSS Components¶

Components:

• Redis Community(https://redis.io/)

• Python 3.8 (https://www.python.org/)

• Docker Community (https://docs.docker.com/get-docker/)

• NGINX Community (https://www.nginx.com/)

• Mosquitto (https://mosquitto.org/)

Python Libraries:

• Async Redis (aioredis,https://github.com/aio-libs/aioredis-py, MIT License)

• HIREDIS (hiredis,https://github.com/redis/hiredis,BSD License)

• Licensing (licensing,https://github.com/Cryptolens/cryptolens-python,MIT License)

• Protobuf (protobuf,https://developers.google.com/protocol-buffers/,https://github.com/protocolbuffers/protobuf/blob/master/LICENSE)

• Pydantic (pydantic,https://github.com/samuelcolvin/pydantic/,MIT License)

• Redis (redis,https://github.com/andymccurdy/redis-py,MIT License)

• Tornado (tornado,https://github.com/tornadoweb/tornado,Apache License 2.0)

• Flask (flask,https://flask.palletsprojects.com/en/1.1.x/,BSD=https://flask.palletsprojects.com/en/0.12.x/license/)

• Conexion (conexion,https://github.com/zalando/connexion,https://github.com/zalando/connexion/blob/master/LICENSE.txt)

• Azure (azure,https://github.com/Azure/azure-sdk-for-python,MIT)

• Bitstring (bitstring,https://github.com/scott-griffiths/bitstring,MIT)

• crc8 (crc8,https://github.com/niccokunzmann/crc8,MIT)

• paho-mqtt (paho-mqtt,http://www.eclipse.org/paho/,BSD=https://projects.eclipse.org/projects/iot.paho)

• pycryptodome (pycryptodome,https://github.com/Legrandin/pycryptodome,https://github.com/Legrandin/pycryptodome/blob/master/LICENSE.rst)

• pyinstaller (pyinstaller,https://github.com/pyinstaller/pyinstaller,https://github.com/pyinstaller/pyinstaller/blob/develop/COPYING.txt)

License Agreement and Data Privacy¶

Please see the License agreement here.

Please see the Data privacy agreement here.

Disclaimer¶

The information provided in this document describes typical features of the EnOcean software products and should not be misunderstood as specified operating characteristics. No liability is assumed for errors and / or omissions. We reserve the right to make changes without prior notice.