ramses-rf 0.52.1__tar.gz → 0.52.3__tar.gz

{ramses_rf-0.52.1 → ramses_rf-0.52.3}/.github/workflows/check-lint.yml

@@ -41,7 +41,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install ruff  # pip install -r requirements_dev.txt
+          pip install ruff  # pip install -r requirements/requirements_dev.txt
 
       - name: Check with ruff
         run: ruff check --output-format=github .

{ramses_rf-0.52.1 → ramses_rf-0.52.3}/.github/workflows/check-test.yml

@@ -41,7 +41,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements_dev.txt
+          pip install -r requirements/requirements_dev.txt
 
       - name: Install the package (and its dependencies)
         run: pip install -e .

{ramses_rf-0.52.1 → ramses_rf-0.52.3}/.github/workflows/check-type.yml

@@ -41,7 +41,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements_dev.txt
+          pip install -r requirements/requirements_dev.txt
 
       - name: Install the package (its dependencies are needed for typing)
         run: pip install -e .

{ramses_rf-0.52.1 → ramses_rf-0.52.3}/.github/workflows/publish-hatch.yml

@@ -26,7 +26,7 @@ jobs:
         run: hatch build
 
       - name: Upload dist
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: dist
           path: dist/
@@ -40,7 +40,7 @@ jobs:
       url: https://pypi.org/project/ramses_rf
     steps:
       - name: Download dist
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v6
         with:
           name: dist
           path: dist/

{ramses_rf-0.52.1 → ramses_rf-0.52.3}/.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
           - --py311-plus
           - --force
           - --keep-updates
-        files: ^(src|tests)/.+\.py$
+        files: ^(src|tests|docs)/.+\.py$
 
   - repo: https://github.com/codespell-project/codespell
     rev: v2.4.1

{ramses_rf-0.52.1 → ramses_rf-0.52.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramses_rf
-Version: 0.52.1
+Version: 0.52.3
 Summary: A stateful RAMSES-II protocol decoder & analyser.
 Project-URL: Homepage, https://github.com/ramses-rf/ramses_rf
 Project-URL: Bug Tracker, https://github.com/ramses-rf/ramses_rf/issues

{ramses_rf-0.52.1 → ramses_rf-0.52.3}/README-developers.md

@@ -66,4 +66,7 @@ The rules for pre-commit are in git in `.pre-commit-config.yaml`.
 Check [issue 170](https://github.com/ramses-rf/ramses_rf/issues/170) when you run into troubles here.
 
 ## More
+Build and view the code documentation locally for easier access and to confirm that
+your own code contribution include proper documentation. See [Usage](docs/source/usage.md) for details.
+
 For more hints, see the [How to submit a PR wiki page](https://github.com/ramses-rf/ramses_cc/wiki/7.-How-to-submit-a-PR)

ramses_rf-0.52.3/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

ramses_rf-0.52.3/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

ramses_rf-0.52.3/docs/source/binding_process_diagram.md

@@ -0,0 +1,159 @@
+# RAMSES RF Binding Process Diagram
+
+## Overview
+This diagram shows the binding finite state machine (FSM) for RAMSES RF devices, illustrating the complete process from initial state to binding completion.
+
+## State Machine Diagram
+
+```mermaid
+stateDiagram-v2
+    direction LR
+    [*] --> DevIsNotBinding
+    DevIsNotBinding --> InitiateBindingProcess : initiate_binding_process()
+    InitiateBindingProcess --> SuppSendOfferWaitForAccept
+    SuppSendOfferWaitForAccept --> OfferSent : _make_offer()
+    OfferSent --> SuppSendOfferWaitForAccept : wait_for_accept()
+    DevIsNotBinding --> RespIsWaitingForOffer : wait_for_binding_request()
+    RespIsWaitingForOffer --> OfferReceived : _wait_for_offer()
+    OfferReceived --> RespSendAcceptWaitForConfirm : _accept_offer()
+    RespSendAcceptWaitForConfirm --> SuppIsReadyToSendConfirm : wait_for_confirm()
+    SuppIsReadyToSendConfirm --> StateDecisionPoint : cast_confirm_accept()
+    StateDecisionPoint --> RespHasBoundAsRespondent : No addenda
+    StateDecisionPoint --> SuppHasBoundAsSupplicant : Yes addenda / Complete
+    RespHasBoundAsRespondent --> DevIsNotBinding
+    SuppHasBoundAsSupplicant --> DevIsNotBinding
+    DevIsNotBinding --> [*] : Binding Complete
+
+    subgraph Supplicant Role
+        SuppSendOfferWaitForAccept
+        OfferSent
+        SuppIsReadyToSendConfirm
+        SuppHasBoundAsSupplicant
+    end
+
+    subgraph Respondent Role
+        RespIsWaitingForOffer
+        OfferReceived
+        RespSendAcceptWaitForConfirm
+        RespHasBoundAsRespondent
+    end
+
+    classDef supplicant fill:#006400,stroke:#ffffff,stroke-width:2px
+    classDef respondent fill:#00008B,stroke:#ffffff,stroke-width:2px
+
+    class SuppSendOfferWaitForAccept,OfferSent,SuppIsReadyToSendConfirm,SuppHasBoundAsSupplicant supplicant
+    class RespIsWaitingForOffer,OfferReceived,RespSendAcceptWaitForConfirm,RespHasBoundAsRespondent respondent
+    class Supplicant Role supplicant
+    class Respondent Role respondent
+
+    note right of DevIsNotBinding
+        Not binding<br/>Ready to start
+    end note
+
+    note right of SuppSendOfferWaitForAccept
+        Made Offer<br/>Waiting for Accept
+    end note
+
+    note right of RespIsWaitingForOffer
+        Waiting for Offer
+    end note
+
+    note right of RespSendAcceptWaitForConfirm
+        Sent Accept<br/>Waiting for Confirm
+    end note
+
+    note right of SuppIsReadyToSendConfirm
+        Received Accept<br/>Ready to send Confirm
+    end note
+
+    note right of StateDecisionPoint
+        If addenda: SendAddenda<br/>If no addenda: Complete
+    end note
+
+    note right of RespHasBoundAsRespondent
+        Binding Complete
+    end note
+
+    note right of SuppHasBoundAsSupplicant
+        Binding Complete<br/>Nothing more to do
+    end note
+```
+
+## Method Flow by Role
+
+### Supplicant Flow (Device initiating binding)
+```python
+async def initiate_binding_process(self, offer_codes, confirm_code=None, ratify_cmd=None):
+    1. _make_offer(offer_codes, oem_code)           # Send Offer packet
+    2. _wait_for_accept(tender)                     # Wait for Accept response
+    3. _confirm_accept(accept, confirm_code)        # Send Confirm packet
+    4. _cast_addenda(accept, ratify_cmd)            # Optional: Send Addenda
+
+    # Result: SuppHasBoundAsSupplicant state
+```
+
+### Respondent Flow (Device responding to binding)
+```python
+async def wait_for_binding_request(self, accept_codes, idx="00", require_ratify=False):
+    1. _wait_for_offer()                            # Wait for Offer packet
+    2. _accept_offer(tender, accept_codes, idx)     # Send Accept packet
+    3. _wait_for_confirm(accept)                    # Wait for Confirm packet
+    4. _wait_for_addenda(accept)                    # Optional: Wait for Addenda
+
+    # Result: RespHasBoundAsRespondent state
+```
+
+## State Details
+
+| State | Role | Description | Key Methods |
+|-------|------|-------------|-------------|
+| `DevIsNotBinding` | Any | Initial/final state, not participating in binding | - |
+| `RespIsWaitingForOffer` | Respondent | Waiting for binding offer from supplicant | `wait_for_offer()` |
+| `RespSendAcceptWaitForConfirm` | Respondent | Sent Accept, waiting for Confirm | `cast_accept_offer()`, `wait_for_confirm()` |
+| `RespIsWaitingForAddenda` | Respondent | Received Confirm, waiting for optional Addenda | `wait_for_addenda()` |
+| `RespHasBoundAsRespondent` | Respondent | Binding completed successfully | ✅ **NEW LOGGING HERE** |
+| `SuppSendOfferWaitForAccept` | Supplicant | Sent Offer, waiting for Accept | `cast_offer()`, `wait_for_accept()` |
+| `SuppIsReadyToSendConfirm` | Supplicant | Received Accept, ready to send Confirm | `cast_confirm_accept()` |
+| `SuppIsReadyToSendAddenda` | Supplicant | Sent Confirm, ready to send Addenda | `cast_addenda()` |
+| `SuppHasBoundAsSupplicant` | Supplicant | Binding completed successfully | ✅ **NEW LOGGING HERE** |
+| `DevHasFailedBinding` | Any | Binding failed, error state | - |
+
+## Binding Phases (Packet Types)
+
+| Phase | Packet Type | Description | Direction |
+|-------|-------------|-------------|-----------|
+| `TENDER` | `1FC9` (I_) | Offer phase - initial binding proposal | Supplicant → Respondent |
+| `ACCEPT` | `1FC9` (W_) | Accept phase - acceptance of offer | Respondent → Supplicant |
+| `AFFIRM` | `1FC9` (I_) | Confirm phase - confirmation of acceptance | Supplicant → Respondent |
+| `RATIFY` | `10E0` (I_) | Addenda phase - optional additional binding info | Either direction |
+
+## New Logging Implementation
+
+The following log.info statements have been added at binding completion points:
+
+### 1. Constructor Logging (Immediate Confirmation)
+- **`RespHasBoundAsRespondent.__init__()`**: Logs when respondent binding completes
+- **`SuppHasBoundAsSupplicant.__init__()`**: Logs when supplicant binding completes
+
+### 2. State Transition Logging (Complete Flow)
+- **`BindContextBase.set_state()`**: Logs the complete state transition to bound states, including:
+  - Previous state name
+  - New bound state name  
+  - Final role (respondent/supplicant)
+
+## Example Log Output
+```
+INFO:ramses_rf.binding_fsm:32:123456: Binding completed as respondent
+INFO:ramses_rf.binding_fsm:37:789012: Binding completed as supplicant  
+INFO:ramses_rf.binding_fsm:32:123456: Binding process completed: RespSendAcceptWaitForConfirm -> RespHasBoundAsRespondent (role: BindRole.RESPONDENT)
+```
+
+## Error Handling
+- **Timeout**: Binding fails if expected packets not received within timeout periods
+- **Retry Limits**: Automatic failure after retry limits exceeded
+- **Exception**: `BindingFlowFailed` raised on binding errors
+
+## Configuration Constants
+- `CONFIRM_RETRY_LIMIT`: 3 (automatic binding after this many confirm sends)
+- `CONFIRM_TIMEOUT_SECS`: 3 (automatic binding after this many seconds)
+- `WAITING_TIMEOUT_SECS`: 5 (fail if no packet received within this time)

ramses_rf-0.52.3/docs/source/conf.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python3
+# Configuration file for the ramses_rf Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+from datetime import datetime
+
+sys.path.insert(0, os.path.abspath("."))
+sys.path.insert(0, os.path.abspath("../../src"))
+
+from ramses_rf import VERSION  # noqa: E402
+
+version = VERSION
+authors = "D. Bonnes, E. Broerse"
+
+# -- Project information -----------------------------------------------------
+# see https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "Ramses RF"
+copyright = f"{datetime.now().year}, {authors}"
+author = authors
+release = version
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+# adapted following https://medium.com/@cissyshu/a-step-by-step-guide-to-automatic-documentation-using-sphinx-a697dbbce0e7
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",  # link to local code (button)
+    "sphinx.ext.githubpages",
+    "sphinx_design",
+    "myst_parser",  # to use Markdown inside reST
+    "sphinxcontrib.mermaid",  # to show mermaid diagrams in docs
+]
+pygments_style = "sphinx"  # enable syntax highlighting
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+# Language
+language = "en"
+
+# -- Options for HTML / Thema output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+html_static_path = ["_static"]
+html_logo = "_static/ramses_rf_logo.png"
+html_theme_options = {
+    "announcement": "Build the new <em>ramses_rf</em> documentation locally",
+}
+
+# --- Extension config ----
+
+# Autodoc
+autodoc_default_options = {
+    # Autodoc members
+    "members": True,
+    # Autodoc private members
+    "private-members": True,
+}
+
+# Autosummary
+autosummary_generate = True
+autosummary_generate_overwrite = True
+
+# Myst
+myst_enable_extensions = ["colon_fence"]
+myst_heading_anchors = 4
+myst_fence_as_directive = ["mermaid"]

ramses_rf-0.52.3/docs/source/glossary.rst

@@ -0,0 +1,16 @@
+Glossary
+========
+
+.. glossary::
+    :sorted:
+
+    a_new_important_word
+        You are invited to help build this glossary of Ramses RF terms.
+        In your code ``docstr``, mark a new occurrence by putting in inside a 'term' block containing
+        single backticks, like so:
+        ``:term:`a_new_important_word```
+        Then, add an entry below. Don't worry about the (exact) sorting as Sphinx will sort that out for us.
+
+    schema
+        A description of valid contents of an entity, often defined
+        using voluptuous classes.

ramses_rf-0.52.3/docs/source/index.rst

@@ -0,0 +1,20 @@
+.. ramses_rf documentation master file, created by
+   sphinx-quickstart.
+   This file should at least contain the root `toctree` directive.
+
+ramses_rf
+=================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Intro:
+
+   usage
+   glossary
+   binding_process_diagram
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules

ramses_rf-0.52.3/docs/source/modules.rst

@@ -0,0 +1,9 @@
+ramses_rf/src/
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   ramses_cli
+   ramses_rf
+   ramses_tx

ramses_rf-0.52.3/docs/source/ramses_cli.rst

@@ -0,0 +1,37 @@
+ramses\_cli package
+===================
+
+Submodules
+----------
+
+ramses\_cli.client module
+-------------------------
+
+.. automodule:: ramses_cli.client
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_cli.debug module
+------------------------
+
+.. automodule:: ramses_cli.debug
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_cli.discovery module
+----------------------------
+
+.. automodule:: ramses_cli.discovery
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: ramses_cli
+   :members:
+   :show-inheritance:
+   :undoc-members:

ramses_rf-0.52.3/docs/source/ramses_rf.device.rst

@@ -0,0 +1,37 @@
+ramses\_rf.device package
+=========================
+
+Submodules
+----------
+
+ramses\_rf.device.base module
+-----------------------------
+
+.. automodule:: ramses_rf.device.base
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.device.heat module
+-----------------------------
+
+.. automodule:: ramses_rf.device.heat
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.device.hvac module
+-----------------------------
+
+.. automodule:: ramses_rf.device.hvac
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: ramses_rf.device
+   :members:
+   :show-inheritance:
+   :undoc-members:

ramses_rf-0.52.3/docs/source/ramses_rf.rst

@@ -0,0 +1,102 @@
+ramses\_rf package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ramses_rf.device
+   ramses_rf.system
+
+Submodules
+----------
+
+ramses\_rf.binding\_fsm module
+------------------------------
+
+.. automodule:: ramses_rf.binding_fsm
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.const module
+-----------------------
+
+.. automodule:: ramses_rf.const
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.database module
+--------------------------
+
+.. automodule:: ramses_rf.database
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.dispatcher module
+----------------------------
+
+.. automodule:: ramses_rf.dispatcher
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.entity\_base module
+------------------------------
+
+.. automodule:: ramses_rf.entity_base
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.exceptions module
+----------------------------
+
+.. automodule:: ramses_rf.exceptions
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.gateway module
+-------------------------
+
+.. automodule:: ramses_rf.gateway
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.helpers module
+-------------------------
+
+.. automodule:: ramses_rf.helpers
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.schemas module
+-------------------------
+
+.. automodule:: ramses_rf.schemas
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.version module
+-------------------------
+
+.. automodule:: ramses_rf.version
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: ramses_rf
+   :members:
+   :show-inheritance:
+   :undoc-members:

ramses_rf-0.52.3/docs/source/ramses_rf.system.rst

@@ -0,0 +1,45 @@
+ramses\_rf.system package
+=========================
+
+Submodules
+----------
+
+ramses\_rf.system.faultlog module
+---------------------------------
+
+.. automodule:: ramses_rf.system.faultlog
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.system.heat module
+-----------------------------
+
+.. automodule:: ramses_rf.system.heat
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.system.schedule module
+---------------------------------
+
+.. automodule:: ramses_rf.system.schedule
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_rf.system.zones module
+------------------------------
+
+.. automodule:: ramses_rf.system.zones
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: ramses_rf.system
+   :members:
+   :show-inheritance:
+   :undoc-members: