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.0.0

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.0.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.0-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 9bf3c9be83021df911680f072b6871cf1a04b1e9cc633b5ae1092329108f108f
MD5 5212f82e106e38cfec9e47b062b432b9
BLAKE2b-256 441425eaf7cab2e24dcc9daecfcbd4e79ebff7f972eb8ee893fed5d3642da6cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e3914ffff59a9763e465ceb778696d0a3e6f04226b3df883df120f762c9de5e
MD5 a96481d7be25c64f7f0f16967ace928d
BLAKE2b-256 01cd0c4802e4a8b900ec9679cfddd3f0b0a71924e5f3cd4aaf065378b544a219

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