Plenti

Plenti is a command-line tool for interacting with Kostal Plenticore inverters. It allows you to retrieve, display, and store solar power data from your Plenticore inverter through its API.

• Features
• Installation
  • From Source
• Configuration
  • Example Configuration
• Usage
  • Basic Commands
    • List Available Fields
    • Display Current Data
    • Save Data to Database
    • Continuous Data Collection
  • Command Line Options
• Docker Usage
  • Building the Docker Image
  • Running the Container
  • Docker Volumes

Features

• Connect to Kostal Plenticore inverter API securely
• Retrieve real-time data from the inverter
• List all available data fields
• Save data to a SQLite database at configurable intervals
• Configure data collection through a simple YAML file
• Dockerized deployment option for continuous data collection

Installation

From Source

1. Clone the repository:

   git clone https://github.com/mgoeppe/plenti.git
   cd plenti

2. Build the application:

   go build -o plenti

3. Move the binary to your PATH (optional):

   sudo mv plenti /usr/local/bin/

Configuration

Plenti uses a YAML configuration file (plenti.yaml) for its settings. Create this file in the directory where you run Plenti, or specify its location with the --config-path flag.

Example Configuration

plenticore:
  server: "inverter.local"  # Your Plenticore inverter address
  password: "yourpassword"  # Your Plenticore password
  fields:                   # List of fields to collect (optional)
    - devices:local/Grid_P
    - devices:local/Home_P
    - devices:local:battery/SoC
    # Add more fields as needed
database:
  path: "plenti.db"        # Path to SQLite database file
  printSummary: true       # Print summary after saving data

You can generate a list of all available fields using the fields command.

Usage

Basic Commands

List Available Fields

plenti fields

This will list all available data fields from your Plenticore inverter, which you can then use in your configuration file.

Display Current Data

plenti data

This will display the current values for all configured fields (or all available fields if none are specified in the config).

Save Data to Database

plenti save

This will retrieve the current data and save it to the database specified in your configuration.

Continuous Data Collection

plenti save --interval=5m

This will save data to the database every 5 minutes. Supported formats include "30s", "5m", "1h", etc.

Command Line Options

Global Flags:
  -c, --config-path string   Path to directory containing plenti.yaml config file (default ".")
      --log-level string     Log level (debug, info, warn, error) (default "info")
  -p, --password string      Plenticore password
  -s, --server string        Plenticore server address

Save Command Flags:
  -d, --database string      Database file path (default "plenti.db")
  -i, --interval string      Run continuously with specified interval (e.g. '30s', '5m', '1h')
      --summary              Print a summary after saving

Docker Usage

For continuous data collection, you can use the provided Docker image.

Building the Docker Image

docker build -t plenti-save .

Running the Container

docker run -d \
  --name plenti-save \
  -v /path/to/your/config:/config \
  -v plenti-data:/data \
  plenti-save

Docker Volumes

• /config: Mount directory containing your plenti.yaml configuration file
• /data: Mount point for the database storage

Make sure to configure all settings (including database path and interval) in your plenti.yaml file within the mounted config directory. For example:

plenticore:
  server: "inverter.local"
  password: "yourpassword"
database:
  path: "/data/plenti.db"  # Note the path points to the data volume
  interval: "5m"           # Save data every 5 minutes
  printSummary: true