Python script for the pyscript addon in Home Assistant that watches a MQTT topic for messages from a Ruuvi Gateway, decodes and processes them, and sends the data back to MQTT formatted for Home Assistant auto-discovery.
- Install the pyscript addon
- Copy ruuvi-gateway.py to /config/pyscript/apps
- Add ruuvi_decoders (the ruuvi_decoders Python module) to requirements.txt in the /config/pyscript folder.
- Add your application configuration to config/configuration.yaml (see the configuration-sample.yaml) file for an example)
- Reload the pyscript addon
- Select Custom server under Advanced when prompted to configure where to send Ruuv Tag data
- Select MQTT and configure it as follows:
- Server - the IP address (or resolvable FQDN) of your MQTT broker
- Port - the port your MQTT broker is listening for non-SSL requests on; usually this is 1883
- User name - the user to use when connecting to your MQTT broker
- Password - the password to use when connecting to your MQTT broker
- Client name - the client name used when connecting to the MQTT server (MAC address default is fine)
- Topic prefix - the high-level topic prefix must match what's configured for MQTT_TOPIC_PREFIX in the script
- Once finished, power cycle the gateway to begin sending any received sensor beacons to MQTT
The measurements included in the the sample configuration YAML file are:
- temperature (demonstrates custom unit and conversion to Fahrenheit using transform)
- humidity
- battery (demonstrates custom unit and calculation of percentage using transform)
- pressure
- tx_power
I specifically did not add examples for the acceleration measurements, as there's no device class for acceleration in Home Assistant currently.
You can use a rudimentary arithmetic expression to modify a metric value by setting the value of the "transform" key for the measurement in the config file. This is best-effort; i.e. it works for the two simple use-cases I had (convert C to F, and calculate a rough (read: wildly inaccurate) battery level remaining percentage. I took the code directly from Stack Overflow; it's pretty much guaranteed to be fragile. Standard caveats apply, YMMV, etc..
One tool that was extremely helpful for me during debugging (assuming you're using the Mosquitto MQTT broker addon for Home Assistant) is mosquitto_sub (installed by default with Mosquitto).
E.g. to view messages being sent from the gateway to the MQTT top-level topic "ruuvi", Open an SSH terminal to your Home Assistant instance and enter:
mosquitto_sub -h <MQTT_BROKER_IP> -u <MQTT_USERNAME> -P "<MQTT_PASSWORD>" -v -t "ruuvi/#"
This will subscribe you to the topic and allow you to view messages as they come in to the broker. To check whether the messages are being correctly processed and submitted back to MQTT, replace "ruuvi" in the topic with "homeassist/sensor".
You can also add logging commands such as
"log.info(f"message with variable {varname}")
to the Python script itself and view them in the core log.