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.0a5.tar.gz (16.4 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.0a5-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.0.0a5.tar.gz
  • Upload date:
  • Size: 16.4 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.0a5.tar.gz
Algorithm Hash digest
SHA256 27147ef7f5b6b8f87945776cb6658d434a27a9d5fd3ab92dabdbd850d47aee3f
MD5 eab46d84e57d5eb5d70bd5df2cdac707
BLAKE2b-256 9a8f2c002aa55d852f19e429b824430d5bc6dd5f60dcfe4ea5cbf7c6b8f8c9c3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.0.0a5-py3-none-any.whl
Algorithm Hash digest
SHA256 1f277dead839db29ee915b4088c1212a7741c709958a8eb3169bcc8b7398fb12
MD5 7835e0d774cd1f9d28d3baccd4a161e2
BLAKE2b-256 ea4e1a8007332ae145ab65ed1a2354685deedc1aa03fde897683ce497ebabb1b

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