sonnen_exporter

sonnen_exporter is a Prometheus Exporter for batteries from German Manufacturer Sonnen. It's based on Docker and prometheus-community/json_exporter.

It uses API V2 of local battery, docs are available at your local battery.

Disclaimer

I'm not involved in any way in Sonnen GmbH and this repository is not an official Sonnen GmbH project. This is just a hobby project of some nerd.

Please keep following topics in mind:

There is no encryption or authentication/authorization included, so I suggest to run this only in a protected environment (like your LAN ... hopefully 😉) and don't publish this service to the Internet. If your Prometheus is not running in the same environment as this project, please use some kind of tunnel technology like VPN.
docker-compose.yml is referencing to the latest json_exporter available in Docker Registry. In a commercial environment, this is often seen as an anti pattern because it could lead to unintended updates and broken systems. However, in my specific scenario, I want to refer to the latest available image. If something fails unintended, I need to fix it.

How to use

Requirements:

Have a server with Docker installed
Have a Sonnen battery which supports API V2 and have Sonnen battery prepared (see below)

Prepare Sonnen battery

You need an Auth token which can be found at your local battery Web UI. Please make sure to enable "Read API" at same page before accessing API. I also suggest to disable "Write API" and test your config using curl.

Setup

There are two ways to setup this repository:

Ansible setup
Manual setup

Please choose one of them.

Ansible setup

To setup sonnen_exporter using Ansible please ensure to have at least Ansible 2.7 installed at your system. If that's the case, run following commands:

cd /YOUR/REPO/CHECKOUT/PATH/sonnen_exporter.git/ansible
cp roles/install-sonnen_exporter/vars/main-sample.yml roles/install-sonnen_exporter/vars/main.yml

Open roles/install-sonnen_exporter/vars/main.yml in your prefered editor and insert your personal Auth token.

To run this role and install sonnen_exporter at your server, you can use following command:

cd /YOUR/REPO/CHECKOUT/PATH/sonnen_exporter.git/ansible
ansible -i /PATH/TO/INVENTORY -b YOURSERVERNAME -m ansible.builtin.include_role --args name=install-sonnen_exporter

Manual setup

To setup sonnen_exporter the manual way, clone this repository and open json_exporter_config.yml. Search for

Auth-Token: 'REPLACETHISWITHYOURAUTHTOKEN'

and insert your Auth token. Please note there are multiple occurances of this line.

Start

After setup, sonnen_exporter can be started using

docker compose up

docker compose up -d

in setup directory.

This will start a web service at port 7979. Following APIs can be scraped by Prometheus:

Description	URL
Overall status of entire system	http://YOURSONNENEXPORTERIP:7979/probe?module=sonnen_v2_status&target=http://YOURSONNENBATTERYIP/api/v2/status
Battery specific data	http://YOURSONNENEXPORTERIP:7979/probe?module=sonnen_v2_battery&target=http://YOURSONNENBATTERYIP/api/v2/battery
Inverter specific data	http://YOURSONNENEXPORTERIP:7979/probe?module=sonnen_v2_inverter&target=http://YOURSONNENBATTERYIP/api/v2/inverter
Configuration data	http://YOURSONNENEXPORTERIP:7979/probe?module=sonnen_v2_configurations&target=http://YOURSONNENBATTERYIP/api/v2/configurations

Upgrade

Ansible role is creating a cronjob which updates base image every night. If you installed manually, you can use following cronjob:

0 4 * * * docker compose -f /opt/sonnen_exporter/docker-compose.yml down && docker compose -f /opt/sonnen_exporter/docker-compose.yml pull && docker compose -f /opt/sonnen_exporter/docker-compose.yml up -d

Further information

For more information please check prometheus-community/json_exporter docs.

Prometheus sample config

Your prometheus.yml which targets sonnen_exporter could look like this:

[...]
- job_name: sonnen_v2_status
  honor_timestamps: true
  scheme: http
  metrics_path: /probe
  params:
    module: ['sonnen_v2_status']
    target: ['http://YOURSONNENBATTERYIP/api/v2/status']
  static_configs:
  - targets:
    - YOURSONNENEXPORTERIP:7979
- job_name: sonnen_v2_battery
  honor_timestamps: true
  scheme: http
  metrics_path: /probe
  params:
    module: ['sonnen_v2_battery']
    target: ['http://YOURSONNENBATTERYIP/api/v2/battery']
  static_configs:
  - targets:
    - YOURSONNENEXPORTERIP:7979
- job_name: sonnen_v2_inverter
  honor_timestamps: true
  scheme: http
  metrics_path: /probe
  params:
    module: ['sonnen_v2_inverter']
    target: ['http://YOURSONNENBATTERYIP/api/v2/inverter']
  static_configs:
  - targets:
    - YOURSONNENEXPORTERIP:7979
- job_name: sonnen_v2_configurations
  honor_timestamps: true
  scrape_interval: 1d
  scheme: http
  metrics_path: /probe
  params:
    module: ['sonnen_v2_configurations']
    target: ['http://YOURSONNENBATTERYIP/api/v2/configurations']
  static_configs:
  - targets:
    - YOURSONNENEXPORTERIP:7979
[...]

thinkpace/sonnen_exporter