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

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-4.3.1.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.2.0-1019-azure

File hashes

Hashes for python_homewizard_energy-4.3.1.tar.gz
Algorithm Hash digest
SHA256 b0b6deabfbd14b7a35f7aff34b538d2e1406ed08c222d229dcc740c5cee0da58
MD5 5be16ecdedc777750f1035829af02725
BLAKE2b-256 b1bb6f58bc6371dc27e5962bd7027d252862c2e7285a48e1950fca7dab3f3ae6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-4.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f6892d17836578daa496d2c7790f2fdd08858d4649e1c345a688a8cc1a495982
MD5 27913ae80b51a5a0765027c5f1c2ee6a
BLAKE2b-256 9723aa34565bd721ed8629cdd2fcb786224f83ed341204fe9bd6b88c3f906c45

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