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 HomeWizardEnergy

IP_ADDRESS = "192.168.1.123"


async def main():

    async with HomeWizardEnergy(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

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


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-6.3.0.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

python_homewizard_energy-6.3.0-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

Details for the file python_homewizard_energy-6.3.0.tar.gz.

File metadata

  • Download URL: python_homewizard_energy-6.3.0.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1025-azure

File hashes

Hashes for python_homewizard_energy-6.3.0.tar.gz
Algorithm Hash digest
SHA256 3997cb2895cb124479dbe2d428772f9868ba93c71bd79c9ae71d8258f8afdf95
MD5 a389fe43581ff325ff9d0fd22f7fc5a9
BLAKE2b-256 814674197718f16174e5ff95b773ec2ed5262fa6c9add276832b4f731ca9eeb2

See more details on using hashes here.

File details

Details for the file python_homewizard_energy-6.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for python_homewizard_energy-6.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1d9d32b51c572e9901be022c2f8644984613a0c0460a931f370a2ae49152b8e1
MD5 5fad4ffa2dca029f1c2008c6751ff403
BLAKE2b-256 e8d09deedfa6f8ec1a87871a3210dd83aa32d156e6b21f16dccc2d34f08ffdee

See more details on using hashes here.

Supported by

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