LocalSolarWatt 0.8.2

python api wrapper for solar watt device api

LocalSolarWatt

A python3 library to access the data of solar watt devices via local api
Disclaimer: This library uses an unofficial local api and could therefore break at any point

Overview

The package uses the kiwigrid api provided by your solar watt energy manager device.
Data available:

• Real time power values from inverter, AC sensor and battery (if exists)
• Long term energy statistics

This library does some preprocessing by extracting relevant fields and grouping them by device class.
For now this mostly includes data I deem usefully for the integration with home assistant.

Note: Polling the energy manager with a very high interval often could lead to reliability issues (untested).

Supported devices

As I only have access to one installation and the api is as far as I'm aware not documented by SolarWatt, I can not guarantee that this library works with your setup.
If you encounter issues with your concrete setup, feel free to open a new issue.
The raw json data is available via http://YOUR_DEVICE_IP/rest/kiwigrid/wizard/devices
If you can provide the raw json dump, I can try to add support for your device.
Important Note: This data does contain some sensitive information (especially for the "Location" device), so make sure to remove any sensitive data before sharing.

Installation

pip install LocalSolarWatt

Usage

from local_solar_watt import EnergyManagerApi, EnergyManagerVersion

# create a new api object
energy_api = EnergyManagerApi(EnergyManagerVersion.CLASSIC, "<host_or_ip>")

# create a new api object for new energy manager flex
energy_api = EnergyManagerApi(EnergyManagerVersion.FLEX, "<host_or_ip>")

# optional, change work units to Wh instead of kWh
api = EnergyManagerApi(EnergyManagerVersion.CLASSIC, "<host_or_ip>", work_unit=WorkUnits.Wh)

# with custom logger
my_logger = logging.getLogger("my_logger")
energy_api = EnergyManagerApi(EnergyManagerVersion.CLASSIC, "<host_or_ip>", logger=my_logger)

# test the connection (returns bool based on success)
status = api.test_connection()

# pull data from the device (returns only selected power values, grouped by device class)
print(api.fetch_data())

Development:

Project uses uv for dependency management.

Rudimentary unit tests are included in the tests folder. These use static data from j́son files and do not require a connection to the device.