mirror of
https://github.com/suaveolent/hoymiles-wifi.git
synced 2024-09-20 03:10:11 +00:00
update Readme.md
This commit is contained in:
parent
6d9ab0097f
commit
4af44907ac
54
README.md
54
README.md
@ -0,0 +1,54 @@
|
||||
# hoymiles-wifi
|
||||
|
||||
This Python library facilitates communication with Hoymiles HMS microinverters, specifically targeting the HMS-XXXXW-T2 series. A special thank you to [DennisOSRM](https://github.com/DennisOSRM) for the inspiration and codebase from the [hms-mqtt-publisher](https://github.com/DennisOSRM/hms-mqtt-publisher) repository.
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
$ pip install your-library-name
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
You can integrate the library into your own project, or simply use it in the command line.
|
||||
|
||||
### Command line:
|
||||
|
||||
```
|
||||
hoymiles-wifi
|
||||
```
|
||||
|
||||
This will retrieve the current inverter state.
|
||||
|
||||
### Python code
|
||||
|
||||
```
|
||||
from hoymiles_wifi.inverter import Inverter
|
||||
|
||||
inverter = Inverter('192.168.1.190')
|
||||
response = inverter.update_state()
|
||||
|
||||
if response:
|
||||
print(f"Inverter State: {response}")
|
||||
else:
|
||||
print("Unable to retrieve inverter state")
|
||||
```
|
||||
|
||||
## Note
|
||||
|
||||
Please be aware of the following considerations:
|
||||
|
||||
- No DTU Implementation: Unlike the original tool, this library
|
||||
retrieves information directly from the internal DTU of Hoymiles
|
||||
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.
|
Loading…
Reference in New Issue
Block a user