dronecot 2.3.3__tar.gz → 2.3.5__tar.gz

{dronecot-2.3.3 → dronecot-2.3.5}/CHANGELOG.md

@@ -1,3 +1,10 @@
+## DroneCOT 2.3.4
+
+- Include `dronecot/VERSION` in wheel and Debian installations. DroneCOT 2.3.3
+  omitted this runtime file and failed at import time after installation.
+- Verify wheel and Debian archives contain the runtime version file before
+  publishing a release.
+
 ## DroneCOT 2.3.3
 
 - Fixed the AntSDR scanner-push listener retaining active client tasks while

{dronecot-2.3.3/dronecot.egg-info → dronecot-2.3.5}/PKG-INFO

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

{dronecot-2.3.3 → dronecot-2.3.5/dronecot.egg-info}/PKG-INFO

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

{dronecot-2.3.3 → dronecot-2.3.5}/setup.cfg

@@ -60,6 +60,9 @@ install_requires =
 [options.packages.find]
 where = src
 
+[options.package_data]
+dronecot = VERSION
+
 [options.extras_require]
 with_takproto = takproto >= 2.0.0
 wifi = scapy >= 2.5.0

dronecot-2.3.5/src/dronecot/VERSION

@@ -0,0 +1 @@
+2.3.5

{dronecot-2.3.3 → dronecot-2.3.5}/src/dronecot/classes.py

@@ -937,24 +937,60 @@ class DJIWorker(pytak.QueueWorker):
     def __init__(self, tx_queue: asyncio.Queue, config, net_queue: asyncio.Queue) -> None:
         super().__init__(tx_queue, config)
         self.net_queue = net_queue
+        self.status = make_status("dronecot", dronecot.__version__)
 
     async def handle_data(self, data) -> None:
+        if not data:
+            return
+
+        self.status.count("rx")
         if isinstance(data, str):
             events = dronecot.dji_handle_text_line(data, self.config)
+            source = "dji-text"
         elif isinstance(data, bytes) and data.startswith(b"dji_O,"):
-            events = dronecot.dji_handle_text_line(data.decode("utf-8", errors="replace"), self.config)
+            events = dronecot.dji_handle_text_line(
+                data.decode("utf-8", errors="replace"), self.config
+            )
+            source = "dji-text"
         else:
             events = dronecot.dji_handle_frame(data, self.config)
+            source = "dji-binary"
+
+        if events:
+            self.status.count("emitted", len(events))
+        else:
+            self.status.count("no_cot")
+        # Do not copy aircraft identifiers or the raw RF payload into the
+        # world-readable status file. Operators need to know whether the
+        # AntSDR is producing usable data, not which aircraft it heard.
+        self.status.record(source=source, placed=bool(events), events=len(events))
+        self.status.write()
+
         for event in events:
             await self.put_queue(event)
 
     async def run(self, _=-1) -> None:
         self._logger.info("Running %s", self.__class__)
+        self.status.set(
+            feed=urlparse(str(self.config.get("FEED_URL", ""))).scheme or None,
+            decoder="dji",
+        )
+        self.status.write(force=True)
+        heartbeat = asyncio.ensure_future(self._heartbeat())
+        try:
+            while True:
+                received = await self.net_queue.get()
+                if not received:
+                    continue
+                await self.handle_data(received)
+        finally:
+            heartbeat.cancel()
+
+    async def _heartbeat(self, interval: float = 5.0) -> None:
+        """Keep DJI status fresh when the RF feed is connected but quiet."""
         while True:
-            received = await self.net_queue.get()
-            if not received:
-                continue
-            await self.handle_data(received)
+            await asyncio.sleep(interval)
+            self.status.write(force=True)
 
 
 class _DJIFeedWorker(pytak.QueueWorker):

{dronecot-2.3.3 → dronecot-2.3.5}/tests/test_status.py

@@ -209,6 +209,70 @@ class TestStatusHeartbeat:
         assert doc["tracked"] == 0
 
 
+@needs_statuswriter
+class TestDJIStatusSurface:
+    """AntSDR/DJI feeds use DJIWorker rather than RIDWorker."""
+
+    def _worker(self, tmp_path):
+        worker = classes.DJIWorker.__new__(classes.DJIWorker)
+        worker.config = {"FEED_URL": "tcp://172.31.100.2:52002"}
+        worker.net_queue = asyncio.Queue()
+        worker._logger = logging.getLogger("test")
+        worker.status = pytak.StatusWriter(
+            "dronecot-test", path=str(tmp_path / "status.json")
+        )
+        worker.put_queue = _noop_put
+        return worker
+
+    def _doc(self, worker):
+        with open(worker.status.path) as handle:
+            return json.load(handle)
+
+    def test_text_frame_counts_received_and_emitted(self, tmp_path, monkeypatch):
+        worker = self._worker(tmp_path)
+        monkeypatch.setattr(
+            classes.dronecot,
+            "dji_handle_text_line",
+            lambda data, config: [b"<event/>", b"<event/>"],
+        )
+
+        asyncio.run(worker.handle_data("dji_O,test"))
+
+        doc = self._doc(worker)
+        assert doc["counters"] == {"rx": 1, "emitted": 2}
+        assert doc["recent"][-1] == {
+            "t": doc["recent"][-1]["t"],
+            "source": "dji-text",
+            "placed": True,
+            "events": 2,
+        }
+
+    def test_unrenderable_binary_frame_is_visible(self, tmp_path, monkeypatch):
+        worker = self._worker(tmp_path)
+        monkeypatch.setattr(
+            classes.dronecot, "dji_handle_frame", lambda data, config: []
+        )
+
+        asyncio.run(worker.handle_data(b"binary-frame"))
+
+        doc = self._doc(worker)
+        assert doc["counters"] == {"rx": 1, "no_cot": 1}
+        assert doc["recent"][-1]["source"] == "dji-binary"
+        assert doc["recent"][-1]["placed"] is False
+
+    def test_heartbeat_refreshes_a_quiet_dji_feed(self, tmp_path):
+        worker = self._worker(tmp_path)
+
+        async def _drive():
+            task = asyncio.ensure_future(worker._heartbeat(interval=0.01))
+            await asyncio.sleep(0.05)
+            task.cancel()
+
+        asyncio.run(_drive())
+
+        assert self._doc(worker)["counters"] == {}
+
+
 class TestStatusDegradesVisibly:
     """A pytak without StatusWriter must not take the gateway down.
 

dronecot-2.3.3/src/dronecot/VERSION

@@ -1 +0,0 @@
-2.3.3