bmdwire 1.1.0__tar.gz → 1.3.0__tar.gz

{bmdwire-1.1.0/bmdwire.egg-info → bmdwire-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bmdwire
-Version: 1.1.0
+Version: 1.3.0
 Summary: Python libraries for Blackmagic Design broadcast devices: ATEM switchers, HyperDeck recorders, Ultimatte keyers and Videohub routers
 Author: Lucas Romanenko, Martijn Braam and the OpenAtem contributors
 License-Expression: LGPL-3.0-only AND MIT
@@ -45,11 +45,11 @@ pip install bmdwire
 | Import | Purpose | License | Docs |
 |---|---|---|---|
 | **`atemwire`** | ATEM switchers: the native UDP protocol, a connection pool, macro bytecode, "Save Switcher State" profiles | LGPL-3.0-only | [atemwire/README.md](atemwire/README.md) |
-| **`hyperdeckwire`** | HyperDeck recorders: transport control and clip listing over TCP 9993, clip upload over FTP | MIT | [hyperdeckwire/README.md](hyperdeckwire/README.md) |
+| **`hyperdeckwire`** | HyperDeck recorders: transport control and clip listing over TCP 9993, clip upload over FTP, and the deck's configuration (network, FTP / Web Media Manager / Ethernet Protocol switches, certificate, users, time) over the API HyperDeck Setup drives | MIT | [hyperdeckwire/README.md](hyperdeckwire/README.md) |
 | **`ultimattewire`** | Ultimatte 12 keyers: archive and restore over the native TCP protocol, Smart Remote 4 compatible zips | MIT | [ultimattewire/README.md](ultimattewire/README.md) |
 | **`videohubwire`** | Videohub routers: state snapshot, crosspoint routing, labels over TCP 9990 | MIT | [videohubwire/README.md](videohubwire/README.md) |
 
-All four are pure standard library except atemwire, whose small C extension ships prebuilt for Linux, macOS and Windows on CPython 3.10 to 3.14, so installing needs no compiler. Pin the version in a requirements file (`bmdwire==1.1.0`) so a later release cannot change your install under you.
+All four are pure standard library except atemwire, whose small C extension ships prebuilt for Linux, macOS and Windows on CPython 3.10 to 3.14, so installing needs no compiler. Pin the version in a requirements file (`bmdwire==1.3.0`) so a later release cannot change your install under you.
 
 ## atemwire stands on pyatem
 
@@ -74,7 +74,7 @@ If you want the original rather than this fork, it is at
 
 The four libraries share an author, a shape and a purpose: they are the device layer of one broadcast control application, extracted and published so others can use them. Until 1.0.x each was its own PyPI project with its own version number. Nothing downstream ever wanted them apart, and four numbers to track for one release train was confusion with no benefit, so since 1.1.0 they are one distribution: one tag, one version, one line to pin. The import names did not change.
 
-The four old names stay on PyPI at their last 1.0.x release and are not updated. They are not shims either, on purpose: a release of `atemwire` that depended on bmdwire would break `pip install -U atemwire`, because pip installs the dependency first and then removes the old package's files, which are the same paths bmdwire just wrote. **If an environment already has any of the four old packages, uninstall them before installing bmdwire** (`pip uninstall atemwire hyperdeckwire ultimattewire videohubwire`). Two distributions owning one module directory work until one of them is uninstalled. A fresh virtualenv, a pipx install or a container build never has this problem.
+The four old PyPI projects (`atemwire`, `hyperdeckwire`, `ultimattewire`, `videohubwire`) were deleted on 2026-09-16; bmdwire is the only package. They were not replaced by shims, on purpose: a release of `atemwire` that depended on bmdwire would have broken `pip install -U atemwire`, because pip installs the dependency first and then removes the old package's files, which are the same paths bmdwire just wrote. **If an environment still has any of the four old packages from before, uninstall them before installing bmdwire** (`pip uninstall atemwire hyperdeckwire ultimattewire videohubwire`). Two distributions owning one module directory work until one of them is uninstalled. A fresh virtualenv, a pipx install or a container build never has this problem.
 
 ## Development
 

{bmdwire-1.1.0 → bmdwire-1.3.0}/README.md

@@ -11,11 +11,11 @@ pip install bmdwire
 | Import | Purpose | License | Docs |
 |---|---|---|---|
 | **`atemwire`** | ATEM switchers: the native UDP protocol, a connection pool, macro bytecode, "Save Switcher State" profiles | LGPL-3.0-only | [atemwire/README.md](atemwire/README.md) |
-| **`hyperdeckwire`** | HyperDeck recorders: transport control and clip listing over TCP 9993, clip upload over FTP | MIT | [hyperdeckwire/README.md](hyperdeckwire/README.md) |
+| **`hyperdeckwire`** | HyperDeck recorders: transport control and clip listing over TCP 9993, clip upload over FTP, and the deck's configuration (network, FTP / Web Media Manager / Ethernet Protocol switches, certificate, users, time) over the API HyperDeck Setup drives | MIT | [hyperdeckwire/README.md](hyperdeckwire/README.md) |
 | **`ultimattewire`** | Ultimatte 12 keyers: archive and restore over the native TCP protocol, Smart Remote 4 compatible zips | MIT | [ultimattewire/README.md](ultimattewire/README.md) |
 | **`videohubwire`** | Videohub routers: state snapshot, crosspoint routing, labels over TCP 9990 | MIT | [videohubwire/README.md](videohubwire/README.md) |
 
-All four are pure standard library except atemwire, whose small C extension ships prebuilt for Linux, macOS and Windows on CPython 3.10 to 3.14, so installing needs no compiler. Pin the version in a requirements file (`bmdwire==1.1.0`) so a later release cannot change your install under you.
+All four are pure standard library except atemwire, whose small C extension ships prebuilt for Linux, macOS and Windows on CPython 3.10 to 3.14, so installing needs no compiler. Pin the version in a requirements file (`bmdwire==1.3.0`) so a later release cannot change your install under you.
 
 ## atemwire stands on pyatem
 
@@ -40,7 +40,7 @@ If you want the original rather than this fork, it is at
 
 The four libraries share an author, a shape and a purpose: they are the device layer of one broadcast control application, extracted and published so others can use them. Until 1.0.x each was its own PyPI project with its own version number. Nothing downstream ever wanted them apart, and four numbers to track for one release train was confusion with no benefit, so since 1.1.0 they are one distribution: one tag, one version, one line to pin. The import names did not change.
 
-The four old names stay on PyPI at their last 1.0.x release and are not updated. They are not shims either, on purpose: a release of `atemwire` that depended on bmdwire would break `pip install -U atemwire`, because pip installs the dependency first and then removes the old package's files, which are the same paths bmdwire just wrote. **If an environment already has any of the four old packages, uninstall them before installing bmdwire** (`pip uninstall atemwire hyperdeckwire ultimattewire videohubwire`). Two distributions owning one module directory work until one of them is uninstalled. A fresh virtualenv, a pipx install or a container build never has this problem.
+The four old PyPI projects (`atemwire`, `hyperdeckwire`, `ultimattewire`, `videohubwire`) were deleted on 2026-09-16; bmdwire is the only package. They were not replaced by shims, on purpose: a release of `atemwire` that depended on bmdwire would have broken `pip install -U atemwire`, because pip installs the dependency first and then removes the old package's files, which are the same paths bmdwire just wrote. **If an environment still has any of the four old packages from before, uninstall them before installing bmdwire** (`pip uninstall atemwire hyperdeckwire ultimattewire videohubwire`). Two distributions owning one module directory work until one of them is uninstalled. A fresh virtualenv, a pipx install or a container build never has this problem.
 
 ## Development
 

{bmdwire-1.1.0 → bmdwire-1.3.0}/atemwire/atem.py

@@ -221,8 +221,11 @@ class ATEM:
 
     @property
     def connected(self) -> bool:
+        """True while the session is up AND its state is current — False
+        during a transport re-handshake, when the state is empty (see
+        ``ATEMConnection.is_ready``)."""
         conn = self._conn
-        return bool(conn and conn.is_connected)
+        return bool(conn and conn.is_ready)
 
     @property
     def video_mode(self) -> str:

{bmdwire-1.1.0 → bmdwire-1.3.0}/atemwire/connection.py

@@ -131,6 +131,12 @@ class ATEMConnection:
         # immediately reflects the post-disconnect state.
         self._handshake_done: bool = False
 
+        # ``_session_ready`` follows the protocol's 'connected' /
+        # 'disconnected' events: False from the moment a transport
+        # re-handshake empties mixerstate until the new state dump is
+        # complete. Read through ``is_ready``.
+        self._session_ready: bool = False
+
         self._lifecycle_lock = threading.Lock()  # serializes connect/disconnect calls
         self._transfer_serial_lock = threading.Lock()  # one native transfer at a time
 
@@ -168,6 +174,19 @@ class ATEMConnection:
         worker = self._worker
         return worker is not None and worker.is_alive()
 
+    @property
+    def is_ready(self) -> bool:
+        """True iff ``is_connected`` AND the switcher's state is current.
+
+        After ~5 s without packets the transport re-handshakes on its own:
+        the protocol raises 'disconnected' and empties ``mixerstate``, the
+        same worker carries on, and 'connected' fires again once the new
+        state dump is complete. ``is_connected`` stays True through that
+        gap (the worker is alive and recovering, so the pool must not evict
+        it); ``is_ready`` is False for its whole length.
+        """
+        return self._session_ready and self.is_connected
+
     @property
     def mixerstate(self) -> dict:
         """Live state dict from atemwire. Safe to read from any thread — CPython
@@ -405,6 +424,7 @@ class ATEMConnection:
             self._ready_event.clear()
             self._connect_error = None
             self._handshake_done = False
+            self._session_ready = False
             self._died_signalled = False
             self.ip_address = ip_address
 
@@ -478,12 +498,27 @@ class ATEMConnection:
             # bare (non-indexed) field so the event name is 'change:macro-play-status'.
             def _on_macro_play(contents):
                 running = bool(getattr(contents, 'running', False))
-                idx = int(getattr(contents, 'index', 0xFFFF) or 0xFFFF)
+                # Slot 0 is a real macro; only 0xFFFF (or no index) is idle.
+                idx = getattr(contents, 'index', None)
+                idx = 0xFFFF if idx is None else int(idx)
                 if running and idx != 0xFFFF and idx >= 0:
                     self.last_run_macro_index = idx
 
             self._protocol.on('change:macro-play-status', _on_macro_play)
 
+            # Session readiness (``is_ready``): 'disconnected' is raised when
+            # the transport gives up on the session and mixerstate is
+            # emptied; 'connected' when a state dump is complete, at the
+            # first connect and again after every re-handshake.
+            def _on_connected():
+                self._session_ready = True
+
+            def _on_disconnected():
+                self._session_ready = False
+
+            self._protocol.on('connected', _on_connected)
+            self._protocol.on('disconnected', _on_disconnected)
+
             try:
                 self._protocol.connect()
             except Exception as e: