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

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.0.0a3.tar.gz
  • Upload date:
  • Size: 16.5 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.0a3.tar.gz
Algorithm Hash digest
SHA256 078def058907a0f054be2c06221e40d04c00c240a7708307c2d68eb3274ea506
MD5 a76fee7a7423604c45903f80ef408ed6
BLAKE2b-256 63602ffc03ed846b8a25a2a82e9baf317a847d84cb49a42901e6970b0dda64e2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.0.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 4b292f51dcee273352d365441365e1fc35d49e3e14a317f89f4822552136c7bd
MD5 ad26ce7b0711cc801f723210b77d3e0c
BLAKE2b-256 d4abb93d8febe904d6ae4d3101adf1aece42075d38f54aa533476483f4cacb60

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