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.0.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.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-6.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 cbe035f935688c04f67016691ea959820a009788a35a70e69a09ee8220df5cc0
MD5 6e022c8b02b06d708f873615a8ca0f11
BLAKE2b-256 72253fbdf203fdbd5d9aaee4556efe45004090441856ef855420ccf213a31e65

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-6.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23e726bb12aed7ae02b16d08f25d3830017e8f8ffeb745bcc02039c3d802b630
MD5 3c0ab5f97f914fbd05d66a875d6eb9eb
BLAKE2b-256 5387d9de7c4290c054232d33a4cf3029bbef09d11601b51fad46bca52b3f97cd

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