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-8.0.0a2.tar.gz (16.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-8.0.0a2-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.0.0a2.tar.gz
  • Upload date:
  • Size: 16.3 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.0a2.tar.gz
Algorithm Hash digest
SHA256 704f6e6b1d3053713128ffd569e958bcca69f66fba5f0a27b84d5c7205069ee1
MD5 2cf7bc64af38d846df312fcc3af45182
BLAKE2b-256 a6b3a004d2bc0268387847d68bc544de12217362f435a4fba7f7a9788c5b4835

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.0.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 a76dc87a891132a35798cc8c704adbe9fa46ed431defa19a97d69b50fdfcdddd
MD5 c8bdc39d17e76d26fe3008357d17aa06
BLAKE2b-256 b6fa30c8a6490a6eda5397760513694e63bf671daeaa2b83bec33581a4c673a0

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