burst-link-protocol 1.0.2__tar.gz → 1.0.3__tar.gz

{burst_link_protocol-1.0.2 → burst_link_protocol-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: burst-link-protocol
-Version: 1.0.2
+Version: 1.0.3
 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

{burst_link_protocol-1.0.2 → burst_link_protocol-1.0.3}/ROADMAP.md

@@ -20,4 +20,4 @@
 - ⬜️ Add a way to get C test coverage 
     - ⬜️ Add test report as a badge
 - ⬜️ Fix dependencies once compilation succeeds 
-
+- ⬜️ Fix packets that start with a 0x00 byte, they are currently not encoded correctly

burst_link_protocol-1.0.3/platform/zephyr/CMakeLists.txt

@@ -0,0 +1,9 @@
+zephyr_library_named(burst-link-protocol)
+zephyr_library_sources(
+"../../src/decoder.c"
+"../../src/encoder.c"
+"../../src/crc.c"
+)
+
+target_include_directories(burst-link-protocol PUBLIC ../../src)
+

{burst_link_protocol-1.0.2 → burst_link_protocol-1.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "burst-link-protocol"
-version = "1.0.2"  # Choose one version reference here
+version = "1.0.3"  # Choose one version reference here
 description = "Binary Utility for Reliable Stream Transfer (BURST) is a library for encoding and decoding binary data streams into and from a byte stream."
 requires-python = ">=3.10,<4.0"
 authors = [

{burst_link_protocol-1.0.2 → burst_link_protocol-1.0.3}/src/decoder.c

@@ -145,6 +145,6 @@ burst_packet_t burst_decoder_get_packet(burst_decoder_t *ctx)
 
   burst_packet_t packet;
   packet.data = ctx->buffer;
-  packet.size = ctx->out_head-1;
+  packet.size = ctx->out_head;
   return packet;
 }

burst_link_protocol-1.0.3/test/test_c.py

@@ -0,0 +1,24 @@
+from burst_link_protocol import BurstInterfaceC
+
+
+def test_c_encoding_decoding():
+    c_interface = BurstInterfaceC()
+
+    packets = [b"Hello, world!", b"Goodbye, world!"]
+
+    decoded = c_interface.decode(c_interface.encode(packets))
+    print(decoded)
+    assert packets == decoded, f"Expected {packets}, got {decoded}"
+
+
+def test_c_encoding_decoding_fail():
+    c_interface = BurstInterfaceC()
+
+    packets = [b"\0Hello, world!"]
+
+    decoded = c_interface.decode(c_interface.encode(packets))
+    print(decoded)
+    assert packets == decoded, f"Expected {packets}, got {decoded}"
+
+if __name__ == "__main__":
+    test_c_encoding_decoding()

{burst_link_protocol-1.0.2 → burst_link_protocol-1.0.3}/test/test_c_validation.py

@@ -1,11 +1,11 @@
-
-from burst_link_protocol import BurstInterfacePy,BurstInterfaceC
+from burst_link_protocol import BurstInterfacePy, BurstInterfaceC
 import pytest
 import numpy as np
 
+
 def test_c_decoder_python():
-    python_interface =  BurstInterfacePy()
-    c_interface =  BurstInterfaceC()
+    python_interface = BurstInterfacePy()
+    c_interface = BurstInterfaceC()
 
     packets = [b"Hello, world!", b"Goodbye, world!"]
 
@@ -14,39 +14,45 @@ def test_c_decoder_python():
     print(decoded)
     assert packets == decoded
 
+
 def test_python_crc_validation():
-    interface =  BurstInterfacePy()
+    interface = BurstInterfacePy()
     packets = [b"Hello, world!", b"Goodbye, world!"]
 
     data = bytearray(interface.encode(packets))
 
-    for i in range( len(data)):
-        c_interface =  BurstInterfaceC()
+    for i in range(len(data)):
+        c_interface = BurstInterfaceC()
 
         data_copy = data.copy()
 
         # modify byte x
         data_copy[i] = (data_copy[i] + 1) % 256
         with pytest.raises(Exception):
-            decoded = c_interface.decode(bytes(data_copy),fail_on_crc_error=True)
+            decoded = c_interface.decode(bytes(data_copy), fail_on_crc_error=True)
             print(decoded)
-            assert len(decoded) == len(packets), f"Expected {len(packets)} packets, got {len(decoded)}"
+            assert len(decoded) == len(packets), (
+                f"Expected {len(packets)} packets, got {len(decoded)}"
+            )
+
 
 def test_max_size_error():
-    interface =  BurstInterfacePy()
-    c_interface =  BurstInterfaceC()
+    interface = BurstInterfacePy()
+    c_interface = BurstInterfaceC()
     packets = np.random.bytes(1500)
     with pytest.raises(Exception):
-        data = c_interface.decode(interface.encode([packets]),fail_on_crc_error=True)
-    
+        data = c_interface.decode(interface.encode([packets]), fail_on_crc_error=True)
+
+
 def test_encoding():
-    interface =  BurstInterfacePy()
-    c_interface =  BurstInterfaceC()
+    interface = BurstInterfacePy()
+    c_interface = BurstInterfaceC()
     packets = [b"Hello, world!", b"Goodbye, world!"]
 
     assert interface.encode(packets) == c_interface.encode(packets)
 
+
 # if __name__ == "__main__":
 #     # test_c_decoder_python()
 #     # test_python_crc_validation()
-#     # max_size_error()
+#     # max_size_error()