Package: powerfox
Asynchronous Python client forPowerfoxdevices (poweropti's).AboutA python package with which you can read the data from apoweroptidevice.Powerfoxhas various poweropti devices on the market that you
can use with a power, heater and water meter.InstallationpipinstallpowerfoxDatasetsList of all your Poweropti devices linked to your account.Get information from a specific Poweropti device.CLICK HERE! to see all datasetsAll DevicesNameTypeDescriptiondevice_idStrThe unique identifier of the device.nameStrThe name of the device.date_addedDatetimeThe date the device was added to your account.main_deviceBoolIf the device is the main device.bidirectionalBoolIf the device is bidirectional.divisionIntThe division number of the device.Poweropti for Power metersNameTypeDescriptionoutdatedBoolIf the data from the device is outdated.timestampDatetimeThe timestamp of the data.powerIntThe amount of power used in W.energy_usageFloatThe amount of energy used (from the grid) in kWh.energy_returnFloatThe amount of energy returned (to the grid) in kWh.energy_usage_high_tariffFloatThe amount of energy used in kWh during high tariff.energy_usage_low_tariffFloatThe amount of energy used in kWh during low tariff.Poweropti for Water metersNameTypeDescriptionoutdatedBoolIf the data from the device is outdated.timestampDatetimeThe timestamp of the data.cold_waterFloatThe amount of cold water used in m³.warm_waterFloatThe amount of warm water used in m³.ExampleimportasynciofrompowerfoximportPowerfoxasyncdefmain()->None:"""Show example on using this package."""asyncwithPowerfox(username="EMAIL_ADDRESS",password="PASSWORD",)asclient:devices=awaitclient.all_devices()print(devices)if__name__=="__main__":asyncio.run(main())More examples can be found in theexamples folder.Class ParametersParametervalue TypeDescriptionusernamestrThe email address of your Powerfox account.passwordstrThe password of your Powerfox account.ContributingThis 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 ourcontribution guidelines.Thank you for being involved! :heart_eyes:Setting up development environmentThe simplest way to begin is by utilizing theDev Containerfeature 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 onPoetryas its dependency manager,
providing comprehensive management and control over project dependencies.You need at least:Python 3.11+PoetryInstall all packages, including all development requirements:poetryinstallPoetry creates by default an virtual environment where it installs all
necessary pip packages, to enter or exit the venv run the following commands:poetryshellexitSetup the pre-commit check, you must run this inside the virtual environment:pre-commitinstallNow you're all set to get started!As this repository uses thepre-commitframework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:poetryrunpre-commitrun--all-filesTo run just the Python tests:poetryrunpytestTo update the syrupy snapshot tests:poetryrunpytest--snapshot-updateLicenseMIT LicenseCopyright (c) 2024 Klaas SchoutePermission 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.