prometheus exporter for GivEnergy inverter metrics.
Project description
prometheus-givenergy
prometheus exporter for GivEnergy inverter metrics
prometheus-givenergy is inspired by givenergy-modbus module. givenergy-modbus does not work with current version of pymodbus.
Usage: prometheus_givenergy <host> [--port=<port>] [--prom-file=<prom-file> [--version]
<host> ip-address or hostname
<port> default 8899
<prom-file> default /var/lib/prometheus/node-exporter/givenergy.prom
All holding metrics are prefixed with givenergy_holding_.
And all input metrics are prefixed with givenergy_.
The unit type of the metric is used to add a suffix.
| Unit | Suffix | Example |
|---|---|---|
| Scaler value | no suffix | givenergy_battery_num_cycles |
| kilo Watt Hours | _kwh | givenergy_grid_in_total_kwh |
| Watts | _w | givenergy_load_demand_w |
| VA | _va | givenergy_grid_apparent_va |
| Voltage | _volts | givenergy_holding_ac_high_in_volts |
| Current | _amps | givenergy_grid_port_amps |
| Amp Hours | _ah | givenergy_holding_battery_nominal_capacity_ah |
| Temperature C | _temp_c | givenergy_battery_temp_c |
| Frequency Hz | _hz | givenergy_ac1_hz |
Installing on Fedora
- Install and configure Prometheus and Grafana
- sudo dnf copr enable barryascott/tools
- sudo dnf install python3-prometheus-givenergy
Use systemd service and timer units to run the command periodically (or cron if you prefer).
Timer unit: /etc/systemd/system/givenergy.timer
[Unit]
Description=givenergy.timer
[Timer]
OnBootSec=60 seconds
OnUnitInactiveSec=30 seconds
[Install]
WantedBy=multi-user.target
Service unit: /etc/systemd/system/givenergy.service
[Unit]
Description=givenergy.service
[Service]
User=prometheus
Type=oneshot
TimeoutStartSec=0
ExecStartPre=/usr/bin/id
ExecStart=/usr/bin/prometheus-givenergy hf-a21.chelsea.private
[Install]
WantedBy=multi-user.target
Once the systemd unit files are in place:
- sudo systemctl daemon-reload
- sudo systemctl enable --now givenergy.timer
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file prometheus-givenergy-1.0.3.tar.gz.
File metadata
- Download URL: prometheus-givenergy-1.0.3.tar.gz
- Upload date:
- Size: 20.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c333ea0c7a2913459d4e2fc6a1289df9c2b27e6f44baea931ad74eb89d2b7c9b
|
|
| MD5 |
77da99b0185135fb40eb0d2d40cb927d
|
|
| BLAKE2b-256 |
12484a9f8ca339979e64da9a5a0f7d77b2aaea0b231a034c28f5fae4cc0ffbd4
|
File details
Details for the file prometheus_givenergy-1.0.3-py3-none-any.whl.
File metadata
- Download URL: prometheus_givenergy-1.0.3-py3-none-any.whl
- Upload date:
- Size: 17.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
34112a10abcf00e5577d2c6a1af0373980dc5a7c4408aae4aa1056bfeeed389c
|
|
| MD5 |
73b22d5b99ab729f6aceb5c30cf41c0c
|
|
| BLAKE2b-256 |
3dc75890cdf51baecc0cdcdfb93fcb27d5f2a77909afaccb506de528ed39cb1c
|