powerfox 0.2.0

Asynchronous Python client for the Powerfox devices

Asynchronous Python client for Powerfox devices (poweropti's).

About

A python package with which you can read the data from a poweropti device, via your Powerfox account (cloud polling). Powerfox has various poweropti devices on the market that you can use with a power, heat and water meter.

Installation

pip install powerfox

Datasets

• List of all your Poweropti devices linked to your account.
• Get information from a specific Poweropti device.

CLICK HERE! to see all datasets

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³.

Example

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.

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.

Thank you for being involved! :heart_eyes:

Setting up development environment

The simplest way to begin is by utilizing the Dev Container 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.

This Python project relies on Poetry as its dependency manager, providing comprehensive management and control over project dependencies.

You need at least:

• Python 3.11+
• Poetry

Installation

Install all packages, including all development requirements:

poetry install

Poetry creates by default an virtual environment where it installs all necessary pip packages.

Pre-commit

This repository uses the pre-commit framework, all changes are linted and tested with each commit. To setup the pre-commit check, run:

poetry run pre-commit install

And to run all checks and tests manually, use the following command:

poetry run pre-commit run --all-files

Testing

It uses pytest as the test framework. To run the tests:

poetry run pytest

To update the syrupy snapshot tests:

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.