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.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-9.0.0.tar.gz (17.3 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-9.0.0-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-9.0.0.tar.gz
  • Upload date:
  • Size: 17.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.2 Linux/6.8.0-1021-azure

File hashes

Hashes for python_homewizard_energy-9.0.0.tar.gz
Algorithm Hash digest
SHA256 af351c7ab416d8d2cb5bfee641eba5c5e577d987bbfebc09d6b525509cdee1a7
MD5 0d3c4234780decf8736270d6164b7942
BLAKE2b-256 aeb7bccbb057d33c1e0b77fe7993e95f39f987bbde1a84c640c3861282923803

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-9.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1ca4e99811c17c1f170fa421126c9be4590c455d5fb76d5b615bc6de24cede16
MD5 846eeace9fc32d557a8402247e654c52
BLAKE2b-256 a3c87b67c10a4f74e67f2bde78ad4d8c32699ea0e9967686cd6fa03f4f942135

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