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.3.0b2.tar.gz (12.7 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.3.0b2-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

Details for the file python_homewizard_energy-6.3.0b2.tar.gz.

File metadata

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

File hashes

Hashes for python_homewizard_energy-6.3.0b2.tar.gz
Algorithm Hash digest
SHA256 4361a0480ebe463c81ee4142afe2b340ac87a80e8d579c6aa417e33a98ee956d
MD5 cdddc29b64e3d791421df54c44910ed6
BLAKE2b-256 008e0c358dccba6cbf61f7af8eb18d172f544451e827e58c1582616948059f31

See more details on using hashes here.

File details

Details for the file python_homewizard_energy-6.3.0b2-py3-none-any.whl.

File metadata

File hashes

Hashes for python_homewizard_energy-6.3.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 28c6710ed78518817fc56dce95e1cb9a6041f18a81e6d7285fd93d533061f4e5
MD5 2cf17d5ddd535d131f2451cc4be3b6dc
BLAKE2b-256 c931a3d0b1734654fd1f805f19db3378cc30d7c86e392a33385a43146d3583d9

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