pyhems

Python Version License

ECHONET Lite library for Home Energy Management System (HEMS).

🇯🇵 日本語ドキュメント

Features

  • ECHONET Lite frame encoding/decoding
  • UDP multicast device discovery
  • Async runtime client with event subscription
  • Device state management with DeviceManager
  • Adaptive poll scheduler for non-notifying properties via PropertyPoller
  • Entity definitions based on MRA data
  • Full type hints (py.typed)

Requirements

  • Python 3.14+
  • bidict>=0.23.0

License

MIT License

Installation

pip install pyhems

Quick Start

import asyncio
from pyhems import EOJ, HemsClient, HemsFrameEvent, HemsInstanceListEvent

async def main():
    client = HemsClient(interface="0.0.0.0")
    await client.start()

    def on_event(event):
        if isinstance(event, HemsInstanceListEvent):
            print(f"Node: {event.node_id}, Instances: {event.instances}")
        elif isinstance(event, HemsFrameEvent):
            print(f"Frame from {event.node_id}: {event.frame}")

    unsubscribe = client.subscribe(on_event)

    # Read properties from a discovered device
    # node_id = "fe..."  # obtained from HemsInstanceListEvent
    # props = await client.get(node_id, EOJ(0x013001), [0x80, 0xB3])

    # Write a property (example: power ON)
    # await client.set_property(node_id, EOJ(0x013001), 0x80, b"\x30")

    await asyncio.sleep(60)
    unsubscribe()
    await client.stop()

asyncio.run(main())

Runtime API Overview

  • HemsClient.start() / HemsClient.stop(): Start and stop UDP transport.
  • HemsClient.subscribe(callback): Subscribe to runtime events.
  • HemsClient.probe_nodes(): Trigger multicast node discovery.
  • HemsClient.get(node_id, deoj, epcs): Read property values.
  • HemsClient.set_property(node_id, deoj, epc, edt): Write a single property.
  • HemsClient.set_properties(node_id, deoj, properties): Write multiple properties.

Adaptive Property Polling

PropertyPoller uses an adaptive scheduler designed for mixed ECHONET Lite devices:

  • TID-correlated in-flight tracking avoids request pileups on slow devices.
  • Poll cadence is adjusted from latency EWMA and failure backoff, starting from the base interval.
  • Instantaneous-value EPCs can be scheduled on a separate fast lane (fast_poll_epcs).
  • When devices truncate large responses, batch size is learned (observed_batch_capacity) and reused.
  • Poll targets can be narrowed dynamically through DeviceManager.subscribe_epcs(...).

Definitions

from pyhems import REGISTRY

print(REGISTRY.version, REGISTRY.mra_version)

# Mapping: class_code -> tuple[EntityDefinition, ...]
ac_entities = REGISTRY.entities.get(0x0130, ())
for entity in ac_entities[:3]:
    print(entity.epc, entity.name_en)

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.8.9)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for sayurin from gravatar.com sayurin

Credits

Author: Sayurin

License expression

MIT
View SPDX License List

Requires

Python >=3.14

Provides Extra

dev

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyhems-0.8.2.tar.gz (104.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyhems-0.8.2-py3-none-any.whl (85.7 kB view details)

Uploaded Python 3

File details

Details for the file pyhems-0.8.2.tar.gz.

File metadata

  • Download URL: pyhems-0.8.2.tar.gz
  • Upload date:
  • Size: 104.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pyhems-0.8.2.tar.gz
Algorithm Hash digest
SHA256 6cd2af8f480ba7df26319862b14da41b1800249e44f77bae5e5276054aa4e11f
MD5 9ad3e37f4ab037d07bd7bad2e59a66a0
BLAKE2b-256 8983f45f6bda7f6443852176ad586f03dec7016da94ab5b4bc802d4071abffd8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyhems-0.8.2.tar.gz:

Publisher: release.yml on sayurin/pyhems

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyhems-0.8.2-py3-none-any.whl.

File metadata

  • Download URL: pyhems-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 85.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pyhems-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fe0251130dd90a6ccaa89c86fd7bf240aa4e36ccd68bf3ada96b8f87b853421c
MD5 4a23bbbeae2d90ffe10cab9f3c205581
BLAKE2b-256 953dbde599e49fdbde5a22ab53f549aa35c64392eee0be18ec16d3d3c441031f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyhems-0.8.2-py3-none-any.whl:

Publisher: release.yml on sayurin/pyhems

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.8.9

2 files

0.8.8

2 files

0.8.7

2 files

0.8.6

2 files

0.8.5

2 files

0.8.4

2 files

0.8.3

2 files

This release

0.8.2 This release

2 files

0.8.1

2 files

0.8.0

2 files

0.7.1

2 files

0.7.0

2 files

0.6.0

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

Yanked

0.1.0

2 files

Yanked reason: removed dependent web site.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page