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.12 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-10.1.0.tar.gz (18.6 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-10.1.0-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-10.1.0.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.13.13 Linux/6.17.0-1013-azure

File hashes

Hashes for python_homewizard_energy-10.1.0.tar.gz
Algorithm Hash digest
SHA256 deecb94e62aea4fa8c09b91b2178649b8c4b540da15f8afeddc80bbf272fd1d7
MD5 72d0c54e9146b8e0ee6b2d34980f66c3
BLAKE2b-256 f3acdd9dab1f532b2654a6cb37b0e9becd8917853a614de689c3ceb87316ff99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-10.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd505d42263089b68155feb3aa6b37ec1e8e4bb554bdaf656a5b8a8b20134979
MD5 ebcbce88c3dfe4058b1b361be13b5269
BLAKE2b-256 bf61ad49e8c73500deecb240e33a16123e3eb5fd40a20b3fb9cac11feb82c88d

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