pyfastnet 3.0.0__tar.gz → 3.1.0__tar.gz

{pyfastnet-3.0.0/pyfastnet.egg-info → pyfastnet-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyfastnet
-Version: 3.0.0
+Version: 3.1.0
 Summary: A Python library for decoding FastNet protocol data streams.
 Author-email: Alex Salmon <alex@ivila.net>
 License: MIT License
@@ -170,9 +170,18 @@ unit_for("environment.water.temperature")   # "K"
 unit_for("navigation.position")             # "deg"
 ```
 
-The complete mapping — every B&G channel id/name → Signal K path + unit, the
-`bandg.*` vendor namespace, layout-driven Magnetic/True routing, and the
-dropped/collapsed channels — is documented in
+The master reference — every B&G channel number → name → Signal K path + unit — is
+`channel_map()`, derived from the projection tables so it can't drift:
+
+```python
+from fastnet_decoder import channel_map
+channel_map()[0x41]
+# {'name': 'Boatspeed (Knots)', 'path': 'navigation.speedThroughWater',
+#  'unit': 'm/s', 'kind': 'standard'}
+```
+
+It is rendered as a table in [`docs/channel_map.md`](docs/channel_map.md). The design
+rationale, `bandg.*` namespace, Magnetic/True routing, and open TBCs are in
 [`docs/v3_signalk_mapping.md`](docs/v3_signalk_mapping.md).
 
 ### Position

{pyfastnet-3.0.0 → pyfastnet-3.1.0}/README.md

@@ -118,9 +118,18 @@ unit_for("environment.water.temperature")   # "K"
 unit_for("navigation.position")             # "deg"
 ```
 
-The complete mapping — every B&G channel id/name → Signal K path + unit, the
-`bandg.*` vendor namespace, layout-driven Magnetic/True routing, and the
-dropped/collapsed channels — is documented in
+The master reference — every B&G channel number → name → Signal K path + unit — is
+`channel_map()`, derived from the projection tables so it can't drift:
+
+```python
+from fastnet_decoder import channel_map
+channel_map()[0x41]
+# {'name': 'Boatspeed (Knots)', 'path': 'navigation.speedThroughWater',
+#  'unit': 'm/s', 'kind': 'standard'}
+```
+
+It is rendered as a table in [`docs/channel_map.md`](docs/channel_map.md). The design
+rationale, `bandg.*` namespace, Magnetic/True routing, and open TBCs are in
 [`docs/v3_signalk_mapping.md`](docs/v3_signalk_mapping.md).
 
 ### Position

{pyfastnet-3.0.0 → pyfastnet-3.1.0}/fastnet_decoder/__init__.py

@@ -1,9 +1,9 @@
-__version__ = "3.0.0"
+__version__ = "3.1.0"
 
 from .frame_buffer import FrameBuffer
 from .decode_fastnet import decode_frame, decode_ascii_frame, decode_light_frame
-from .signalk_map import project, unit_for  # v3: projection + per-path SI units
+from .signalk_map import project, unit_for, channel_map  # projection + units + master map
 from .logger import logger, set_log_level  # Import set_log_level for user control
 
 __all__ = ["FrameBuffer", "decode_frame", "decode_ascii_frame", "decode_light_frame",
-           "project", "unit_for", "logger", "set_log_level"]
+           "project", "unit_for", "channel_map", "logger", "set_log_level"]

{pyfastnet-3.0.0 → pyfastnet-3.1.0}/fastnet_decoder/signalk_map.py

@@ -121,7 +121,7 @@ VENDOR = {
     0x29: ("bandg.steering.offCourse", _deg),
     0xAF: ("bandg.steering.autopilot.offCourse", _deg),
     0x46: ("bandg.steering.autopilot.fixedSpeed", _kn),
-    0x86: ("bandg.environment.pressureTrend", _hpa),
+    0x86: ("bandg.environment.pressureTrend", _id),   # rate/tendency, encoding TBC — opaque
     0xDC: ("bandg.time.local", _id),
     0x75: ("bandg.time.timer", _id),
 }
@@ -180,6 +180,59 @@ def unit_for(path):
     return ""
 
 
+# ── Master reference: B&G channel -> name -> Signal K path ─────────────────────
+# Channels collapsed onto a canonical sibling (redundant unit/format variants).
+COLLAPSED = {
+    0x1C: "environment.outside.temperature",            # Air Temp °F -> °C
+    0x1E: "environment.water.temperature",              # Sea Temp °F -> °C
+    0x4D: "environment.wind.speedApparent",             # AWS knots -> m/s
+    0x55: "environment.wind.speedTrue",                 # TWS knots -> m/s
+    0x65: "bandg.navigation.speedThroughWaterAverage",  # Average Speed raw -> 0x64
+}
+
+
+def _disposition(cid):
+    """(path, unit, kind) for a channel id, resolved against the projection maps."""
+    if cid in _ROUTED:
+        m, _t, _ = _ROUTED[cid]
+        stem = m[:-len("Magnetic")]            # m ends with "Magnetic"
+        return f"{stem}{{Magnetic,True}}", "rad", "routed(M/T)"
+    if cid in (0xC1, 0xC2, 0xC3):
+        return DEPTH_PATH, "m", "standard(depth fallback)"
+    if cid == 0xB5:
+        return "steering.autopilot.state", "enum", "standard"
+    if cid in STANDARD:
+        p = STANDARD[cid][0]
+        return p, unit_for(p.format(id="house")), "standard"
+    if cid in VENDOR:
+        p = VENDOR[cid][0]
+        return p, unit_for(p), "vendor"
+    if cid in COLLAPSED:
+        return f"→ {COLLAPSED[cid]}", "", "collapsed"
+    if cid in DROP:
+        return "—", "", "drop"
+    return f"bandg.unknown.0x{cid:02X}", "", "unknown"
+
+
+def channel_map():
+    """Master reference table: ``{channel_id: {"name","path","unit","kind"}}`` for
+    every B&G channel in ``CHANNEL_LOOKUP``.
+
+    Derived from the projection maps (``STANDARD``/``DEPTH``/``_ROUTED``/``VENDOR``/
+    ``COLLAPSED``/``DROP``), so it is always in step with what ``project()`` emits —
+    treat this as the authoritative B&G-channel → Signal K-path reference.
+
+    Note: position (``navigation.position``) and backlight come from *command* frames
+    (LatLon / Light Intensity), not channel ids, so they are not listed here.
+    """
+    from .mappings import CHANNEL_LOOKUP
+    out = {}
+    for cid, bng in sorted(CHANNEL_LOOKUP.items()):
+        path, unit, kind = _disposition(cid)
+        out[cid] = {"name": bng, "path": path, "unit": unit, "kind": kind}
+    return out
+
+
 def _cid(entry):
     """Parse a decoded value's channel_id ('0xC1') to int, or None."""
     raw = entry.get("channel_id")
@@ -229,9 +282,10 @@ def parse_position(ascii_text):
 def project(decoded_frame, battery_id="house"):
     """Project a decoded frame (from decode_frame/ascii/light) → {signalk_path: value}.
 
-    Returns SI floats / enum strings / position dicts / None. Unmapped or dropped
-    channels are omitted. Layout-routed bearings pick Magnetic vs True from the
-    decoded layout byte.
+    Returns SI floats / enum strings / position dicts / None. Dropped and collapsed
+    channels are omitted; a channel we could decode but have no mapping for is kept
+    under ``bandg.unknown.0x<id>`` (raw value) so decodable data is never silently
+    lost. Layout-routed bearings pick Magnetic vs True from the decoded layout byte.
     """
     command = decoded_frame.get("command")
     values = decoded_frame.get("values", {})
@@ -249,7 +303,7 @@ def project(decoded_frame, battery_id="house"):
     for entry in values.values():
         cid = _cid(entry)
         value = entry.get("value")
-        if cid is None or cid in DROP:
+        if cid is None or cid in DROP or cid in COLLAPSED:
             continue
 
         # Depth fallback chain, resolved after the loop.
@@ -283,6 +337,11 @@ def project(decoded_frame, battery_id="house"):
         if cid in VENDOR:
             path, tf = VENDOR[cid]
             out[path] = tf(value) if value is not None else None
+            continue
+
+        # Unmapped but decodable — keep it (raw value) rather than drop it silently.
+        if value is not None:
+            out[f"bandg.unknown.0x{cid:02X}"] = value
 
     # Resolve depth by priority: metres → feet → fathoms.
     for cid, tf in DEPTH:

{pyfastnet-3.0.0 → pyfastnet-3.1.0/pyfastnet.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyfastnet
-Version: 3.0.0
+Version: 3.1.0
 Summary: A Python library for decoding FastNet protocol data streams.
 Author-email: Alex Salmon <alex@ivila.net>
 License: MIT License
@@ -170,9 +170,18 @@ unit_for("environment.water.temperature")   # "K"
 unit_for("navigation.position")             # "deg"
 ```
 
-The complete mapping — every B&G channel id/name → Signal K path + unit, the
-`bandg.*` vendor namespace, layout-driven Magnetic/True routing, and the
-dropped/collapsed channels — is documented in
+The master reference — every B&G channel number → name → Signal K path + unit — is
+`channel_map()`, derived from the projection tables so it can't drift:
+
+```python
+from fastnet_decoder import channel_map
+channel_map()[0x41]
+# {'name': 'Boatspeed (Knots)', 'path': 'navigation.speedThroughWater',
+#  'unit': 'm/s', 'kind': 'standard'}
+```
+
+It is rendered as a table in [`docs/channel_map.md`](docs/channel_map.md). The design
+rationale, `bandg.*` namespace, Magnetic/True routing, and open TBCs are in
 [`docs/v3_signalk_mapping.md`](docs/v3_signalk_mapping.md).
 
 ### Position

{pyfastnet-3.0.0 → pyfastnet-3.1.0}/pyfastnet.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ tests/test_aws.py
 tests/test_backlight.py
 tests/test_battery.py
 tests/test_boatspeed.py
+tests/test_channel_map.py
 tests/test_depth_frame.py
 tests/test_format07_msb_regression.py
 tests/test_format08_layout.py

pyfastnet-3.1.0/tests/test_channel_map.py

@@ -0,0 +1,28 @@
+"""channel_map() is the master reference — verify coverage and doc sync."""
+import importlib.util
+from pathlib import Path
+
+from fastnet_decoder import channel_map
+from fastnet_decoder.mappings import CHANNEL_LOOKUP
+
+DOCS = Path(__file__).resolve().parents[1] / "docs"
+
+
+def test_covers_every_channel():
+    cm = channel_map()
+    assert set(cm) == set(CHANNEL_LOOKUP), "channel_map must cover all CHANNEL_LOOKUP ids"
+    for cid, r in cm.items():
+        assert r["name"] == CHANNEL_LOOKUP[cid]
+        assert set(r) == {"name", "path", "unit", "kind"}
+
+
+def test_doc_is_in_sync():
+    # Render via the generator and compare to the committed doc — catches drift.
+    spec = importlib.util.spec_from_file_location("gen_cm", DOCS / "generate_channel_map.py")
+    gen = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(gen)
+    rows = channel_map()
+    committed = (DOCS / "channel_map.md").read_text()
+    for cid, r in rows.items():
+        assert f"| 0x{cid:02X} | {r['name']} | `{r['path']}` |" in committed, \
+            f"docs/channel_map.md out of date for 0x{cid:02X} — regenerate it"

{pyfastnet-3.0.0 → pyfastnet-3.1.0}/tests/test_signalk_projection.py

@@ -135,6 +135,26 @@ def test_vendor_path():
     assert "bandg.wind.upwash" in out
 
 
+def test_unmapped_channel_emitted_as_unknown():
+    out = sk.project(_frame("0x0C", 123.0))            # Linear 5 — in CHANNEL_LOOKUP, unmapped
+    assert out == {"bandg.unknown.0x0C": 123.0}
+
+
+def test_unknown_channel_id_emitted():
+    out = sk.project(_frame("0xC4", 42.0))             # id not in CHANNEL_LOOKUP
+    assert out == {"bandg.unknown.0xC4": 42.0}
+
+
+def test_collapsed_channel_not_unknown():
+    out = sk.project(_frame("0x1C", 70.0))             # Air Temp °F — collapsed, must be dropped
+    assert out == {}
+
+
+def test_unknown_skips_none_value():
+    out = sk.project(_frame("0xC5", None))             # unmapped, no value → nothing
+    assert out == {}
+
+
 # ── end-to-end against a real decoded frame ───────────────────────────────────
 def test_real_heel_frame_end_to_end():
     # Heel-to-port frame (value -20.4°) from tests/test_heel_trim.py