burst-link-protocol 1.0.5__cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl → 1.1.5__cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl

burst_interface_c.pyi

@@ -6,3 +6,21 @@ class BurstInterfaceC:
     def decode(self, data: bytes, fail_on_crc_error: bool = False) -> list: ...
 
     def encode(self, packets: list) -> bytes: ...
+
+    @property
+    def bytes_handled(self) -> int: ...
+
+    @property
+    def bytes_processed(self) -> int: ...
+
+    @property
+    def packets_processed(self) -> int: ...
+
+    @property
+    def crc_errors(self) -> int: ...
+
+    @property
+    def overflow_errors(self) -> int: ...
+
+    @property
+    def decode_errors(self) -> int: ...

burst_link_protocol/__init__.py

@@ -1,4 +1,5 @@
-from burst_interface_c import  BurstInterfaceC
+from burst_interface_c import BurstInterfaceC
 from .main import BurstInterfacePy
+from .serial_burst_interface import SerialBurstInterface, BurstSerialStatistics
 
-__all__ = ["BurstInterfaceC", "BurstInterfacePy"]
+__all__ = ["BurstInterfaceC", "BurstInterfacePy", "SerialBurstInterface", "BurstSerialStatistics"]

burst_link_protocol/main.py

@@ -1,7 +1,8 @@
 from cobs import cobs
-from crc import Calculator,Crc16
+from crc import Calculator, Crc16
+
+crc = Calculator(Crc16.IBM_3740)  # type: ignore
 
-crc = Calculator(Crc16.IBM_3740)
 
 class BurstInterfacePy:
     buffer = b""
@@ -10,9 +11,8 @@ class BurstInterfacePy:
         pass
 
     @staticmethod
-    def crc16( data: bytes) -> bytes:
+    def crc16(data: bytes) -> bytes:
         return crc.checksum(data).to_bytes(2, "big")
-    
 
     @staticmethod
     def encode_packet(packet: bytes) -> bytes:
@@ -38,4 +38,3 @@ class BurstInterfacePy:
         # Add last packet to buffer
         self.buffer = separated_packets.pop()
         return [self.decode_packet(packet) for packet in separated_packets]
-

burst_link_protocol/serial_burst_interface.py

@@ -0,0 +1,231 @@
+from burst_interface_c import BurstInterfaceC
+import serial
+import time
+import threading
+import asyncio
+import janus
+from pydantic import BaseModel, Field
+
+
+def to_si(value: float, suffix: str) -> str:
+    """
+    Convert a value to a string with SI suffix.
+    """
+    if value == 0:
+        return "0"
+    elif value < 1e-3:
+        return f"{value:.2f} {suffix}"
+    elif value < 1e3:
+        return f"{value:.2f} {suffix}"
+    elif value < 1e6:
+        return f"{value / 1e3:.2f} k{suffix}"
+    elif value < 1e9:
+        return f"{value / 1e6:.2f} M{suffix}"
+    else:
+        return f"{value / 1e9:.2f} G{suffix}"
+
+
+class BurstSerialStatistics(BaseModel):
+    last_update_timestamp: float = Field(default_factory=time.time)
+
+    bytes_handled: int = 0
+    bytes_processed: int = 0
+    packets_processed: int = 0
+    crc_errors: int = 0
+    overflow_errors: int = 0
+    decode_errors: int = 0
+
+    handled_bytes_per_second: float = 0.0
+    processed_bytes_per_second: float = 0.0
+    processed_packets_per_second: float = 0.0
+
+    def update(
+        self,
+        bytes_handled,
+        bytes_processed,
+        packets_processed,
+        crc_errors,
+        overflow_errors,
+        decode_errors,
+    ):
+        now = time.time()
+        if now - self.last_update_timestamp > 1:
+            delta_time = now - self.last_update_timestamp
+            self.last_update_timestamp = now
+
+            self.handled_bytes_per_second = (bytes_handled - self.bytes_handled) / delta_time
+            self.processed_bytes_per_second = (bytes_processed - self.bytes_processed) / delta_time
+            self.processed_packets_per_second = (packets_processed - self.packets_processed) / delta_time
+
+            self.bytes_handled = bytes_handled
+            self.bytes_processed = bytes_processed
+            self.packets_processed = packets_processed
+            self.crc_errors = crc_errors
+            self.overflow_errors = overflow_errors
+            self.decode_errors = decode_errors
+
+        return self
+
+    def __str__(self):
+        return (
+            f"Byte Raw: {to_si(self.bytes_handled, 'B')} ({to_si(self.handled_bytes_per_second * 8, 'bps')}), "
+            f"Bytes processed: {to_si(self.bytes_processed, 'B')} ({to_si(self.processed_bytes_per_second * 8, 'bps')}), "
+            f"Packets processed: {self.packets_processed} ({to_si(self.processed_packets_per_second, 'packets/s')}), "
+            f"Errors (CRC: {self.crc_errors}, Overflow: {self.overflow_errors}, Decode: {self.decode_errors})"
+        )
+
+    def to_dict(self):
+        return self.model_dump(exclude={"last_update_timestamp"})
+
+
+class SerialBurstInterface:
+    debug_timings = False
+    debug_io = False
+
+    kill = False
+    block_size = 1000
+    RATE_CHECK_INTERVAL = 1
+
+    interface: BurstInterfaceC
+    last_rate_timestamp: float = 0
+
+    statitsics: BurstSerialStatistics
+
+    @classmethod
+    def from_serial(cls, port: str, bitrate: int):
+        serial_handle: serial.Serial = serial.Serial(port, bitrate, timeout=0.5)
+        serial_handle.set_buffer_size(rx_size=100 * 1024, tx_size=100 * 1024)  # type: ignore
+        return cls(serial_handle)
+
+    def __init__(self, serial_handle: serial.Serial):
+        self.handle = serial_handle
+        self.handle.reset_input_buffer()
+        self.handle.reset_output_buffer()
+
+        self.current_stats = BurstSerialStatistics()
+        self.statitsics = BurstSerialStatistics()
+
+        self.receive_task_handle = threading.Thread(target=self.receive_task, daemon=True)
+        self.transmit_task_handle = threading.Thread(target=self.transmit_task, daemon=True)
+
+        self.interface = BurstInterfaceC()
+        self.transmit_packet_queue = janus.Queue()
+        self.receive_packet_queue = janus.Queue()
+
+        self.receive_task_handle.start()
+        self.transmit_task_handle.start()
+
+    @property
+    def statistics(self):
+        return self.current_stats.update(
+            self.interface.bytes_handled,
+            self.interface.bytes_processed,
+            self.interface.packets_processed,
+            self.interface.crc_errors,
+            self.interface.overflow_errors,
+            self.interface.decode_errors,
+        )
+
+    def close(self):
+        self.kill = True
+        self.handle.close()
+        self.transmit_packet_queue.close()
+        self.receive_packet_queue.close()
+
+    def receive_task(self):
+        try:
+            while True:
+                # Read incoming data
+                data = self.handle.read(self.block_size)
+
+                if self.kill:
+                    break
+
+                if data:
+                    if self.debug_io:
+                        print(f"Received burst frame: {' '.join([f'{x:02X}' for x in data])}, length: {len(data)}")
+                    try:
+                        decoded_packets = self.interface.decode(data, fail_on_crc_error=True)
+                    except Exception as e:
+                        print(f"Error decoding: {e}")
+                        continue
+
+                    for packet in decoded_packets:
+                        # put all packets in the receive queue
+                        if self.debug_io:
+                            print(f"Received: {packet}")
+
+                        self.receive_packet_queue.sync_q.put(packet)
+
+                time.sleep(0.001)
+
+        except Exception as e:
+            print(f"Error in read task: {e}")
+            self.close()
+
+    def transmit_task(self):
+        try:
+            while True:
+                packet = self.transmit_packet_queue.sync_q.get()
+                if self.debug_io:
+                    print(f"Transmitting packet: {' '.join([f'{x:02X}' for x in packet])}")
+
+                data = self.interface.encode([packet])
+
+                if self.debug_io:
+                    from cobs import cobs
+
+                    daat = cobs.decode(data[:-1])
+                    # print in space separated hex
+                    print(f"Transmitting burst frame: {' '.join([f'{x:02X}' for x in daat])}")
+
+                    # print raw frame
+                    print(f"Transmitting 'raw' burst frame: {' '.join([f'{x:02X}' for x in data])}")
+                self.handle.write(data)
+
+        except Exception as e:
+            print(f"Error in transmit task: {e}")
+            self.close()
+
+    async def send(self, data: bytes):
+        await self.transmit_packet_queue.async_q.put(data)
+
+    async def flush_receive_queue(self):
+        while not self.receive_packet_queue.async_q.empty():
+            self.receive_packet_queue.async_q.get_nowait()
+
+    async def send_with_response(self, data: bytes):
+        # Flush all other packets
+        await self.flush_receive_queue()
+
+        start_time = time.time()
+        await self.transmit_packet_queue.async_q.put(data)
+        response = await self.receive_packet_queue.async_q.get()
+        end_time = time.time()
+
+        if self.debug_timings:
+            print(f"Time taken: {(end_time - start_time) * 1000} ms for {len(data)} bytes")
+
+        return response
+
+    async def receive(self):
+        return await self.receive_packet_queue.async_q.get()
+
+    def receive_all(self):
+        packets = []
+        while not self.receive_packet_queue.sync_q.empty():
+            packets.append(self.receive_packet_queue.sync_q.get())
+        return packets
+
+
+async def main():
+    interface = SerialBurstInterface.from_serial("COM4", 115200)
+
+    for i in range(1000):
+        response = await interface.send_with_response(10 * f"Hello World {i}!".encode())
+        print(f"Received: {response}")
+        await asyncio.sleep(0.01)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

{burst_link_protocol-1.0.5.dist-info → burst_link_protocol-1.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: burst-link-protocol
-Version: 1.0.5
+Version: 1.1.5
 Summary: Binary Utility for Reliable Stream Transfer (BURST) is a library for encoding and decoding binary data streams into and from a byte stream.
 Author-Email: Floris vernieuwe <floris@vernieuwe.eu>
 License-File: LICENSE
@@ -14,6 +14,8 @@ Requires-Dist: pytest-cov<7.0.0,>=6.0.0
 Requires-Dist: pytest-benchmark<6.0.0,>=5.1.0
 Requires-Dist: scikit-build-core>=0.10.7
 Requires-Dist: nanobind>=2.5.0
+Requires-Dist: pyserial>=3.5
+Requires-Dist: janus>=2.0.0
 Provides-Extra: dev
 Requires-Dist: scikit-build-core[pyproject]<0.11.0,>=0.10.7; extra == "dev"
 Requires-Dist: nanobind<3.0.0,>=2.5.0; extra == "dev"
@@ -61,6 +63,7 @@ uv pip install --reinstall --no-build-isolation -ve .
 Auto rebuild on run
 ```sh
 uv pip install --reinstall --no-build-isolation -Ceditable.rebuild=true -ve .
+# or 
 pip install --no-build-isolation -Ceditable.rebuild=true -ve .
 ``` 
 

burst_link_protocol-1.1.5.dist-info/RECORD

@@ -0,0 +1,9 @@
+burst_interface_c.cpython-311-i386-linux-gnu.so,sha256=1bBseQ90rLsLtqx0TIJ0rS0-DjTNkGYB-w0nXkjPhVw,2401840
+burst_interface_c.pyi,sha256=hOKp_AFoFwNYlrbkPxQC1Z_-WKf4LQcsoPQbR3roG3s,528
+burst_link_protocol/__init__.py,sha256=_AN_MobLsSZT-n7a1Tp07diWIDvna6KX3xqDkYLXF6o,261
+burst_link_protocol/main.py,sha256=oG3tiGyAjAWs3g3tvgbTuNoPwV1uHRUOfWTk7wZBQhs,1181
+burst_link_protocol/serial_burst_interface.py,sha256=mtdcp-VOTnGjvfRhG4IY4k5RK6EUq_fCViKsyFEaxdw,7629
+burst_link_protocol-1.1.5.dist-info/METADATA,sha256=RBftwGhSNW8G89OfxFcnFGQ_EJY8r0z3Rp8VMuwH20Y,2599
+burst_link_protocol-1.1.5.dist-info/WHEEL,sha256=s5c7Bx6mFIqyJbKt63fQgI-I64486E68P0CAeFKeuXE,152
+burst_link_protocol-1.1.5.dist-info/RECORD,,
+burst_link_protocol-1.1.5.dist-info/licenses/LICENSE,sha256=x290DRUhub7ZynoErVJsMQSTxiYhsTQdYjtDFzZTOzA,16725

{burst_link_protocol-1.0.5.dist-info → burst_link_protocol-1.1.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: scikit-build-core 0.11.1
+Generator: scikit-build-core 0.11.4
 Root-Is-Purelib: false
 Tag: cp311-cp311-manylinux_2_17_i686
 Tag: cp311-cp311-manylinux2014_i686

burst_link_protocol-1.0.5.dist-info/RECORD

@@ -1,8 +0,0 @@
-burst_interface_c.cpython-311-i386-linux-gnu.so,sha256=6dZ8DynzK_iudxq_dex3vPBJvC_BNyKcLxDdS8OTyxk,2502508
-burst_interface_c.pyi,sha256=x_agiw2iVgDi2qJOOwEpWXVsV14K6GtJgcMqOBqjASQ,193
-burst_link_protocol/main.py,sha256=Pu67bwI7Szk1Y_AdrFVRTBCvl0o45uhFJTd8b0KQl_E,1170
-burst_link_protocol/__init__.py,sha256=cyEhIzfFlNOtubh_JjZg6bGSGn_sPq8daTi4cYBKnxc,132
-burst_link_protocol-1.0.5.dist-info/WHEEL,sha256=px6RMsu5cdbww4sFnrih1lk7C47hT1iFEDRtsKnen10,152
-burst_link_protocol-1.0.5.dist-info/RECORD,,
-burst_link_protocol-1.0.5.dist-info/METADATA,sha256=9_-fIKdU8nGot4HR9imtOpZaccCfm953TF6bD1SKABE,2536
-burst_link_protocol-1.0.5.dist-info/licenses/LICENSE,sha256=x290DRUhub7ZynoErVJsMQSTxiYhsTQdYjtDFzZTOzA,16725