pyfastnet 1.2.3__tar.gz → 1.2.4__tar.gz

{pyfastnet-1.2.3/pyfastnet.egg-info → pyfastnet-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyfastnet
-Version: 1.2.3
+Version: 1.2.4
 Summary: A Python library for decoding FastNet protocol data streams.
 Home-page: https://github.com/ghotihook/pyfastnet
 Author: Alex Salmon

{pyfastnet-1.2.3 → pyfastnet-1.2.4}/fastnet_decoder/decode_fastnet.py

@@ -369,7 +369,8 @@ def decode_format_and_data(channel_id, format_byte, data_bytes):
             segment_code = (data_bytes[0] >> 1) & 0b01111111  # 7-bit segment
             unsigned_value = ((data_bytes[0] & 0b1) << 8) | data_bytes[1]  # 9-bit unsigned value
             interpreted_value = unsigned_value / divisor
-            raw_value = {"segment_code": segment_code, "unsigned_value": unsigned_value}
+            layout = convert_segment_a_to_char(segment_code)
+            raw_value = {"segment_code": segment_code, "layout": layout, "unsigned_value": unsigned_value}
 
         elif format_bits == 0x0A:  # 16-bit signed + 16-bit signed
             if len(data_bytes) != 4:

{pyfastnet-1.2.3 → pyfastnet-1.2.4}/fastnet_decoder/utils.py

@@ -62,6 +62,7 @@ def convert_segment_a_to_char(segment_byte):
     #}
 
     segment_mapping = {
+        0x66: "°M",  # magnetic bearing indicator (seen on Heading, Course, TWD, Tidal Set)
         0x28: "[data]=",
         0xa8: "=[data]",
         0x20: "[data]-",

{pyfastnet-1.2.3 → pyfastnet-1.2.4/pyfastnet.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyfastnet
-Version: 1.2.3
+Version: 1.2.4
 Summary: A Python library for decoding FastNet protocol data streams.
 Home-page: https://github.com/ghotihook/pyfastnet
 Author: Alex Salmon

{pyfastnet-1.2.3 → pyfastnet-1.2.4}/pyfastnet.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ tests/test_apparent_frame.py
 tests/test_autopilot_frame.py
 tests/test_depth_frame.py
 tests/test_format07_msb_regression.py
+tests/test_format08_layout.py
 tests/test_heel_frame.py
 tests/test_rudder_frame.py
 tests/test_tide_frame.py

{pyfastnet-1.2.3 → pyfastnet-1.2.4}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="pyfastnet",
-    version="1.2.3",  # Ensure this matches your intended version
+    version="1.2.4",  # Ensure this matches your intended version
     author="Alex Salmon",
     author_email="alex@ivila.net",
     description="A Python library for decoding FastNet protocol data streams.",

pyfastnet-1.2.4/tests/test_format08_layout.py

@@ -0,0 +1,61 @@
+import unittest
+from fastnet_decoder.decode_fastnet import decode_frame
+
+
+class TestFormat08Layout(unittest.TestCase):
+    """
+    Tests for format 0x08 layout field (magnetic bearing indicator).
+
+    Format 0x08: SEGCODE_B-derived 7-bit segment code + 9-bit unsigned value.
+    Segment code 0x66 (segments f+g+a+b = degree symbol) activates the "°M"
+    annunciator on the Hydra 2000 FFD, indicating a magnetic-referenced bearing.
+
+    Frame "ff120e01e00b038c274908cc294a0a1cdd6067e5" contains:
+      - Rudder Angle (0x0b), format 0x03
+      - Heading     (0x49), format 0x08, data=[0xCC, 0x29]
+          data[0]=0xCC → segment_code = (0xCC >> 1) & 0x7F = 0x66 → layout "°M"
+          unsigned_value = 0x29 = 41 → interpreted 41.0°
+      - Heading Raw (0x4a), format 0x0a
+    """
+
+    FRAME_HEX = "ff120e01e00b038c274908cc294a0a1cdd6067e5"
+
+    def setUp(self):
+        self.decoded = decode_frame(bytes.fromhex(self.FRAME_HEX))
+        self.heading = self.decoded["values"]["Heading"]
+
+    def test_no_decode_error(self):
+        self.assertNotIn("error", self.decoded)
+
+    def test_heading_present(self):
+        self.assertIn("Heading", self.decoded["values"])
+
+    def test_heading_interpreted_value(self):
+        self.assertEqual(self.heading["interpreted"], 41.0)
+
+    def test_heading_format_is_08(self):
+        self.assertEqual(self.heading["format_bits"], 8)
+
+    def test_heading_raw_has_layout(self):
+        self.assertIn("layout", self.heading["raw"])
+
+    def test_heading_layout_is_magnetic(self):
+        self.assertEqual(self.heading["raw"]["layout"], "°M")
+
+    def test_heading_segment_code(self):
+        # 0x66 = segments f+g+a+b = degree symbol, co-activates Hydra 2000 "M" annunciator
+        self.assertEqual(self.heading["raw"]["segment_code"], 0x66)
+
+    def test_cog_true_has_blank_layout(self):
+        # COG True is GPS-derived — no magnetic indicator, segment code 0x00 = blank
+        # Frame: ff051601e5 ... e9 08 00 XX ... (COG True channel 0xe9)
+        # Use a frame that contains COG True with blank segment code
+        cog_frame = bytes.fromhex("FF051601E555610030566100185903A86B7F8700BB00016D08CD0DCB")
+        decoded = decode_frame(cog_frame)
+        cog = decoded["values"].get("Course Over Ground (True)")
+        if cog:
+            self.assertEqual(cog["raw"]["layout"], " ", "GPS COG should have blank layout (no magnetic indicator)")
+
+
+if __name__ == "__main__":
+    unittest.main()