PyFronius


NamePyFronius JSON
Version 0.7.3 PyPI version JSON
download
home_pagehttps://github.com/nielstron/pyfronius/
SummaryAutomated JSON API based communication with Fronius Symo
upload_time2024-02-03 13:32:38
maintainer
docs_urlNone
authorNiels Mündler, Gerrit Beine
requires_python>=3
licenseMIT
keywords python fronius json api solar photovoltaics pv
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            # PyFronius - a very basic Fronius python bridge
[![Build Status](https://app.travis-ci.com/nielstron/pyfronius.svg?branch=master)](https://app.travis-ci.com/nielstron/pyfronius)
[![Coverage Status](https://coveralls.io/repos/github/nielstron/pyfronius/badge.svg?branch=master)](https://coveralls.io/github/nielstron/pyfronius?branch=master)
 [![PyPI version](https://badge.fury.io/py/PyFronius.svg)](https://pypi.org/project/pyfronius/)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/PyFronius.svg)
 [![PyPI - Status](https://img.shields.io/pypi/status/PyFronius.svg)](https://pypi.org/project/pyfronius/)

A package that connects to a Fronius device in the local network and provides data
that is provided via the JSON API of the Fronius.
This includes the grid consumption, grid return, photovoltaic production
and many more details on the status of the local power supply.

> This package is looking for maintainers. I do not own a Fronius device anymore and cannot test the package.
> If you are interested in maintaining this package, please contact me.

## Features 

The package supports the following data provided by Fronius devices:

- Power Flow (System scope)
- Meter (System and Device scope)
- Inverter (System and Device scope)
- Storage (System and Device scope, Experimental) 
- Active Devices
- Logger Information
- Inverter Information

The package currently supportes the Fronius API V1 and V0
and aims to support as many different device types as possible (Hybrid, GEN24,...).

I also know there are better scripts, yet they are not on pypi which is necessary
for using them with [Home Assistant](https://www.home-assistant.io)

## Contributing

Support may be enhanced based on the official documentation ([V1](https://www.fronius.com/~/downloads/Solar%20Energy/Operating%20Instructions/42%2C0410%2C2012.pdf), [V0](https://www.fronius.com/~/downloads/Solar%20Energy/Operating%20Instructions/42,0410,2011.pdf)).
Pull requests are very welcome.

If you own a Fronius device, feel free to provide us with raw data returned
by fetching the API endpoints manually.
Data from systems featuring Ohmpilots and Storages are much welcomed as we
have no data for testing these so far.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nielstron/pyfronius/",
    "name": "PyFronius",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": "",
    "keywords": "python fronius json api solar photovoltaics pv",
    "author": "Niels M\u00fcndler, Gerrit Beine",
    "author_email": "n.muendler@web.de, mail@gerritbeine.de",
    "download_url": "https://files.pythonhosted.org/packages/86/43/e50881d07eab3e975455fb60455486476bb1cebcd6b69372e253bf76356a/PyFronius-0.7.3.tar.gz",
    "platform": null,
    "description": "# PyFronius - a very basic Fronius python bridge\n[![Build Status](https://app.travis-ci.com/nielstron/pyfronius.svg?branch=master)](https://app.travis-ci.com/nielstron/pyfronius)\n[![Coverage Status](https://coveralls.io/repos/github/nielstron/pyfronius/badge.svg?branch=master)](https://coveralls.io/github/nielstron/pyfronius?branch=master)\n [![PyPI version](https://badge.fury.io/py/PyFronius.svg)](https://pypi.org/project/pyfronius/)\n ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/PyFronius.svg)\n [![PyPI - Status](https://img.shields.io/pypi/status/PyFronius.svg)](https://pypi.org/project/pyfronius/)\n\nA package that connects to a Fronius device in the local network and provides data\nthat is provided via the JSON API of the Fronius.\nThis includes the grid consumption, grid return, photovoltaic production\nand many more details on the status of the local power supply.\n\n> This package is looking for maintainers. I do not own a Fronius device anymore and cannot test the package.\n> If you are interested in maintaining this package, please contact me.\n\n## Features \n\nThe package supports the following data provided by Fronius devices:\n\n- Power Flow (System scope)\n- Meter (System and Device scope)\n- Inverter (System and Device scope)\n- Storage (System and Device scope, Experimental) \n- Active Devices\n- Logger Information\n- Inverter Information\n\nThe package currently supportes the Fronius API V1 and V0\nand aims to support as many different device types as possible (Hybrid, GEN24,...).\n\nI also know there are better scripts, yet they are not on pypi which is necessary\nfor using them with [Home Assistant](https://www.home-assistant.io)\n\n## Contributing\n\nSupport may be enhanced based on the official documentation ([V1](https://www.fronius.com/~/downloads/Solar%20Energy/Operating%20Instructions/42%2C0410%2C2012.pdf), [V0](https://www.fronius.com/~/downloads/Solar%20Energy/Operating%20Instructions/42,0410,2011.pdf)).\nPull requests are very welcome.\n\nIf you own a Fronius device, feel free to provide us with raw data returned\nby fetching the API endpoints manually.\nData from systems featuring Ohmpilots and Storages are much welcomed as we\nhave no data for testing these so far.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Automated JSON API based communication with Fronius Symo",
    "version": "0.7.3",
    "project_urls": {
        "Homepage": "https://github.com/nielstron/pyfronius/"
    },
    "split_keywords": [
        "python",
        "fronius",
        "json",
        "api",
        "solar",
        "photovoltaics",
        "pv"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8643e50881d07eab3e975455fb60455486476bb1cebcd6b69372e253bf76356a",
                "md5": "10acd4cc2f4e9d9effd8bae8190dc96e",
                "sha256": "d8b8eab2494a01b27acedbbf591529242822b50fabcb3c6107f1af1239d2f9aa"
            },
            "downloads": -1,
            "filename": "PyFronius-0.7.3.tar.gz",
            "has_sig": false,
            "md5_digest": "10acd4cc2f4e9d9effd8bae8190dc96e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 12581,
            "upload_time": "2024-02-03T13:32:38",
            "upload_time_iso_8601": "2024-02-03T13:32:38.908067Z",
            "url": "https://files.pythonhosted.org/packages/86/43/e50881d07eab3e975455fb60455486476bb1cebcd6b69372e253bf76356a/PyFronius-0.7.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-03 13:32:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nielstron",
    "github_project": "pyfronius",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "tox": true,
    "lcname": "pyfronius"
}
        
Elapsed time: 2.76645s