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.0b1.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.0b1-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.0.0b1.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.0b1.tar.gz
Algorithm Hash digest
SHA256 c667b30fc4285178e612de7141648129e844ac5068b4e5ddd7067a1ae685fab4
MD5 11810ba7fb7d6317ea2bb9579897351d
BLAKE2b-256 e7bc68962b4c85fe74da75ef417fde6df791aaf24f0930d2fc07b707dcdc2f99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 cdb6ddf2f3fb952e2b0a6a7829a98251e01cc5c510cc8a7e23158c8db03d8d6f
MD5 430bbe60e3b908b19a61c38843c339d8
BLAKE2b-256 3573297a00f88739eed9a1f3fdb02c89aab1b32889deb246c2ce051d9ae3b461

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