README.md

Growatt API

A Python wrapper for the Growatt API, allowing you to interact with Growatt's services.

Installation

pip install growatt-api

Usage

Initialization and Login

First, create an instance of the Growatt class and log in using your Growatt credentials.

from growatt import Growatt

api = Growatt()
api.login("[email protected]", "your_password")

Fetching Plants

Retrieve the first plant and get the id.

plant_list = api.get_plants()[0]["id"]
print(plant_list)

Fetching Specific Plant

Get detailed information about a specific plant.

plant_id = "plant_id"
plant_topic = api.get_plant(plant_id)
print(plant_topic)

Quick Demo

Here's a quick demo showing how to use the Growatt API wrapper.

from growatt import Growatt

api = Growatt()

api.login("[email protected]", "pass123")

plantId = api.get_plants()[0]["id"]
print(f"Plant ID: {plantId}")

plant = api.get_plant(plantId)
print(plant)

mixSn = api.get_mix_ids(plantId)[0][1]
print(mixSn)

mixTotal = api.get_mix_total(plantId, mixSn)
print(mixTotal)

mixStatus = api.get_mix_status(plantId, mixSn)
print(mixStatus)

Fetching periodic data

To fetch periodic data such as daily, monthly, yearly or total, you can use the following functions.

Daily

api.get_energy_stats_daily("2024-08-06",plantId, mixSn)

Monthly

api.get_energy_stats_monthly("2024-08",plantId, mixSn)

Yearly

api.get_energy_stats_yearly("2024",plantId, mixSn)

Battery weekly data

Battery information is in a weekly format.

api.get_weekly_battery_stats(plantId, mixSn)

License

This project is licensed under the MIT License. See the LICENSE file for more details.