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.3.2.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.2-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for python_homewizard_energy-8.3.2.tar.gz
Algorithm Hash digest
SHA256 589b3bc7d6f593c1b1f518217660a9b22ebdf31389f86fb28c6fabf862422e06
MD5 abf84ef6daca051df7a8de1e73411068
BLAKE2b-256 b2e16317289f983b95ff48ddd9e73ac6865bb884fda74835c408f3850c8c948f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e83e4d8a035fca2fbe0d111ba066de1a80965f61b02cc49809222928b06b2f34
MD5 512cf0ad906cf13bab0a820771f58698
BLAKE2b-256 b4febc9d6514ec0590e98374e53bf5e057932c22bd3df755d7de7539cff3ae27

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