pyfastnet 2.0.15__tar.gz → 2.0.17__tar.gz

{pyfastnet-2.0.15/pyfastnet.egg-info → pyfastnet-2.0.17}/PKG-INFO

@@ -1,25 +1,54 @@
 Metadata-Version: 2.4
 Name: pyfastnet
-Version: 2.0.15
+Version: 2.0.17
 Summary: A Python library for decoding FastNet protocol data streams.
-Home-page: https://github.com/ghotihook/pyfastnet
-Author: Alex Salmon
-Author-email: alex@ivila.net
-Classifier: Programming Language :: Python :: 3
+Author-email: Alex Salmon <alex@ivila.net>
+License: MIT License
+        
+        Copyright (c) 2025 ghotihook
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/ghotihook/pyfastnet
+Project-URL: Repository, https://github.com/ghotihook/pyfastnet
+Project-URL: Issues, https://github.com/ghotihook/pyfastnet/issues
+Keywords: fastnet,bandg,hydra,h2000,marine,sailing,decoder
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
 Dynamic: license-file
-Dynamic: requires-python
-Dynamic: summary
 
 # pyfastnet
 
@@ -153,10 +182,9 @@ fb.get_buffer_contents()  # hex string of buffer contents
 
 ## Companion apps
 
-- [fastnet2ip](https://github.com/ghotihook/fastnet2ip) — reads FastNet from serial, broadcasts NMEA 0183 via UDP
-- [fastnet2ip_n2k](https://github.com/ghotihook/fastnet2ip_n2k) — reads FastNet from serial, broadcasts NMEA 2000 via UDP
+- [fastnet2ip](https://github.com/ghotihook/fastnet2ip) — reads FastNet from serial and broadcasts it over UDP as either NMEA 0183 or NMEA 2000 (selected with `--output`). Install with `pipx install fastnet2ip`.
 
-Both run on Raspberry Pi, macOS, or Linux.
+Runs on Raspberry Pi, macOS, or Linux.
 
 ## Acknowledgments
 

{pyfastnet-2.0.15 → pyfastnet-2.0.17}/README.md

@@ -130,10 +130,9 @@ fb.get_buffer_contents()  # hex string of buffer contents
 
 ## Companion apps
 
-- [fastnet2ip](https://github.com/ghotihook/fastnet2ip) — reads FastNet from serial, broadcasts NMEA 0183 via UDP
-- [fastnet2ip_n2k](https://github.com/ghotihook/fastnet2ip_n2k) — reads FastNet from serial, broadcasts NMEA 2000 via UDP
+- [fastnet2ip](https://github.com/ghotihook/fastnet2ip) — reads FastNet from serial and broadcasts it over UDP as either NMEA 0183 or NMEA 2000 (selected with `--output`). Install with `pipx install fastnet2ip`.
 
-Both run on Raspberry Pi, macOS, or Linux.
+Runs on Raspberry Pi, macOS, or Linux.
 
 ## Acknowledgments
 

{pyfastnet-2.0.15 → pyfastnet-2.0.17}/fastnet_decoder/__init__.py

@@ -1,3 +1,5 @@
+__version__ = "2.0.17"
+
 from .frame_buffer import FrameBuffer
 from .decode_fastnet import decode_frame, decode_ascii_frame
 from .logger import logger, set_log_level  # Import set_log_level for user control

{pyfastnet-2.0.15 → pyfastnet-2.0.17}/fastnet_decoder/decode_fastnet.py

@@ -1,4 +1,5 @@
 import datetime
+import logging
 from .mappings import ADDRESS_LOOKUP, COMMAND_LOOKUP, CHANNEL_LOOKUP, FORMAT_SIZE_MAP
 from .mappings import SEGMENT_A, SEGMENT_B, AUTOPILOT_MODES
 from .logger import logger
@@ -109,6 +110,81 @@ def decode_frame(frame: bytes) -> dict:
         return {"error": "Decoding failure"}
 
 
+def probe_frame(frame: bytes) -> None:
+    """
+    Speculatively unpack a non-broadcast frame using the same channel-record
+    assembly as Broadcast frames, for reverse-engineering only.
+
+    The body layout of non-broadcast commands (pilot messages, NMEA-sourced
+    data, etc.) is NOT known to match the Broadcast channel-record format, so
+    everything decoded here is a guess: results are logged at DEBUG and are
+    never queued or assigned to channels. The point is to eyeball whether the
+    same (channel_id, format_byte, data...) structure holds for these frames.
+    """
+    if not logger.isEnabledFor(logging.DEBUG):
+        return
+    try:
+        to_address   = frame[0]
+        from_address = frame[1]
+        command      = frame[3]
+        body         = frame[5:-1]
+
+        to_name   = ADDRESS_LOOKUP.get(to_address,   f"Unknown (0x{to_address:02X})")
+        from_name = ADDRESS_LOOKUP.get(from_address, f"Unknown (0x{from_address:02X})")
+        cmd_name  = COMMAND_LOOKUP.get(command,      f"Unknown (0x{command:02X})")
+
+        logger.debug(
+            f"  PROBE cmd={cmd_name}  {to_name}←{from_name}  body=[{body.hex()}]"
+        )
+
+        index = 0
+        while index < len(body):
+            if index + 1 >= len(body):
+                logger.debug(f"    PROBE trailing byte  [{body[index:].hex()}]")
+                break
+
+            channel_id   = body[index]
+            format_byte  = body[index + 1]
+            channel_name = CHANNEL_LOOKUP.get(channel_id, f"Unknown (0x{channel_id:02X})")
+            index += 2
+
+            data_length = FORMAT_SIZE_MAP.get(format_byte & 0x0F, 0)
+            if data_length == 0:
+                logger.debug(
+                    f"    PROBE 0x{channel_id:02X} {channel_name}  "
+                    f"fmt=0x{format_byte:02X}  unknown format, stop  "
+                    f"remaining=[{body[index:].hex()}]"
+                )
+                break
+            if index + data_length > len(body):
+                logger.debug(
+                    f"    PROBE 0x{channel_id:02X} {channel_name}  "
+                    f"fmt=0x{format_byte:02X}  incomplete  need={data_length}B  "
+                    f"have={len(body) - index}B  remaining=[{body[index:].hex()}]"
+                )
+                break
+
+            data_bytes = body[index:index + data_length]
+            index     += data_length
+
+            decoded = decode_format_and_data(channel_id, format_byte, data_bytes)
+            if decoded:
+                logger.debug(
+                    f"    PROBE 0x{channel_id:02X} {channel_name}  "
+                    f"fmt=0x{format_byte:02X}  data=[{data_bytes.hex()}]  "
+                    f"value={decoded['value']}  display='{decoded['display_text']}'  "
+                    f"layout={decoded['layout']}"
+                )
+            else:
+                logger.debug(
+                    f"    PROBE 0x{channel_id:02X} {channel_name}  "
+                    f"fmt=0x{format_byte:02X}  data=[{data_bytes.hex()}]  (no decode)"
+                )
+
+    except Exception as e:
+        logger.debug(f"  PROBE error: {e}  [{frame.hex()}]")
+
+
 def decode_ascii_frame(frame: bytes) -> dict:
     try:
         to_address   = frame[0]

{pyfastnet-2.0.15 → pyfastnet-2.0.17}/fastnet_decoder/frame_buffer.py

@@ -1,7 +1,7 @@
 import logging
 from .utils import calculate_checksum
 from .mappings import COMMAND_LOOKUP, IGNORED_COMMANDS
-from .decode_fastnet import decode_frame, decode_ascii_frame
+from .decode_fastnet import decode_frame, decode_ascii_frame, probe_frame
 from .logger import logger
 from queue import Queue, Full
 
@@ -84,9 +84,22 @@ class FrameBuffer:
             self.decode_and_queue_frame(frame, command_name)
 
     def decode_and_queue_frame(self, frame, command_name):
-        """Decode a frame and add it to the queue if valid."""
-        decoder = decode_ascii_frame if command_name == "LatLon" else decode_frame
-        decoded_frame = decoder(frame)
+        """
+        Decode a frame and add it to the queue if valid.
+
+        Only Broadcast frames carry the channel-record body layout, and LatLon
+        frames carry ASCII; those are decoded and queued. Every other command
+        (pilot messages, NMEA-sourced data, etc.) has an unknown body structure,
+        so it is never queued — it is only probed speculatively for debugging.
+        """
+        if command_name == "Broadcast":
+            decoded_frame = decode_frame(frame)
+        elif command_name == "LatLon":
+            decoded_frame = decode_ascii_frame(frame)
+        else:
+            probe_frame(frame)
+            return
+
         if decoded_frame and "values" in decoded_frame:
             try:
                 self.frame_queue.put_nowait(decoded_frame)

{pyfastnet-2.0.15 → pyfastnet-2.0.17/pyfastnet.egg-info}/PKG-INFO

@@ -1,25 +1,54 @@
 Metadata-Version: 2.4
 Name: pyfastnet
-Version: 2.0.15
+Version: 2.0.17
 Summary: A Python library for decoding FastNet protocol data streams.
-Home-page: https://github.com/ghotihook/pyfastnet
-Author: Alex Salmon
-Author-email: alex@ivila.net
-Classifier: Programming Language :: Python :: 3
+Author-email: Alex Salmon <alex@ivila.net>
+License: MIT License
+        
+        Copyright (c) 2025 ghotihook
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/ghotihook/pyfastnet
+Project-URL: Repository, https://github.com/ghotihook/pyfastnet
+Project-URL: Issues, https://github.com/ghotihook/pyfastnet/issues
+Keywords: fastnet,bandg,hydra,h2000,marine,sailing,decoder
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
 Dynamic: license-file
-Dynamic: requires-python
-Dynamic: summary
 
 # pyfastnet
 
@@ -153,10 +182,9 @@ fb.get_buffer_contents()  # hex string of buffer contents
 
 ## Companion apps
 
-- [fastnet2ip](https://github.com/ghotihook/fastnet2ip) — reads FastNet from serial, broadcasts NMEA 0183 via UDP
-- [fastnet2ip_n2k](https://github.com/ghotihook/fastnet2ip_n2k) — reads FastNet from serial, broadcasts NMEA 2000 via UDP
+- [fastnet2ip](https://github.com/ghotihook/fastnet2ip) — reads FastNet from serial and broadcasts it over UDP as either NMEA 0183 or NMEA 2000 (selected with `--output`). Install with `pipx install fastnet2ip`.
 
-Both run on Raspberry Pi, macOS, or Linux.
+Runs on Raspberry Pi, macOS, or Linux.
 
 ## Acknowledgments
 

{pyfastnet-2.0.15 → pyfastnet-2.0.17}/pyfastnet.egg-info/SOURCES.txt

@@ -1,7 +1,6 @@
 LICENSE
-MANIFEST.in
 README.md
-setup.py
+pyproject.toml
 fastnet_decoder/__init__.py
 fastnet_decoder/decode_fastnet.py
 fastnet_decoder/frame_buffer.py
@@ -11,6 +10,7 @@ fastnet_decoder/utils.py
 pyfastnet.egg-info/PKG-INFO
 pyfastnet.egg-info/SOURCES.txt
 pyfastnet.egg-info/dependency_links.txt
+pyfastnet.egg-info/requires.txt
 pyfastnet.egg-info/top_level.txt
 tests/test_autopilot.py
 tests/test_awa.py

pyfastnet-2.0.17/pyfastnet.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[test]
+pytest>=7.0

pyfastnet-2.0.17/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyfastnet"
+dynamic = ["version"]
+description = "A Python library for decoding FastNet protocol data streams."
+readme = "README.md"
+requires-python = ">=3.7"
+license = { file = "LICENSE" }
+authors = [{ name = "Alex Salmon", email = "alex@ivila.net" }]
+keywords = ["fastnet", "bandg", "hydra", "h2000", "marine", "sailing", "decoder"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Communications",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/ghotihook/pyfastnet"
+Repository = "https://github.com/ghotihook/pyfastnet"
+Issues = "https://github.com/ghotihook/pyfastnet/issues"
+
+[project.optional-dependencies]
+test = ["pytest>=7.0"]
+
+[tool.setuptools.packages.find]
+include = ["fastnet_decoder*"]
+
+[tool.setuptools.dynamic]
+version = { attr = "fastnet_decoder.__version__" }

pyfastnet-2.0.15/MANIFEST.in

@@ -1,17 +0,0 @@
-# Include README, LICENSE, and other important files
-include README.md
-include LICENSE
-
-# Include all Python source files
-recursive-include pyfastnet *.py
-
-# Include tests directory
-recursive-include tests *.py
-
-# Include any data files, if applicable
-include pyfastnet/data/*
-
-# Exclude unwanted files (e.g., caches, temp files, etc.)
-global-exclude __pycache__/*
-global-exclude *.py[cod]
-global-exclude .DS_Store

pyfastnet-2.0.15/setup.py

@@ -1,20 +0,0 @@
-from setuptools import setup, find_packages
-
-setup(
-    name="pyfastnet",
-    version="2.0.15",
-    author="Alex Salmon",
-    author_email="alex@ivila.net",
-    description="A Python library for decoding FastNet protocol data streams.",
-    long_description=open("README.md").read(),
-    long_description_content_type="text/markdown",
-    url="https://github.com/ghotihook/pyfastnet",
-    packages=find_packages(),
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-    ],
-    python_requires=">=3.7",
-    install_requires=[]  # Add dependencies if required
-)