python-aidot-cameras 1.0.0rc1__tar.gz → 1.0.0rc2__tar.gz

{python_aidot_cameras-1.0.0rc1/python_aidot_cameras.egg-info → python_aidot_cameras-1.0.0rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-aidot-cameras
-Version: 1.0.0rc1
+Version: 1.0.0rc2
 Summary: Control AiDot/Leedarson WiFi lights and cameras (WebRTC streaming, two-way audio, PTZ, controls)
 Author-email: cbrightly <chris.brightly@gmail.com>
 License-Expression: MIT

{python_aidot_cameras-1.0.0rc1 → python_aidot_cameras-1.0.0rc2}/aidot_cameras/camera/sdes_open.py

@@ -615,6 +615,44 @@ def _sdes_tmmbr_after_s() -> float:
 EXPT_CAP_FILE = _os.environ.get("AIDOT_EXPT_CAP_FILE")
 
 
+#: How long to wait for the broker to echo our own livePlayReq back before
+#: proceeding. Was 5.0 s (1.5 s with fast-liveplay), and it is pure latency:
+#: across 22 h of one deployment the wait ran 169 times and timed out 169 times,
+#: never once ending early, and not a single inbound `livePlayReq` was seen among
+#: 5000+ messages the cameras and broker did send. The success branch has never
+#: executed. On timeout the code proceeds anyway, so the wait has never changed
+#: behaviour - only delayed it, by 44% of a measured 11.4 s time-to-first-frame
+#: on an A001064.
+#:
+#: Kept rather than deleted, and still honoured, because a broker or firmware
+#: that does echo should still short-circuit the wait; only the price of its
+#: absence changes. Override with AIDOT_SDES_LIVEPLAY_ECHO_S (seconds, 0
+#: disables the wait entirely) to measure it against the old value.
+_LIVEPLAY_ECHO_S = 0.25
+#: Fast-liveplay models keep the 1.5 s they were given: that value came out
+#: of its own 3 h live soak, and nothing here measured it.  The 169/169
+#: evidence below is for the 5.0 s non-fast wait only, so only that one
+#: moves.
+_LIVEPLAY_ECHO_S_FAST = 1.5
+
+
+def _sdes_liveplay_echo_timeout(fast_liveplay: bool) -> float:
+    """Seconds to wait for the livePlayReq echo. Never negative.
+
+    A malformed env value is ignored rather than raising: this runs on every
+    open, and an unparseable knob must not be able to stop a camera streaming.
+    """
+    raw = _os.environ.get("AIDOT_SDES_LIVEPLAY_ECHO_S")
+    if raw is not None:
+        try:
+            val = float(raw)
+        except (TypeError, ValueError):
+            val = None
+        if val is not None and val >= 0.0:
+            return val
+    return _LIVEPLAY_ECHO_S_FAST if fast_liveplay else _LIVEPLAY_ECHO_S
+
+
 def _sdes_max_session_s(device_id: str, path: "Optional[str]" = None) -> float:
     """Seconds of media after which to end THIS device's session.  0 = off.
 
@@ -2559,7 +2597,7 @@ class _SdesOpenMixin:
         # (_NO_FAST_LIVEPLAY_MODELS, e.g. A001064) are always excluded; disable
         # elsewhere via AIDOT_SDES_FAST_LIVEPLAY={0,false,no,off}.
         _skip_lp = self._resolve_sdes_fast_liveplay()
-        _echo_timeout = 1.5 if _skip_lp else 5.0
+        _echo_timeout = _sdes_liveplay_echo_timeout(_skip_lp)
         _echo_t0 = time.monotonic()
         try:
             await _asyncio.wait_for(liveplay_echo_ev.wait(), timeout=_echo_timeout)

{python_aidot_cameras-1.0.0rc1 → python_aidot_cameras-1.0.0rc2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-aidot-cameras"
-version = "1.0.0rc1"
+version = "1.0.0rc2"
 description = "Control AiDot/Leedarson WiFi lights and cameras (WebRTC streaming, two-way audio, PTZ, controls)"
 readme = "README.md"
 license = "MIT"

{python_aidot_cameras-1.0.0rc1 → python_aidot_cameras-1.0.0rc2/python_aidot_cameras.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-aidot-cameras
-Version: 1.0.0rc1
+Version: 1.0.0rc2
 Summary: Control AiDot/Leedarson WiFi lights and cameras (WebRTC streaming, two-way audio, PTZ, controls)
 Author-email: cbrightly <chris.brightly@gmail.com>
 License-Expression: MIT

{python_aidot_cameras-1.0.0rc1 → python_aidot_cameras-1.0.0rc2}/python_aidot_cameras.egg-info/SOURCES.txt

@@ -141,6 +141,7 @@ tests/test_live_session_carries_talk.py
 tests/test_live_stream_param.py
 tests/test_live_validate_policy.py
 tests/test_live_video_canary.py
+tests/test_liveplay_echo_timeout.py
 tests/test_local_only_controls.py
 tests/test_logging_caps.py
 tests/test_login_connect_deadline.py

python_aidot_cameras-1.0.0rc2/tests/test_liveplay_echo_timeout.py

@@ -0,0 +1,67 @@
+"""The livePlayReq-echo wait is latency, and this pins its price.
+
+The broker echoing our own livePlayReq back is what this wait is for. Across
+22 h of one deployment it ran 169 times and timed out 169 times - never once
+ending early - and not one inbound `livePlayReq` appeared among the 5000+
+messages the cameras and broker did send. The success branch has never
+executed, and on timeout the open proceeds anyway, so the wait has never
+changed behaviour: only delayed it, by 44% of a measured 11.4 s
+time-to-first-frame on an A001064.
+
+The wait is kept so a broker that does echo still short-circuits it. Only the
+price of its absence changed, from 5.0 s to 0.25 s, on the non-fast
+path only.
+"""
+import pytest
+
+from aidot_cameras.camera.sdes_open import (
+    _LIVEPLAY_ECHO_S,
+    _LIVEPLAY_ECHO_S_FAST,
+    _sdes_liveplay_echo_timeout,
+)
+
+
+class TestTheDefault:
+    def test_only_the_non_fast_path_moves(self, monkeypatch):
+        monkeypatch.delenv("AIDOT_SDES_LIVEPLAY_ECHO_S", raising=False)
+        assert _sdes_liveplay_echo_timeout(False) == _LIVEPLAY_ECHO_S == 0.25
+        # The fast-liveplay models are deliberately NOT changed: their 1.5 s
+        # came out of its own live soak and no measurement here touched it.
+        assert _sdes_liveplay_echo_timeout(True) == _LIVEPLAY_ECHO_S_FAST == 1.5
+
+    def test_it_is_far_below_the_old_five_seconds(self, monkeypatch):
+        """The regression this guards: quietly restoring a multi-second wait for
+        a message this fleet has never once received."""
+        monkeypatch.delenv("AIDOT_SDES_LIVEPLAY_ECHO_S", raising=False)
+        assert _sdes_liveplay_echo_timeout(False) <= 0.5
+
+
+class TestTheOverride:
+    @pytest.mark.parametrize("raw,expected", [("5.0", 5.0), ("0", 0.0),
+                                              ("1.5", 1.5), ("0.1", 0.1)])
+    def test_a_valid_value_is_honoured(self, monkeypatch, raw, expected):
+        """The old behaviour has to remain reachable, or the change cannot be
+        measured against it."""
+        monkeypatch.setenv("AIDOT_SDES_LIVEPLAY_ECHO_S", raw)
+        assert _sdes_liveplay_echo_timeout(False) == expected
+
+    @pytest.mark.parametrize("raw", ["", "  ", "abc", "-1", "-0.5", "1,5", "None"])
+    def test_a_bad_value_falls_back_instead_of_raising(self, monkeypatch, raw):
+        """This runs on every open. An unparseable knob must not be able to stop
+        a camera streaming."""
+        monkeypatch.setenv("AIDOT_SDES_LIVEPLAY_ECHO_S", raw)
+        assert _sdes_liveplay_echo_timeout(False) == _LIVEPLAY_ECHO_S
+
+    def test_zero_disables_the_wait_entirely(self, monkeypatch):
+        monkeypatch.setenv("AIDOT_SDES_LIVEPLAY_ECHO_S", "0")
+        assert _sdes_liveplay_echo_timeout(True) == 0.0
+
+
+class TestItIsWiredIn:
+    def test_the_open_path_uses_the_resolver_not_a_literal(self):
+        import inspect
+        from aidot_cameras.camera import sdes_open
+        src = inspect.getsource(sdes_open)
+        assert "_echo_timeout = _sdes_liveplay_echo_timeout(" in src, (
+            "the echo wait is back to a hardcoded timeout")
+        assert "_echo_timeout = 1.5 if" not in src