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

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-5.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 7045405ed54dced85bd22471dae586c2efab89323ac238ac7ffccb324d98e6f9
MD5 7b19297ee26aeb06c1385e71b8b2d997
BLAKE2b-256 d62c6c2c477e01eb2f217793ddeaf9f680121bb143573c788175fb00bbd8d940

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aa07bb13b5dbc00df1a90a98badbe48a729cb625f9088f9ef6a9ea07036d9e8d
MD5 1e38aa9fdc505c910f0581f3b8982384
BLAKE2b-256 556e89cd2e1821f0bab6b0417702da41a022f946ddda47a0f92bf296e705a1e0

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