mypv-elwa-prometheus-exporter (0.1.3)
Installation
pip install --index-url About this package
A Python script that exports my-PV AC ELWA device statistics as Prometheus metrics
my-PV AC ELWA Prometheus Exporter
A Python application that exports my-PV AC ELWA device statistics as Prometheus metrics for monitoring and visualization.
Features
- Export my-PV AC ELWA device metrics in Prometheus format
- Support for multiple devices
- HTTP server mode for continuous Prometheus scraping
- One-time export mode for batch metrics collection
- Configurable logging levels and output destinations
- Docker container support for easy deployment
Installation
From Source
# Clone the repository
git clone https://git.h.oluflorenzen.de/finkregh/mypv-ac-elwa-exporter.git
cd mypv-ac-elwa-exporter
# Install with uv (recommended)
uv sync
# Or install with pip
pip install -e .
Using Docker
Pull the pre-built image:
docker pull git.h.oluflorenzen.de/finkregh/mypv-ac-elwa-exporter:latest
Or build locally:
docker build -t mypv-elwa-exporter .
Nix
The repository is a flake and can be consumed directly, without Docker. The
package is built from source with the same uv_build backend used by pip and
uv; the test suite is hermetic (HTTP is mocked with responses) and runs as
part of nix build.
Run / build
# Run straight from the repository (or a git ref)
nix run .# -- serve --url http://192.168.178.125 --port 8000
nix run git+https://git.h.oluflorenzen.de/finkregh/mypv-elwa-prometheus-exporter?ref=0.0.26 -- serve --url http://192.168.178.125
# Build
nix build .# # -> result/bin/mypv-elwa-prometheus-exporter
result/bin/mypv-elwa-prometheus-exporter serve --help
Flake outputs
| Output | Description |
|---|---|
packages.<system>.default |
The exporter (<system> is x86_64-linux, aarch64-linux or aarch64-darwin) |
packages.<system>.mypv-elwa-prometheus-exporter |
Same package under its attribute name |
overlays.default |
Adds pkgs.mypv-elwa-prometheus-exporter |
nixosModules.default |
NixOS module (see below) |
devShells.<system>.default |
Python, uv, pytest, responses, black, mypy |
Consuming from another flake
{
inputs.mypv-elwa-exporter = {
url = "git+https://git.h.oluflorenzen.de/finkregh/mypv-elwa-prometheus-exporter?ref=0.0.26";
# Recommended: reuse the consumer's nixpkgs instead of fetching a second one.
inputs.nixpkgs.follows = "nixpkgs";
};
}
Then reference inputs.mypv-elwa-exporter.packages.${system}.default.
?ref=0.0.26 follows the git tag; use ?rev=<full-commit-sha> for an immutable
pin (ref can be moved, rev cannot). flake.lock in the consuming flake pins
the resolved revision either way.
The package needs no Python overrides: its runtime dependencies (typer,
requests, rich, prometheus-client) are taken from the flake's nixpkgs.
NixOS module
{ inputs, ... }:
{
imports = [ inputs.mypv-elwa-exporter.nixosModules.default ];
services.mypv-elwa-exporter = {
enable = true;
url = [ "http://192.168.178.125" ]; # one or more devices
port = 8000; # default
logLevel = "INFO"; # default
# openFirewall = true; # listens on 0.0.0.0; keep closed for local-only scraping
};
}
The unit runs mypv-elwa-prometheus-exporter serve as a stateless DynamicUser
and passes settings through the usual environment variables
(MYPVELWAEXPORTER_SERVE_URL, MYPVELWAEXPORTER_SERVE_PORT,
MYPVELWAEXPORTER_SERVE_LOG_LEVEL). Logs go to the journal. The exporter exits
at startup when no configured device is reachable, so the unit uses
Restart=always.
Development shell
nix develop
uv run pytest
Usage
Command Line
Test Connection
mypv-elwa-prometheus-exporter test-connection --url http://192.168.178.125
HTTP Server Mode (Recommended for Prometheus)
Start an HTTP server that continuously serves metrics for Prometheus scraping:
mypv-elwa-prometheus-exporter serve --url http://192.168.178.125 --port 8000
Multiple devices:
mypv-elwa-prometheus-exporter serve --url "http://192.168.178.125,http://192.168.178.126" --port 8000
Export Mode (One-time)
Export metrics once to stdout or file:
# To stdout
mypv-elwa-prometheus-exporter export --url http://192.168.178.125
# To file
mypv-elwa-prometheus-exporter export --url http://192.168.178.125 --output metrics.txt
Docker
Using Docker Run
# HTTP server mode
docker run -d --name mypv-exporter \
-p 8000:8000 \
-e MYPVELWAEXPORTER_SERVE_URL=http://192.168.178.125 \
git.h.oluflorenzen.de/finkregh/mypv-ac-elwa-exporter:latest
# Export mode (one-time)
docker run --rm \
-e MYPVELWAEXPORTER_EXPORT_URL=http://192.168.178.125 \
git.h.oluflorenzen.de/finkregh/mypv-ac-elwa-exporter:latest \
mypv-elwa-prometheus-exporter export
Using Docker Compose
Copy the example-config.env file and customize it:
cp example-config.env .env
# Edit .env with your device URL(s)
Start with docker-compose:
docker-compose up -d
The metrics will be available at http://localhost:8000/metrics.
Configuration
Environment Variables
The application uses environment variables with the prefix MYPVELWAEXPORTER_:
Server Mode (serve command)
MYPVELWAEXPORTER_SERVE_URL: Device URL(s), comma-separated for multiple devicesMYPVELWAEXPORTER_SERVE_PORT: HTTP server port (default: 8000)MYPVELWAEXPORTER_SERVE_LOG_LEVEL: Logging level (default: INFO)MYPVELWAEXPORTER_SERVE_LOG_FILE: Optional log file path
Export Mode (export command)
MYPVELWAEXPORTER_EXPORT_URL: Device URL(s), comma-separated for multiple devicesMYPVELWAEXPORTER_EXPORT_OUTPUT: Optional output file path (default: stdout)MYPVELWAEXPORTER_EXPORT_LOG_LEVEL: Logging level (default: INFO)
Configuration File
You can also use the provided example-config.env as a template:
# Copy and edit the configuration
cp example-config.env my-config.env
# Use with Docker
docker-compose --env-file my-config.env up -d
# Or source it for local usage
source my-config.env
mypv-elwa-prometheus-exporter serve
Prometheus Configuration
Add the exporter to your Prometheus configuration:
scrape_configs:
- job_name: 'mypv-elwa'
static_configs:
- targets: ['localhost:8000'] # Adjust host and port as needed
scrape_interval: 30s
metrics_path: /metrics
Metrics
The exporter provides the following metrics:
- Device Information: Device model, firmware version, serial number
- Power Metrics: ELWA power consumption, grid power, solar power
- Temperature Metrics: Temperature sensors (T1, T2)
- Electrical System: Voltage, frequency, power factor
- Device Health: Connection status, error codes
All metrics are labeled with device instance information for multi-device setups.
Development
Setup Development Environment
# Install with development dependencies
uv sync --all-extras --dev
# Run tests
uv run pytest
# Run linting
uv run black .
uv run mypy .
Building
# Build package
uv build
# Build Docker image
docker build -t mypv-elwa-exporter .
Docker Deployment
Production Deployment
-
Create configuration file:
cp example-config.env production.env # Edit production.env with your actual device URLs -
Deploy with docker-compose:
docker-compose --env-file production.env up -d -
Check logs:
docker-compose logs -f mypv-elwa-exporter -
Health check:
curl http://localhost:8000/metrics
Integration with Monitoring Stack
The exporter integrates well with the standard Prometheus + Grafana monitoring stack:
# docker-compose.yml example for full monitoring stack
version: '3.8'
services:
mypv-elwa-exporter:
image: git.h.oluflorenzen.de/finkregh/mypv-ac-elwa-exporter:latest
environment:
- MYPVELWAEXPORTER_SERVE_URL=http://192.168.178.125
networks:
- monitoring
prometheus:
image: prom/prometheus:latest
volumes:
- ./prometheus.yml:/etc/prometheus/prometheus.yml
networks:
- monitoring
grafana:
image: grafana/grafana:latest
networks:
- monitoring
networks:
monitoring:
License
This project is licensed under the MIT License - see the LICENSE file for details.
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
Support
For issues and questions:
- Open an issue on the project repository
- Check the logs with
--log-level DEBUGfor troubleshooting