cdpuk / givenergy-local

Home Assistant integration for local access to GivEnergy inverter and battery systems
MIT License
47 stars 14 forks source link
energy givenergy hacs home-assistant solar

GivEnergy Local

GitHub Release GitHub Activity License hacs

This custom component provides local access to GivEnergy inverters via Modbus. This provides more frequent and reliable updates compared to using the GivEnergy Cloud API.

While the risk of something going wrong is low, bear in mind the use of this integration is entirely at your own risk.

Installation

This integration is delivered as a HACS custom repository.

  1. Download and install HACS.
  2. Add a custom repository in HACS. You will need to enter the URL of this repository when prompted: https://github.com/cdpuk/givenergy-local.

Configuration

You need to know the hostname or IP address of your inverter, which you can normally work out by looking at your router status pages. When using an IP address that was issued with DHCP, bear in mind it needs to remain stable; this is normally fine since inverters stay connected 24/7.

Your Home Assistant instance must be able to establish a TCP connection to your inverter on port 8899.

Documentation

Limitations

GivEnergy are continually releasing new equipment and firmware. There is a risk that new devices won't work, or that firmware updates may suddenly prevent the integration being able to talk to your inverter.

If this happens, bear in mind the maintainers of this integration do not have access to your equipment, so debugging such issues can be challenging. Raise an issue with as much detail as possible to make it easier to help you.

Acknowledgements

givenergy_modbus

The Modbus protocol implementation for GivEnergy systems was originally created by the givenergy-modbus project. Huge thanks goes to the author and contributors for unpicking the non-standard low level technical details of the protocol.

Since the project was paused, the current implementation of this integration uses an embedded forked version of the library so that further bugfixes and updates can be made without an external dependency.

GivTCP

GivTCP is an alternative to this integration, which runs as a Home Assistant add-on, and therefore may not be suitable for all installations. However, it sees frequent updates and several compatibility updates made to that project have been reused here.

Contributing

If you want to contribute to this please read the Contribution Guidelines.