search

muppet3000 / homeassistant-growatt_server_api

Home Assistant Integration for Growatt - Upstream repo for the growatt_server integration that is part of the Core Home Assistant repository
MIT License
52 stars 6 forks source link
growatt home-assistant home-automation python3

readme

validate_badge hacs_badge bmab_badge paypal_badge

Growatt Server API Home Assistant Custom Component (growatt_server_api)

This custom component (installable via HACS) is an upstream version of growatt_server integration that is part of the Home Assistant Core repository.

The integration has been through a period of instability due to various issues with the authentication mechanism for Growatt (Growatt keep blocking the python library), using the HACS system will allow for more dynamic responses to the changes made by Growatt.

The changes made in this repository will be rolled up monthly and then submitted as a Pull-Request to the main Home Assistant Core repository for release as an 'official' Integration.

Note - This Integration works not only with Growatt systems but also Jinko Solar systems (as they appear to be exactly the same systems & API).

!IMPORTANT NOTICE!

Since 07/02/2023 (7th Feb) Growatt have started implementing rate limiting and blocking to user accounts that make excessive API calls i.e. this integration. There is an extended discussion around it here.

If you're interested in the short version read these posts: first, second, third

The recent developments throw into question the long-term viability of this Integration, please see the 'third' link above for the proposed plan.

Implementation

On initial release this plugin is an identical copy of the original integration that was part of the Home Assistant release. Going forward, this will be the upstream release of the Integration and the first place that bugs are fixed & new features are added.

Installation

This integration can be installed via HACS for Home Assistant

  1. Install HACS (Follow all the way through to the 'Configuration' page)
  2. In HACS install this integration (this will be simplified once this repository has been added to the default HACS repos via this PR):
    1. Click 'HACS' on the left menu
    2. Click 'Integrations'
    3. Click the three dots in the top-right corner
    4. Click 'Custom repositories'
    5. In the 'Repository' field enter: https://github.com/muppet3000/homeassistant-growatt_server_api
    6. In the 'Category' field select 'Integration'
    7. Click 'Add'
    8. Once the repository is added click on Growatt Server API
    9. On the next page select 'Download' in the bottom-right corner
    10. Choose the latest released version and click 'DOWNLOAD'
    11. Click the 'HACS' button in the menu and restart Home Assistant when prompted