# 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](https://github.com/kellerza/sunsynk/raw/main/images/addon-install.png)
Below an example of the HomeAssistant Energy management dashboard using sensors from the Sunsynk.
![HASS Energy management](https://github.com/kellerza/sunsynk/raw/main/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`
Raw data
{
"_id": null,
"home_page": "https://kellerza.github.io/sunsynk/",
"name": "sunsynk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "sunsynk,deye,inverter,modbus,asyncio",
"author": "Johann Kellerman",
"author_email": "kellerza@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/83/fa/4c16c10e8c712d849f0b8bda454c1e003f2edf7cd74d3b4bfa066e1c6fef/sunsynk-0.6.4.tar.gz",
"platform": null,
"description": "# Deye/Sunsynk Inverters\n\nThis 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.\n\nThis code was developed on a [Sunsynk](https://www.sunsynk.org/) 5.5 kWh inverter.\n\n> DISCLAIMER: Use at your own risk! Especially when writing any settings.\n\n## Documentation\n\nRefer to [https://kellerza.github.io/sunsynk/](https://kellerza.github.io/sunsynk/)\n\n## Home Assistant Sunsynk Add-On\n\nFor 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.\n\n### Installation\n\n1. Add this repository to your HA Supervisor\n\n [![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)\n\n `https://github.com/kellerza/sunsynk`\n\n2. Install the Sunsynk Add-On from the **Add-On Store** and configure through the UI\n\n ![Install Sunsynk Addon](https://github.com/kellerza/sunsynk/raw/main/images/addon-install.png)\n\n\nBelow an example of the HomeAssistant Energy management dashboard using sensors from the Sunsynk.\n\n![HASS Energy management](https://github.com/kellerza/sunsynk/raw/main/images/energy.png)\n\n## Sunsynk Python Library\n[![PyPI version](https://badge.fury.io/py/sunsynk.svg)](https://pypi.org/project/sunsynk/)\n[![codecov](https://codecov.io/gh/kellerza/sunsynk/branch/main/graph/badge.svg?token=ILKRC5UTXI)](https://codecov.io/gh/kellerza/sunsynk)\n\nThe Python library is available through pip: `pip install sunsynk`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library to interface Deye/Sunsynk Hybrid Inverters",
"version": "0.6.4",
"project_urls": {
"Homepage": "https://kellerza.github.io/sunsynk/"
},
"split_keywords": [
"sunsynk",
"deye",
"inverter",
"modbus",
"asyncio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "90e086124e350818fb8da4afa43ab8b0bf58fea51328a3c719d9d83ec523ad35",
"md5": "a35b364ccd93ffe4cc028712266d7c6d",
"sha256": "656338ff28b38644d4b2299d63bd5917c511d7a2ffb963bc67b5cf189ba837f5"
},
"downloads": -1,
"filename": "sunsynk-0.6.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a35b364ccd93ffe4cc028712266d7c6d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 42847,
"upload_time": "2023-09-12T18:44:41",
"upload_time_iso_8601": "2023-09-12T18:44:41.469219Z",
"url": "https://files.pythonhosted.org/packages/90/e0/86124e350818fb8da4afa43ab8b0bf58fea51328a3c719d9d83ec523ad35/sunsynk-0.6.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83fa4c16c10e8c712d849f0b8bda454c1e003f2edf7cd74d3b4bfa066e1c6fef",
"md5": "74125949a9ba0656be2e20156003d440",
"sha256": "98f6ce4b875fe6c2a3f5e8a81790635a3be7e83854b6e7fc2991847522943fac"
},
"downloads": -1,
"filename": "sunsynk-0.6.4.tar.gz",
"has_sig": false,
"md5_digest": "74125949a9ba0656be2e20156003d440",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 63093,
"upload_time": "2023-09-12T18:44:43",
"upload_time_iso_8601": "2023-09-12T18:44:43.188373Z",
"url": "https://files.pythonhosted.org/packages/83/fa/4c16c10e8c712d849f0b8bda454c1e003f2edf7cd74d3b4bfa066e1c6fef/sunsynk-0.6.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-12 18:44:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sunsynk"
}