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-7.0.0.tar.gz (16.1 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-7.0.0-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-7.0.0.tar.gz
  • Upload date:
  • Size: 16.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.0 Linux/6.5.0-1025-azure

File hashes

Hashes for python_homewizard_energy-7.0.0.tar.gz
Algorithm Hash digest
SHA256 8b3e1e9bab7940f783f8a3afbd64ad57b2abb18ad746d1dc461a708557e2fda0
MD5 1910029258a9979d4b253ee0273d8865
BLAKE2b-256 b177e42fff3a6f444c659cd7eff06da9ae5bf3e94e54b0569d1d878d5688226a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-7.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 611257292dfaf07c1e08b727017952b26092ab8664cd03e5ef81fb88d6c88bea
MD5 27c1c5ccfceb66eb9bb09b764a82e75c
BLAKE2b-256 4a35e98947d97dfcc5f13b5f62c7f3ca0ac4cf0c44083ba31cbcc8614f1d24e6

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