ramses-rf 0.51.7__py3-none-any.whl → 0.51.9__py3-none-any.whl

ramses_rf/dispatcher.py

@@ -70,12 +70,12 @@ def _create_devices_from_addrs(gwy: Gateway, this: Message) -> None:
     # Devices need to know their controller, ?and their location ('parent' domain)
     # NB: only addrs processed here, packet metadata is processed elsewhere
 
-    # Determinging bindings to a controller:
+    # Determining bindings to a controller:
     #  - configury; As per any schema                                                   # codespell:ignore configury
     #  - discovery: If in 000C pkt, or pkt *to* device where src is a controller
     #  - eavesdrop: If pkt *from* device where dst is a controller
 
-    # Determinging location in a schema (domain/DHW/zone):
+    # Determining location in a schema (domain/DHW/zone):
     #  - configury; As per any schema                                                   # codespell:ignore configury
     #  - discovery: If in 000C pkt - unable for 10: & 00: (TRVs)
     #  - discovery: from packet fingerprint, excl. payloads (only for 10:)
@@ -99,7 +99,7 @@ def _create_devices_from_addrs(gwy: Gateway, this: Message) -> None:
 def _check_msg_addrs(msg: Message) -> None:  # TODO
     """Validate the packet's address set.
 
-    Raise InvalidAddrSetError if the meta data is invalid, otherwise simply return.
+    Raise InvalidAddrSetError if the metadata is invalid, otherwise simply return.
     """
 
     # TODO: needs work: doesn't take into account device's (non-HVAC) class
@@ -218,7 +218,7 @@ def process_msg(gwy: Gateway, msg: Message) -> None:
             and msg.dst != msg.src
         ):
             # HGI80 can do what it likes
-            # receiving an I isn't currently in the schema & so can't yet be tested
+            # receiving an I_ isn't currently in the schema & so can't yet be tested
             _check_dst_slug(msg)  # ? raise exc.PacketInvalid
 
         if gwy.config.reduce_processing >= DONT_UPDATE_ENTITIES:
@@ -269,7 +269,9 @@ def process_msg(gwy: Gateway, msg: Message) -> None:
     else:
         logger_xxxx(msg)
         if gwy.msg_db:
-            gwy.msg_db.add(msg)
+            gwy.msg_db.add(
+                msg
+            )  # why add it anyway? will fail in testst comparing to _msgs
 
 
 # TODO: this needs cleaning up (e.g. handle intervening packet)

ramses_rf/entity_base.py

@@ -220,7 +220,7 @@ class _MessageDB(_Entity):
             self._msgz_[msg.code][msg.verb][msg._pkt._ctx] = msg
 
     @property
-    def _msg_db(self) -> list[Message]:  # flattened version of _msgz[code][verb][indx]
+    def _msg_db(self) -> list[Message]:  # flattened version of _msgz[code][verb][index]
         """Return a flattened version of _msgz[code][verb][index].
 
         The idx is one of:

ramses_rf/exceptions.py

@@ -72,11 +72,45 @@ class DeviceNotFaked(SystemInconsistent):
     HINT = "faking is configured in the known_list"
 
 
-class ForeignGatewayError(_RamsesUpperError):
+class ForeignGatewayError(SystemInconsistent):
     """Raised when a foreign gateway is detected.
 
     These devices may not be gateways (set a class), or belong to a neighbour (exclude
-    via block_list/known_list), or should be allowed (known_list).
-    """
+    via block_list/known_list), or should be allowed (known_list)."""
 
     HINT = "consider enforcing a known_list"
+
+
+class DeviceNotRecognised(_RamsesUpperError):
+    """Raised when a device is not recognized.
+
+    This typically happens when trying to interact with a device that doesn't exist
+    or is not properly configured in the system."""
+
+    HINT = "check the device ID and ensure the device is properly configured"
+
+
+class CommandInvalid(_RamsesUpperError):
+    """Raised when an invalid command is sent to a device.
+
+    This can happen if the command format is incorrect or if the command is not
+    supported by the target device."""
+
+    HINT = "verify the command format and ensure it's supported by the device"
+
+
+class SendFailure(_RamsesUpperError):
+    """Raised when a command fails to be sent to a device.
+
+    This typically indicates a communication issue with the device or gateway."""
+
+    HINT = "check the device connection and try again"
+
+
+class SendPriority(_RamsesUpperError):
+    """Raised when the command queue is full.
+
+    This happens when too many commands are queued for sending and the queue
+    has reached its maximum capacity."""
+
+    HINT = "wait for pending commands to complete and try again"

ramses_rf/gateway.py

@@ -306,7 +306,7 @@ class Gateway(Engine):
         enforce_include_list = bool(
             self._enforce_known_list
             and extract_known_hgi_id(
-                self._include, disable_warnings=True, strick_checking=True
+                self._include, disable_warnings=True, strict_checking=True
             )
         )
 

ramses_rf/schemas.py

@@ -39,6 +39,7 @@ from ramses_tx.schemas import (  # noqa: F401
     SCH_TRAITS as SCH_TRAITS,
     SZ_ALIAS as SZ_ALIAS,
     SZ_BLOCK_LIST,
+    SZ_BOUND_TO as SZ_BOUND_TO,
     SZ_CLASS as SZ_CLASS,
     SZ_DISABLE_SENDING,
     SZ_ENFORCE_KNOWN_LIST,
@@ -321,17 +322,19 @@ SCH_RESTORE_CACHE_DICT = {
 def _get_device(gwy: Gateway, dev_id: DeviceIdT, **kwargs: Any) -> Device:  # , **traits
     """Get a device from the gateway.
 
-    Raise a LookupError if a device_id is filtered out by a list.
+    Raise a LookupError if a device_id is filtered out by the known or block list.
 
     The underlying method is wrapped only to provide a better error message.
     """
 
     def check_filter_lists(dev_id: DeviceIdT) -> None:
-        """Raise an LookupError if a device_id is filtered out by a list."""
+        """Raise a LookupError if a device_id is filtered out by a list."""
 
         err_msg = None
         if gwy._enforce_known_list and dev_id not in gwy._include:
             err_msg = f"it is in the {SZ_SCHEMA}, but not in the {SZ_KNOWN_LIST}"
+        # issue ramses_cc #296: if enforce_known_list is turned on, error on any "unknown" dev_id
+        # fix: delete from schema?
         if dev_id in gwy._exclude:
             err_msg = f"it is in the {SZ_SCHEMA}, but also in the {SZ_BLOCK_LIST}"
 

ramses_rf/version.py

@@ -1,4 +1,4 @@
 """RAMSES RF - a RAMSES-II protocol decoder & analyser (application layer)."""
 
-__version__ = "0.51.7"
+__version__ = "0.51.9"
 VERSION = __version__

{ramses_rf-0.51.7.dist-info → ramses_rf-0.51.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramses_rf
-Version: 0.51.7
+Version: 0.51.9
 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.9.dist-info/RECORD

@@ -0,0 +1,55 @@
+ramses_cli/__init__.py,sha256=uvGzWqOf4avvgzxJNSLFWEelIWqSZ-AeLAZzg5x58bc,397
+ramses_cli/client.py,sha256=vbKS3KVPiGsDWLp5cR3SVBtXrs-TinzlxSbTgcb4G2k,19724
+ramses_cli/debug.py,sha256=vgR0lOHoYjWarN948dI617WZZGNuqHbeq6Tc16Da7b4,608
+ramses_cli/discovery.py,sha256=81XbmpNiCpUHVZBwo2g1eRwyJG-wZhpSsc44G3hHlFA,12972
+ramses_cli/utils/cat_slow.py,sha256=AhUpM5gnegCitNKU-JGHn-DrRzSi-49ZR1Qw6lxe_t8,607
+ramses_cli/utils/convert.py,sha256=D_YiCyX5na9pgC-_NhBlW9N1dgRKUK-uLtLBfofjzZM,1804
+ramses_rf/__init__.py,sha256=VG3E9GHbtC6lx6E1DMQJeFitHnydMKJyPxQBethdrzg,1193
+ramses_rf/binding_fsm.py,sha256=uZAOl3i19KCXqqlaLJWkEqMMP7NJBhVPW3xTikQD1fY,25996
+ramses_rf/const.py,sha256=L3z31CZ-xqno6oZp_h-67CB_5tDDqTwSWXsqRtsjMcs,5460
+ramses_rf/database.py,sha256=eaD34qyYmjg1AZ5mU78CcjwSbEbjLSVzRXlSoZLtmbI,17264
+ramses_rf/dispatcher.py,sha256=7DNJ5nLpMnaJTCXhm_BLEAnMnYWlvh1XPdkMP_ucBGg,11290
+ramses_rf/entity_base.py,sha256=Byt8mFRUKETNiKHaL0cNaMywjLcopDG3Sldiy1Q7lAo,39213
+ramses_rf/exceptions.py,sha256=mt_T7irqHSDKir6KLaf6oDglUIdrw0S40JbOrWJk5jc,3657
+ramses_rf/gateway.py,sha256=s2bhkUzR42mzL4lZ1crTBsEWMOMGI8tpuHN1UZdAB74,20564
+ramses_rf/helpers.py,sha256=TNk_QkpIOB3alOp1sqnA9LOzi4fuDCeapNlW3zTzNas,4250
+ramses_rf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ramses_rf/schemas.py,sha256=UhvRhV4nZ3kvrLLM3wwIguQUIjIgd_AKvp2wkTSpNEA,13468
+ramses_rf/version.py,sha256=NXm_d5LEm9kUTuOqMEH3o0RLs7W6Ahdv2527DIwmnJc,125
+ramses_rf/device/__init__.py,sha256=sUbH5dhbYFXSoM_TPFRutpRutBRpup7_cQ9smPtDTy8,4858
+ramses_rf/device/base.py,sha256=WGkBTUNjRUEe-phxdtdiXVCZnTi6-i1i_YT6g689UTM,17450
+ramses_rf/device/heat.py,sha256=2sCsggySVcuTzyXDmgWy76QbhlU5MQWSejy3zgI5BDE,54242
+ramses_rf/device/hvac.py,sha256=SY2FpO54k4y5E7MYWyjMMRbBDqRLWgB8Cvk9lAOFkyY,44653
+ramses_rf/system/__init__.py,sha256=uZLKio3gLlBzePa2aDQ1nxkcp1YXOGrn6iHTG8LiNIw,711
+ramses_rf/system/faultlog.py,sha256=GdGmVGT3137KsTlV_nhccgIFEmYu6DFsLTn4S-8JSok,12799
+ramses_rf/system/heat.py,sha256=3jaFEChU-HlWCRMY1y7u09s7AH4hT0pC63hnqwdmZOc,39223
+ramses_rf/system/schedule.py,sha256=Ts6tdZPTQLV5NkgwA73tPa5QUsnZNIIuYoKC-8VsXDk,18808
+ramses_rf/system/zones.py,sha256=9AH7ooN5QfiqvWuor2P1Dn8aILjQb2RWL9rWqDH1IjA,36075
+ramses_tx/__init__.py,sha256=qNMTe8hBkIuecvtCiekUB0pKdD8atb0SjWxVNVe3yhE,3538
+ramses_tx/address.py,sha256=F5ZE-EbPNNom1fW9XXUILvD7DYSMBxNJvsHVliT5gjw,8452
+ramses_tx/command.py,sha256=r9dNaofjjOQXZSUrZjsNpvEukNn4rSGy0OLr2Dyd2TI,125129
+ramses_tx/const.py,sha256=pnxq5upXvLUizv9Ye_I1llD9rAa3wddHgsSkc91AIUc,30300
+ramses_tx/exceptions.py,sha256=FJSU9YkvpKjs3yeTqUJX1o3TPFSe_B01gRGIh9b3PNc,2632
+ramses_tx/fingerprints.py,sha256=nfftA1E62HQnb-eLt2EqjEi_la0DAoT0wt-PtTMie0s,11974
+ramses_tx/frame.py,sha256=GzNsXr15YLeidJYGtk_xPqsZQh4ehDDlUCtT6rTDhT8,22046
+ramses_tx/gateway.py,sha256=Z2TLysmTsi6wc2LEvbF-mL141aesdcWEFRCm0zheR0I,11267
+ramses_tx/helpers.py,sha256=J4OCRckp3JshGQTvvqEskFjB1hPS7uA_opVsuIqmZds,32915
+ramses_tx/logger.py,sha256=qYbUoNPnPaFWKVsYvLG6uTVuPTdZ8HsMzBbGx0DpBqc,10177
+ramses_tx/message.py,sha256=LnzLVMmdV1oNHbdoldCAFW3lESgOqzPWWDsHed5K7iI,13391
+ramses_tx/opentherm.py,sha256=58PXz9l5x8Ou6Fm3y-R_UnGHCYahoi2RKIDdYStUMzk,42378
+ramses_tx/packet.py,sha256=_qHiPFWpQpKueZOgf1jJ93Y09iZjo3LZWStLglVkXg4,7370
+ramses_tx/parsers.py,sha256=g0vKu1vDXjjp_kV_iipeGL5M8XYi67AE3c97IZX00Qk,110888
+ramses_tx/protocol.py,sha256=9R3aCzuiWEyXmugmB5tyR_RhBlgfnpUXj7AsMP9BzzU,28867
+ramses_tx/protocol_fsm.py,sha256=ZKtehCr_4TaDdfdlfidFLJaOVTYtaEq5h4tLqNIhb9s,26827
+ramses_tx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ramses_tx/ramses.py,sha256=DujcZe4WelHvPNKYfoz9YWmXNoCayV5UsAkiu8Y6vms,53432
+ramses_tx/schemas.py,sha256=18IPRdoCWXpcRg4v8Z1ehTnRronQPYGrf4AvRL-1OD0,12932
+ramses_tx/transport.py,sha256=bGprlfuuwBgQ1bmBRSrcicuk7s-jVqyuKpZCfQ-sSpw,58469
+ramses_tx/typed_dicts.py,sha256=w-0V5t2Q3GiNUOrRAWiW9GtSwbta_7luME6GfIb1zhI,10869
+ramses_tx/typing.py,sha256=eF2SlPWhNhEFQj6WX2AhTXiyRQVXYnFutiepllYl2rI,5042
+ramses_tx/version.py,sha256=F7K6xGXIUnJDASKlhAoABr7EZ8WnHdqeUfJqZuvdczY,123
+ramses_rf-0.51.9.dist-info/METADATA,sha256=ITVv4OBf_zE3S2iCQ9Eqci8EuceqtCIfr9oyK5lE_Sw,4000
+ramses_rf-0.51.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ramses_rf-0.51.9.dist-info/entry_points.txt,sha256=NnyK29baOCNg8DinPYiZ368h7MTH7bgTW26z2A1NeIE,50
+ramses_rf-0.51.9.dist-info/licenses/LICENSE,sha256=-Kc35W7l1UkdiQ4314_yVWv7vDDrg7IrJfMLUiq6Nfs,1074
+ramses_rf-0.51.9.dist-info/RECORD,,

ramses_tx/__init__.py

@@ -43,8 +43,18 @@ from .logger import set_pkt_logging
 from .message import Message
 from .packet import PKT_LOGGER, Packet
 from .protocol import PortProtocol, ReadProtocol, protocol_factory
-from .ramses import CODES_BY_DEV_SLUG, CODES_SCHEMA
-from .schemas import SZ_SERIAL_PORT, DeviceIdT, DeviceListT
+from .ramses import (
+    _2411_PARAMS_SCHEMA,
+    CODES_BY_DEV_SLUG,
+    CODES_SCHEMA,
+    SZ_DATA_TYPE,
+    SZ_DATA_UNIT,
+    SZ_DESCRIPTION,
+    SZ_MAX_VALUE,
+    SZ_MIN_VALUE,
+    SZ_PRECISION,
+)
+from .schemas import SZ_BOUND_TO, SZ_SERIAL_PORT, DeviceIdT, DeviceListT
 from .transport import (
     FileTransport,
     PortTransport,
@@ -76,6 +86,15 @@ __all__ = [
     "SZ_ZONE_IDX",
     "SZ_ZONE_MASK",
     "SZ_ZONE_TYPE",
+    "SZ_BOUND_TO",
+    # Schema-related constants
+    "SZ_DATA_UNIT",
+    "SZ_DESCRIPTION",
+    "SZ_DATA_TYPE",
+    "SZ_MAX_VALUE",
+    "SZ_MIN_VALUE",
+    "SZ_PRECISION",
+    "_2411_PARAMS_SCHEMA",
     #
     "ALL_DEV_ADDR",
     "ALL_DEVICE_ID",
@@ -153,8 +172,10 @@ def extract_known_hgi_id(
     /,
     *,
     disable_warnings: bool = False,
-    strick_checking: bool = False,
+    strict_checking: bool = False,
 ) -> DeviceIdT | None:
     return PortProtocol._extract_known_hgi_id(
-        include_list, disable_warnings=disable_warnings, strick_checking=strick_checking
+        include_list,
+        disable_warnings=disable_warnings,
+        strict_checking=strict_checking,
     )

ramses_tx/address.py

@@ -195,7 +195,7 @@ def pkt_addrs(addr_fragment: str) -> tuple[Address, Address, Address, Address, A
 
     returns: src_addr, dst_addr, addr_0, addr_1, addr_2
 
-    Will raise an InvalidAddrSetError is the address fields are not valid.
+    Will raise an InvalidAddrSetError if the address fields are not valid.
     """
     # for debug: print(pkt_addrs.cache_info())