A Python library for interacting with Solarman (IGEN-Tech) v5 based Solar Data Loggers
Project description
pysolarmanv5
This is a Python module to interact with Solarman (IGEN-Tech) v5 based solar inverter data loggers. Modbus RTU frames can be encapsulated in the proprietary Solarman v5 protocol and requests sent to the data logger on port tcp/8899.
This module aims to simplify the Solarman v5 protocol, exposing both sync and async interfaces similar to that of the uModbus library.
Details of the Solarman v5 protocol have been based on the excellent work of Inverter-Data-Logger by XtheOne and others.
Documentation
pysolarmanv5 documentation is available on Read the Docs.
The Solarman V5 protocol is documented here.
Supported Devices
A user contributed list of supported devices is available here.
If you are unsure if your device is supported, please use the solarman_scan utility to find compatible data logging sticks on your local network.
Please note that the Solis S3-WIFI-ST data logging stick is NOT supported.
See GH issue #8 for further information.
Some Ethernet data logging sticks have native support Modbus TCP and therefore do not require pysolarmanv5. See GH issue #5 for further information.
Dependencies
- pysolarmanv5 requires Python 3.8 or greater.
- pysolarmanv5 depends on uModbus.
Installation
To install the latest stable version of pysolarmanv5 from PyPi, run:
pip install pysolarmanv5
To install the latest development version from git, run:
pip install git+https://github.com/jmccrohan/pysolarmanv5.git
Projects using pysolarmanv5
- StephanJoubert/home_assistant_solarman
- NosIreland/solismon3
- NosIreland/solismod
- jmccrohan/ha_pyscript_pysolarmanv5
- YodaDaCoda/hass-solarman-modbus
- schwatter/solarman_mqtt
- RonnyKempe/solismon
- toledobastos/solarman_battery_autocharge
- AndyTaylorTweet/solis2mqtt
- pixellos/codereinvented.automation.py
- cjgwhite/hass-solar
- imcfarla2003/solarconfig
- githubDante/deye-controller
- danfoster/solis
Contributions
Contributions welcome. Please raise any Issues / Pull Requests via Github.
License
pysolarmanv5 is licensed under the MIT License. Copyright (c) 2023 Jonathan McCrohan
Release history Release notifications | RSS feed
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
Hashes for pysolarmanv5-3.0.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5ab2ed08b15eef1bcc92b4f518375a94c933b7f30c52a22092df85bcfbed773f |
|
| MD5 | eb881a34d921dc5a8dc2d8337c57ad32 |
|
| BLAKE2b-256 | 05d59d8fd698c7e91486dd5787a4e43da56908ac60ebea3aeee317b75b28d367 |
