Changelog

0.0.3 (unreleased)

In development.

Noteworthy changes

• The physical byte-stuffing codec has been fixed to avoid recursive destuffing during decode which could cause valid frames to be decoded incorrectly.

  The implementation now uses a single-pass approach for both decode() and encode(). This removes a fragile ordering dependency in encoding and improves handling of truncated or otherwise unrecognized stuffing sequences, with corresponding test coverage updates.

  Introduces two new exceptions in the codec module: TruncatedStuffingError and InvalidStuffingByteError.

  Thanks to Jan Kundrát for reporting the issue along with a proposed fix (PR #6).

• The catalog of units and registers in pykmp.constants has been expanded substantially:

  • The register display names catalog has been expanded for an additional 108 register IDs. 90 of which were found on MULTICAL® 603 and MULTICAL® 303 meters and 18 on the 382 electricity meter.
  • Eight new unit IDs have been added to the unit display names mapping.
  • Several unit display names have been corrected and extended, including fixes for Kelvin and for watt- and var-based units.
  • A few register display names have been refined with clearer suffixes to denote the 'channel'.

  Thanks to Jan Kundrát for contributing the extensive list of the MULTICAL® heat meter additions along with a proposed change (PR #4).

  Thanks to Benny Lyne Amorsen for listing the registers on the electricity meter.

Tooling changes

• Project documentation has been migrated from MkDocs with Material for MkDocs to Zensical. The repository now uses zensical.toml for site configuration.

Development changes

• The constants module now uses decimal IDs for REGISTERS and UNITS_NAMES, matching the primary numbering used in vendor documentation and the tool's default output more closely.
• Pyright has been adopted as an additional strict type checker in run-all-linters, with configuration aligned more closely with the VS Code IDE experience.
• Binary-heavy tests and related constants have been reformatted to use bytes.fromhex(), improving the readability of byte-oriented inputs and outputs.
• The physical codec happy-path tests now combine decode() and encode() round-trip examples into a single parametrized test, reducing duplication and keeping the example cases symmetrical.
• Minor follow-up changes further modernized the developer tooling after 0.0.2. These under-the-hood updates included refreshing the VS Code workspace for the uv-managed environment, refining Pyright-specific suppressions, correcting a small type annotation issue in test_codec_application_encode, cleaning up codec.OutOfRangeError, and a minor polish update to the lint runner output.

0.0.2: 'Reboot' (2026-04-16)

No new features are included in 0.0.2; the main focus is tooling, packaging, documentation, and maintainability. The Python landscape has changed significantly since the initial release of this project in 2023. The setup, linting, build, and release workflows have been modernized so the project can use current tool versions again.

A subsequent release should focus on incorporating pull-request contributions and new features.

Noteworthy changes

• The top-level package no longer re-exports PySerialClientCommunicator. Import it from pykmp.client instead:

  from pykmp.client import PySerialClientCommunicator
  

• Documentation has expanded substantially. The project now has a MkDocs site with getting started, troubleshooting, practical hardware notes, API reference, contributing, and releasing documentation. Most of this documentation was already published soon after the 0.0.1 release in 2023.

Development changes

• Development workflow has been modernized around uv and documented. Local setup, linting, building, and release instructions now use uv-managed environments and commands.
• Ruff has been updated from 0.0.292 to 0.15.11, along with the required configuration changes, updates to the run-all-linters script, and a few behavior-preserving code cleanups to satisfy newer lint rules.
• Formatting is now handled by ruff format, replacing Black in the repository tooling.
• Packaging and release instructions have been refreshed for the current toolchain, including local-first release guidance.

0.0.1: Initial release (2023-09-24)

Initial public release.