jqueuniet / ecowitt_exporter

Republish metrics sent with the Ecowitt weather station protocol to the prometheus format

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ecowitt_exporter

This program listens to ecowitt protocol submissions to provide them in the Prometheus/OpenMetrics format.

Supported hardware

The Ecowitt protocol should be supported by the various Ecowitt clones like Ambient Weather or Froggit weather stations. Development is made with a Froggit HP1000SE Pro (HP2553 clone), with the following sensors:

  • WH25 (indoor sensor)
  • WH80 (ultrasonic combined sensor array)
  • WH40 (raingauge sensor)

Request for new sensors should be sent with an HTTP capture of your ecowitt payload. You can easily make one by running nc -l -p 8000 (or nc -l 8000 on macOS).

Configuration

This project uses Rocket as HTTP server and for now relies on its default settings. You can customize them with either a Rocket.toml file or ROCKET_ environment variables. At the very least, you will have to set ROCKET_ADDRESS to listen on IP addresses other than 127.0.0.1. The default port is 8000.

Usage

Ecowitt data should be sent to the default /data/report/ URL path. Metrics can be retrieved at /metrics.

Do note that in the event of sensor failure, like if its battery is exhausted, the station will at first keep sending its last received metrics. After some time, it will declare the sensor dead and stop sending those metrics. Only at this point will metrics be culled from the exporter. No attempt will be made by this program to detect the situation beforehand.

About

Republish metrics sent with the Ecowitt weather station protocol to the prometheus format

License:GNU Affero General Public License v3.0


Languages

Language:Rust 96.2%Language:Dockerfile 3.8%