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

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-5.0.0b1.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.18 Linux/6.5.0-1016-azure

File hashes

Hashes for python_homewizard_energy-5.0.0b1.tar.gz
Algorithm Hash digest
SHA256 f5a09f76a59af50f5b821c64aab81cf5a4f1dca8ef96bf9361385ab376e7a045
MD5 f8d8c947388da473fc7b2f1c0af232cf
BLAKE2b-256 eed8195f4d61c558e6208cfde268dbacf35ddc248333ff09b2c90d13c5dff832

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-5.0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 c69f30b27eec89bdd1d7848d5e448273dd3a49e52b393fe67ca3403ced170e17
MD5 bf128b3ad3ff8a6be26ff4f8813cd8fe
BLAKE2b-256 6fbca1ca464d26f93462db8c2db0e57ecee00cbeeb9f1a2151835e28a7c6d2e9

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