Metadata-Version: 2.4
Name: sunsynk
Version: 0.8.4
Summary: Library to interface Deye/Sunsynk Hybrid Inverters
Author-email: Johann Kellerman <kellerza@gmail.com>
License: Apache-2.0
Project-URL: Homepage, https://kellerza.github.io/sunsynk/
Keywords: sunsynk,deye,inverter,modbus,asyncio
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: attrs==25.3.0
Requires-Dist: cattrs==24.1.3
Requires-Dist: jmespath==1.0.1
Requires-Dist: mqtt-entity==0.0.4
Requires-Dist: prettytable==3.16.0
Requires-Dist: pymodbus[serial]==3.9.2
Requires-Dist: pyyaml==6.0.2
Provides-Extra: umodbus
Requires-Dist: async_modbus==0.2.2; extra == "umodbus"
Requires-Dist: connio==0.2.0; extra == "umodbus"
Requires-Dist: umodbus==1.0.4; extra == "umodbus"
Provides-Extra: solarman
Requires-Dist: pysolarmanv5==3.0.6; extra == "solarman"
Provides-Extra: addon
Requires-Dist: aiohttp==3.12.13; extra == "addon"

# Deye/Sunsynk Inverters

This repo enables access to Deye Hybrid Inverters & Deye branded inverters like Sunsynk through a Python 3 library. It also provides an Add-On that can be installed in the Home Assistant OS.

This code was developed on a [Sunsynk](https://www.sunsynk.org/) 5.5 kWh inverter.

> DISCLAIMER: Use at your own risk! Especially when writing any settings.

## Documentation

Refer to [https://kellerza.github.io/sunsynk/](https://kellerza.github.io/sunsynk/)

## Home Assistant Sunsynk Add-On

For the Add-On you require Home Assistant OS and a RS-485 adaptor to connect to your Sunsynk inverter. Sensors are read using the Modbus protocol and sent to a MQTT server. See [deployment options](https://kellerza.github.io/sunsynk/guide/deployment-options) for examples of tested hardware.

### Installation

1. Add this repository to your HA Supervisor

   [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fkellerza%2Fsunsynk)

   `https://github.com/kellerza/sunsynk`

2. Install the Sunsynk Add-On from the **Add-On Store** and configure through the UI

   ![Install Sunsynk Addon](//github.com/kellerza/sunsynk/raw/main/www/docs/images/addon-install.png)

Below an example of the HomeAssistant Energy management dashboard using sensors from the Sunsynk.

![HASS Energy management](//github.com/kellerza/sunsynk/raw/main/www/docs/images/energy.png)

## Sunsynk Python Library

[![PyPI version](https://badge.fury.io/py/sunsynk.svg)](https://pypi.org/project/sunsynk/)
[![codecov](https://codecov.io/gh/kellerza/sunsynk/branch/main/graph/badge.svg?token=ILKRC5UTXI)](https://codecov.io/gh/kellerza/sunsynk)

The Python library is available through pip: `pip install sunsynk`
