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 HomeWizardEnergyV1

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)

        # Example of getting raw telegram data
        telegram = await api.telegram()
        print(telegram)  # Raw P1 meter data

        # 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.12 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-10.0.0.tar.gz (18.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-10.0.0-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-10.0.0.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.11 Linux/6.11.0-1018-azure

File hashes

Hashes for python_homewizard_energy-10.0.0.tar.gz
Algorithm Hash digest
SHA256 1bd79375c31968f8fed4a90ae6db867cdacfb6b156a85eda0332d9fd92703227
MD5 5ac23efbb17b11b8e405ba73fdfc20d7
BLAKE2b-256 e32f818f9488a65661a02ab91001627bb073614e3c6977710effe281298f8766

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-10.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66129b452b823f5262a98fc26d3a0adad60174fc0872f6f6fd58dfccafdfd1a6
MD5 2a7d355d9dcde52934ce3b94fa6c9851
BLAKE2b-256 2db4d63f2237cacfe5b62d38461dc89a25f6e662c8bc1084927082e1cb576e8b

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