Giter Site home page Giter Site logo

sungrow-shx-inverter-modbus-home-assistant's Introduction

An easy-to-use YAML-based integration for several Sungrow inverters for Home Assistant.

WARNING: For many users HA 2024.4 does not work

If you upgraded to HA 2024.4 and experience missing sungrow / modbus values, it is most likelycaused by HA-internal changes (transitioning from sync to async calls). It does not look like this can somehow be fixed by rewriting stuff in this integration. If you are affected, there is currently no other option than to downgrade to 2024.3 :/

In #274 there are some related links. Please continue discussions there :)

Discord Chat

Contents

1. Overview

This integration lets you gather sensor data and control the EMS (Energy Management System) of a wide range of Sungrow inverters, including, but not limited to: SH3.6RS, SH4.6RS, SH5.0RS, SH5.0RT, SH6.0RS, SH8.0RT, SH8.0RT-V112, SH6.0RT, SH10RT, SH10RT-V112, SH5K-20, SH3K6, SH4K6, SH5K-V13, SH5K-30. A battery is not required, but several sensors will not be available without one.

Ensure, that you connected the inverter to the Home Assistant network using the internal LAN port. The WiNet Ethernet port and the WiNet WLAN are only partially working and we cannot fix this! (==> no support, sorry :/ )

Overview

Inverter LAN connection

2. Documentation

The documentation covers following topics:

Installation/ Configuration

Dashboard Setup

Usage Instructions

FAQ, Troubleshooting, Known Issues

3. Support

If you any kind of assistance, you have three options:

a) Use the github discussion

b) (new! Created in July 2023) Join the Discord Channel Discord Chat.

c) Only if code-related (bugs / contributions): Open an github issue or isse a pullrequest

4. Visual impressions

Home Asisstants built-in Energy Dashboard

Default dashboard tab "overview"

Default dashboard tab "Detail"

Default dashboard tab "EMS"

5. Tested configurations

I have a Sungrow SH10.RT Inverter and a PylonTech Force H1 battery with 14.4 kWh updating frequently to the latest Home Assistant (> 2023.3). I try to thoroughly test features before releasing them, but I cannot test everything (e.g., backup capabilities, DO-related, ...)

The Modbus register mapping is based on two documents the Sungrow support sent me (my current version is v1.0.25 from 12.01.2023. The changelogs from .23 to .25 only mention added device codes (*RT-20, *-V112 and *-V122). I am not sure if I am allowed to share the files, but you can search for them using their names. Let me know in the github discussions, if there are newer versions available.

Communication.Protocol.of.Residential.Hybrid.Inverter_V1.0.23_EN
10.4 Communication Protocol_String Inverter_V1.1.36_EN.pdf

Please let me know if the integration also works with other Sungrow models.

Community-confirmed supported inverters (thank you for reporting!)

  • SH10RT (via home assistant community, brix29 Axel)
  • SH10RT-V112 (github, dzarth, ViktorReinhold)
  • SH5.0RT(home assistant community, ptC7H12 Paul)
  • SH8.0RT (github, lindehoff)
  • SH5K-30 (github, ajbatchelor)

partially working

  • SH5.RS (home assistant community, Danirb80) via WiNetS: register running_state is not available. Created workarounds using template sensors

6. Status and future work

  1. See #38 for some kind of a roadmap
  2. I included the registers, which are common between a wide range of Sungrow inverter models. There are many more registers in the Sungrow documents, which I left out, but I am happy to include them, if you need them. --> github discussions
  3. If you made a nice visualization - let us know! --> github discussions
  4. This is meant to be a simple, straightforward YAML-based integration. If you need more than this, I recommend having a look at the SunGather project: https://github.com/bohdan-s

7. Contribution

We are happy to share our experiences - feel encouraged to share yours with us, too!

If you have any questions, feature requests, found any bugs or have some hints how to update the documentation, a low-threshold way is to join the Discord Chat and just ask

Thanks to all the people, who are actively contributing to this project! Special thanks to @Louisbertelsmann, dylan09 and elektrinis for their efforts

sungrow-shx-inverter-modbus-home-assistant's People

Contributors

abredhauer avatar andi-blafasl avatar brettlynch123 avatar dst6se avatar dylan09 avatar dzarth avatar grandammor avatar hoellenwesen avatar housemaister avatar johschmitz avatar lapplandscohan avatar louisbertelsmann avatar mastameista avatar mkaiser avatar mmierke avatar stephan192 avatar tsopic avatar viktorreinhold avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.