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:

        print(await api.device()) # Get device information, like firmware version
        print(await api.data()) # Get measurements, like power or water usage

        await api.state_set(power_on=True) # Turn on the Energy Socket outlet


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.0.0b1.tar.gz (11.8 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.0.0b1-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file python_homewizard_energy-6.0.0b1.tar.gz.

File metadata

  • Download URL: python_homewizard_energy-6.0.0b1.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.9.19 Linux/6.5.0-1021-azure

File hashes

Hashes for python_homewizard_energy-6.0.0b1.tar.gz
Algorithm Hash digest
SHA256 f42451d404314d28dc1ff8d31576ce9e5dfe69d2711ca52a71b4dc41cf589cde
MD5 0224c145727f8397a254b0d8a259854c
BLAKE2b-256 38608aef6dcc021adb0230d3bfdf8c3ee396d1484bcbaf4cb7c1c3ac50a5276d

See more details on using hashes here.

File details

Details for the file python_homewizard_energy-6.0.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for python_homewizard_energy-6.0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 e2dcfd236444aacde0232fbc5e992942172af8b6d05c8d0fc87af68f575036e1
MD5 6d7dc7624b7a6ccf689e7a03cb38b280
BLAKE2b-256 6baa51da447f5d38c6b6ba674c8620015bceb33205bc13764f6d72a0b58a72ad

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