MIT License

项目介绍

mkaiser/Sungrow-SHx-Inverter-Modbus-Home-Assistant 是一个托管在 GitHub 上的开源项目,主要使用 Python 编写,采用 MIT License 许可证,目前获得 708 个 Star、159 次 Fork。

仓库全名
mkaiser/Sungrow-SHx-Inverter-Modbus-Home-Assistant
开源许可证
MIT License
Star 数
708
Fork 数
159
未关闭 Issue
5

README 摘要

An easy-to-use YAML-based integration for several Sungrow inverters for Home Assistant. 2026-11-07 "A real Home Assistant integration is coming" A Home Assistant integration to replace this YAML package is being built on the proper-ha-integration branch, and is targeted for December 2026. It keeps your entity ids, so your recorder history, statistics and dashboards carry on across the switch. Nothing changes for you…

完整内容见 GitHub 原始 README 或本页 。

常见问题

Sungrow-SHx-Inverter-Modbus-Home-Assistant 用什么语言开发?

主要使用 Python 编写,采用 MIT License 许可证,目前有 708 个 Star。

Sungrow-SHx-Inverter-Modbus-Home-Assistant 可以免费商用吗?

仓库采用 MIT License 许可证,可免费使用与修改,商业使用请遵守许可证条款(例如保留版权声明与许可声明)。

如何获取 Sungrow-SHx-Inverter-Modbus-Home-Assistant 的源码?

可以直接克隆仓库:git clone https://github.com/mkaiser/Sungrow-SHx-Inverter-Modbus-Home-Assistant.git,默认分支为 main;安装与运行步骤见仓库 README。

Sungrow-SHx-Inverter-Modbus-Home-Assistant 最近还在维护吗?

仓库最近一次更新为 1 周前,当前有 5 个未关闭 Issue;Star 数为 708,可作为社区活跃度的参考。

关于

GitHub 原始描述(英文)

Home Assistant integration for Sungrow inverters: SH*RT series (SH10RT), SHx.RS series (SH3.RS), SH*K series (SH4K6), SxT-series (S20T)

描述取自 GitHub 官方 API,保持仓库作者书写的原文。

简要分析

热度分
1113
价值分
480
活跃状态
活跃

语言占比

Python
Shell

Release

README

A PV array, an inverter, a battery and a car

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

Discord Chat

2026-11-07 “A real Home Assistant integration is coming”

A Home Assistant integration to replace this YAML package is being built on the proper-ha-integration branch, and is targeted for December 2026. It keeps your entity ids, so your recorder history, statistics and dashboards carry on across the switch. Nothing changes for you now: this package keeps working and is maintained until the integration has everything it has. The integration will support multiple inverters, meters, wallboxes, logger and iHomeManager units. A guide for the move comes with the release. If you are new, you can still install it like described in the README and quickly migrate later. Own a Sungrow device and want to help? Run the survey (#786).

2026-10-30 “A proper Home Assistant integration is coming: help with a device survey”

A HACS-based integration that will supersede this YAML package, with a migration path that keeps your entity IDs and history, is in development on the proper-ha-integration branch. Sungrow publishes no firmware changelogs, so it is built from surveys of real devices. If you can, run one and attach it to the survey issue #786, which explains how. Nothing changes for this YAML package.

2026-01-10 “small breaking change: new parameter in secrets.yaml”

With the newest version you need to add sungrow_modbus_wait_milliseconds to your secrets.yaml. Choose 5 ms for LAN, 20 or higher for WiNet-S. This hopefully fixes some stability issues with WiNet-S connections.

Sorry, I forgot to migrate this patch from the old version :/

2026-01-01 “Version 2 of modbus_sungrow.yaml”

After five years of continuous development with maintained backwards compatibility, this integration reached its limits. With the help of @theunknown86 and several others, this yaml-based integration was rebased on a better and more flexible codebase. It still remains yaml-based and not a “full” Home Assistant integration, but can now support different Sungrow models with their specific features (“quirks”). As long there is no “real integration” available, I will continue to maintain the new yaml file.

The migration to the new version requires a few manual steps, see migration guide.

The old version will be archived in the separate branch 2025-legacy. The “dev”-branch which was tested now by several users is now the “main”-branch.

Contents

1. Overview

This integration lets you gather sensor data and control the EMS (Energy Management System) of a wide range of Sungrow inverters, but is primary tested using a SH10RT attached via LAN cable. Other inverters like SHRS, SHRT-V112, SHRT-V112, SHK-20 are supported partially. There might be sensors or controls not be working. A battery is not required, but several sensors will not be available without one.

If available on your inverter, connect the inverter to the Home Assistant network using the inverters internal LAN port. The WiNet-S Ethernet port and the WiNet-S Wi-Fi also work, but sometimes slightly slower and with some restrictions imposed by Sungrow on which data is available.

SHxRT connections overview
SHxRT LAN connection

2. Documentation

3. Support

My personal time is quite limited, but there are several nice people here who like to help.

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

4. Visual impressions

Home Assistant's built-in Energy Dashboard
Default dashboard tab "Overview"
Default dashboard tab "Detail"
Default dashboard tab "EMS control"

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 available firmware and Home Assistant. I try to thoroughly test features before releasing them, but I cannot test everything (e.g., backup capabilities, DO-related, sungrow-battery-specifics …)

The Modbus register mapping is based on Sungrow’s official Modbus communication protocol specification. These documents are available from Sungrow support. They are only updated sporadically. If you have a newer version, let me know in the GitHub discussions!

TI_20251119_Communication_Protocol_of_Residential_Hybrid_Inverter_V1.1.11_EN.pdf
TI_20230117_Communication.Protocol.of.Residential.and.Commerical.PV.Grid-connected.Inverter_V1.1.53_EN.pdf

6. Status and future work

This is meant to be a simple, straight-forward YAML-based integration. If you need more than this, I recommend having a look at other projects:

7. Contributions

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.

9. Acknowledgements

Thanks to all the people, who are actively contributing to this project! Special thanks to Gnarfoz, Louisbertelsmann, dylan09, elektrinis and many more!

评论

暂无评论