<!-- Banner -->
<!-- PROJECT SHIELDS -->
[![GitHub Release][releases-shield]][releases]
[![Python Versions][python-versions-shield]][pypi]
![Project Stage][project-stage-shield]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE)
[![GitHub Activity][commits-shield]][commits-url]
[![PyPi Downloads][downloads-shield]][downloads-url]
[![GitHub Last Commit][last-commit-shield]][commits-url]
[![Open in Dev Containers][devcontainer-shield]][devcontainer]
[![Build Status][build-shield]][build-url]
[![Typing Status][typing-shield]][typing-url]
[![Maintainability][maintainability-shield]][maintainability-url]
[![Code Coverage][codecov-shield]][codecov-url]
Asynchronous Python client for [Powerfox][poweropti] devices (poweropti's).
## About
A python package with which you can read the data from a [poweropti][poweropti]
device. [Powerfox][powerfox] has various poweropti devices on the market that you
can use with a power, heater and water meter.
## Installation
```bash
pip install powerfox
```
## Datasets
- List of all your Poweropti devices linked to your account.
- Get information from a specific Poweropti device.
<details>
<summary>CLICK HERE! to see all datasets</summary>
### All Devices
| Name | Type | Description |
| :--- | :--- | :---------- |
| `device_id` | Str | The unique identifier of the device. |
| `name` | Str | The name of the device. |
| `date_added` | Datetime | The date the device was added to your account. |
| `main_device` | Bool | If the device is the main device. |
| `bidirectional` | Bool | If the device is bidirectional. |
| `division` | Int | The division number of the device. |
### Poweropti for Power meters
| Name | Type | Description |
| :--- | :--- | :---------- |
| `outdated` | Bool | If the data from the device is outdated. |
| `timestamp` | Datetime | The timestamp of the data. |
| `power` | Int | The amount of power used in W. |
| `energy_usage` | Float | The amount of energy used (from the grid) in kWh. |
| `energy_return` | Float | The amount of energy returned (to the grid) in kWh. |
| `energy_usage_high_tariff` | Float | The amount of energy used in kWh during high tariff. |
| `energy_usage_low_tariff` | Float | The amount of energy used in kWh during low tariff. |
### Poweropti for Water meters
| Name | Type | Description |
| :--- | :--- | :---------- |
| `outdated` | Bool | If the data from the device is outdated. |
| `timestamp` | Datetime | The timestamp of the data. |
| `cold_water` | Float | The amount of cold water used in m³. |
| `warm_water` | Float | The amount of warm water used in m³. |
</details>
### Example
```python
import asyncio
from powerfox import Powerfox
async def main() -> None:
"""Show example on using this package."""
async with Powerfox(
username="EMAIL_ADDRESS",
password="PASSWORD",
) as client:
devices = await client.all_devices()
print(devices)
if __name__ == "__main__":
asyncio.run(main())
```
More examples can be found in the [examples folder](./examples/).
### Class Parameters
| Parameter | value Type | Description |
| :-------- | :--------- | :---------- |
| `username` | `str` | The email address of your Powerfox account. |
| `password` | `str` | The password of your Powerfox account. |
## Contributing
This is an active open-source project. We are always open to people who want to
use the code or contribute to it.
We've set up a separate document for our
[contribution guidelines](CONTRIBUTING.md).
Thank you for being involved! :heart_eyes:
## Setting up development environment
The simplest way to begin is by utilizing the [Dev Container][devcontainer]
feature of Visual Studio Code or by opening a CodeSpace directly on GitHub.
By clicking the button below you immediately start a Dev Container in Visual Studio Code.
[![Open in Dev Containers][devcontainer-shield]][devcontainer]
This Python project relies on [Poetry][poetry] as its dependency manager,
providing comprehensive management and control over project dependencies.
You need at least:
- Python 3.11+
- [Poetry][poetry-install]
Install all packages, including all development requirements:
```bash
poetry install
```
Poetry creates by default an virtual environment where it installs all
necessary pip packages, to enter or exit the venv run the following commands:
```bash
poetry shell
exit
```
Setup the pre-commit check, you must run this inside the virtual environment:
```bash
pre-commit install
```
*Now you're all set to get started!*
As this repository uses the [pre-commit][pre-commit] framework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:
```bash
poetry run pre-commit run --all-files
```
To run just the Python tests:
```bash
poetry run pytest
```
To update the syrupy snapshot tests:
```bash
poetry run pytest --snapshot-update
```
## License
MIT License
Copyright (c) 2024 Klaas Schoute
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
<!-- LINKS FROM PLATFORM -->
[powerfox]: https://www.powerfox.energy
[poweropti]: https://shop.powerfox.energy/collections/frontpage
<!-- MARKDOWN LINKS & IMAGES -->
[build-shield]: https://github.com/klaasnicolaas/python-powerfox/actions/workflows/tests.yaml/badge.svg
[build-url]: https://github.com/klaasnicolaas/python-powerfox/actions/workflows/tests.yaml
[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-powerfox/branch/main/graph/badge.svg?token=GWI54W3CG9
[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-powerfox
[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-powerfox.svg
[commits-url]: https://github.com/klaasnicolaas/python-powerfox/commits/main
[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-powerfox
[downloads-shield]: https://img.shields.io/pypi/dm/powerfox
[downloads-url]: https://pypistats.org/packages/powerfox
[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-powerfox.svg
[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-powerfox.svg
[maintainability-shield]: https://api.codeclimate.com/v1/badges/a036b3dc5a9656137de2/maintainability
[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-powerfox/maintainability
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[pypi]: https://pypi.org/project/powerfox/
[python-versions-shield]: https://img.shields.io/pypi/pyversions/powerfox
[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-powerfox.svg
[releases]: https://github.com/klaasnicolaas/python-powerfox/releases
[typing-shield]: https://github.com/klaasnicolaas/python-powerfox/actions/workflows/typing.yaml/badge.svg
[typing-url]: https://github.com/klaasnicolaas/python-powerfox/actions/workflows/typing.yaml
[poetry-install]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org
[pre-commit]: https://pre-commit.com
Raw data
{
"_id": null,
"home_page": "https://github.com/klaasnicolaas/python-powerfox",
"name": "powerfox",
"maintainer": "Klaas Schoute",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "hello@student-techlife.com",
"keywords": "powerfox,api,async,client",
"author": "Klaas Schoute",
"author_email": "hello@student-techlife.com",
"download_url": "https://files.pythonhosted.org/packages/07/bc/c6772dc3c3f2fe8e62c0dd6c44be7424c5974274d3c631af630e8368d3e5/powerfox-0.1.0.tar.gz",
"platform": null,
"description": "<!-- Banner -->\n\n\n<!-- PROJECT SHIELDS -->\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE)\n\n[![GitHub Activity][commits-shield]][commits-url]\n[![PyPi Downloads][downloads-shield]][downloads-url]\n[![GitHub Last Commit][last-commit-shield]][commits-url]\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\n[![Build Status][build-shield]][build-url]\n[![Typing Status][typing-shield]][typing-url]\n[![Maintainability][maintainability-shield]][maintainability-url]\n[![Code Coverage][codecov-shield]][codecov-url]\n\n\nAsynchronous Python client for [Powerfox][poweropti] devices (poweropti's).\n\n## About\n\nA python package with which you can read the data from a [poweropti][poweropti]\ndevice. [Powerfox][powerfox] has various poweropti devices on the market that you\ncan use with a power, heater and water meter.\n\n## Installation\n\n```bash\npip install powerfox\n```\n\n## Datasets\n\n- List of all your Poweropti devices linked to your account.\n- Get information from a specific Poweropti device.\n\n<details>\n <summary>CLICK HERE! to see all datasets</summary>\n\n### All Devices\n\n| Name | Type | Description |\n| :--- | :--- | :---------- |\n| `device_id` | Str | The unique identifier of the device. |\n| `name` | Str | The name of the device. |\n| `date_added` | Datetime | The date the device was added to your account. |\n| `main_device` | Bool | If the device is the main device. |\n| `bidirectional` | Bool | If the device is bidirectional. |\n| `division` | Int | The division number of the device. |\n\n### Poweropti for Power meters\n\n| Name | Type | Description |\n| :--- | :--- | :---------- |\n| `outdated` | Bool | If the data from the device is outdated. |\n| `timestamp` | Datetime | The timestamp of the data. |\n| `power` | Int | The amount of power used in W. |\n| `energy_usage` | Float | The amount of energy used (from the grid) in kWh. |\n| `energy_return` | Float | The amount of energy returned (to the grid) in kWh. |\n| `energy_usage_high_tariff` | Float | The amount of energy used in kWh during high tariff. |\n| `energy_usage_low_tariff` | Float | The amount of energy used in kWh during low tariff. |\n\n### Poweropti for Water meters\n\n| Name | Type | Description |\n| :--- | :--- | :---------- |\n| `outdated` | Bool | If the data from the device is outdated. |\n| `timestamp` | Datetime | The timestamp of the data. |\n| `cold_water` | Float | The amount of cold water used in m\u00b3. |\n| `warm_water` | Float | The amount of warm water used in m\u00b3. |\n</details>\n\n### Example\n\n```python\nimport asyncio\n\nfrom powerfox import Powerfox\n\n\nasync def main() -> None:\n \"\"\"Show example on using this package.\"\"\"\n async with Powerfox(\n username=\"EMAIL_ADDRESS\",\n password=\"PASSWORD\",\n ) as client:\n devices = await client.all_devices()\n print(devices)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\nMore examples can be found in the [examples folder](./examples/).\n\n### Class Parameters\n\n| Parameter | value Type | Description |\n| :-------- | :--------- | :---------- |\n| `username` | `str` | The email address of your Powerfox account. |\n| `password` | `str` | The password of your Powerfox account. |\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThe simplest way to begin is by utilizing the [Dev Container][devcontainer]\nfeature of Visual Studio Code or by opening a CodeSpace directly on GitHub.\nBy clicking the button below you immediately start a Dev Container in Visual Studio Code.\n\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\nThis Python project relies on [Poetry][poetry] as its dependency manager,\nproviding comprehensive management and control over project dependencies.\n\nYou need at least:\n\n- Python 3.11+\n- [Poetry][poetry-install]\n\nInstall all packages, including all development requirements:\n\n```bash\npoetry install\n```\n\nPoetry creates by default an virtual environment where it installs all\nnecessary pip packages, to enter or exit the venv run the following commands:\n\n```bash\npoetry shell\nexit\n```\n\nSetup the pre-commit check, you must run this inside the virtual environment:\n\n```bash\npre-commit install\n```\n\n*Now you're all set to get started!*\n\nAs this repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. You can run all checks and tests\nmanually, using the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\nTo run just the Python tests:\n\n```bash\npoetry run pytest\n```\n\nTo update the syrupy snapshot tests:\n\n```bash\npoetry run pytest --snapshot-update\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2024 Klaas Schoute\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\n<!-- LINKS FROM PLATFORM -->\n[powerfox]: https://www.powerfox.energy\n[poweropti]: https://shop.powerfox.energy/collections/frontpage\n\n\n<!-- MARKDOWN LINKS & IMAGES -->\n[build-shield]: https://github.com/klaasnicolaas/python-powerfox/actions/workflows/tests.yaml/badge.svg\n[build-url]: https://github.com/klaasnicolaas/python-powerfox/actions/workflows/tests.yaml\n[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-powerfox/branch/main/graph/badge.svg?token=GWI54W3CG9\n[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-powerfox\n[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-powerfox.svg\n[commits-url]: https://github.com/klaasnicolaas/python-powerfox/commits/main\n[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode\n[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-powerfox\n[downloads-shield]: https://img.shields.io/pypi/dm/powerfox\n[downloads-url]: https://pypistats.org/packages/powerfox\n[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-powerfox.svg\n[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-powerfox.svg\n[maintainability-shield]: https://api.codeclimate.com/v1/badges/a036b3dc5a9656137de2/maintainability\n[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-powerfox/maintainability\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg\n[pypi]: https://pypi.org/project/powerfox/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/powerfox\n[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-powerfox.svg\n[releases]: https://github.com/klaasnicolaas/python-powerfox/releases\n[typing-shield]: https://github.com/klaasnicolaas/python-powerfox/actions/workflows/typing.yaml/badge.svg\n[typing-url]: https://github.com/klaasnicolaas/python-powerfox/actions/workflows/typing.yaml\n\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "description",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/klaasnicolaas/python-powerfox/issues",
"Changelog": "https://github.com/klaasnicolaas/python-powerfox/releases",
"Documentation": "https://github.com/klaasnicolaas/python-powerfox",
"Homepage": "https://github.com/klaasnicolaas/python-powerfox",
"Repository": "https://github.com/klaasnicolaas/python-powerfox"
},
"split_keywords": [
"powerfox",
"api",
"async",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e9efe33297c3b9c99587b8b0245dbc1fab26d5cdf9e9c3ff6d870e175c73049",
"md5": "9fb5c4f10314a5aa973975298c94f18a",
"sha256": "74c92440c0584189dc15cb56eb968c9e29d096369e2ba826cc951906b13617cb"
},
"downloads": -1,
"filename": "powerfox-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9fb5c4f10314a5aa973975298c94f18a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 8407,
"upload_time": "2024-02-06T17:40:33",
"upload_time_iso_8601": "2024-02-06T17:40:33.736030Z",
"url": "https://files.pythonhosted.org/packages/2e/9e/fe33297c3b9c99587b8b0245dbc1fab26d5cdf9e9c3ff6d870e175c73049/powerfox-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "07bcc6772dc3c3f2fe8e62c0dd6c44be7424c5974274d3c631af630e8368d3e5",
"md5": "bc39272037101cc414e2800f8ce13194",
"sha256": "a9f88127a885d0baa6bda2a33c672fe492fb2fef95911f87b86b9f6d769caf91"
},
"downloads": -1,
"filename": "powerfox-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "bc39272037101cc414e2800f8ce13194",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 7741,
"upload_time": "2024-02-06T17:40:39",
"upload_time_iso_8601": "2024-02-06T17:40:39.178236Z",
"url": "https://files.pythonhosted.org/packages/07/bc/c6772dc3c3f2fe8e62c0dd6c44be7424c5974274d3c631af630e8368d3e5/powerfox-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-06 17:40:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "klaasnicolaas",
"github_project": "python-powerfox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "powerfox"
}
JSON
