Including the TX packet in the RX response.

This allows us more freedom to build higher level decoding functions.

Author: CreatingNull

CHANGES.rst

@@ -28,6 +28,8 @@ Version 0.5.0
   packet rather than all of these needing to build the packet internally.
 * Shifted NPC based functionality into an explict class that bundles this.
   ``abstractions.NPCPacket``
+* Including the TX packet in the RX response.
+  This allows us more freedom to build higher level decoding functions.
 
 Version 0.4.0
 -------------

uoshardware/abstractions.py

@@ -77,26 +77,6 @@ def get_from_address(address: int) -> UOSFunction | None:
         return None  # function not found.
 
 
-@dataclass
-class ComResult:
-    """Containing the data structure used to capture UOS results."""
-
-    status: bool
-    exception: str = ""
-    ack_packet: list = field(default_factory=list)
-    rx_packets: list = field(default_factory=list)
-
-
-@dataclass
-class InstructionArguments:
-    """Containing the data structure used to generalise UOS arguments."""
-
-    payload: tuple = ()
-    expected_rx_packets: int = 1
-    check_pin: int | None = None
-    volatility: Persistence = Persistence.NONE
-
-
 @dataclass(init=False)
 class NPCPacket:
     """Class contains functions and data for the packet based communication."""
@@ -163,6 +143,27 @@ def expects_rx_packets(self) -> list[int]:
         )
 
 
+@dataclass
+class ComResult:
+    """Containing the data structure used to capture UOS results."""
+
+    status: bool
+    exception: str = ""
+    ack_packet: list = field(default_factory=list)
+    rx_packets: list = field(default_factory=list)
+    tx_packet: NPCPacket | None = None
+
+
+@dataclass
+class InstructionArguments:
+    """Containing the data structure used to generalise UOS arguments."""
+
+    payload: tuple = ()
+    expected_rx_packets: int = 1
+    check_pin: int | None = None
+    volatility: Persistence = Persistence.NONE
+
+
 class UOSInterface(metaclass=ABCMeta):
     """Base class for low level UOS interfaces classes to inherit."""
 

uoshardware/api.py

@@ -293,6 +293,8 @@ def __execute_instruction(
                             rx_response.status = rx_response.status & (
                                 computed_checksum == current_packet[-2]
                             )
+                # include the tx packet for convenience
+                rx_response.tx_packet = packet
             else:  # run a special action
                 rx_response = getattr(self.__device_interface, function.name)()
         finally:  # Safety check for lazy loading being used outside of context manager