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

API v1

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
        measurement = await api.measurement()
        print(measurement.energy_import_kwh)

        # Get all data and remap v1 data to new v2 structure
        print(await api.combined())

        # Turn on the Energy Socket outlet
        await api.state(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.0b3.tar.gz (16.5 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.0b3-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.0.0b3.tar.gz
  • Upload date:
  • Size: 16.5 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.0b3.tar.gz
Algorithm Hash digest
SHA256 106de33449a2cd60547d19c9d62835868ca1d20ff2c3571bfe9b82c8a5e5c6a0
MD5 9d093e4beb631817904696adb7e1287b
BLAKE2b-256 b2b82efd1997b08ab3cbde7f3c533b7e4f22aabd158c55daf75a5cda7bef3153

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.0.0b3-py3-none-any.whl
Algorithm Hash digest
SHA256 8b1709a2a16962876af8480ee14feda4b4aed5816242a474d589613a003b5363
MD5 05285ef3fcb885e9e1ceab59dd1ec8e2
BLAKE2b-256 905a8ce4119b2bb3fd6320ae144ac4b70b0b64976299368e5d4800e977986ebe

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