# Enphase-API - The unofficial Enphase® SDK for Python
Enphase-API is an unofficial project providing an API wrapper and the documentation for Enphase®'s products and services.
This project is focusing primarily on the Enphase® "IQ Gateway" (formerly "IQ Envoy") system, the gateway for Enphase®'s IQ6, IQ7 and IQ8 Microinverters used on solar panels to convert Direct Current (DC) to Alternating Current (AC) to be directly consumed by the home.
> **Warning**
> This project currently predominantly consumes the same local API that the local Gateway web administration portal consumes and Enphase® may choose to change it in subsequent updates without warning.
## Installing Enphase-API
Enphase-API is available on PyPI:
```console
$ python -m pip install Enphase_API
```
## Documentation
The documentation for the wrapper and the API itself is at [Enphase-API Documentation GitHub](https://github.com/Matthew1471/Enphase-API/blob/main/Documentation/README.adoc)
## Copyright and License
### Code
Copyright ©️ 2023 Matthew1471
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
### Documentation
Copyright ©️ 2023 Matthew1471.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file [Enphase-API Documentation License](https://github.com/Matthew1471/Enphase-API/blob/main/Documentation/LICENSE.md).
## Authors
*Enphase-API* is led by [Matthew1471](https://github.com/Matthew1471) and may have received contributions from [other individuals](https://github.com/Matthew1471/Enphase-API/graphs/contributors) in GitHub's awesome community.
The project was initiated in 2022 by [Matthew1471](https://github.com/Matthew1471) after having his own solar installation and wanting to know when is the cheapest time to put on the dishwasher.
## Trademarks
Enphase®, Envoy® are trademarks of Enphase Energy®.
All trademarks are the property of their respective owners.
Any trademarks used in this project are used in a purely descriptive manner and to state compatability.
Raw data
{
"_id": null,
"home_page": "",
"name": "Enphase-API",
"maintainer": "Matthew1471! (https://Matthew1471.co.uk/Contact.php)",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Enphase,Envoy,Gateway,Solar,Microinverters,Production,Generation,Sun",
"author": "Matthew1471! (https://Matthew1471.co.uk/Contact.php)",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/af/08/6b76cdfef6d9d1a78b0120f1a43c9307e73b93943df26092f245a47b1237/Enphase-API-1.0.0.tar.gz",
"platform": null,
"description": "# Enphase-API - The unofficial Enphase\u00ae SDK for Python\r\n\r\nEnphase-API is an unofficial project providing an API wrapper and the documentation for Enphase\u00ae's products and services.\r\n\r\nThis project is focusing primarily on the Enphase\u00ae \"IQ Gateway\" (formerly \"IQ Envoy\") system, the gateway for Enphase\u00ae's IQ6, IQ7 and IQ8 Microinverters used on solar panels to convert Direct Current (DC) to Alternating Current (AC) to be directly consumed by the home.\r\n\r\n> **Warning**\r\n> This project currently predominantly consumes the same local API that the local Gateway web administration portal consumes and Enphase\u00ae may choose to change it in subsequent updates without warning.\r\n\r\n## Installing Enphase-API\r\n\r\nEnphase-API is available on PyPI:\r\n\r\n```console\r\n$ python -m pip install Enphase_API\r\n```\r\n\r\n## Documentation\r\n\r\nThe documentation for the wrapper and the API itself is at [Enphase-API Documentation GitHub](https://github.com/Matthew1471/Enphase-API/blob/main/Documentation/README.adoc)\r\n\r\n## Copyright and License\r\n\r\n### Code\r\n\r\nCopyright \u00a9\ufe0f 2023 Matthew1471\r\n\r\nThis program is free software: you can redistribute it and/or modify\r\nit under the terms of the GNU General Public License as published by\r\nthe Free Software Foundation, either version 3 of the License, or\r\n(at your option) any later version.\r\n\r\nThis program is distributed in the hope that it will be useful,\r\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\r\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r\nGNU General Public License for more details.\r\n\r\nYou should have received a copy of the GNU General Public License\r\nalong with this program. If not, see <https://www.gnu.org/licenses/>.\r\n\r\n### Documentation\r\n\r\nCopyright \u00a9\ufe0f 2023 Matthew1471.\r\n\r\nPermission is granted to copy, distribute and/or modify this document\r\nunder the terms of the GNU Free Documentation License, Version 1.3\r\nor any later version published by the Free Software Foundation;\r\nwith no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.\r\nA copy of the license is included in the file [Enphase-API Documentation License](https://github.com/Matthew1471/Enphase-API/blob/main/Documentation/LICENSE.md).\r\n\r\n## Authors\r\n\r\n*Enphase-API* is led by [Matthew1471](https://github.com/Matthew1471) and may have received contributions from [other individuals](https://github.com/Matthew1471/Enphase-API/graphs/contributors) in GitHub's awesome community.\r\nThe project was initiated in 2022 by [Matthew1471](https://github.com/Matthew1471) after having his own solar installation and wanting to know when is the cheapest time to put on the dishwasher.\r\n\r\n## Trademarks\r\n\r\nEnphase\u00ae, Envoy\u00ae are trademarks of Enphase Energy\u00ae.\r\n\r\nAll trademarks are the property of their respective owners.\r\n\r\nAny trademarks used in this project are used in a purely descriptive manner and to state compatability.\r\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"summary": "An unofficial Enphase\u00ae API that predominantly focuses on the local API.",
"version": "1.0.0",
"project_urls": {
"Bug Reports": "https://github.com/Matthew1471/Enphase-API/issues",
"Documentation": "https://github.com/Matthew1471/Enphase-API/tree/main/Documentation",
"Homepage": "https://github.com/Matthew1471/Enphase-API",
"Say Thanks!": "https://Matthew1471.co.uk/Contact.php",
"Source": "https://github.com/Matthew1471/Enphase-API"
},
"split_keywords": [
"enphase",
"envoy",
"gateway",
"solar",
"microinverters",
"production",
"generation",
"sun"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d7861e3823be2260c6a1686159b86d67580af7f8fcca1eaf9944e31f41ec106",
"md5": "9c0e284126bf9a22566dd69953930db9",
"sha256": "5db9880ce12f22b878b5529bda64cee146f77312231d34aabefe87270425b981"
},
"downloads": -1,
"filename": "Enphase_API-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c0e284126bf9a22566dd69953930db9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13692,
"upload_time": "2023-08-15T21:31:00",
"upload_time_iso_8601": "2023-08-15T21:31:00.269712Z",
"url": "https://files.pythonhosted.org/packages/1d/78/61e3823be2260c6a1686159b86d67580af7f8fcca1eaf9944e31f41ec106/Enphase_API-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "af086b76cdfef6d9d1a78b0120f1a43c9307e73b93943df26092f245a47b1237",
"md5": "a6d61ee0c69b1e7ad613d876578248de",
"sha256": "0d6b9ab5f372b5a77f9e1ff982558f2b232de346f55e68d842c5d6b9ffa75a69"
},
"downloads": -1,
"filename": "Enphase-API-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a6d61ee0c69b1e7ad613d876578248de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12269,
"upload_time": "2023-08-15T21:31:02",
"upload_time_iso_8601": "2023-08-15T21:31:02.212062Z",
"url": "https://files.pythonhosted.org/packages/af/08/6b76cdfef6d9d1a78b0120f1a43c9307e73b93943df26092f245a47b1237/Enphase-API-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-15 21:31:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Matthew1471",
"github_project": "Enphase-API",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "enphase-api"
}
JSON
