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:

         # Get device information, like firmware version
        print(await api.device())

         # Get measurements, like energy or water usage
        data = await api.data()
        print(data.total_energy_import_kwh)

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


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.3.0b1.tar.gz (12.7 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.3.0b1-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-6.3.0b1.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1025-azure

File hashes

Hashes for python_homewizard_energy-6.3.0b1.tar.gz
Algorithm Hash digest
SHA256 86b1994db9773aaf12afd0e094738d942f1b1c844d43b182484d005e8306873d
MD5 a92c7726817b3f6122f28aa7537c2cd6
BLAKE2b-256 12b867434009ce770eb4e9667e3862e46da4a3813a1d9af6bee4a53bda90d16b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-6.3.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 136c6749d8859614ca4ab0f5575af03405d657c5521b25e9b4b314051aff0bea
MD5 52f76dc3c55a0a16c3281cb24c5423cc
BLAKE2b-256 8922ae680fe7e6e64bc4d6fb8d02f18b5289632c52d4585a0b323c80d098f3a7

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