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 HomeWizardEnergyV1

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)

        # Example of getting raw telegram data
        telegram = await api.telegram()
        print(telegram)  # Raw P1 meter data

        # 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-9.1.1.tar.gz (17.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-9.1.1-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-9.1.1.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.3 Linux/6.11.0-1015-azure

File hashes

Hashes for python_homewizard_energy-9.1.1.tar.gz
Algorithm Hash digest
SHA256 05b11782afe90034830fbc9b0c34c1c63f12b79cfa137de9ac990d15196ce867
MD5 c3d47c93645e387b7268c82265b7796c
BLAKE2b-256 0b4c6b3d462cb4cfdfb0a09a17052a790671698676db836226ce9dfbb9536d25

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-9.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b7c2e8a092c0b79ae582425bbd2a92268b4b95f28fc8ab24dfa76d3d66975f0d
MD5 054259be0dc66eb8b9747c5e237de57b
BLAKE2b-256 62a58f50305b0152938fc09b89964e2bdc6a4545e3ea9cf476fb616f54c4c8a4

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