xair-api 2.2.6__tar.gz → 2.3.2__tar.gz

{xair_api-2.2.6 → xair_api-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xair-api
-Version: 2.2.6
+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
 
@@ -139,7 +140,7 @@ Contains the subclasses:
 ### `Strip`
 
 Contains the subclasses:
-(`Config`, `Preamp`, `Gate`, `Dyn`, `Insert`, `GEQ`, `EQ`, `Mix`, `Group`, `Automix`)
+(`Config`, `Preamp`, `Gate`, `Dyn`, `Insert`, `GEQ`, `EQ`, `Mix`, `Group`, `Automix`, `Send`)
 
 ### `Bus`
 
@@ -154,12 +155,12 @@ Contains the subclasses:
 ### `FXRtn`
 
 Contains the subclasses:
-(`Config`, `Preamp`, `EQ`, `Mix`, `Group`)
+(`Config`, `Preamp`, `EQ`, `Mix`, `Group`, `Send`)
 
 ### `AuxRtn`
 
 Contains the subclasses:
-(`Config`, `Preamp`, `EQ`, `Mix`, `Group`)
+(`Config`, `Preamp`, `EQ`, `Mix`, `Group`, `Send`)
 
 ### `Subclasses`
 
@@ -306,6 +307,12 @@ tuple containing a class for each mute group
 
 for example: `config.mute_group[0].on = True`
 
+### `Send`
+
+- `level`: float, -inf to 10.0
+
+for example: `mixer.strip[10].send[3].level = -16.5`
+
 ### XAirRemote class (lower level)
 
 Send an OSC command directly to the mixer
@@ -329,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.2.6 → xair_api-2.3.2}/README.md

@@ -55,7 +55,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:
 
@@ -72,6 +72,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
 
@@ -121,7 +122,7 @@ Contains the subclasses:
 ### `Strip`
 
 Contains the subclasses:
-(`Config`, `Preamp`, `Gate`, `Dyn`, `Insert`, `GEQ`, `EQ`, `Mix`, `Group`, `Automix`)
+(`Config`, `Preamp`, `Gate`, `Dyn`, `Insert`, `GEQ`, `EQ`, `Mix`, `Group`, `Automix`, `Send`)
 
 ### `Bus`
 
@@ -136,12 +137,12 @@ Contains the subclasses:
 ### `FXRtn`
 
 Contains the subclasses:
-(`Config`, `Preamp`, `EQ`, `Mix`, `Group`)
+(`Config`, `Preamp`, `EQ`, `Mix`, `Group`, `Send`)
 
 ### `AuxRtn`
 
 Contains the subclasses:
-(`Config`, `Preamp`, `EQ`, `Mix`, `Group`)
+(`Config`, `Preamp`, `EQ`, `Mix`, `Group`, `Send`)
 
 ### `Subclasses`
 
@@ -288,6 +289,12 @@ tuple containing a class for each mute group
 
 for example: `config.mute_group[0].on = True`
 
+### `Send`
+
+- `level`: float, -inf to 10.0
+
+for example: `mixer.strip[10].send[3].level = -16.5`
+
 ### XAirRemote class (lower level)
 
 Send an OSC command directly to the mixer
@@ -311,6 +318,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.2.6 → xair_api-2.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "xair-api"
-version = "2.2.6"
+version = "2.3.2"
 description = "Remote control Behringer X-Air | Midas MR mixers through OSC"
 authors = ["onyx-and-iris <code@onyxandiris.online>"]
 license = "MIT"
@@ -13,10 +13,11 @@ python-osc = "^1.8.0"
 tomli = { version = "^2.0.1", python = "<3.11" }
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.1.2"
+pytest = "^7.4.4"
 pytest-randomly = "^3.12.0"
 black = "^22.6.0"
 isort = "^5.10.1"
+tox = "^4.12.1"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
@@ -27,3 +28,16 @@ obs = "scripts:ex_obs"
 sends = "scripts:ex_sends"
 xair = "scripts:test_xair"
 x32 = "scripts:test_x32"
+all = "scripts:test_all"
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+envlist = py310,py311,py312
+
+[testenv]
+allowlist_externals = poetry
+commands =
+  poetry install -v
+  poetry run pytest tests/
+"""

{xair_api-2.2.6 → xair_api-2.3.2}/xair_api/bus.py

@@ -1,8 +1,11 @@
 import abc
+import logging
 
 from .meta import mute_prop
 from .shared import EQ, GEQ, Config, Dyn, Group, Insert, Mix
 
+logger = logging.getLogger(__name__)
+
 
 class IBus(abc.ABC):
     """Abstract Base Class for buses"""
@@ -10,6 +13,7 @@ class IBus(abc.ABC):
     def __init__(self, remote, index: int):
         self._remote = remote
         self.index = index + 1
+        self.logger = logger.getChild(self.__class__.__name__)
 
     def getter(self, param: str):
         return self._remote.query(f"{self.address}/{param}")

{xair_api-2.2.6 → xair_api-2.3.2}/xair_api/config.py

@@ -1,15 +1,18 @@
 import abc
+import logging
 
 from . import kinds, util
-from .errors import XAirRemoteError
 from .meta import bool_prop
 
+logger = logging.getLogger(__name__)
+
 
 class IConfig(abc.ABC):
     """Abstract Base Class for config"""
 
     def __init__(self, remote):
         self._remote = remote
+        self.logger = logger.getChild(self.__class__.__name__)
 
     def getter(self, param: str):
         return self._remote.query(f"{self.address}/{param}")
@@ -114,7 +117,9 @@ class Config(IConfig):
         @sourcetrim.setter
         def sourcetrim(self, val: float):
             if not -18 <= val <= 18:
-                raise XAirRemoteError("expected value in range -18.0 to 18.0")
+                self.logger.warning(
+                    f"sourcetrim got {val}, expected value in range -18.0 to 18.0"
+                )
             self.setter("sourcetrim", util.lin_set(-18, 18, val))
 
         @property
@@ -140,7 +145,9 @@ class Config(IConfig):
         @dimgain.setter
         def dimgain(self, val: int):
             if not -40 <= val <= 0:
-                raise XAirRemoteError("expected value in range -40 to 0")
+                self.logger.warning(
+                    f"dimgain got {val}, expected value in range -40 to 0"
+                )
             self.setter("dimatt", util.lin_set(-40, 0, val))
 
         @property

{xair_api-2.2.6 → xair_api-2.3.2}/xair_api/dca.py

@@ -1,4 +1,7 @@
 import abc
+import logging
+
+logger = logging.getLogger(__name__)
 
 
 class IDCA(abc.ABC):
@@ -7,6 +10,7 @@ class IDCA(abc.ABC):
     def __init__(self, remote, index: int):
         self._remote = remote
         self.index = index + 1
+        self.logger = logger.getChild(self.__class__.__name__)
 
     def getter(self, param: str) -> tuple:
         return self._remote.query(f"{self.address}/{param}")

xair_api-2.3.2/xair_api/errors.py

@@ -0,0 +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-2.2.6 → xair_api-2.3.2}/xair_api/fx.py

@@ -1,8 +1,11 @@
 import abc
+import logging
 
 from .meta import mute_prop
 from .shared import Config, Group, Mix
 
+logger = logging.getLogger(__name__)
+
 
 class IFX(abc.ABC):
     """Abstract Base Class for fxs"""
@@ -10,6 +13,7 @@ class IFX(abc.ABC):
     def __init__(self, remote, index: int):
         self._remote = remote
         self.index = index + 1
+        self.logger = logger.getChild(self.__class__.__name__)
 
     def getter(self, param: str):
         return self._remote.query(f"{self.address}/{param}")

{xair_api-2.2.6 → xair_api-2.3.2}/xair_api/lr.py

@@ -1,9 +1,12 @@
 import abc
+import logging
 from typing import Optional
 
 from .meta import mute_prop
 from .shared import EQ, GEQ, Config, Dyn, Insert, Mix
 
+logger = logging.getLogger(__name__)
+
 
 class ILR(abc.ABC):
     """Abstract Base Class for lr"""
@@ -12,6 +15,7 @@ class ILR(abc.ABC):
         self._remote = remote
         if index is not None:
             self.index = index + 1
+        self.logger = logger.getChild(self.__class__.__name__)
 
     def getter(self, param: str):
         return self._remote.query(f"{self.address}/{param}")

{xair_api-2.2.6 → xair_api-2.3.2}/xair_api/meta.py

@@ -1,4 +1,3 @@
-from .errors import XAirRemoteError
 from .util import lin_get, lin_set
 
 
@@ -58,7 +57,9 @@ def geq_prop(param):
 
     def fset(self, val):
         if not -15 <= val <= 15:
-            raise XAirRemoteError("expected value in range -15.0 to 15.0")
+            self.logger.warning(
+                f"slider_{param} got {val}, expected value in range -15.0 to 15.0"
+            )
         self.setter(param, lin_set(-15, 15, val))
 
     return property(fget, fset)

{xair_api-2.2.6 → xair_api-2.3.2}/xair_api/rtn.py

@@ -1,9 +1,12 @@
 import abc
+import logging
 from typing import Optional
 
 from .meta import mute_prop
 from .shared import EQ, Config, Group, Mix, Preamp, Send
 
+logger = logging.getLogger(__name__)
+
 
 class IRtn(abc.ABC):
     """Abstract Base Class for rtn"""
@@ -12,6 +15,7 @@ class IRtn(abc.ABC):
         self._remote = remote
         if index is not None:
             self.index = index + 1
+        self.logger = logger.getChild(self.__class__.__name__)
 
     def getter(self, param: str):
         return self._remote.query(f"{self.address}/{param}")

{xair_api-2.2.6 → xair_api-2.3.2}/xair_api/shared.py

@@ -1,7 +1,6 @@
 from typing import Optional, Union
 
 from . import util
-from .errors import XAirRemoteError
 from .meta import geq_prop
 
 """
@@ -61,7 +60,9 @@ class Preamp:
     @usbtrim.setter
     def usbtrim(self, val: float):
         if not -18 <= val <= 18:
-            raise XAirRemoteError("expected value in range -18.0 to 18.0")
+            self.logger.warning(
+                f"usbtrim got {val}, expected value in range -18.0 to 18.0"
+            )
         self.setter("rtntrim", util.lin_set(-18, 18, val))
 
     @property
@@ -95,7 +96,9 @@ class Preamp:
     @highpassfilter.setter
     def highpassfilter(self, val: int):
         if not 20 <= val <= 400:
-            raise XAirRemoteError("expected value in range 20 to 400")
+            self.logger.warning(
+                f"highpassfilter got {val}, expected value in range 20 to 400"
+            )
         self.setter("hpf", util.log_set(20, 400, val))
 
 
@@ -122,7 +125,7 @@ class Gate:
     def mode(self, val: str):
         opts = ("gate", "exp2", "exp3", "exp4", "duck")
         if val not in opts:
-            raise XAirRemoteError(f"expected one of {opts}")
+            self.logger.warning(f"mode got {val}, expected one of {opts}")
         self.setter("mode", opts.index(val))
 
     @property
@@ -132,7 +135,9 @@ class Gate:
     @threshold.setter
     def threshold(self, val: float):
         if not -80 <= val <= 0:
-            raise XAirRemoteError("expected value in range -80.0 to 0.0")
+            self.logger.warning(
+                f"threshold got {val}, expected value in range -80.0 to 0.0"
+            )
         self.setter("thr", util.lin_set(-80, 0, val))
 
     @property
@@ -142,7 +147,7 @@ class Gate:
     @range.setter
     def range(self, val: int):
         if not 3 <= val <= 60:
-            raise XAirRemoteError("expected value in range 3 to 60")
+            self.logger.warning(f"range got {val}, expected value in range 3 to 60")
         self.setter("range", util.lin_set(3, 60, val))
 
     @property
@@ -152,7 +157,7 @@ class Gate:
     @attack.setter
     def attack(self, val: int):
         if not 0 <= val <= 120:
-            raise XAirRemoteError("expected value in range 0 to 120")
+            self.logger.warning(f"attack got {val}, expected value in range 0 to 120")
         self.setter("attack", util.lin_set(0, 120, val))
 
     @property
@@ -163,7 +168,9 @@ class Gate:
     @hold.setter
     def hold(self, val: float):
         if not 0.02 <= val <= 2000:
-            raise XAirRemoteError("expected value in range 0.02 to 2000.0")
+            self.logger.warning(
+                f"hold got {val}, expected value in range 0.02 to 2000.0"
+            )
         self.setter("hold", util.log_set(0.02, 2000, val))
 
     @property
@@ -173,7 +180,7 @@ class Gate:
     @release.setter
     def release(self, val: int):
         if not 5 <= val <= 4000:
-            raise XAirRemoteError("expected value in range 5 to 4000")
+            self.logger.warning(f"release got {val}, expected value in range 5 to 4000")
         self.setter("release", util.log_set(5, 4000, val))
 
     @property
@@ -208,7 +215,9 @@ class Gate:
     @filterfreq.setter
     def filterfreq(self, val: Union[float, int]):
         if not 20 <= val <= 20000:
-            raise XAirRemoteError("expected value in range 20 to 20000")
+            self.logger.warning(
+                f"filterfreq got {val}, expected value in range 20 to 20000"
+            )
         self.setter("filter/f", util.log_set(20, 20000, val))
 
 
@@ -235,7 +244,7 @@ class Dyn:
     def mode(self, val: str):
         opts = ("comp", "exp")
         if val not in opts:
-            raise XAirRemoteError(f"expected one of {opts}")
+            self.logger.warning(f"mode got {val}, expected one of {opts}")
         self.setter("mode", opts.index(val))
 
     @property
@@ -247,7 +256,7 @@ class Dyn:
     def det(self, val: str):
         opts = ("peak", "rms")
         if val not in opts:
-            raise XAirRemoteError(f"expected one of {opts}")
+            self.logger.warning(f"det got {val}, expected one of {opts}")
         self.setter("det", opts.index(val))
 
     @property
@@ -259,7 +268,7 @@ class Dyn:
     def env(self, val: str):
         opts = ("lin", "log")
         if val not in opts:
-            raise XAirRemoteError(f"expected one of {opts}")
+            self.logger.warning(f"env got {val}, expected one of {opts}")
         self.setter("env", opts.index(val))
 
     @property
@@ -269,7 +278,9 @@ class Dyn:
     @threshold.setter
     def threshold(self, val: float):
         if not -60 <= val <= 0:
-            raise XAirRemoteError("expected value in range -60.0 to 0")
+            self.logger.warning(
+                f"threshold got {val}, expected value in range -60.0 to 0"
+            )
         self.setter("thr", util.lin_set(-60, 0, val))
 
     @property
@@ -288,7 +299,7 @@ class Dyn:
     @knee.setter
     def knee(self, val: int):
         if not 0 <= val <= 5:
-            raise XAirRemoteError("expected value in range 0 to 5")
+            self.logger.warning(f"knee got {val}, expected value in range 0 to 5")
         self.setter("knee", util.lin_set(0, 5, val))
 
     @property
@@ -298,7 +309,7 @@ class Dyn:
     @mgain.setter
     def mgain(self, val: float):
         if not 0 <= val <= 24:
-            raise XAirRemoteError("expected value in range 0.0 to 24.0")
+            self.logger.warning(f"mgain got {val}, expected value in range 0.0 to 24.0")
         self.setter("mgain", util.lin_set(0, 24, val))
 
     @property
@@ -308,7 +319,7 @@ class Dyn:
     @attack.setter
     def attack(self, val: int):
         if not 0 <= val <= 120:
-            raise XAirRemoteError("expected value in range 0 to 120")
+            self.logger.warning(f"attack got {val}, expected value in range 0 to 120")
         self.setter("attack", util.lin_set(0, 120, val))
 
     @property
@@ -319,7 +330,9 @@ class Dyn:
     @hold.setter
     def hold(self, val: float):
         if not 0.02 <= val <= 2000:
-            raise XAirRemoteError("expected value in range 0.02 to 2000.0")
+            self.logger.warning(
+                f"hold got {val}, expected value in range 0.02 to 2000.0"
+            )
         self.setter("hold", util.log_set(0.02, 2000, val))
 
     @property
@@ -329,7 +342,7 @@ class Dyn:
     @release.setter
     def release(self, val: int):
         if not 5 <= val <= 4000:
-            raise XAirRemoteError("expected value in range 5 to 4000")
+            self.logger.warning(f"release got {val}, expected value in range 5 to 4000")
         self.setter("release", util.log_set(5, 4000, val))
 
     @property
@@ -339,7 +352,7 @@ class Dyn:
     @mix.setter
     def mix(self, val: int):
         if not 0 <= val <= 100:
-            raise XAirRemoteError("expected value in range 0 to 100")
+            self.logger.warning(f"mix got {val}, expected value in range 0 to 100")
         self.setter("mix", util.lin_set(0, 100, val))
 
     @property
@@ -382,7 +395,9 @@ class Dyn:
     @filterfreq.setter
     def filterfreq(self, val: Union[float, int]):
         if not 20 <= val <= 20000:
-            raise XAirRemoteError("expected value in range 20 to 20000")
+            self.logger.warning(
+                f"filterfreq got {val}, expected value in range 20 to 20000"
+            )
         self.setter("filter/f", util.log_set(20, 20000, val))
 
 
@@ -462,7 +477,7 @@ class EQ:
     def mode(self, val: str):
         opts = ("peq", "geq", "teq")
         if val not in opts:
-            raise XAirRemoteError(f"expected one of {opts}")
+            self.logger.warning(f"mode got {val}, expected one of {opts}")
         self.setter("mode", opts.index(val))
 
     class EQBand:
@@ -491,7 +506,9 @@ class EQ:
         @frequency.setter
         def frequency(self, val: float):
             if not 20 <= val <= 20000:
-                raise XAirRemoteError("expected value in range 20.0 to 20000.0")
+                self.logger.warning(
+                    f"frequency got {val}, expected value in range 20.0 to 20000.0"
+                )
             self.setter("f", util.log_set(20, 20000, val))
 
         @property
@@ -501,7 +518,9 @@ class EQ:
         @gain.setter
         def gain(self, val: float):
             if not -15 <= val <= 15:
-                raise XAirRemoteError("expected value in range -15.0 to 15.0")
+                self.logger.warning(
+                    f"gain got {val}, expected value in range -15.0 to 15.0"
+                )
             self.setter("g", util.lin_set(-15, 15, val))
 
         @property
@@ -512,7 +531,9 @@ class EQ:
         @quality.setter
         def quality(self, val: float):
             if not 0.3 <= val <= 10:
-                raise XAirRemoteError("expected value in range 0.3 to 10.0")
+                self.logger.warning(
+                    f"quality got {val}, expected value in range 0.3 to 10.0"
+                )
             self.setter("q", util.log_set(0.3, 10, val))
 
 
@@ -620,7 +641,9 @@ class Automix:
     @weight.setter
     def weight(self, val: float):
         if not -12 <= val <= 12:
-            raise XAirRemoteError("expected value in range -12.0 to 12.0")
+            self.logger.warning(
+                f"weight got {val}, expected value in range -12.0 to 12.0"
+            )
         self.setter("weight", util.lin_set(-12, 12, val))
 
 

{xair_api-2.2.6 → xair_api-2.3.2}/xair_api/strip.py

@@ -1,8 +1,11 @@
 import abc
+import logging
 
 from .meta import mute_prop
 from .shared import EQ, Automix, Config, Dyn, Gate, Group, Insert, Mix, Preamp, Send
 
+logger = logging.getLogger(__name__)
+
 
 class IStrip(abc.ABC):
     """Abstract Base Class for strips"""
@@ -10,6 +13,7 @@ class IStrip(abc.ABC):
     def __init__(self, remote, index: int):
         self._remote = remote
         self.index = index + 1
+        self.logger = logger.getChild(self.__class__.__name__)
 
     def getter(self, param: str) -> tuple:
         return self._remote.query(f"{self.address}/{param}")

{xair_api-2.2.6 → xair_api-2.3.2}/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-2.2.6 → xair_api-2.3.2}/xair_api/xair.py

@@ -14,17 +14,19 @@ 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
 from .rtn import AuxRtn, FxRtn
 from .strip import Strip
 
+logger = logging.getLogger(__name__)
+
 
 class OSCClientServer(BlockingOSCUDPServer):
     def __init__(self, address: str, dispatcher: Dispatcher):
@@ -45,10 +47,6 @@ class OSCClientServer(BlockingOSCUDPServer):
 class XAirRemote(abc.ABC):
     """Handles the communication with the mixer via the OSC protocol"""
 
-    logger = logging.getLogger("xair.xairremote")
-
-    _CONNECT_TIMEOUT = 0.5
-
     _info_response = []
 
     def __init__(self, **kwargs):
@@ -57,6 +55,8 @@ 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")
         self.server = OSCClientServer((self.xair_ip, self.xair_port), dispatcher)
@@ -73,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]}."
         )
@@ -116,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
@@ -134,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.2.6/xair_api/errors.py

@@ -1,2 +0,0 @@
-class XAirRemoteError(Exception):
-    """Base error class for XAIR Remote."""