Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lkiesow/shelly-ht-exporter
Shelly H&T Prometheus Exporter
https://github.com/lkiesow/shelly-ht-exporter
humidity-monitoring iot metrics prometheus prometheus-exporter sensors shelly temperature-monitoring
Last synced: about 1 month ago
JSON representation
Shelly H&T Prometheus Exporter
- Host: GitHub
- URL: https://github.com/lkiesow/shelly-ht-exporter
- Owner: lkiesow
- License: gpl-3.0
- Created: 2024-11-16T17:01:09.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-16T17:07:44.000Z (about 2 months ago)
- Last Synced: 2024-11-16T18:18:38.728Z (about 2 months ago)
- Topics: humidity-monitoring, iot, metrics, prometheus, prometheus-exporter, sensors, shelly, temperature-monitoring
- Language: Go
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shelly H&T Prometheus Exporter
This is a Prometheus exporter for [Shelly H&T sensor IoT devices](https://shellyparts.de/en/products/shelly-h-t).
The exporter supports multiple Shelly H&T sensors which can send their data to the exporter via the `Actions` integration.
## Building and Running the Exporter
To build the project, run:
```
go build
```
Run the built executable using:
```
./shelly-ht-exporter
```
This will start the web server.
By default, it listens on `127.0.0.1:8090`.
To listen on a different address, use the `SHELLY_HT_EXPORTER_ADDR` environment variable:
```
export SHELLY_HT_EXPORTER_ADDR=":8000"
./shelly-ht-exporter
```
## Configure Shelly H&T to Send Data
To have your Shelly H&T sensor send data to the Prometheus exporter, you should configure it to send HTTP requests to the exporter.
1. **Access Shelly Device Configuration**:
- Ensure your Shelly H&T sensor is connected to the network and accessible through its web interface.
2. **Set Up Actions**:
- Go to the settings of Shelly H&T and go to the tab for configuring actions
- Add a new action, specifying the URL of your Prometheus exporter. This would be something like `http://:8090/`.
3. **Testing**:
- Once set up, the Shelly H&T should start sending requests to the exporter every five minutes
- You can check the `/metrics` endpoint of the exporter to see if the data has been updated.
## Metrics
The exporter provides a `/metrics` endpoint.
You can use cURL to test it and get an overview of the available data:
```
❯ curl http://localhost:8090/metrics
# HELP count_updated The number of updates to a sensor value
# TYPE count_updated counter
count_updated{sensor="shellyht-221"} 1
count_updated{sensor="shellyht-CA62E1"} 2
...
# HELP humidity The measured humidity
# TYPE humidity gauge
humidity{sensor="shellyht-221"} 52.4
humidity{sensor="shellyht-CA62E1"} 54.2
# HELP last_updated_time_seconds Timestamp of the last update in seconds since epoch.
# TYPE last_updated_time_seconds gauge
last_updated_time_seconds{sensor="shellyht-221"} 1.731776654e+09
last_updated_time_seconds{sensor="shellyht-CA62E1"} 1.73177662e+09
...
# HELP temperature The measured temperature
# TYPE temperature gauge
temperature{sensor="shellyht-221"} 20.7
temperature{sensor="shellyht-CA62E1"} 21.5
```