Library to communicate with Hoymiles DTUs and HMS-XXXXW-2T microinverters via protobuf.
Go to file
2023-12-20 09:51:49 +01:00
hoymiles_wifi renamed proto names 2023-12-20 09:44:28 +01:00
.gitignore update gitignore 2023-12-06 17:26:22 +01:00
LICENSE Create LICENSE 2023-11-20 14:27:58 +01:00
MANIFEST.in begin refactor / adding new commands 2023-12-19 08:41:57 +01:00
README.md version bump to v0.0.4 2023-12-20 09:51:49 +01:00
setup.py version bump to v0.0.4 2023-12-20 09:51:49 +01:00

hoymiles-wifi

This Python library facilitates communication with Hoymiles HMS microinverters, specifically targeting the HMS-XXXXW-T2 series. A special thank you to DennisOSRM for the inspiration and codebase from the hms-mqtt-publisher repository.

Disclaimer: This library is not affiliated with Hoymiles. It is an independent project developed to provide tools for interacting with Hoymiles HMS-XXXXW-T2 series micro-inverters featuring integrated WiFi DTU. Any trademarks or product names mentioned are the property of their respective owners.

Installation

$ pip install hoymiles-wifi

Usage

You can integrate the library into your own project, or simply use it in the command line.

Command line:

hoymiles-wifi [-h] --host HOST <command>

commands: {get-real-data-new, get-real-data-hms, get-real-data, get-config, network-info, app-information-data,app-get-hist-power}

This will retrieve the current inverter state.

Python code

from hoymiles_wifi.inverter import Inverter

inverter = Inverter(<ip_address>)
response = inverter.<command>

if response:
    print(f"Inverter Response: {response}")
else:
    print("Unable to get response!")

Available functions

  • get_real_data_new: Retrieve real-time data
  • get_real_data_hms: Retrieve real-time data
  • get_real_data: Retrieve real-time data
  • get_config: Retrieve configuration information
  • network_info: Retrieve network information
  • app_information_data: Retrieve application information data
  • app_get_hist_power: Retrieve historical power data

Note

Please be aware of the following considerations:

  • No DTU Implementation: This library retrieves information directly from the internal DTU of Hoymiles Wifi inverters.

Caution

Use this library responsibly and be aware of potential risks. There are no guarantees provided, and any misuse or incorrect implementation may result in undesirable outcomes. Ensure that your inverter is not compromised during communication.

Known Limitations

Update Frequency: The library may experience limitations in fetching updates, potentially around twice per minute. The inverter firmware may enforce a mandatory wait period of approximately 30 seconds between requests.

Compatibility: While developed for the HMS-800W-T2 inverter, compatibility with other inverters from the series is untested at the time of writing. Exercise caution and conduct thorough testing if using with different inverter models.