{ "info": { "author": "Paul G\u00f6rgen", "author_email": "pypi@pgoergen.de", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8" ], "description": "=====\npyess\n=====\n\n------------------------------------------------------------------------------\nPython library for LG ESS Solar power converters with EnerVU app compatibility\n------------------------------------------------------------------------------\n\n\n.. image:: https://travis-ci.org/gluap/pyess.svg?branch=master\n :target: https://travis-ci.org/gluap/pyess?branch=master\n.. image:: https://coveralls.io/repos/github/gluap/pyess/badge.svg?branch=master\n :target: https://coveralls.io/github/gluap/pyess?branch=master\n\n\nPython library for communication with LG ESS power converter / energy storage devices for photovoltaic solar generators\n\nThis library is **not endorsed by the manufacturer**. It was written for lack of an official API. It should allow to\ndesign home automation around the current state of a solar energy system - e.g. turn appliances on when there is surplus\nsolar power. LG only offers access via a badly scriptable web page or alternatively via a proprietary app that - at least\non my phone - crashes at least twice for every successful startup.\n\n**Disclaimer:**\nFor this python module I reverse-engineered the communication between the *LG EnerVu Plus 1.2.3* Android\nApp and the Energy Storage / Inverter device, so there is some likelihood that it will work for devices that\ncan be accessed via that app. Nevertheless it looks like some of the interface is delivered by the ESS as html via the\nnetwork. Therefore it may be that not all commands work against all boxes. I only have customer-level access to my own\nbox, so this module only offers those parts of the API that are accessible to me as a customer. As far as I can tell\nthe installer has higher privileges and can fiddle with internal parameters of the system from what I saw him do when he\ninstalled the system.\n\n\nUsage\n=====\n\n\nCommand Line\n------------\nThis module comes with a rudimentary command line interface that allows for the following actions.\n\nFetch the device password\n.........................\n\nCaveat: **To fetch the device password you need to be connected to the devices wifi.** Once you are on the wifi you can\nrun the following to get the password. Write it down, it seems it is a static password per device::\n\n esscli --action get_password\n\nThe command assumes that the ess device is listening on ``192.168.23.1`` on its own wifi, in my setup it reproducibly\nchooses that IP.\n\nFind the esses on your network\n..............................\nGet a list of ESS devices on the local network (your home wifi, not the one of ess)::\n\n esscli --action list_ess\n\n\nFetch the state from ess as json\n................................\nfetch a bunch of json states as json and display the result on the command line::\n\n esscli --action get_state --password \n\nExamples for the data available:\n- current power from and to the grid and the battery\n- current voltage and power from both strings of the photovoltaic system independently\n- current ip address\n- details on grid power, battery state, daily and monthly statistics\n\nLog ess state into a graphite server\n....................................\nThis command will fetch the ``home`` and ``common`` info from ess every 10 seconds and log them against a graphite\nserver (assuming standard port and udp as protocol). Running this command requires the ess password to be passed on\nthe command line::\n\n esscli --action log_against_graphite --password --graphite \n\nAPI\n---\nFor the time being please use the docstrings in the code on https://github.com/gluap/pyess as documentation for the\nAPI. A good place to start is pyess/cli.py where you can find the implementation of the CLI. One thing available\nvia the API but not yet via the CLI is the data for the daily / weekly / monthly / yearly statistics graphs that can\nbe accessed via the EnerVu App.\n\n\nChangelog\n=========\n\n**2019-10-09 0.0.1**\n- More documentation\n- Initial commit for pypi relase\n\n**License**::\n\n Copyright (c) 2019 Paul G\u00f6rgen\n\n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n\n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/gluap/pyess", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pyess", "package_url": "https://pypi.org/project/pyess/", "platform": "", "project_url": "https://pypi.org/project/pyess/", "project_urls": { "Homepage": "https://github.com/gluap/pyess" }, "release_url": "https://pypi.org/project/pyess/0.0.2/", "requires_dist": [ "zeroconf", "requests", "graphyte" ], "requires_python": "", "summary": "Library for communicating with LG ESS solar power converters/batteries", "version": "0.0.2" }, "last_serial": 5964131, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "7e76d9fc6238927b257fe8fac0cf4981", "sha256": "da523d901c8e5f0374468f0c21c2f4c0b64730ae3d65a9358af67e58b7c98f2d" }, "downloads": -1, "filename": "pyess-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "7e76d9fc6238927b257fe8fac0cf4981", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8649, "upload_time": "2019-10-09T19:50:03", "url": "https://files.pythonhosted.org/packages/b0/a7/94c0602375aeb96224e3ba694be5274fac8da3c1860858627f1df3dd4cd4/pyess-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9797314feb9fa162750c13ccff6e9a3a", "sha256": "379961542ae02cfb7cc9ca4022174fb72e97e7a8f19e146540c62bb056e7456f" }, "downloads": -1, "filename": "pyess-0.0.1.tar.gz", "has_sig": false, "md5_digest": "9797314feb9fa162750c13ccff6e9a3a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7821, "upload_time": "2019-10-09T19:50:06", "url": "https://files.pythonhosted.org/packages/be/4e/40402f747dc2cd6c835163c9fef35ba80626db24547b3ba171b74cb08251/pyess-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "73de00a2a954ca5f99700c96a0a11631", "sha256": "becd8024ea7785b066e2bcd2a8f376bbfb69008b5fd8413f2245141c95650cfe" }, "downloads": -1, "filename": "pyess-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "73de00a2a954ca5f99700c96a0a11631", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8652, "upload_time": "2019-10-12T12:35:45", "url": "https://files.pythonhosted.org/packages/bc/4b/ef1bdb2f7691b7abc49c006822d11ee9ed672e78876ac5ff48da3dc4c73d/pyess-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "35e94ee96f8175b24952c39e2658b8a2", "sha256": "f1308b58589e9f2f14f6950d62dbf7583dee2a87cb4886c121ae831e2dff46f3" }, "downloads": -1, "filename": "pyess-0.0.2.tar.gz", "has_sig": false, "md5_digest": "35e94ee96f8175b24952c39e2658b8a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7826, "upload_time": "2019-10-12T12:35:46", "url": "https://files.pythonhosted.org/packages/98/3a/c45c477a0f7941d2bac85f9afb229003ed31afb6bb21dee605377fe8a9d1/pyess-0.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "73de00a2a954ca5f99700c96a0a11631", "sha256": "becd8024ea7785b066e2bcd2a8f376bbfb69008b5fd8413f2245141c95650cfe" }, "downloads": -1, "filename": "pyess-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "73de00a2a954ca5f99700c96a0a11631", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8652, "upload_time": "2019-10-12T12:35:45", "url": "https://files.pythonhosted.org/packages/bc/4b/ef1bdb2f7691b7abc49c006822d11ee9ed672e78876ac5ff48da3dc4c73d/pyess-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "35e94ee96f8175b24952c39e2658b8a2", "sha256": "f1308b58589e9f2f14f6950d62dbf7583dee2a87cb4886c121ae831e2dff46f3" }, "downloads": -1, "filename": "pyess-0.0.2.tar.gz", "has_sig": false, "md5_digest": "35e94ee96f8175b24952c39e2658b8a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7826, "upload_time": "2019-10-12T12:35:46", "url": "https://files.pythonhosted.org/packages/98/3a/c45c477a0f7941d2bac85f9afb229003ed31afb6bb21dee605377fe8a9d1/pyess-0.0.2.tar.gz" } ] }