UDP Protobuf API for the ESP8266 based sensors
The protocol buffers struct is automatically generated using the tools provided by Google's Protocol Buffers. The definition file will be found here or in the repository for the ESP8266 temperature sensor's source code.
The server responds to the device's message with either:
- Go to sleep for X seconds - this can be used for example to sync the reporting times of multiple sensors, so that the WiFi hotspot does not have to be transmitting all the time. It can also be used to adjust the reporting frequency if for example the batteries die too fast.
- Update firmware from $URL - the sensor can perform a firmware upgrade over HTTP.
Currently the server logs the reports to STDOUT and reports them to the API on the website. This requires an API key.
There's zero security on the server side, anyone could send pretty much anything they want to. TODO: investigate how to implement some super simple security mechanism that is lightweight and easy to implement also on the ESP8266 side. Most likely some kind of simple shared-key checksum/signature.
$ docker build -t sompisapi .
$ docker run -e REPORT_API_KEY=xyz -p 8000:8000/udp sompisapi
Requires Ruby >= 2.5
$ bundle
$ LISTEN_UDP_PORT=8000 REPORT_API_KEY=xyz bin/server