xair-api 2.3.1__tar.gz → 2.4.0__tar.gz

{xair_api-2.3.1 → xair_api-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xair-api
-Version: 2.3.1
+Version: 2.4.0
 Summary: Remote control Behringer X-Air | Midas MR mixers through OSC
 Home-page: https://github.com/onyx-and-iris/xair-api-python
 License: MIT
@@ -11,6 +11,8 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: python-osc (>=1.8.0,<2.0.0)
 Requires-Dist: tomli (>=2.0.1,<3.0.0) ; python_version < "3.11"
 Project-URL: Repository, https://github.com/onyx-and-iris/xair-api-python
@@ -18,8 +20,7 @@ Description-Content-Type: text/markdown
 
 [![PyPI version](https://badge.fury.io/py/xair-api.svg)](https://badge.fury.io/py/xair-api)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/xair-api-python/blob/dev/LICENSE)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 ![Tests Status](./tests/xair/MR18.svg?dummy=8484744)
 
 # Xair API
@@ -73,7 +74,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 +91,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
 
@@ -131,6 +133,10 @@ A class representing auxreturn channel
 
 A class representing the main config settings
 
+`mixer.headamp`
+
+A class representing the channel preamps (phantom power/gain).
+
 ### `LR`
 
 Contains the subclasses:
@@ -161,6 +167,13 @@ Contains the subclasses:
 Contains the subclasses:
 (`Config`, `Preamp`, `EQ`, `Mix`, `Group`, `Send`)
 
+### `HeadAmp`
+
+The following properties are available:
+
+- `gain`: float, from -12.0 to 60.0
+- `phantom`: bool
+
 ### `Subclasses`
 
 For each subclass the corresponding properties are available.
@@ -335,6 +348,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 → xair_api-2.4.0}/README.md

@@ -1,7 +1,6 @@
 [![PyPI version](https://badge.fury.io/py/xair-api.svg)](https://badge.fury.io/py/xair-api)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/xair-api-python/blob/dev/LICENSE)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 ![Tests Status](./tests/xair/MR18.svg?dummy=8484744)
 
 # Xair API
@@ -55,7 +54,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 +71,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
 
@@ -113,6 +113,10 @@ A class representing auxreturn channel
 
 A class representing the main config settings
 
+`mixer.headamp`
+
+A class representing the channel preamps (phantom power/gain).
+
 ### `LR`
 
 Contains the subclasses:
@@ -143,6 +147,13 @@ Contains the subclasses:
 Contains the subclasses:
 (`Config`, `Preamp`, `EQ`, `Mix`, `Group`, `Send`)
 
+### `HeadAmp`
+
+The following properties are available:
+
+- `gain`: float, from -12.0 to 60.0
+- `phantom`: bool
+
 ### `Subclasses`
 
 For each subclass the corresponding properties are available.
@@ -317,6 +328,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.4.0/pyproject.toml

@@ -0,0 +1,135 @@
+[tool.poetry]
+name = "xair-api"
+version = "2.4.0"
+description = "Remote control Behringer X-Air | Midas MR mixers through OSC"
+authors = ["onyx-and-iris <code@onyxandiris.online>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/onyx-and-iris/xair-api-python"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+python-osc = "^1.8.0"
+tomli = { version = "^2.0.1", python = "<3.11" }
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.4.4"
+pytest-randomly = "^3.12.0"
+ruff = "^0.8.6"
+tox = "^4.23.2"
+virtualenv-pyenv = "^0.5.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+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]
+setenv = VIRTUALENV_DISCOVERY=pyenv
+allowlist_externals = poetry
+commands =
+  poetry install -v
+  poetry run pytest tests/
+"""
+
+[tool.ruff]
+lint.select = [
+    "E",
+    "F",
+]
+lint.ignore = [
+    "E501",
+]
+lint.fixable = [
+    "A",
+    "B",
+    "C",
+    "D",
+    "E",
+    "F",
+    "G",
+    "I",
+    "N",
+    "Q",
+    "S",
+    "T",
+    "W",
+    "ANN",
+    "ARG",
+    "BLE",
+    "COM",
+    "DJ",
+    "DTZ",
+    "EM",
+    "ERA",
+    "EXE",
+    "FBT",
+    "ICN",
+    "INP",
+    "ISC",
+    "NPY",
+    "PD",
+    "PGH",
+    "PIE",
+    "PL",
+    "PT",
+    "PTH",
+    "PYI",
+    "RET",
+    "RSE",
+    "RUF",
+    "SIM",
+    "SLF",
+    "TCH",
+    "TID",
+    "TRY",
+    "UP",
+    "YTT",
+]
+lint.unfixable = []
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+]
+line-length = 88
+lint.dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+target-version = "py312"
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = [
+    "E402",
+    "F401",
+]

{xair_api-2.3.1 → xair_api-2.4.0}/xair_api/adapter.py

@@ -1,4 +1,5 @@
 from .bus import Bus as IBus
+from .headamp import HeadAmp as IHeadAmp
 from .lr import LR as ILR
 from .rtn import AuxRtn as IAuxRtn
 from .rtn import FxRtn as IFxRtn
@@ -38,3 +39,9 @@ class Matrix(ILR):
     @property
     def address(self) -> str:
         return f"/mtx/{str(self.index).zfill(2)}"
+
+
+class HeadAmp(IHeadAmp):
+    @property
+    def address(self):
+        return f"/headamp/{str(self.index).zfill(3)}"

xair_api-2.4.0/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.4.0/xair_api/headamp.py

@@ -0,0 +1,49 @@
+import abc
+import logging
+
+from . import util
+
+logger = logging.getLogger(__name__)
+
+
+class IHeadAmp(abc.ABC):
+    """Abstract Base Class for headamps"""
+
+    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}")
+
+    def setter(self, param: str, val: int):
+        self._remote.send(f"{self.address}/{param}", val)
+
+    @abc.abstractmethod
+    def address(self):
+        pass
+
+
+class HeadAmp(IHeadAmp):
+    """Concrete class for headamps"""
+
+    @property
+    def address(self):
+        return f"/headamp/{str(self.index).zfill(2)}"
+
+    @property
+    def gain(self):
+        return round(util.lin_get(-12, 60, self.getter("gain")[0]), 1)
+
+    @gain.setter
+    def gain(self, val):
+        self.setter("gain", util.lin_set(-12, 60, val))
+
+    @property
+    def phantom(self):
+        return self.getter("phantom")[0] == 1
+
+    @phantom.setter
+    def phantom(self, val):
+        self.setter("phantom", 1 if val else 0)

{xair_api-2.3.1 → xair_api-2.4.0}/xair_api/kinds.py

@@ -16,6 +16,7 @@ class X32KindMap(KindMap):
     num_fx: int = 8
     num_auxrtn: int = 8
     num_matrix: int = 6
+    num_headamp: int = 127
 
 
 @dataclass

{xair_api-2.3.1 → xair_api-2.4.0}/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.3.1 → xair_api-2.4.0}/xair_api/xair.py

@@ -14,12 +14,13 @@ 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 .headamp import HeadAmp
 from .kinds import KindMap
 from .lr import LR
 from .rtn import AuxRtn, FxRtn
@@ -47,8 +48,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 +56,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 +74,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 +114,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
@@ -133,9 +135,15 @@ def _make_remote(kind: KindMap) -> XAirRemote:
         self.fxreturn = tuple(adapter.FxRtn.make(self, i) for i in range(kind.num_fx))
         self.auxin = tuple(adapter.AuxRtn.make(self, i) for i in range(kind.num_auxrtn))
         self.config = Config.make(self)
+        self.headamp = tuple(adapter.HeadAmp(self, i) for i in range(kind.num_headamp))
 
     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
@@ -148,6 +156,7 @@ def _make_remote(kind: KindMap) -> XAirRemote:
         self.fxreturn = tuple(FxRtn.make(self, i) for i in range(kind.num_fx))
         self.auxreturn = AuxRtn.make(self)
         self.config = Config.make(self)
+        self.headamp = tuple(HeadAmp(self, i) for i in range(kind.num_strip))
 
     if kind.id_ == "X32":
         return type(

xair_api-2.3.1/pyproject.toml

@@ -1,29 +0,0 @@
-[tool.poetry]
-name = "xair-api"
-version = "2.3.1"
-description = "Remote control Behringer X-Air | Midas MR mixers through OSC"
-authors = ["onyx-and-iris <code@onyxandiris.online>"]
-license = "MIT"
-readme = "README.md"
-repository = "https://github.com/onyx-and-iris/xair-api-python"
-
-[tool.poetry.dependencies]
-python = "^3.10"
-python-osc = "^1.8.0"
-tomli = { version = "^2.0.1", python = "<3.11" }
-
-[tool.poetry.group.dev.dependencies]
-pytest = "^7.1.2"
-pytest-randomly = "^3.12.0"
-black = "^22.6.0"
-isort = "^5.10.1"
-
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry.scripts]
-obs = "scripts:ex_obs"
-sends = "scripts:ex_sends"
-xair = "scripts:test_xair"
-x32 = "scripts:test_x32"

xair_api-2.3.1/xair_api/errors.py

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