xair-api 2.3.1__py3-none-any.whl → 2.3.2__py3-none-any.whl

xair_api/errors.py

@@ -1,2 +1,14 @@
 class XAirRemoteError(Exception):
     """Base error class for XAIR Remote."""
+
+
+class XAirRemoteConnectionTimeoutError(XAirRemoteError):
+    """Exception raised when a connection attempt times out"""
+
+    def __init__(self, ip, port):
+        self.ip = ip
+        self.port = port
+
+        super().__init__(
+            f"Timeout attempting to connect to mixer at {self.ip}:{self.port}"
+        )

xair_api/util.py

@@ -1,6 +1,35 @@
 import functools
+import time
 from math import exp, log
 
+from .errors import XAirRemoteConnectionTimeoutError
+
+
+def timeout(func):
+    """
+    Times out the validate_connection function once time elapsed exceeds remote.connect_timeout.
+    """
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        remote, *_ = args
+
+        err = None
+        start = time.time()
+        while time.time() < start + remote.connect_timeout:
+            try:
+                func(*args, **kwargs)
+                remote.logger.debug(f"login time: {round(time.time() - start, 2)}")
+                err = None
+                break
+            except XAirRemoteConnectionTimeoutError as e:
+                err = e
+                continue
+        if err:
+            raise err
+
+    return wrapper
+
 
 def lin_get(min, max, val):
     return min + (max - min) * val

xair_api/xair.py

@@ -14,11 +14,11 @@ from pythonosc.dispatcher import Dispatcher
 from pythonosc.osc_message_builder import OscMessageBuilder
 from pythonosc.osc_server import BlockingOSCUDPServer
 
-from . import adapter, kinds
+from . import adapter, kinds, util
 from .bus import Bus
 from .config import Config
 from .dca import DCA
-from .errors import XAirRemoteError
+from .errors import XAirRemoteConnectionTimeoutError, XAirRemoteError
 from .fx import FX, FXSend
 from .kinds import KindMap
 from .lr import LR
@@ -47,8 +47,6 @@ class OSCClientServer(BlockingOSCUDPServer):
 class XAirRemote(abc.ABC):
     """Handles the communication with the mixer via the OSC protocol"""
 
-    _CONNECT_TIMEOUT = 0.5
-
     _info_response = []
 
     def __init__(self, **kwargs):
@@ -57,6 +55,7 @@ class XAirRemote(abc.ABC):
         self.xair_ip = kwargs["ip"] or self._ip_from_toml()
         self.xair_port = kwargs["port"]
         self._delay = kwargs["delay"]
+        self.connect_timeout = kwargs["connect_timeout"]
         self.logger = logger.getChild(self.__class__.__name__)
         if not self.xair_ip:
             raise XAirRemoteError("No valid ip detected")
@@ -74,13 +73,10 @@ class XAirRemote(abc.ABC):
             conn = tomllib.load(f)
         return conn["connection"].get("ip")
 
+    @util.timeout
     def validate_connection(self):
-        self.send("/xinfo")
-        time.sleep(self._CONNECT_TIMEOUT)
-        if not self.info_response:
-            raise XAirRemoteError(
-                "Failed to setup OSC connection to mixer. Please check for correct ip address."
-            )
+        if not self.query("/xinfo"):
+            raise XAirRemoteConnectionTimeoutError(self.xair_ip, self.xair_port)
         self.logger.info(
             f"Successfully connected to {self.info_response[2]} at {self.info_response[0]}."
         )
@@ -117,7 +113,12 @@ def _make_remote(kind: KindMap) -> XAirRemote:
     """
 
     def init_x32(self, *args, **kwargs):
-        defaultkwargs = {"ip": None, "port": 10023, "delay": 0.02}
+        defaultkwargs = {
+            "ip": None,
+            "port": 10023,
+            "delay": 0.02,
+            "connect_timeout": 2,
+        }
         kwargs = defaultkwargs | kwargs
         XAirRemote.__init__(self, *args, **kwargs)
         self.kind = kind
@@ -135,7 +136,12 @@ def _make_remote(kind: KindMap) -> XAirRemote:
         self.config = Config.make(self)
 
     def init_xair(self, *args, **kwargs):
-        defaultkwargs = {"ip": None, "port": 10024, "delay": 0.02}
+        defaultkwargs = {
+            "ip": None,
+            "port": 10024,
+            "delay": 0.02,
+            "connect_timeout": 2,
+        }
         kwargs = defaultkwargs | kwargs
         XAirRemote.__init__(self, *args, **kwargs)
         self.kind = kind

{xair_api-2.3.1.dist-info → xair_api-2.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xair-api
-Version: 2.3.1
+Version: 2.3.2
 Summary: Remote control Behringer X-Air | Midas MR mixers through OSC
 Home-page: https://github.com/onyx-and-iris/xair-api-python
 License: MIT
@@ -73,7 +73,7 @@ if __name__ == "__main__":
     main()
 ```
 
-#### `xair_api.connect(kind_id, ip=ip, delay=delay)`
+#### `xair_api.connect(kind_id, ip=ip, delay=0.02, connect_timeout=2)`
 
 Currently the following devices are supported:
 
@@ -90,6 +90,7 @@ The following keyword arguments may be passed:
 - `port`: mixer port, defaults to 10023 for x32 and 10024 for xair
 - `delay`: a delay between each command (applies to the getters). Defaults to 20ms.
   - a note about delay, stability may rely on network connection. For wired connections the delay can be safely reduced.
+- `connect_timeout`: amount of time to wait for a validated connection. Defaults to 2s.
 
 ## API
 
@@ -335,6 +336,14 @@ for example:
 print(mixer.query("/ch/01/mix/on"))
 ```
 
+### Errors
+
+- `errors.XAirRemoteError`: Base error class for XAIR Remote.
+- `errors.XAirRemoteConnectionTimeoutError`:Exception raised when a connection attempt times out.
+  - The following attributes are available:
+    - `ip`: IP of the mixer.
+    - `port`: Port of the mixer.
+
 ### `Tests`
 
 Unplug any expensive equipment before running tests.

{xair_api-2.3.1.dist-info → xair_api-2.3.2.dist-info}/RECORD

@@ -3,7 +3,7 @@ xair_api/adapter.py,sha256=icQXeqrYu6iWOJbke6zXdOzxyhAV__dXKrCnuDbZAUU,797
 xair_api/bus.py,sha256=digswx5ApbLCpF6R7_8OqfvnJ8C9JIFpe8MFxKXbSB0,1771
 xair_api/config.py,sha256=ditmhP770trYIu7eouw4pU3BgOtXwOB8dearYJbhSuw,5853
 xair_api/dca.py,sha256=C-wyBqeAi0qr1qrOKefyIWsJwI8ebs2iV83Q2iC67-k,1443
-xair_api/errors.py,sha256=RAqGQ3gndR9l8c_RfEBKC0tMsa5_n8F7o3X7ppVHfL8,80
+xair_api/errors.py,sha256=rfFmAW6QitHe0iB56M48He-qsbvDaKe1_AN_j4-9oUA,411
 xair_api/fx.py,sha256=AzjgpJSHDCWwWRGCWxeGwwsm8jcxl3fJykprk9cwSUM,1811
 xair_api/kinds.py,sha256=ulJJhLpiUuOw5Ir7Q3CQbmAKrd33xq8CIHpAFc5zEdw,1119
 xair_api/lr.py,sha256=WL5YnDeLeJPxIK5OdTqZQ3s6UEfQ3-onz99OEdi0-mE,1788
@@ -11,10 +11,10 @@ xair_api/meta.py,sha256=iUWPSP4QcWMW6gyLc5SGDJ49pKZgJrHzFphtL6OFptE,1564
 xair_api/rtn.py,sha256=lOTGSkxsYpc4usIba-reZSRmfa-7JIr_FTThSw6BdLY,3177
 xair_api/shared.py,sha256=ABVTgx9sIH9zZLJLKeZBrhdMXj-WGNuggxrqjn8oa3M,19171
 xair_api/strip.py,sha256=pAFX0Ssq1kC9BghGJhd6ShJ0on16DbkWoickH0jA-Jg,2082
-xair_api/util.py,sha256=VYgSWxKXnvD3tu564wbr5PTdODNrmGNnsZErER5hY3I,1485
-xair_api/xair.py,sha256=966mt1rYbjCtC82vtnKIpbrRYAGFnvgz8ctHxTvDL1Y,6261
-xair_api-2.3.1.dist-info/entry_points.txt,sha256=p2vlpkx3x9BZ3Mslqg2ngV3g-mdqwB14oEltOqi8kgg,105
-xair_api-2.3.1.dist-info/LICENSE,sha256=m2fbtv9II-iQqimTd4zjgynL5vuEqGXauLSDJZycYIo,1124
-xair_api-2.3.1.dist-info/METADATA,sha256=llkWczr78xaVVyGZ-5LjnzpFLxXp8IePPszpjrers_M,8483
-xair_api-2.3.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-xair_api-2.3.1.dist-info/RECORD,,
+xair_api/util.py,sha256=Rd2eGhqIjFe29s-0ffQGzs9p5lXsfCRJ91i6BPEVzxE,2263
+xair_api/xair.py,sha256=60ZAZVj0dWmVfcedFtB_rEbv6fnyb-7nP-Z1ltAeqUs,6384
+xair_api-2.3.2.dist-info/entry_points.txt,sha256=hlKDU0C0XSGDitHXAvt6YQfmI99p3eJBaoQqEQhpH2U,126
+xair_api-2.3.2.dist-info/LICENSE,sha256=m2fbtv9II-iQqimTd4zjgynL5vuEqGXauLSDJZycYIo,1124
+xair_api-2.3.2.dist-info/METADATA,sha256=OhG5fjrYkW_wVbEFE6yIbaup5Owe0rz2e1scbLIX2rg,8868
+xair_api-2.3.2.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+xair_api-2.3.2.dist-info/RECORD,,

{xair_api-2.3.1.dist-info → xair_api-2.3.2.dist-info}/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
+all=scripts:test_all
 obs=scripts:ex_obs
 sends=scripts:ex_sends
 x32=scripts:test_x32