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 interfaces similar to that of the uModbus library.

The following Modbus RTU Function Codes are supported:

Modbus Function Code Description pysolarmanv5 Function
3 Read Holding Registers read_holding_registers(register_addr, quantity)
4 Read Input Registers read_input_registers(register_addr, quantity)
6 Write Single Holding Register write_holding_register(register_addr, value)
16 Write Multiple Holding Registers write_multiple_holding_registers(register_addr, values)

Details of the Solarman v5 protocol have been based on the excellent work of Inverter-Data-Logger by XtheOne and others.

Dependencies

pysolarmanv5 requires Python 3.8 or greater. pysolarmanv5 depends on uModbus.

Installation

For the moment, run the steps below. I will publish to PyPI in due course.

  • git clone https://github.com/jmccrohan/pysolarmanv5.git
  • cd pysolarmanv5
  • pip install .
  • See example code in examples

Contributions

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

License

pysolarmanv5 is licensed under the MIT License. Copyright (c) 2021 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-2.3.0.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

pysolarmanv5-2.3.0-py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 3

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