Skip to main content

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

Contributions

Contributions welcome. Please raise any Issues / Pull Requests via Github.

License

pysolarmanv5 is licensed under the MIT License. Copyright (c) 2024 Jonathan McCrohan

Release files for pysolarmanv5 3.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pysolarmanv5 3.0.6
File Size Uploaded
pysolarmanv5-3.0.6.tar.gz 14.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pysolarmanv5 3.0.6
File Interpreter ABI Platform
pysolarmanv5-3.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 29.6 kB

Release files / pysolarmanv5-3.0.6.tar.gz

Download URL pysolarmanv5-3.0.6.tar.gz
Size 14.6 kB
Tags Source
SHA-256 checksum
How to use checksums
ec3c6c03ec47bd0ee811f32ee4da272a28cc53141ab1113b5dbec55834c8afb5
BLAKE2b-256 checksum
How to use checksums
84f68140c8e6c3fef744c40039c8ef255ee4ca73c84100abed876e252c4fd5a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.8

Release files / pysolarmanv5-3.0.6-py3-none-any.whl

Download URL pysolarmanv5-3.0.6-py3-none-any.whl
Size 15.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9e38e47914c5b8bf44166dd74056040ec041b1d7c44ff2ce94ec192eeae9fc5d
BLAKE2b-256 checksum
How to use checksums
b4b553474eb876dfe9af0750ad63cf240439d863404e301ae13a52b0afbb3eb4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.8

Release history Release notifications | RSS feed

This release

3.0.6 This release

2 release files

3.0.5

2 release files

3.0.4

2 release files

3.0.3

2 release files

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.5.0

2 release files

2.4.0

2 release files

2.3.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page