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

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
        data = await api.data()
        print(data.total_energy_import_kwh)

         # Turn on the Energy Socket outlet
        await api.state_set(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.0.0a4.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.0a4-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-8.0.0a4.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.0a4.tar.gz
Algorithm Hash digest
SHA256 633277fc4a59646a77f3b95d04bcfb92b1b3f56dd2ab110e579caff9ff1901aa
MD5 66114b2f3244687082509ceece012df8
BLAKE2b-256 9109cf246bd1e464de53e77ce1698fd61b15cba4e9a083af548eb1c3cd68e080

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-8.0.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 0b780f241403ed81f414b085af338d7e20e7b495e79342547ff4a5bcb357714b
MD5 d66999c55ab0642aef7da4ee84e15157
BLAKE2b-256 6490931be04c7183b4d6f0291612f357291f1f3d8de0027370882355ddb0fef1

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