Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.78 KB

README.rst

File metadata and controls

48 lines (31 loc) · 1.78 KB

HomematicIP Tracking

Track the temperature and humidity of a HomematicIP smart home and expose them as prometheus metrics

  • Free software: MIT license

Installation

So far this project only exists on github and you can simply clone and install it as follows:

git clone [email protected]:Emrys-Merlin/homematicip_tracking.git
cd homematic_tracking
pip install -r requirements.txt
pip install -e .

Usage

  • The above installation gives you access to the shell command homematicip_tracking which polls the HomematicIP sensors and exposes the metrics.
homematicip_tracking <config> <port> [<options>]
  • <config> should point to the config file for the HomematicIP API access. This file can be generated using the hmip_generate_auth_token.py of the homematic package found at https://github.com/coreGreenberet/homematicip-rest-api.
  • <port> the port at which the prometheus metrics will be exposed
  • At the moment there are two possible options --wait is the waiting time between HomematicIP polls and --print/--no-print which prints the read sensor data to stdout.
  • The metrics that are exposed are temperature_gauge_c and humidity_gauge_percent. Both have the labels room, device_name and device_type for further filtering.

Example Grafana Dashboard

Image of a Grafana dashboard using the data exposed by this script.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.