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

This version

7.0.1

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.0.1.tar.gz (16.2 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.0.1-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-7.0.1.tar.gz
  • Upload date:
  • Size: 16.2 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.0.1.tar.gz
Algorithm Hash digest
SHA256 5327198538c8c054562da454a4e359ff5b9112fe536cf12aa6c9d6b241547f17
MD5 a7445d68108e255ae5232d23bb41cc98
BLAKE2b-256 183acc23afababc0a70a577a8fd7175ef704c8eb2160df8649a6a9281c8d88c6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-7.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d9a1d9775e65d511a27815b04af46c40fddc3f8bb4b2ded0389c0fdc741a5211
MD5 068622526ee9885f1be4d2b21f41fd4d
BLAKE2b-256 e117477b1a6936f35a0de90403ebfe34707dee1fe7b5c2209d38a71ad53db3b5

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