Skip to main content

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

Contributions

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

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysolarmanv5-3.0.4.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

pysolarmanv5-3.0.4-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file pysolarmanv5-3.0.4.tar.gz.

File metadata

  • Download URL: pysolarmanv5-3.0.4.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for pysolarmanv5-3.0.4.tar.gz
Algorithm Hash digest
SHA256 67173530f24f58f6a763123393370d69935f7a7a1f2d3cd2523dffb894902153
MD5 50446d5b7bdc7fde5ac6aa07e9d89b08
BLAKE2b-256 dfdb4a4159af816732ffd5c378e1caf4f27df8f183bfe4956cc4afa1d1ad2df2

See more details on using hashes here.

File details

Details for the file pysolarmanv5-3.0.4-py3-none-any.whl.

File metadata

  • Download URL: pysolarmanv5-3.0.4-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for pysolarmanv5-3.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 602d29c5c6b960bbfc690f70e7e86117d509be16163c1ac051c70a98e4a4a152
MD5 91c2698ca803b5588adef9e1a621f8ca
BLAKE2b-256 f9c407576724b06ff060dadce66984c3b66e823acc22d91ccae9ec3837ee9132

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page