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.2.0.tar.gz (17.0 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.2.0-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.2.0.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.13.1 Linux/6.8.0-1020-azure

File hashes

Hashes for python_homewizard_energy-8.2.0.tar.gz
Algorithm Hash digest
SHA256 a4dcc705ecc6da89b01b44bc9d5083d85f65e4b8ca1a0f03d5572060d37d4339
MD5 4150417063288cabbab2e7edd209eee1
BLAKE2b-256 8891d97e586fc342ebf20b32aac06369dffc04171b385492291329cef146e07a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c8ebda000c0698b3c364c6b0ecc933609e22b4c3a1ad45e79e362eba60ef1511
MD5 bd5850020935630e0afa5fe99e8edf74
BLAKE2b-256 c2bb7899e3a986e60cbdf9a209e6267f41504e9051f46a8bc0524ac8c589a9ce

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