Skip to main content

Asynchronous Python client for the HomeWizard Energy

Project description

HomeWizard Energy: python-homewizard-energy

Asyncio package to communicate with HomeWizard Energy devices This package is aimed at basic control of the device. Initial setup and configuration is assumed to done with the official HomeWizard Energy app.

Testing Codecov Release

Usage

Instantiate the HomeWizard class and access the API.

For more details on the API see the API documentation for HomeWizard Energy on https://api-documentation.homewizard.com

Installation

python3 -m pip install python-homewizard-energy

Example

import asyncio
from homewizard_energy import HomeWizardEnergyV1V1

IP_ADDRESS = "192.168.1.123"


async def main():

    async with HomeWizardEnergyV1(host=IP_ADDRESS) as api:

         # Get device information, like firmware version
        print(await api.device())

         # Get measurements, like energy or water usage
        data = await api.data()
        print(data.total_energy_import_kwh)

         # Turn on the Energy Socket outlet
        await api.state_set(power_on=True)


asyncio.run(main())

Development and contribution

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Requirements

  • Python 3.10 or higher
  • Poetry

Installation and setup

poetry install
poetry shell
pre-commit install

You can now start developing. The pre-commit hooks will run automatically when you commit your changes. Please note that a failed pre-commit hook will prevent you from committing your changes. This is to make sure that the code is formatted correctly and that the tests pass.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_homewizard_energy-8.0.0a6.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_homewizard_energy-8.0.0a6-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file python_homewizard_energy-8.0.0a6.tar.gz.

File metadata

  • Download URL: python_homewizard_energy-8.0.0a6.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.13.1 Linux/6.5.0-1025-azure

File hashes

Hashes for python_homewizard_energy-8.0.0a6.tar.gz
Algorithm Hash digest
SHA256 b687493dce05056c71980ce41112bb1e2359df034712ce70e91005d52692fa4f
MD5 00e5e0cfdf6ca5ff4b69be6c97110954
BLAKE2b-256 89d163ffe1b31b4b22c67450d94416c6f6c6243b460160bc4232e19f8688fcbc

See more details on using hashes here.

File details

Details for the file python_homewizard_energy-8.0.0a6-py3-none-any.whl.

File metadata

File hashes

Hashes for python_homewizard_energy-8.0.0a6-py3-none-any.whl
Algorithm Hash digest
SHA256 43ad0e229187185079eaa5af51aedd9d3746ca69ad9c874051f91492e0ca8e59
MD5 dd54ae9330c37d00e6ab7f414e2cc607
BLAKE2b-256 df462bc79d9e309ee984444197a24af42d2474e63b9b1ffee02cb79ee8abd306

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page