ramses-rf 0.51.6__tar.gz → 0.51.8__tar.gz

{ramses_rf-0.51.6 → ramses_rf-0.51.8}/.pre-commit-config.yaml

@@ -3,9 +3,9 @@ exclude: ^(.secrets|docs|misc|tests/deprecated)/
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.1
+    rev: v0.13.0
     hooks:
-      - id: ruff         # linter
+      - id: ruff-check   # linter
       - id: ruff-format  # formatter
 
   - repo: https://github.com/cdce8p/python-typing-update
@@ -24,7 +24,7 @@ repos:
         files: ^(src|tests)/.+\.py$
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         args:
@@ -35,7 +35,7 @@ repos:
         exclude: ^(tests/.+/fixtures|tests/.+/snapshots)/
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-executables-have-shebangs
       # id: check-json  # don't enable this one

{ramses_rf-0.51.6 → ramses_rf-0.51.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramses_rf
-Version: 0.51.6
+Version: 0.51.8
 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
@@ -29,13 +29,13 @@ Description-Content-Type: text/markdown
  - (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 requires a USB-to-RF device, either a Honeywell HGI80 (somewhat rare, expensive) or a USB/MQTT dongle running the [ramses_esp](https://github.com/IndaloTech/ramses_esp) or [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
+ - allows you to send commands to CH/DHW and HVAC systems, or monitor them for state changes
+ - allows you to emulate some hardware devices (remotes)
 
 > [!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.
@@ -45,9 +45,9 @@ For CH/DHW, the simplest way to know if it will work with your system is to iden
  - **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.
+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:
+This library 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
 

{ramses_rf-0.51.6 → ramses_rf-0.51.8}/README-developers.md

@@ -48,7 +48,12 @@ 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
+First, verify the installed pre-commit version (compare to requirements_dev.txt):
+```
+pre-commit --version
+```
+
+Install the repo's pre-commit hook:
 ```
 pre-commit install
 ```
@@ -56,5 +61,9 @@ pre-commit install
 Running `pre-commit run` will only check staged files before a commit, while
 `pre-commit run -a` will check all files.
 
+Your IDE should automatically activate the pre-commit check when you try to commit.
+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
-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)
+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.51.6 → ramses_rf-0.51.8}/README.md

@@ -8,13 +8,13 @@
  - (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 requires a USB-to-RF device, either a Honeywell HGI80 (somewhat rare, expensive) or a USB/MQTT dongle running the [ramses_esp](https://github.com/IndaloTech/ramses_esp) or [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
+ - allows you to send commands to CH/DHW and HVAC systems, or monitor them for state changes
+ - allows you to emulate some hardware devices (remotes)
 
 > [!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.
@@ -24,9 +24,9 @@ For CH/DHW, the simplest way to know if it will work with your system is to iden
  - **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.
+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:
+This library 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
 

{ramses_rf-0.51.6 → ramses_rf-0.51.8}/ramses_rf/__init__.py

@@ -16,7 +16,9 @@ from typing import TYPE_CHECKING
 
 from ramses_tx import Address, Command, Message, Packet  # noqa: F401
 
+from . import exceptions  # noqa: F401
 from .device import Device  # noqa: F401
+from .exceptions import CommandInvalid  # noqa: F401
 from .gateway import Gateway  # noqa: F401
 from .version import VERSION  # noqa: F401
 
@@ -38,6 +40,7 @@ __all__ = [
     #
     "Address",
     "Command",
+    "CommandInvalid",
     "Device",
     "Message",
     "Packet",
@@ -50,6 +53,8 @@ __all__ = [
     "Code",
     "IndexT",
     "VerbT",
+    #
+    "exceptions",
 ]
 
 _LOGGER = logging.getLogger(__name__)