Skip to main content

Kostal Plenticore Prometheus Exporter

This is a Prometheus exporter for the Kostal Plenticore series of inverters. It exports the metrics exposed by the inverter in Prometheus format. This way it can be ingested into Prometheus and used for Grafana dashboards or to trigger notifications in case of failure events.

Usage

Run the kostal-plenticore-exporter passing it the IP address of the inverter and the password of the operator user. As command line arguments can be seen by other users on the system, the password should be passed via environment variable:

PASSWORD="my super secret" kostal-plenticore-exporter 192.168.1.3

The metrics will be default be exposed at http://localhost:9876/. See kostal-plenticore-exporter --help for all arguments available.

Alternatively, you can also invoke the Python module: python3 -m kostal_plenticore_exporter --help.

Status Metrics

Some metrics export state as a numeric value. These decoded meanings of these values are given in the interface description document available on the Kostal product page.

For the kostal_plenticore_inverter_status metric these values are:

  • 0: Off

  • 1: Init

  • 2: IsoMeas

  • 3: GridCheck

  • 4: StartUp

  • 5: -

  • 6: FeedIn

  • 7: Throttled

  • 8: ExtSwitchOff

  • 9: Update

  • 10: Standby

  • 11: GridSync

  • 12: GridPreCheck

  • 13: GridSwitchOff

  • 14: Overheating

  • 15: Shutdown

  • 16: ImproperDcVoltage

  • 17: ESB

  • 18: Unknown

For the kostal_plenticore_battery_status metric, which is called energy manager status in the document, these values are:

  • 0: Idle

  • 1: n/a

  • 2: Emergency Battery Charge

  • 4: n/a

  • 8: Winter Mode Step 1; on the UI and in the user manual this is Battery Sleep Mode 1.

  • 16: Winter Mode Step 2; on the UI and in the user manual this is Battery Sleep Mode 2.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Metadata

Release files for kostal_plenticore_exporter 0.5.1

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

Source distribution (sdist)

Source distribution for kostal_plenticore_exporter 0.5.1
File Size Uploaded
kostal_plenticore_exporter-0.5.1.tar.gz 17.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kostal_plenticore_exporter 0.5.1
File Interpreter ABI Platform
kostal_plenticore_exporter-0.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 63.1 kB

Release files / kostal_plenticore_exporter-0.5.1.tar.gz

Download URL kostal_plenticore_exporter-0.5.1.tar.gz
Size 17.5 kB
Tags Source
SHA-256 checksum
How to use checksums
fb41e6dc0c010257c6685fdfd1507253a56a7b09f57e7d398478e64bf311858c
BLAKE2b-256 checksum
How to use checksums
b619ddbafa3b20bcdef4bcf4f390947a43ae5639fbe412bfbb9f38fde1e54dc0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.24.0

Release files / kostal_plenticore_exporter-0.5.1-py3-none-any.whl

Download URL kostal_plenticore_exporter-0.5.1-py3-none-any.whl
Size 45.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1c97f0f25bc31d8b44d7da58b89a794416f7152ea6980457112ffbad2d308273
BLAKE2b-256 checksum
How to use checksums
c57d57e2defcbd36b25552e3b283708c0f99c080e90d195b7b333a53953db49a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.24.0

Release history Release notifications | RSS feed

This release

0.5.1 This release

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

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