pyfastnet 2.0.13__tar.gz → 2.0.14__tar.gz

{pyfastnet-2.0.13/pyfastnet.egg-info → pyfastnet-2.0.14}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: pyfastnet
-Version: 2.0.13
+Version: 2.0.14
 Summary: A Python library for decoding FastNet protocol data streams.
 Home-page: https://github.com/ghotihook/pyfastnet
 Author: Alex Salmon
@@ -17,6 +17,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: requires-python
 Dynamic: summary
 
@@ -99,6 +100,22 @@ Each decoded frame is a dict with `to_address`, `from_address`, `command`, and `
 }
 ```
 
+### Position (LatLon) frames
+
+Position frames (command `LatLon`) appear under the `"LatLon"` key. The raw coordinate
+string (`DDMM.mmm` with hemisphere letters) is carried in `display_text`; `value` is
+`None`. The originating source's marker byte is preserved in `channel_id` (e.g. `0x47`,
+`0x4E`) but does not affect the key:
+
+```python
+"LatLon": {
+    "channel_id":   "0x4E",
+    "value":        None,
+    "display_text": "3352.450S15113.920E",
+    "layout":       None,
+}
+```
+
 ### Layout field
 
 The `layout` field describes the indicator symbol shown on the physical display around the numeric value:

{pyfastnet-2.0.13 → pyfastnet-2.0.14}/README.md

@@ -77,6 +77,22 @@ Each decoded frame is a dict with `to_address`, `from_address`, `command`, and `
 }
 ```
 
+### Position (LatLon) frames
+
+Position frames (command `LatLon`) appear under the `"LatLon"` key. The raw coordinate
+string (`DDMM.mmm` with hemisphere letters) is carried in `display_text`; `value` is
+`None`. The originating source's marker byte is preserved in `channel_id` (e.g. `0x47`,
+`0x4E`) but does not affect the key:
+
+```python
+"LatLon": {
+    "channel_id":   "0x4E",
+    "value":        None,
+    "display_text": "3352.450S15113.920E",
+    "layout":       None,
+}
+```
+
 ### Layout field
 
 The `layout` field describes the indicator symbol shown on the physical display around the numeric value:

{pyfastnet-2.0.13 → pyfastnet-2.0.14}/fastnet_decoder/decode_fastnet.py

@@ -119,9 +119,14 @@ def decode_ascii_frame(frame: bytes) -> dict:
         channel_id   = body[0]
         # body[1] is a format byte — not used for ASCII frames
         data_bytes   = body[2:]
-        channel_name = CHANNEL_LOOKUP.get(channel_id)
-        if channel_name is None:
-            channel_name = f"Unknown (0x{channel_id:02X})"
+        # This decoder is only ever called for LatLon command frames, so the
+        # entry is named from the command — not from body[0]. body[0] is a
+        # source/marker byte that varies by GPS unit (0x47, 0x4E, ...) and is
+        # NOT a generic channel id; looking it up in CHANNEL_LOOKUP produced
+        # nonsense names like "Apparent Wind Speed (Raw)". The raw byte is kept
+        # in channel_id below for diagnostics.
+        cmd_name     = COMMAND_LOOKUP.get(command)
+        channel_name = cmd_name if cmd_name is not None else f"Unknown (0x{command:02X})"
 
         try:
             ascii_text = data_bytes.decode("ascii").strip()
@@ -133,7 +138,6 @@ def decode_ascii_frame(frame: bytes) -> dict:
 
         to_name   = ADDRESS_LOOKUP.get(to_address)
         from_name = ADDRESS_LOOKUP.get(from_address)
-        cmd_name  = COMMAND_LOOKUP.get(command)
 
         return {
             "to_address":   to_name   if to_name   is not None else f"Unknown (0x{to_address:02X})",

{pyfastnet-2.0.13 → pyfastnet-2.0.14}/fastnet_decoder/mappings.py

@@ -192,7 +192,6 @@ CHANNEL_LOOKUP = {
     0x42: "Boatspeed (Raw)",
     0x44: "Yaw rate",
     0x46: "Autopilot Speed Fixed (Knots)",
-    0x47: "LatLon",
     0x49: "Heading",
     0x4A: "Heading (Raw)",
     0x4D: "Apparent Wind Speed (Knots)",

{pyfastnet-2.0.13 → pyfastnet-2.0.14/pyfastnet.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: pyfastnet
-Version: 2.0.13
+Version: 2.0.14
 Summary: A Python library for decoding FastNet protocol data streams.
 Home-page: https://github.com/ghotihook/pyfastnet
 Author: Alex Salmon
@@ -17,6 +17,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: requires-python
 Dynamic: summary
 
@@ -99,6 +100,22 @@ Each decoded frame is a dict with `to_address`, `from_address`, `command`, and `
 }
 ```
 
+### Position (LatLon) frames
+
+Position frames (command `LatLon`) appear under the `"LatLon"` key. The raw coordinate
+string (`DDMM.mmm` with hemisphere letters) is carried in `display_text`; `value` is
+`None`. The originating source's marker byte is preserved in `channel_id` (e.g. `0x47`,
+`0x4E`) but does not affect the key:
+
+```python
+"LatLon": {
+    "channel_id":   "0x4E",
+    "value":        None,
+    "display_text": "3352.450S15113.920E",
+    "layout":       None,
+}
+```
+
 ### Layout field
 
 The `layout` field describes the indicator symbol shown on the physical display around the numeric value:

{pyfastnet-2.0.13 → pyfastnet-2.0.14}/pyfastnet.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ tests/test_depth_frame.py
 tests/test_format07_msb_regression.py
 tests/test_format08_layout.py
 tests/test_heel_frame.py
+tests/test_latlon_frame.py
 tests/test_rudder_frame.py
 tests/test_tide_frame.py
 tests/test_true_frame.py

{pyfastnet-2.0.13 → pyfastnet-2.0.14}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="pyfastnet",
-    version="2.0.13",  # Ensure this matches your intended version
+    version="2.0.14",  # 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-2.0.14/tests/test_latlon_frame.py

@@ -0,0 +1,56 @@
+import unittest
+from fastnet_decoder.decode_fastnet import decode_ascii_frame
+
+
+class TestLatLonFrame(unittest.TestCase):
+    """
+    Tests for LatLon (position) command frames (command 0x03).
+
+    These frames are dispatched to decode_ascii_frame, which carries the raw
+    coordinate string in display_text. The entry is named from the command
+    ("LatLon") — NOT from body[0]. body[0] is a per-source marker byte that
+    varies by GPS unit (0x4E, 0x47, ...) and is not a generic channel id, so
+    it must not be looked up in CHANNEL_LOOKUP (doing so previously mislabelled
+    positions as "Apparent Wind Speed (Raw)").
+    """
+
+    # Real frame, from_address 0x60 (External Compass NMEA FFD 60).
+    # body[0] = 0x4E. Position: 33°52.450'S, 151°13.920'E (Sydney).
+    FRAME_4E = "ff601503894e50333335322e3435305331353131332e3932304572"
+
+    # Real frame, from_address 0x62 (External Compass NMEA FFD 62).
+    # body[0] = 0x47. Position: 16°46.61'S, 179°20.23'E.
+    FRAME_47 = "ff621503874750313634362e3631205331373932302e3233204595"
+
+    def test_4e_source_keyed_latlon(self):
+        values = decode_ascii_frame(bytes.fromhex(self.FRAME_4E))["values"]
+        self.assertIn("LatLon", values)
+        self.assertNotIn("Apparent Wind Speed (Raw)", values)
+        entry = values["LatLon"]
+        self.assertEqual(entry["channel_id"], "0x4E")
+        self.assertEqual(entry["display_text"], "3352.450S15113.920E")
+        self.assertIsNone(entry["value"])
+
+    def test_47_source_keyed_latlon(self):
+        values = decode_ascii_frame(bytes.fromhex(self.FRAME_47))["values"]
+        self.assertIn("LatLon", values)
+        entry = values["LatLon"]
+        self.assertEqual(entry["channel_id"], "0x47")
+        self.assertEqual(entry["display_text"], "1646.61 S17920.23 E")
+        self.assertIsNone(entry["value"])
+
+    def test_both_sources_share_one_key(self):
+        # The fix normalises differing source bytes to a single consistent key.
+        keys_4e = set(decode_ascii_frame(bytes.fromhex(self.FRAME_4E))["values"])
+        keys_47 = set(decode_ascii_frame(bytes.fromhex(self.FRAME_47))["values"])
+        self.assertEqual(keys_4e, keys_47, {"LatLon"})
+
+    def test_command_metadata(self):
+        decoded = decode_ascii_frame(bytes.fromhex(self.FRAME_4E))
+        self.assertNotIn("error", decoded)
+        self.assertEqual(decoded["command"], "LatLon")
+        self.assertEqual(decoded["from_address"], "External Compass (NMEA FFD 60)")
+
+
+if __name__ == "__main__":
+    unittest.main()