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

This version

8.3.3

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.3.3.tar.gz (17.2 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.3.3-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.3.3.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.13.3 Linux/6.11.0-1014-azure

File hashes

Hashes for python_homewizard_energy-8.3.3.tar.gz
Algorithm Hash digest
SHA256 55aa8e8213a34d1effb3cdf272c68071ad0b4d308b8cdf0e869516525a1aa057
MD5 73f0710046eba9e8aaa1bb595c1813f6
BLAKE2b-256 cf69221f099505b94e1107226eec8dac3189056c71c5d2eedfafd9b2f4534437

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e77d8cad53d9f79c7891fe708522f79fe3cc5e629fb23519fd6a7d8148f9d5fa
MD5 f7f2ecdcf1bb3b16c6598c64b7fae92c
BLAKE2b-256 85407456df2709cf68685b17f50c0ea5dc48908ba72e2590fc1481b7718e75e5

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