ramses-rf 0.51.6__py3-none-any.whl → 0.51.8__py3-none-any.whl

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/helpers.py

@@ -67,7 +67,7 @@ def shrink(
     """Return a minimized dict, after removing all the meaningless items.
 
     Specifically, removes items with:
-    - uwanted keys (starting with '_')
+    - unwanted keys (starting with '_')
     - falsey values
     """
 

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.6"
+__version__ = "0.51.8"
 VERSION = __version__

{ramses_rf-0.51.6.dist-info → ramses_rf-0.51.8.dist-info}/METADATA

@@ -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.dist-info → ramses_rf-0.51.8.dist-info}/RECORD

@@ -4,52 +4,52 @@ 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=zONFBiRdf07cPTSxzr2V3t-b3CGokZjT9SGit4JUKRA,1055
+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=ZZZgucyuU1IHsSewGukZfDg2gu8KeNaEFriWKM0TUHs,10287
 ramses_rf/dispatcher.py,sha256=JGkqSi1o-YhQ2rj8tNkXwYLLeJIC7F061xpHoH8sSsM,11201
-ramses_rf/entity_base.py,sha256=V9m_Q5SOLP5ko3sok0NDvyz3YdYch1QsxM6tHCIE7cA,39212
-ramses_rf/exceptions.py,sha256=rzVZDcYxFH7BjUAQ3U1fHWtgBpwk3BgjX1TO1L1iM8c,2538
-ramses_rf/gateway.py,sha256=WdIIGgs87CYfXwSCSVb2YzqOgLC7W4bkpulWQb7PFNw,20564
-ramses_rf/helpers.py,sha256=LcrVLqnF2qJWqXrC7UXKOQE8khCT3OhoTpZ_ZVBjw3A,4249
+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=mYOUZOH5OIDNBxRM2vd8POzDWEEmLhxh5UtqjTpFNek,13287
-ramses_rf/version.py,sha256=QtONmxsLFzHSx9Z1ddbRf5_x-XAddalTD9dH8-naWpo,125
+ramses_rf/schemas.py,sha256=UhvRhV4nZ3kvrLLM3wwIguQUIjIgd_AKvp2wkTSpNEA,13468
+ramses_rf/version.py,sha256=PUTZH-D81qyH8onRDdeZzxGwuCVDzMYTbItYAp9NKKI,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=H_PUfG_jrrvJgtnu6Bco6PLxHn7CHALwebZzZI1ygFo,23917
+ramses_rf/device/hvac.py,sha256=uKljqweushvpHwRTiYfR26YST6--KAIp8X9zyiRv9HI,45607
 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=4FsVOzICJ4H80LJ0MknZCN0_V-g0k1nMkHUQ0IdrJW8,3161
+ramses_tx/__init__.py,sha256=qNMTe8hBkIuecvtCiekUB0pKdD8atb0SjWxVNVe3yhE,3538
 ramses_tx/address.py,sha256=5swDr_SvOs1CxBmT-iJpldf8R00mOb7gKPMiEnxLz84,8452
-ramses_tx/command.py,sha256=y69y9NYgQHuPbm7h6xC0osf3e1YIKY9jwmsfPiJ8N6U,58348
+ramses_tx/command.py,sha256=r9dNaofjjOQXZSUrZjsNpvEukNn4rSGy0OLr2Dyd2TI,125129
 ramses_tx/const.py,sha256=QmwSS4BIN3ZFrLUiiFScP1RCUHuJ782V3ycRPQTtB_c,30297
 ramses_tx/exceptions.py,sha256=FJSU9YkvpKjs3yeTqUJX1o3TPFSe_B01gRGIh9b3PNc,2632
 ramses_tx/fingerprints.py,sha256=nfftA1E62HQnb-eLt2EqjEi_la0DAoT0wt-PtTMie0s,11974
 ramses_tx/frame.py,sha256=9lUVh8gAMXNRAolfFw2WuWANjn24AWkmscuM9Tm5imE,22036
 ramses_tx/gateway.py,sha256=TXLYwT6tFpmSokD29Qyj1ze7UGCxKidooeyP557Jfoo,11266
-ramses_tx/helpers.py,sha256=0zIvMY2zZ5V52fDAyVGXxNBND1HI-9fBN3dlgDNKNyo,33040
-ramses_tx/logger.py,sha256=9xTxKVdZEoNZvvbjKSeKtMmlSzLhocTRW-61O6WpVsk,11397
+ramses_tx/helpers.py,sha256=J4OCRckp3JshGQTvvqEskFjB1hPS7uA_opVsuIqmZds,32915
+ramses_tx/logger.py,sha256=qYbUoNPnPaFWKVsYvLG6uTVuPTdZ8HsMzBbGx0DpBqc,10177
 ramses_tx/message.py,sha256=hl_gLfwrF79ftUNnsgNt3XGsIhM2Pts0MtZZuGjfaxk,13169
 ramses_tx/opentherm.py,sha256=58PXz9l5x8Ou6Fm3y-R_UnGHCYahoi2RKIDdYStUMzk,42378
 ramses_tx/packet.py,sha256=NGunaGCkEjhTp9t4mARK5e7kbqT-Z_JKCH7ibMYMJXU,7357
-ramses_tx/parsers.py,sha256=ngKmZNFPp4k-HmpOtX8_zWnrjM4O68OzjqAOEMznHFE,109863
-ramses_tx/protocol.py,sha256=ifj3qwcQivjQDaQUwM94xp-U8Pmef6zwSH7mav8DLWA,28867
-ramses_tx/protocol_fsm.py,sha256=YhHkTqbl8w-myimsOjV50uIFgg9HiApwPU7xA_jg5nU,26827
+ramses_tx/parsers.py,sha256=c6D3NB79vZfOGpVmrHc-EhSh4_N4tKljBp1J3HFfkXw,109950
+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=9R-JrInORWUNMPklrAPQWwtr_2aaruQmFqQPw5mFkrE,52223
-ramses_tx/schemas.py,sha256=h2AcArVROy1_C4n6F0Crj4e-2BxXxH74xogFlc6nKHI,12769
-ramses_tx/transport.py,sha256=aLpULRSivoJqzH8GDPRDcbehETOhFflEqmHbaniGLvg,56210
+ramses_tx/ramses.py,sha256=DujcZe4WelHvPNKYfoz9YWmXNoCayV5UsAkiu8Y6vms,53432
+ramses_tx/schemas.py,sha256=18IPRdoCWXpcRg4v8Z1ehTnRronQPYGrf4AvRL-1OD0,12932
+ramses_tx/transport.py,sha256=MwPnkQ0L-2qJt4mIJy3-C9XmHwBDjT7Kg-1LthPByVw,58331
 ramses_tx/typed_dicts.py,sha256=w-0V5t2Q3GiNUOrRAWiW9GtSwbta_7luME6GfIb1zhI,10869
 ramses_tx/typing.py,sha256=eF2SlPWhNhEFQj6WX2AhTXiyRQVXYnFutiepllYl2rI,5042
-ramses_tx/version.py,sha256=Jvb0klvS67N7SxexepgSmtxSwb8sKcIR8MBBeUXTfSM,123
-ramses_rf-0.51.6.dist-info/METADATA,sha256=OzEjMdl75qcH3T8URoBIKgSNQKAualdYRRD8giwa034,3909
-ramses_rf-0.51.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ramses_rf-0.51.6.dist-info/entry_points.txt,sha256=NnyK29baOCNg8DinPYiZ368h7MTH7bgTW26z2A1NeIE,50
-ramses_rf-0.51.6.dist-info/licenses/LICENSE,sha256=-Kc35W7l1UkdiQ4314_yVWv7vDDrg7IrJfMLUiq6Nfs,1074
-ramses_rf-0.51.6.dist-info/RECORD,,
+ramses_tx/version.py,sha256=kLXw7G-2GHtLEZnlOm_5jj8TGeibQYmH_NZ9F7FVHAU,123
+ramses_rf-0.51.8.dist-info/METADATA,sha256=JmxHDvvXI3gRkt2zHELxS9G3ZaMyOn8bOvaraq5_0Ro,4000
+ramses_rf-0.51.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ramses_rf-0.51.8.dist-info/entry_points.txt,sha256=NnyK29baOCNg8DinPYiZ368h7MTH7bgTW26z2A1NeIE,50
+ramses_rf-0.51.8.dist-info/licenses/LICENSE,sha256=-Kc35W7l1UkdiQ4314_yVWv7vDDrg7IrJfMLUiq6Nfs,1074
+ramses_rf-0.51.8.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,
     )