microdlms 0.1.0__tar.gz

microdlms-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

microdlms-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,97 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  spellcheck:
+    name: Spell check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.0
+        with:
+          enable-cache: true
+          python-version: "3.14"
+
+      - name: Run spellcheck
+        run: uv run codespell
+
+  lint:
+    name: Lint & Format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.0
+        with:
+          enable-cache: true
+          python-version: "3.14"
+
+      - name: Run linter
+        run: uv run ruff check
+
+      - name: Check formatting
+        run: uv run ruff format --check
+
+  typecheck:
+    name: Type check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.0
+        with:
+          enable-cache: true
+          python-version: "3.14"
+
+      - name: Run mypy
+        run: uv run mypy src tests
+
+  complexity:
+    name: Code complexity
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.0
+        with:
+          enable-cache: true
+          python-version: "3.14"
+
+      - name: Run complexipy
+        run: uv run complexipy . --max-complexity-allowed 15
+
+  test:
+    name: Tests & Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.0
+        with:
+          enable-cache: true
+          python-version: "3.14"
+
+      - name: Run pytest
+        run: uv run pytest
+

microdlms-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+*"
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.3.0
+        with:
+          enable-cache: false
+          python-version: "3.14"
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v3
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: Release ${{ github.ref_name }}
+          generate_release_notes: true
+          files: dist/*

microdlms-0.1.0/.gitignore

@@ -0,0 +1,181 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor  
+#  Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to 
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore

microdlms-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.0
+    hooks:
+      - id: ruff-check
+      - id: ruff-format
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.3
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v2.4.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - pytest>=8.0
+        args: [--config-file=pyproject.toml]
+
+  - repo: https://github.com/rohaquinlop/complexipy-pre-commit
+    rev: v8.0.1
+    hooks:
+      - id: complexipy
+        args: [--max-complexity-allowed=15]

microdlms-0.1.0/AGENTS.md

@@ -0,0 +1,126 @@
+# Agent Guidelines for `microdlms`
+
+This document outlines architecture principles, operational standards, hardware constraints, and testing patterns for AI agents developing or maintaining `microdlms`.
+
+---
+
+## 1. Project Overview & Identity
+
+`microdlms` is an MIT-licensed, zero-core-dependency Python 3.14+ library for read-only DLMS/COSEM utility meter communication.
+
+### Role & Ecosystem
+- **Lightweight Alternative**: Designed for Home Assistant and standalone IoT metering systems.
+- **Permissive Licensing**: `microdlms` provides an MIT-licensed library implementing the required read-only DLMS subset, suitable for open-source integration.
+- **Transport Independence**: Core protocol codecs and state machines operate sans-I/O. Serial/socket I/O is segregated into `microdlms.client` via [`serialx`](https://github.com/home-assistant-libs/serialx), supporting standard serial ports (`/dev/ttyUSB*`, `COM*`), network URLs (`socket://`, `tcp://`), and ESPHome `serial_proxy` bridges.
+
+---
+
+## 2. Architectural Rules & Design Principles
+
+### 2.1 Sans-I/O Purity in Core
+- **Zero I/O in Core**: Modules `microdlms.hdlc`, `microdlms.axdr`, `microdlms.apdu`, `microdlms.obis`, `microdlms.types`, and `microdlms.session` must remain **100% sans-I/O**.
+- **No I/O Imports**: Never import `socket`, `asyncio`, `serial`, `serialx`, `urllib`, or any networking libraries in core modules.
+- **State Machine Pattern**: The session engine (`DlmsSession`) operates strictly on in-memory buffers:
+  - Ingestion: `receive_bytes(data: bytes) -> list[SessionEvent]`
+  - Outbound data: `data_to_send() -> bytes`
+- **I/O Isolation**: All async I/O, timeouts, task orchestration, and socket management reside exclusively in `microdlms.client.AsyncMeterClient`.
+
+### 2.2 Specification-Driven Design
+- **Open Standards**: Base protocol implementations on official open DLMS Blue Book and Green Book specifications.
+- **Test Vectors**: Validate behavior against verified physical meter frame captures in `tests/meter_fixtures.py`.
+
+---
+
+## 3. Git & Operational Conventions
+
+### 3.1 Commit Guidelines
+- **Commit Message Prefix**: Always prefix agent-generated commits with `[ai]` (e.g., `[ai] Support multi-frame A-XDR structures.`).
+- **Commit Format**: Keep commit messages concise (under 50 characters including prefix) and end with a full stop (`.`).
+- **Branching**: Conduct feature and bugfix work on dedicated branches (`feature/<name>` or `fix/<name>`). Never commit experimental scaffolding directly to the main branch.
+
+### 3.2 Code Hygiene Tools
+Before submitting changes, all checks must pass cleanly with zero errors:
+
+```bash
+# Code formatting and linting
+uv run ruff check
+uv run ruff format --check
+
+# Strict static type checking
+uv run mypy src tests
+
+# Cognitive complexity verification (max allowed: 15)
+uv run complexipy .
+
+# Spelling verification
+uv run codespell
+
+# Test suite execution with coverage enforcement
+uv run pytest
+```
+
+> **Note on Pytest Plugins**: If your local environment has third-party pytest plugins installed (such as `pytest-homeassistant-custom-component` or `pytest-socket`), they may interfere with test execution. You can disable them by adding `-p no:homeassistant -p no:socket`:
+> ```bash
+> uv run pytest -p no:homeassistant -p no:socket
+> ```
+
+
+When using `prek` (Astral's Git hook manager):
+```bash
+prek run --all-files
+```
+
+### 3.3 Code Style & Naming Conventions
+- **Self-Descriptive Naming**: Ensure human-readable, self-descriptive names for variables, parameters, and attributes across both codebase and test suites. Avoid terse or cryptic abbreviations (e.g., use `position` over `pos`, `message` over `msg`, `frame_1` over `f1`).
+
+---
+
+## 4. Hardware Realities & DLMS Communication
+
+### 4.1 Optical Probe Timing & Constraints
+- **Low Baud Rate**: Optical IR utility meter communication runs predominantly at 9600 baud (8N1).
+- **Latency**: Each attribute read request-response exchange takes between 0.5 and 1.5 seconds over physical optical links.
+- **Exclusive Access**: Serial connections and optical probes are strictly exclusive. Only one active session may use the serial link or TCP socket proxy at a time.
+- **Frame Slicing**: Optical links frequently fragment or concatenate byte streams. Codecs must handle partial frames across multiple chunk arrivals and cleanly identify frame boundaries (`0x7E` framing flags).
+
+### 4.2 Sequence Tracking & Protocol Fields
+- **HDLC Sequence Counters**: $N(S)$ (send sequence number) and $N(R)$ (receive sequence number) are cyclic counters modulo 8 ($0..7$).
+- **DLMS Invoke IDs**: DLMS invocation identifiers are cyclic counters modulo 16 ($0..15$).
+- **LLC Sublayer**: DLMS frames over HDLC I-frames use LLC encapsulation:
+  - Client LLC header: `0xE6 0xE6 0x00`
+  - Server LLC header: `0xE6 0xE7 0x00`
+- **Dual Error Model**:
+  - The sans-I/O `DlmsSession` yields typed events (`AssociationRejectedEvent`, `GetAccessErrorEvent`, `ProtocolErrorEvent`) rather than raising exceptions, maintaining continuous byte consumption.
+  - The async `AsyncMeterClient` converts error events into appropriate Python exceptions:
+    - `CommunicationError`: physical link, timeout, or framing errors.
+    - `AuthenticationError`: LLS password or association rejections.
+    - `DataAccessError`: COSEM data access errors (carrying `DataAccessResult`).
+
+---
+
+## 5. Testing & Coverage Rules
+
+### 5.1 Simulated & Mocked I/O
+- **No Real Hardware or Network I/O**: Tests must never open real physical serial ports or external network connections.
+- **Mock Transport**: Test client interactions using mock readers/writers or mocked `serialx.open_serial_connection` factories.
+- **Deterministic Sans-I/O Testing**: Primary protocol logic must be tested by feeding synthetic or captured byte vectors directly to `DlmsSession.receive_bytes()`.
+
+### 5.2 Test Vectors & Replay Verification
+- **Physical Meter Fixtures**: The repository includes physical meter captures in `tests/meter_fixtures.py` and `tests/meter_data.json` covering:
+  - HDLC Connection (`SNRM` $\rightarrow$ `UA`)
+  - AARQ Application Association with LLS password authentication
+  - Authentication failure responses (`REJECTED_PERMANENT`, diagnostic `13`)
+  - Logical Device Name (`0.0.42.0.0.255`, attr 2)
+  - Meter Serial Number (`0.0.96.1.0.255`, attr 2)
+  - Voltage, current, power readings and `ScalerUnit` structures
+  - Error responses (`OBJECT_UNDEFINED` for non-existent OBIS or attribute)
+  - Disconnect sequence (`DISC` $\rightarrow$ `UA`)
+- `tests/test_fixture_replay.py` must continually validate all 46 captured frame exchanges.
+
+### 5.3 Coverage Enforcement
+- **Minimum 95% Coverage**: Branch and statement coverage across `src/microdlms/` must remain at or above 95% at all times.
+- Pytest enforces this via:
+  ```bash
+  uv run pytest --cov=microdlms --cov-fail-under=95
+  ```
+

microdlms-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 denpamusic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.