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

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_homewizard_energy-6.2.0.tar.gz
  • Upload date:
  • Size: 12.6 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.2.0.tar.gz
Algorithm Hash digest
SHA256 adaa073ffb9fe4d53ce7e5a9e7bc670aca8ec1f9d8f26ac5839e992aa3c8ee5e
MD5 e1fdabe242a2238272ec72ba36f0dad7
BLAKE2b-256 ed100164b18a04e35b4501f61b9ae54d68f93c9151ca34ea66f76946726f3645

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_homewizard_energy-6.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e731261e53e9912eb4ee1a7e7a9cb062fcfbac5ba4d1439fff89cf24153a4f20
MD5 cae4374077398ac7e986182f92e3184d
BLAKE2b-256 bd429c7398167cb13a4cc5cce2874585c886771096778c780c229b69bed9391e

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