ramses-rf 0.22.40__tar.gz → 0.51.2__tar.gz

ramses_rf-0.51.2/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a useful report to help us improve ramses_rf
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of the bug.
+
+**To Reproduce**
+Steps to reproduce the behaviour (for example):
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+Please provide enough details. For example, if you are having an issue with a device, provide details of the model and specs
+
+**Expected behaviour**
+A clear and concise description of what you expected to happen.
+
+**Please include the following information:**
+ - your **RF Gateway** hardware type, firmware and connection (USB, MQTT)
+ - output from the **Serial Console**, if applicable
+ - contemporaneous portion of the **packet.log**, preferably for several hours
+
+**Screenshots**
+Only if applicable, add screenshots to help explain your problem. Do not provide a screenshot as an alternative to providing the above information.
+
+**Additional context**
+Add any other context about the problem here, such as the make/model of the device etc.

ramses_rf-0.51.2/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "github-actions"
+    directory: ".github/workflows"
+    schedule:
+      interval: "weekly"

ramses_rf-0.51.2/.github/workflows/check-lint.yml

@@ -0,0 +1,52 @@
+name: Linting
+
+
+on:
+  push:
+    branches: [ "master", "stable" ]
+    paths: [
+      ".github/workflows/check-lint.yml",
+      "src/**.py",
+      "tests/**",
+    ]
+
+  pull_request:
+    branches: [ "master", "stable" ]
+    paths: [
+      ".github/workflows/check-lint.yml",
+      "src/**.py",
+      "tests/**",
+    ]
+
+  workflow_dispatch:
+
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff  # pip install -r requirements_dev.txt
+
+      - name: Check with ruff
+        run: ruff check --output-format=github .
+
+      - name: Check with ruff (format)
+        run: ruff format --check .
+
+      - run: echo "🍏 This job's status is ${{ job.status }}."

ramses_rf-0.51.2/.github/workflows/check-test.yml

@@ -0,0 +1,54 @@
+name: Testing
+
+
+on:
+  push:
+    branches: [ "master", "stable" ]
+    paths: [
+      ".github/workflows/check-test.yml",
+      "src/**.py",
+      "tests/**",
+    ]
+
+  pull_request:
+    branches: [ "master", "stable" ]
+    paths: [
+      ".github/workflows/check-test.yml",
+      "src/**.py",
+      "tests/**",
+    ]
+
+  workflow_dispatch:
+
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements_dev.txt
+
+      - name: Install the package (and its dependencies)
+        run: pip install -e .
+
+      - name: Test with pytest
+        env:
+          PYTEST_ADDOPTS: "--color=yes"
+        run: pytest -v
+
+      - run: echo "🍏 This job's status is ${{ job.status }}."

ramses_rf-0.51.2/.github/workflows/check-type.yml

@@ -0,0 +1,52 @@
+name: Typing
+
+
+on:
+  push:
+    branches: [ "master", "stable" ]
+    paths: [
+      ".github/workflows/check-type.yml",
+      "src/**.py", "src/**/py.typed",
+      "tests/**.py",
+    ]
+
+  pull_request:
+    branches: [ "master", "stable" ]
+    paths: [
+      ".github/workflows/check-type.yml",
+      "src/**.py", "src/**/py.typed",
+      "tests/**.py",
+    ]
+
+  workflow_dispatch:
+
+
+jobs:
+  type:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements_dev.txt
+
+      - name: Install the package (its dependencies are needed for typing)
+        run: pip install -e .
+
+      - name: Check with mypy
+        run: mypy
+
+      - run: echo "🍏 This job's status is ${{ job.status }}."

ramses_rf-0.51.2/.github/workflows/publish-hatch.yml

@@ -0,0 +1,51 @@
+# This workflow will build a Python Package using Hatch and upload it to PyPi when a release is published
+# No action on a release still in draft
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+# and: https://github.com/pypa/hatch/issues/669 and https://github.com/marketplace/actions/pypi-publish
+
+name: Publish via Hatch
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build-dist:
+    name: Build release to /dist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install hatch
+        run: pipx install hatch
+
+      - name: Build dist
+        run: hatch build
+
+      - name: Upload dist
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    needs: build-dist
+    environment:
+      name: pypi
+      url: https://pypi.org/project/ramses_rf
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v5
+        with:
+          name: dist
+          path: dist/
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.RF_PYPI_API_TOKEN }}
+      - run: echo "🍏 This job's status is ${{ job.status }}."

ramses_rf-0.51.2/.gitignore

@@ -0,0 +1,185 @@
+### local .gitignore used by this repo
+/*.json
+/*.log
+/*.log.*
+/*.old
+/*.out
+/*.txt
+/*.yaml
+
+
+### generic .gitignore used by https://github.com/ramses-rf
+
+!.gitignore
+!.pre-commit-config.yaml
+!pyproject.toml
+!requirements*.txt
+
+# beware the *.log in github's default .gitignore
+!tests/
+!tests/**/*.ambr
+!tests/**/*.json
+!tests/**/*.log
+!tests/**/*.yaml
+
+.secrets*/
+.ruff_cache/
+.vscode/
+
+
+### github's default .gitignore for Python - copied 2023/11/02
+# https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# 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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/

ramses_rf-0.51.2/.pre-commit-config.yaml

@@ -0,0 +1,99 @@
+
+exclude: ^(.secrets|docs|misc|tests/deprecated)/
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.1
+    hooks:
+      - id: ruff         # linter
+      - id: ruff-format  # formatter
+
+  - repo: https://github.com/cdce8p/python-typing-update
+    rev: v0.7.0
+    hooks:
+      # Run `python-typing-update` hook manually from time to time
+      # to update python typing syntax.
+      # Will require manual work, before submitting changes!
+      # pre-commit run --hook-stage manual python-typing-update --all-files
+      - id: python-typing-update
+        stages: [manual]
+        args:
+          - --py311-plus
+          - --force
+          - --keep-updates
+        files: ^(src|tests)/.+\.py$
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=childs,IndexT,OT,ser
+          - --skip="./.*,*.csv,*.json,*.ambr"
+          - --quiet-level=2
+        exclude_types: [csv, json, html]
+        exclude: ^(tests/.+/fixtures|tests/.+/snapshots)/
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-executables-have-shebangs
+      # id: check-json  # don't enable this one
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: python-check-blanket-noqa
+      - id: python-check-blanket-type-ignore
+      # id: python-no-eval
+      - id: python-no-log-warn
+
+  - repo: local
+    hooks:
+      # entry: '[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+'  # email address
+
+    - id: debugs
+      name: check for DEBUG flags
+      entry: '_DBG_.*=.*True'
+      language: pygrep
+      args: [-i]
+      exclude: (.pre-commit-config.yaml|^tests/.*\.py$)  # avoid false +ve
+
+    - id: secrets
+      name: check for secrets
+      entry: '#.*(secret|password|pwd)'
+      language: pygrep
+      args: [-i]
+      exclude: .pre-commit-config.yaml  # avoid false +ve
+
+    - id: style_1
+      name: check for 'as exc:' (should be 'as err:')
+      entry: ' as exc:'
+      language: pygrep
+      args: [-i]
+      exclude: .pre-commit-config.yaml  # avoid false +ve
+
+    # - id: private imports
+    #   name: check for private imports
+    #   entry: 'from .* import _.*'
+    #   language: pygrep
+    #   args: [-i]
+    #   exclude: .pre-commit-config.yaml  # avoid false +ve
+
+
+  # We do not use pre-commit/mirrors-mypy, as it comes with opinionated defaults
+  # (like --ignore-missing-imports) and is difficult to configure to run
+  # with the dependencies correctly installed.
+
+  # - repo: https://github.com/pre-commit/mirrors-mypy
+  #   rev: v1.8.0
+  #   hooks:
+  #   - id: mypy
+  #     additional_dependencies: [voluptuous==0.14.1]
+  #     args: ["--config-file", "./pyproject.toml"]

{ramses-rf-0.22.40 → ramses_rf-0.51.2}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 David Bonnes
+Copyright (c) 2021-2025 David Bonnes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

ramses_rf-0.51.2/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: ramses_rf
+Version: 0.51.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
+Project-URL: Wiki, https://github.com/ramses-rf/ramses_rf/wiki
+Author-email: David Bonnes <zxdavb@bonnes.me>, Egbert Broerse <dcc2@ebroerse.nl>
+Maintainer-email: Egbert Broerse <dcc2@ebroerse.nl>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: airios,chronotherm,climarad,evohome,hometronics,honeywell,itho,nuaire,orcon,ramses,resideo,round thermostat,sundial,vasco
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.11
+Requires-Dist: colorlog>=6.9.0
+Requires-Dist: paho-mqtt>=2.1.0
+Requires-Dist: pyserial-asyncio-fast>=0.16
+Requires-Dist: voluptuous>=0.15.2
+Description-Content-Type: text/markdown
+
+![Linting](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-lint.yml/badge.svg)
+![Typing](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-type.yml/badge.svg)
+![Testing](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-test.yml/badge.svg)
+
+## Overview
+
+**ramses_rf** is a Python client library/CLI utility used to interface with some Honeywell-compatible HVAC & CH/DHW systems that use 868MHz RF, such as:
+ - (Heat) **evohome**, **Sundial**, **Hometronic**, **Chronotherm**
+ - (HVAC) **Itho**, **Orcon**, **Nuaire**, **Vasco**, **ClimaRad**
+
+It requires a USB-to-RF device, either a Honeywell HGI80 (somewhat rare, expensive) or something running the [evofw3](https://github.com/ghoti57/evofw3) firmware, such as the one from [here](https://indalo-tech.onlineweb.shop/) or your own ESP32-S3-WROOM-1 N16R8 with a CC1100 transponder.
+
+It does four things:
+ - decodes RAMSES II-compatible packets and converts them into useful JSON
+ - builds a picture (schema, config & state) of evohome-compatible CH/DHW systems - either passively (by eavesdropping), or actively (probing)
+ - allows you to send commands to CH/DHW and HVAC systems, or monitor for state changes
+ - allows you to emulate some hardware devices
+
+> [!WARNING]
+> This library is not affiliated with Honeywell, Airios nor any final manufacturer. The developers take no responsibility for anything that may happen to your devices because of this library.
+
+For CH/DHW, the simplest way to know if it will work with your system is to identify the box connected to your boiler/HVAC appliance as one of:
+ - **R8810A**: OpenTherm Bridge
+ - **BDR91A**: Wireless Relay (also BDR91T)
+ - **HC60NG**: Wireless Relay (older hardware)
+
+Other systems may well work, such as some Itho Daalderop HVAC systems, use this protocol, YMMV.
+
+It includes a CLI and can be used as a standalone tool, but also is used as a client library by:
+ - [ramses_cc](https://github.com/ramses-rf/ramses_cc), a Home Assistant integration
+ - [evohome-Listener](https://github.com/smar000/evohome-Listener), an MQTT gateway
+
+## Installation
+
+To use the `ramses_cc` Integration in Home Assistant, just install `Ramses RF` from HACS. It will take care of installing this library. See the [`Ramses_cc wiki`](https://github.com/ramses-rf/ramses_cc/wiki/1.-Installation) for details.
+
+### Ramses_rf CLI
+
+To install the `ramses_rf` command line client:
+```
+git clone https://github.com/ramses-rf/ramses_rf
+cd ramses_rf
+pip install -r requirements.txt
+pip install -e .
+```
+
+The CLI is called ``client.py`` and is included in the code root.
+It has options to monitor and parse Ramses-II traffic to screen or a log file, and to parse a file containing Ramses-II messages to the screen.
+See the [client.py CLI wiki page](https://github.com/ramses-rf/ramses_rf/wiki/The-client.py-command-line) for instructions.
+
+For code development, some more setup is required. Please follow the steps in our [Developer's Resource](README-developers.md)

ramses_rf-0.51.2/README-developers.md

@@ -0,0 +1,60 @@
+![Linting](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-lint.yml/badge.svg)
+![Typing](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-type.yml/badge.svg)
+![Testing](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-test.yml/badge.svg)
+
+# Ramses_rf developer's resource
+
+## Installation
+
+Confirm you have Python 3.13.x installed by running:
+```
+python3 --version
+```
+
+### Virtual environment
+
+Create a `venv` virtual environment, for example on macOS or Linux:
+```
+mkdir /your-path-to/virtual-envs
+mkdir /your-path-to/virtual-envs/ramses_rf
+cd /your-path-to/virtual-envs/ramses_rf
+Python3.13 -m venv ~/your-path-to/virtual-envs/ramses_rf
+```
+where `Python3.13` is the python version to set for the `venv`.
+
+### Clone this repo
+
+Clone this repo and install the requirements.
+Using `pip`, in a location where your IDE has access:
+```
+git clone https://github.com/ramses-rf/ramses_rf
+```
+
+Activate the venv (repeat every new session):
+```
+cd /your-path-to/ramses_rf
+source /your-path-to/virtual-envs/ramses_rf/bin/activate
+```
+and confirm your Terminal prompt looks like:
+`(ramses_rf) user:ramses_rf`
+
+### Install dependencies:
+```
+cd /your-path-to/ramses_rf
+pip install -r requirements.txt
+pip install -r requirements_dev.txt
+```
+
+Repeat this after a release update and also when dev_requirements change in master.
+
+### Install pre-commit hook
+Install the repo's pre-commit hook
+```
+pre-commit install
+```
+
+Running `pre-commit run` will only check staged files before a commit, while
+`pre-commit run -a` will check all files.
+
+## More
+For more hints, see the [How to submit a PR wiki page](https://github.com/ramses-rf/ramses_rf/wiki/How-to-submit-a-PR)