Skip to main content

A Prometheus exporter for the Kostal Plenticore series of inverters.

Project description

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/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kostal_plenticore_exporter-0.5.1.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file kostal_plenticore_exporter-0.5.1.tar.gz.

File metadata

File hashes

Hashes for kostal_plenticore_exporter-0.5.1.tar.gz
Algorithm Hash digest
SHA256 fb41e6dc0c010257c6685fdfd1507253a56a7b09f57e7d398478e64bf311858c
MD5 4077eac2e5116462671fac90a2b1c49d
BLAKE2b-256 b619ddbafa3b20bcdef4bcf4f390947a43ae5639fbe412bfbb9f38fde1e54dc0

See more details on using hashes here.

File details

Details for the file kostal_plenticore_exporter-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for kostal_plenticore_exporter-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c97f0f25bc31d8b44d7da58b89a794416f7152ea6980457112ffbad2d308273
MD5 9a460d72b6a8b3ec56a941c777a38584
BLAKE2b-256 c57d57e2defcbd36b25552e3b283708c0f99c080e90d195b7b333a53953db49a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page