dronecot 2.3.1__tar.gz → 2.3.2__tar.gz

{dronecot-2.3.1/dronecot.egg-info → dronecot-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dronecot
-Version: 2.3.1
+Version: 2.3.2
 Summary: Display Drones in Team Awareness Kit (TAK).
 Home-page: https://github.com/snstac/dronecot
 Maintainer: Greg Albrecht <oss@undef.net>

{dronecot-2.3.1 → dronecot-2.3.2/dronecot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dronecot
-Version: 2.3.1
+Version: 2.3.2
 Summary: Display Drones in Team Awareness Kit (TAK).
 Home-page: https://github.com/snstac/dronecot
 Maintainer: Greg Albrecht <oss@undef.net>

{dronecot-2.3.1 → dronecot-2.3.2}/dronecot.egg-info/SOURCES.txt

@@ -32,6 +32,7 @@ src/dronecot/wifi_parse.py
 tests/test_adsb_vehicle.py
 tests/test_bluez_capture.py
 tests/test_functions.py
+tests/test_mavlink_identity.py
 tests/test_rid_normalize.py
 tests/test_rid_track.py
 tests/test_sensor_detail.py

dronecot-2.3.2/src/dronecot/VERSION

@@ -0,0 +1 @@
+2.3.2

{dronecot-2.3.1 → dronecot-2.3.2}/src/dronecot/classes.py

@@ -82,13 +82,64 @@ class SerialWorker(pytak.QueueWorker):
 
         return serial_port, baud_rate
 
-    def _mavlink_pack_to_parse_payload_schema(self, messages, pack_size) -> dict:
+    @staticmethod
+    def _id_or_mac_to_mac(id_or_mac) -> Optional[str]:
+        """Render a MAVLink OpenDroneID ``id_or_mac`` field as an advertiser MAC.
+
+        ODID carries a 20-byte ``id_or_mac`` naming the TRANSMITTER, and it is the
+        only per-aircraft grouping key a MAVLink serial feed offers -- unlike a
+        BLE or Wi-Fi capture there is no radio MAC in the metadata.
+
+        Measured on a DroneScout DS110: populated on 58 of 58 packs, as
+        db:13:81:94:13:55 followed by 14 zero bytes.
+
+        Only a MAC-shaped value (6 significant bytes then padding) is returned.
+        The field may instead carry an opaque ID string, and calling that a MAC
+        would put a wrong-looking value in the CoT UID; such feeds keep the
+        previous behaviour until there is real hardware to test against.
+        """
+        if id_or_mac is None:
+            return None
+        raw = bytes(bytearray(id_or_mac))
+        if not any(raw) or len(raw) < 6 or any(raw[6:]):
+            return None
+        return ":".join("%02X" % b for b in raw[:6])
+
+    def _mavlink_meta(self, id_or_mac=None, payload_type: Optional[str] = None) -> dict:
+        """Sensor metadata for a MAVLink-sourced record.
+
+        The wireless path builds this via rid_normalize.bytes_to_rid_dict; the
+        MAVLink path used to skip it entirely and hand up a record with no
+        ``data`` sub-dict at all. Two consequences, both seen on a live box:
+
+          * no transmitter identity, so a pack carrying only System/OperatorID
+            and no BasicID had nothing to aggregate on and rendered as
+            op-Unknown-BasicID_0 -- every operator in range on ONE track;
+          * no sensor_id, so CoT was attributed to the default
+            dronecot_<hostname> rather than the configured SENSOR_ID, making it
+            impossible to tell which receiver saw a contact.
+        """
+        data = dronecot.rid_normalize.uas_meta_defaults(self.config)
+        if payload_type:
+            data["type"] = payload_type
+        mac = self._id_or_mac_to_mac(id_or_mac)
+        if mac:
+            data["MAC address"] = mac
+        return data
+
+    def _mavlink_pack_to_parse_payload_schema(
+        self, messages, pack_size, id_or_mac=None
+    ) -> dict:
         """Convert MAVLink OPEN_DRONE_ID_MESSAGE_PACK to parse_payload-like schema."""
         parsed = dronecot.odid.message_pack_to_dict(messages, pack_size)
-        return dronecot.rid_normalize.odid_parsed_to_rid_dict(parsed)
+        rid = dronecot.rid_normalize.odid_parsed_to_rid_dict(parsed)
+        rid["data"] = self._mavlink_meta(
+            id_or_mac, payload_type="MAVLink OPEN_DRONE_ID_MESSAGE_PACK"
+        )
+        return rid
 
     @staticmethod
-    def _adsb_vehicle_to_rid_dict(msg) -> dict:
+    def _adsb_vehicle_to_rid_dict(msg, meta: Optional[dict] = None) -> dict:
         """Convert a MAVLink ADSB_VEHICLE to a RIDWorker dict.
 
         The DroneScout Bridge (and similar Remote ID receivers) can emit detected
@@ -113,7 +164,7 @@ class SerialWorker(pytak.QueueWorker):
             "SpeedHorizontal": getattr(msg, "hor_velocity", 0) / 100.0,  # cm/s -> m/s
             "SpeedVertical": getattr(msg, "ver_velocity", 0) / 100.0,
             "Direction": getattr(msg, "heading", 0) / 100.0,  # cdeg -> deg
-            "data": {"type": "MAVLink ADSB_VEHICLE"},
+            "data": dict(meta) if meta else {"type": "MAVLink ADSB_VEHICLE"},
         }
 
     async def run(self, _=-1) -> None:
@@ -180,11 +231,19 @@ class SerialWorker(pytak.QueueWorker):
                 msg_type = msg.get_type()
                 if msg_type == "OPEN_DRONE_ID_MESSAGE_PACK":
                     parsed_payload = self._mavlink_pack_to_parse_payload_schema(
-                        msg.messages, msg.msg_pack_size
+                        msg.messages,
+                        msg.msg_pack_size,
+                        getattr(msg, "id_or_mac", None),
                     )
                     await self.put_queue(parsed_payload)
                 elif msg_type == "ADSB_VEHICLE":
-                    rid = self._adsb_vehicle_to_rid_dict(msg)
+                    rid = self._adsb_vehicle_to_rid_dict(
+                        msg,
+                        self._mavlink_meta(
+                            getattr(msg, "id_or_mac", None),
+                            payload_type="MAVLink ADSB_VEHICLE",
+                        ),
+                    )
                     if rid:
                         await self.put_queue(rid)
                 elif msg_type == "HEARTBEAT":

{dronecot-2.3.1 → dronecot-2.3.2}/src/dronecot/functions.py

@@ -269,7 +269,15 @@ def _rid_identity(data: dict) -> Tuple[str, Optional[str]]:
             # all. Fall back to the feed that delivered it so two receivers do
             # not collide, rather than the shared Unknown-BasicID_0 placeholder
             # that put every such aircraft on one track.
-            feed = src_data.get("sensor_id") or src_data.get("sensor ID")
+            # Checked at BOTH levels, for the same reason the MAC is: MQTT and
+            # serial feeds put this at the top level. Looking only in the
+            # sub-dict meant this rung silently never fired for them.
+            feed = (
+                src_data.get("sensor_id")
+                or src_data.get("sensor ID")
+                or data.get("sensor_id")
+                or data.get("sensor ID")
+            )
             feed = str(feed).strip() if feed else ""
             uasid = f"FEED-{feed}" if feed else "Unknown-BasicID_0"
 

dronecot-2.3.2/tests/test_mavlink_identity.py

@@ -0,0 +1,145 @@
+#!/usr/bin/env python3
+# Copyright Sensors & Signals LLC https://www.snstac.com/
+# SPDX-License-Identifier: Apache-2.0
+"""Transmitter identity on the MAVLink serial feed (DroneScout Bridge).
+
+Regression tests for operator tracks collapsing onto op-Unknown-BasicID_0.
+
+Measured on a live box (aryaos-4f11, DroneScout DS110, dronecot 2.3.1), 30s of
+CoT on the Mesh SA group, attributed by source IP:
+
+    op-Unknown-BasicID_0          x62   <- every operator on ONE track
+    RID.1787F04BM24010011195.uas  x54   correct
+    op-1787F04BM24010011195       x54   correct
+
+The aircraft UID resolved but the operator UID did not. Cause: the MAVLink path
+called rid_normalize.odid_parsed_to_rid_dict directly and attached no ``data``
+metadata at all, unlike the wireless path (bytes_to_rid_dict). With no MAC and no
+sensor_id, a pack carrying only System/OperatorID had no transmitter identity to
+key on, so functions._rid_identity fell all the way to Unknown-BasicID_0.
+
+MAVLink OpenDroneID carries a 20-byte ``id_or_mac`` naming the transmitter. The
+DS110 populates it on every pack -- measured 58 of 58, as
+db:13:81:94:13:55 + 14 zero bytes -- and it is the only per-aircraft grouping key
+a serial feed offers.
+"""
+
+import types
+import unittest
+from unittest import mock
+
+from dronecot.classes import SerialWorker
+from dronecot.functions import _rid_identity
+
+# Exactly what the DS110 sent, including the 14 bytes of padding.
+DS110_ID_OR_MAC = bytes.fromhex("db13819413550000000000000000000000000000")
+DS110_MAC = "DB:13:81:94:13:55"
+
+
+def _worker(sensor_id="dronescout"):
+    """A SerialWorker with just enough state for the metadata helpers."""
+    w = SerialWorker.__new__(SerialWorker)
+    w.config = {"SENSOR_ID": sensor_id}
+    return w
+
+
+class IdOrMacTestCase(unittest.TestCase):
+    def test_real_ds110_value_renders_as_mac(self):
+        self.assertEqual(SerialWorker._id_or_mac_to_mac(DS110_ID_OR_MAC), DS110_MAC)
+
+    def test_all_zeros_is_no_identity(self):
+        self.assertIsNone(SerialWorker._id_or_mac_to_mac(bytes(20)))
+
+    def test_absent_is_no_identity(self):
+        self.assertIsNone(SerialWorker._id_or_mac_to_mac(None))
+
+    def test_opaque_id_is_not_claimed_to_be_a_mac(self):
+        """Payload past byte 6 means this is an ID string, not a MAC.
+
+        Rendering it as one would put a wrong-looking value in the CoT UID, so it
+        is left alone rather than guessed at.
+        """
+        self.assertIsNone(SerialWorker._id_or_mac_to_mac(b"SERIAL12345678901234"))
+
+    def test_accepts_a_bare_six_byte_field(self):
+        self.assertEqual(
+            SerialWorker._id_or_mac_to_mac(bytes.fromhex("db13819413 55".replace(" ", ""))),
+            DS110_MAC,
+        )
+
+
+class MavlinkMetaTestCase(unittest.TestCase):
+    def test_meta_carries_identity_and_configured_sensor_id(self):
+        meta = _worker()._mavlink_meta(DS110_ID_OR_MAC, payload_type="pack")
+        self.assertEqual(meta["MAC address"], DS110_MAC)
+        # Previously absent, so CoT was attributed to dronecot_<hostname> and you
+        # could not tell which receiver saw a contact.
+        self.assertEqual(meta["sensor_id"], "dronescout")
+        self.assertEqual(meta["type"], "pack")
+
+    def test_no_identity_still_yields_sensor_id(self):
+        meta = _worker()._mavlink_meta(bytes(20))
+        self.assertNotIn("MAC address", meta)
+        self.assertEqual(meta["sensor_id"], "dronescout")
+
+
+class PackIdentityTestCase(unittest.TestCase):
+    """The actual regression: a pack with no BasicID must still identify itself."""
+
+    def _pack(self, parsed):
+        with mock.patch("dronecot.odid.message_pack_to_dict", return_value=parsed):
+            return _worker()._mavlink_pack_to_parse_payload_schema(
+                b"\x00" * 25, 1, DS110_ID_OR_MAC
+            )
+
+    def test_pack_without_basicid_gets_a_distinct_uid(self):
+        rid = self._pack({"OperatorLatitude": 37.7, "OperatorLongitude": -122.4})
+        uasid, mac = _rid_identity(rid)
+        self.assertEqual(mac, DS110_MAC)
+        # The bug: this was "Unknown-BasicID_0" for every transmitter in range.
+        self.assertNotEqual(uasid, "Unknown-BasicID_0")
+        self.assertEqual(uasid, "MAC-DB1381941355")
+
+    def test_pack_with_basicid_prefers_the_real_serial(self):
+        rid = self._pack({"UASID": "1787F04BM24010011195"})
+        uasid, mac = _rid_identity(rid)
+        self.assertEqual(uasid, "1787F04BM24010011195")
+        self.assertEqual(mac, DS110_MAC)
+
+    def test_two_transmitters_do_not_collapse(self):
+        """The DS110 reports many aircraft over one port; they must stay distinct."""
+        other = bytes.fromhex("aabbccddeeff" + "00" * 14)
+        with mock.patch("dronecot.odid.message_pack_to_dict", return_value={}):
+            a = _worker()._mavlink_pack_to_parse_payload_schema(
+                b"\x00" * 25, 1, DS110_ID_OR_MAC
+            )
+            b = _worker()._mavlink_pack_to_parse_payload_schema(
+                b"\x00" * 25, 1, other
+            )
+        self.assertNotEqual(_rid_identity(a)[0], _rid_identity(b)[0])
+
+
+class SensorIdFallbackTestCase(unittest.TestCase):
+    """_rid_identity looked for sensor_id only in data['data'].
+
+    The MAC was already checked at both levels because "MQTT and serial feeds put
+    it at the top level" -- the same is true of sensor_id, so that rung of the
+    fallback silently never fired for those feeds.
+    """
+
+    def test_top_level_sensor_id_is_used(self):
+        uasid, mac = _rid_identity({"sensor_id": "dronescout"})
+        self.assertIsNone(mac)
+        self.assertEqual(uasid, "FEED-dronescout")
+
+    def test_nested_sensor_id_still_works(self):
+        uasid, _ = _rid_identity({"data": {"sensor_id": "dronescout"}})
+        self.assertEqual(uasid, "FEED-dronescout")
+
+    def test_nothing_at_all_is_still_the_last_resort(self):
+        uasid, _ = _rid_identity({})
+        self.assertEqual(uasid, "Unknown-BasicID_0")
+
+
+if __name__ == "__main__":
+    unittest.main()

dronecot-2.3.1/src/dronecot/VERSION

@@ -1 +0,0 @@
-2.3.1