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

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
        data = await api.data()
        print(data.total_energy_import_kwh)

         # Turn on the Energy Socket outlet
        await api.state_set(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-7.1.0b2.tar.gz (16.7 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-7.1.0b2-py3-none-any.whl (20.7 kB view details)

Uploaded Python 3

File details

Details for the file python_homewizard_energy-7.1.0b2.tar.gz.

File metadata

  • Download URL: python_homewizard_energy-7.1.0b2.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.1 Linux/6.5.0-1025-azure

File hashes

Hashes for python_homewizard_energy-7.1.0b2.tar.gz
Algorithm Hash digest
SHA256 d07837dd7e2aeb536d665ae2f324d53cf254003d7a9f8cd433479147877d396d
MD5 478807fc865eda8fdc1b6156237f390e
BLAKE2b-256 531b7bfd379804f63686b363dc1f9685d52503d124337d6936b59f5c289d4d3f

See more details on using hashes here.

File details

Details for the file python_homewizard_energy-7.1.0b2-py3-none-any.whl.

File metadata

File hashes

Hashes for python_homewizard_energy-7.1.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 173aa65d1d857a072e312894900f74447fdb21f0f65ed15563c75691434fed84
MD5 d98fdfe96e5648f47b16bc2141d1ee2a
BLAKE2b-256 a79b88b9369d2e52743f5e608f46b8070baac9dd66214d8a845fae5e240f7cd1

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