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 HomeWizardEnergy

IP_ADDRESS = "192.168.1.123"


async def main():

    async with HomeWizardEnergy(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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-6.1.0.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1023-azure

File hashes

Hashes for python_homewizard_energy-6.1.0.tar.gz
Algorithm Hash digest
SHA256 6bba53db57a473d85fdc3d78b473b0f58210d94a252f30c12b6639cd85499519
MD5 67639300bb3f97d8c9131584dff5a9c6
BLAKE2b-256 90388f6987d90662dda873703aec8e2143f6514a30d105216924a326fa6ac6d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-6.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c8e00818a34c1a0ac155af8e4b78fe86428541c6db5ba0fc179530631d03217a
MD5 9e98eeb88163e6baee5ac027efcc6ed3
BLAKE2b-256 3f6afb4b4ae81b9a7abd5bd7ff3afc61081ef8b8cd79d197b369631ccc1dd0f5

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