Skip to main content

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

  1. Install and configure Prometheus and Grafana
  2. sudo dnf copr enable barryascott/tools
  3. 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:

  1. sudo systemctl daemon-reload
  2. sudo systemctl enable --now givenergy.timer

Metadata

Release files for prometheus-givenergy 1.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for prometheus-givenergy 1.0.3
File Size Uploaded
prometheus-givenergy-1.0.3.tar.gz 20.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for prometheus-givenergy 1.0.3
File Interpreter ABI Platform
prometheus_givenergy-1.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 38.0 kB

Release files / prometheus-givenergy-1.0.3.tar.gz

Download URL prometheus-givenergy-1.0.3.tar.gz
Size 20.6 kB
Tags Source
SHA-256 checksum
How to use checksums
c333ea0c7a2913459d4e2fc6a1289df9c2b27e6f44baea931ad74eb89d2b7c9b
BLAKE2b-256 checksum
How to use checksums
12484a9f8ca339979e64da9a5a0f7d77b2aaea0b231a034c28f5fae4cc0ffbd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.12.0

Release files / prometheus_givenergy-1.0.3-py3-none-any.whl

Download URL prometheus_givenergy-1.0.3-py3-none-any.whl
Size 17.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
34112a10abcf00e5577d2c6a1af0373980dc5a7c4408aae4aa1056bfeeed389c
BLAKE2b-256 checksum
How to use checksums
3dc75890cdf51baecc0cdcdfb93fcb27d5f2a77909afaccb506de528ed39cb1c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.12.0

Release history Release notifications | RSS feed

This release

1.0.3 This release

2 release files

1.0.2

2 release files

1.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page