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

{ramses_rf-0.52.1 → ramses_rf-0.52.2}/.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.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramses_rf
-Version: 0.52.1
+Version: 0.52.2
 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.2}/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.2/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.2/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.2/docs/source/conf.py

@@ -0,0 +1,74 @@
+#!/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
+]
+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

ramses_rf-0.52.2/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.2/docs/source/index.rst

@@ -0,0 +1,19 @@
+.. 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
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules

ramses_rf-0.52.2/docs/source/modules.rst

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

ramses_rf-0.52.2/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.2/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.2/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.2/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:

ramses_rf-0.52.2/docs/source/ramses_tx.rst

@@ -0,0 +1,181 @@
+ramses\_tx package
+==================
+
+Submodules
+----------
+
+ramses\_tx.address module
+-------------------------
+
+.. automodule:: ramses_tx.address
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.command module
+-------------------------
+
+.. automodule:: ramses_tx.command
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.const module
+-----------------------
+
+.. automodule:: ramses_tx.const
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.exceptions module
+----------------------------
+
+.. automodule:: ramses_tx.exceptions
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.fingerprints module
+------------------------------
+
+.. automodule:: ramses_tx.fingerprints
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.frame module
+-----------------------
+
+.. automodule:: ramses_tx.frame
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.gateway module
+-------------------------
+
+.. automodule:: ramses_tx.gateway
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.helpers module
+-------------------------
+
+.. automodule:: ramses_tx.helpers
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.logger module
+------------------------
+
+.. automodule:: ramses_tx.logger
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.message module
+-------------------------
+
+.. automodule:: ramses_tx.message
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.opentherm module
+---------------------------
+
+.. automodule:: ramses_tx.opentherm
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.packet module
+------------------------
+
+.. automodule:: ramses_tx.packet
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.parsers module
+-------------------------
+
+.. automodule:: ramses_tx.parsers
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.protocol module
+--------------------------
+
+.. automodule:: ramses_tx.protocol
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.protocol\_fsm module
+-------------------------------
+
+.. automodule:: ramses_tx.protocol_fsm
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.ramses module
+------------------------
+
+.. automodule:: ramses_tx.ramses
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.schemas module
+-------------------------
+
+.. automodule:: ramses_tx.schemas
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.transport module
+---------------------------
+
+.. automodule:: ramses_tx.transport
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.typed\_dicts module
+------------------------------
+
+.. automodule:: ramses_tx.typed_dicts
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.typing module
+------------------------
+
+.. automodule:: ramses_tx.typing
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+ramses\_tx.version module
+-------------------------
+
+.. automodule:: ramses_tx.version
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: ramses_tx
+   :members:
+   :show-inheritance:
+   :undoc-members:

ramses_rf-0.52.2/docs/source/usage.md

@@ -0,0 +1,22 @@
+# Usage
+
+## Installation
+
+To use ramses_rf, first install it using pip:
+
+```console
+   (.venv) $ pip install ramses-rf
+```
+
+## Documentation
+
+We use [sphinx](https://www.sphinx-doc.org/en/master/usage/markdown.html) and
+MyST [markup](https://myst-parser.readthedocs.io/en/latest/syntax/organising_content.html) to automatically create this code documentation from `docstr` annotations in our python code.
+
+- Activate your virtual environment for ramses_rf as described in the [Wiki](https://github.com/ramses-rf/ramses_rf/blob/master/README-developers.md).
+
+- Install the extra required dependencies by running ``pip install -r requirements_docs.txt`` so you can build a local set.
+
+- Then, in a Terminal, enter `cd docs/` and run `sphinx-build -b html source build/html`.
+
+- When the operation finishes, you can open the generated files from the `docs/build/html/` folder in a web browser.

{ramses_rf-0.52.1 → ramses_rf-0.52.2}/ramses_rf/__init__.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 """RAMSES RF - a RAMSES-II protocol decoder & analyser.
+`ramses_rf` takes care of the device (upper) layer.
 
 Works with (amongst others):
 - evohome (up to 12 zones)