Python library for connecting to Huawei SUN2000 Inverters over Modbus
This library implements an easy to use interface to locally connect to Huawei Solar devices over Modbus-TCP or Modbus-RTU following the 'Solar Inverter Modbus Interface Definitions' provided by Huawei.
It was primarily developed to add support for Huawei Solar inverters to Home Assistant, resulting in the following integration: wlcrs/huawei_solar.
Supported devices:
- SUN2000 inverters
- LUNA2000 batteries (when connected to SUN2000)
- EMMA
- SCharger (when connected to EMMA)
Features:
- Modbus-TCP support: connecting to the inverter via the SDongle, EMMA, or over the WiFi-AP (
SUN2000-<serial_no>) broadcasted by the inverter - Modbus-RTU support: connecting to the inverter via the RS485A1 and RS485B1 pins on the COM port
- Batched reading of Modbus registers and converting them into the correct units
- Reading Optimizer data via the specialized 'file' Modbus extension
- Writing to Modbus registers (mostly useful for setting battery parameters)
- Performing the login sequence to gain 'installer'-level access rights
Installation
This library is published on PyPI.
Basic usage
The library consists out of a low level interface implemented in modbus_client.py which implements all the Modbus-operations, and a high level interface in huawei_solar/devices which facilitates easy usage (primarily meant for the HA integration).
Using the high level 'Devices' interface
An example on how to read the most interesting registers from the inverter:
import asyncio
from huawei_solar import (
SUN2000Device,
create_device_instance,
create_tcp_client,
)
from huawei_solar import register_names as rn
async def test() -> None:
"""Run test."""
client = create_tcp_client(host="192.168.1.1", port=503)
device = await create_device_instance(client)
assert isinstance(device, SUN2000Device)
print(
await device.batch_update(
[
rn.INPUT_POWER,
rn.LINE_VOLTAGE_A_B,
rn.LINE_VOLTAGE_B_C,
rn.LINE_VOLTAGE_C_A,
]
),
)
if __name__ == "__main__":
asyncio.run(main())
This results in the following output being printed:
{'input_power': Result(value=82, unit='W'), 'line_voltage_A_B': Result(value=233.4, unit='V'), 'line_voltage_B_C': Result(value=0.0, unit='V'), 'line_voltage_C_A': Result(value=0.0, unit='V')}
Frequently asked questions
Q: the connection is interrupted a few seconds after connecting to the Huawei Device. How do I solve this?
A:: Huawei devices only support one connection at a time. If your connection is interrupted, this is typically because another device is trying to (re-)connect to it. Disable that device and try again.
Acknowledgements
The initial implementation of v1 was done by @Emilv2.
Subsequent development on v2 was done by @wlcrs.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file huawei_solar-3.0.7.tar.gz.
File metadata
- Download URL: huawei_solar-3.0.7.tar.gz
- Upload date:
- Size: 128.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
29976ea686ca53c055ef99c75e14ad3fe0c692b6bf8362a61695d67ab6db5304
|
|
| MD5 |
cde50dd2785cebddedfcbeb762a78501
|
|
| BLAKE2b-256 |
fa7ed7b5d07976c019e9f48b01b33dfe0975ff686463c2552a889367637a4ff2
|
Provenance
The following attestation bundles were made for huawei_solar-3.0.7.tar.gz:
Publisher:
pypi-publish.yml on wlcrs/huawei-solar-lib
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
huawei_solar-3.0.7.tar.gz -
Subject digest:
29976ea686ca53c055ef99c75e14ad3fe0c692b6bf8362a61695d67ab6db5304 - Sigstore transparency entry: 2420419666
- Sigstore integration time:
-
Permalink:
wlcrs/huawei-solar-lib@d7254ca4e75960c2013afb3bd345ef64b7d1985c -
Branch / Tag:
refs/tags/v3.0.7 - Owner: https://github.com/wlcrs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yml@d7254ca4e75960c2013afb3bd345ef64b7d1985c -
Trigger Event:
push
-
Statement type:
File details
Details for the file huawei_solar-3.0.7-py3-none-any.whl.
File metadata
- Download URL: huawei_solar-3.0.7-py3-none-any.whl
- Upload date:
- Size: 91.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0af1c091cf616f251010db760488be99d6521e05b414c43bf62e1322de42cb82
|
|
| MD5 |
f9223852ecdd09ad7ce9fd362f4b0e72
|
|
| BLAKE2b-256 |
dc0dc0abe17fc500a0248c35e742d76a9f7a098b3b02838548c5091eb5549cd0
|
Provenance
The following attestation bundles were made for huawei_solar-3.0.7-py3-none-any.whl:
Publisher:
pypi-publish.yml on wlcrs/huawei-solar-lib
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
huawei_solar-3.0.7-py3-none-any.whl -
Subject digest:
0af1c091cf616f251010db760488be99d6521e05b414c43bf62e1322de42cb82 - Sigstore transparency entry: 2420419845
- Sigstore integration time:
-
Permalink:
wlcrs/huawei-solar-lib@d7254ca4e75960c2013afb3bd345ef64b7d1985c -
Branch / Tag:
refs/tags/v3.0.7 - Owner: https://github.com/wlcrs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yml@d7254ca4e75960c2013afb3bd345ef64b7d1985c -
Trigger Event:
push
-
Statement type:
