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

API v1

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
        measurement = await api.measurement()
        print(measurement.energy_import_kwh)

        # Get all data and remap v1 data to new v2 structure
        print(await api.combined())

        # Turn on the Energy Socket outlet
        await api.state(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.1.0.tar.gz (16.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.1.0-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.1.0.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.13.1 Linux/6.8.0-1017-azure

File hashes

Hashes for python_homewizard_energy-8.1.0.tar.gz
Algorithm Hash digest
SHA256 f2e80569672cea9b68e0dbc9d8c9f536de10bae82490d87d452067203dd5ff3f
MD5 7af868be17a05aaa6b1d0dac0f3bb738
BLAKE2b-256 7ae28dda1b0b8bffeb0ebbf36e781fa0ba17046c06c02a0b48e82d0f660b17ce

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d3794f96223065ad1c3db314e50fcb36ae82de013c800c57b03b33bb0fdb3a1
MD5 0d48a4299b8f32d0a365a8761c59aa9d
BLAKE2b-256 23b52c7a787de9d447aff5fd6b164b9b4acce518940d4e859aa53d35b147e91b

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