sunsynk


Namesunsynk JSON
Version 0.8.2 PyPI version JSON
download
home_pagehttps://kellerza.github.io/sunsynk/
SummaryLibrary to interface Deye/Sunsynk Hybrid Inverters
upload_time2025-01-10 19:55:32
maintainerNone
docs_urlNone
authorJohann Kellerman
requires_python>=3.9
licenseMIT
keywords sunsynk deye inverter modbus asyncio
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "sunsynk, deye, inverter, modbus, asyncio",
    "author": "Johann Kellerman",
    "author_email": "kellerza@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/41/a4/aef6071811c7f43657fda0640fa5eef56b236f06de6b829002e653ac22cd/sunsynk-0.8.2.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.8.2",
    "project_urls": {
        "Homepage": "https://kellerza.github.io/sunsynk/"
    },
    "split_keywords": [
        "sunsynk",
        " deye",
        " inverter",
        " modbus",
        " asyncio"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ef196e9ac50d2c7c9e13a71892a3667b97800cb8aa4eb45f403ee3cdabfd1318",
                "md5": "5eae8a5af2d5b92db342a37640e3663c",
                "sha256": "23a75ce7453596c9ad75c04a856c7b4f23488069339d98123a837675f2a6b46e"
            },
            "downloads": -1,
            "filename": "sunsynk-0.8.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5eae8a5af2d5b92db342a37640e3663c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 50673,
            "upload_time": "2025-01-10T19:55:30",
            "upload_time_iso_8601": "2025-01-10T19:55:30.076315Z",
            "url": "https://files.pythonhosted.org/packages/ef/19/6e9ac50d2c7c9e13a71892a3667b97800cb8aa4eb45f403ee3cdabfd1318/sunsynk-0.8.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "41a4aef6071811c7f43657fda0640fa5eef56b236f06de6b829002e653ac22cd",
                "md5": "3f462cc82e1b0f887e1847afd11ba2c7",
                "sha256": "a4ac78a07a840a2090592a3b803f05899fac7221984545513e24d8d2f1d6df4e"
            },
            "downloads": -1,
            "filename": "sunsynk-0.8.2.tar.gz",
            "has_sig": false,
            "md5_digest": "3f462cc82e1b0f887e1847afd11ba2c7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 70394,
            "upload_time": "2025-01-10T19:55:32",
            "upload_time_iso_8601": "2025-01-10T19:55:32.743211Z",
            "url": "https://files.pythonhosted.org/packages/41/a4/aef6071811c7f43657fda0640fa5eef56b236f06de6b829002e653ac22cd/sunsynk-0.8.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-10 19:55:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "sunsynk"
}
        
Elapsed time: 0.48704s