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.0a1.tar.gz (15.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-8.0.0a1-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.0.0a1.tar.gz
  • Upload date:
  • Size: 15.7 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.0a1.tar.gz
Algorithm Hash digest
SHA256 e453805416fdbfcc4d57ff34f1263f9599ca8e0ad56c1f63024eebc5f49e2a61
MD5 eaa6b5f183c92da7c0793861cf65e9c7
BLAKE2b-256 5a2aecd01c886eb022f0b87a20de7add82b9170f5664426189720bd0108b0e98

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 ed9c08a5997196f2f9f4a099b7c729c343c7dc87122e1596de05f8a4c7a4ed95
MD5 d6246f07289306924970bc778c22d194
BLAKE2b-256 db5fc08f39c66e6cf7a95f764662c9b70c83991391cfedef8485a1ff9cd43206

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