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

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

@@ -1,25 +1,24 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: xair-api
-Version: 2.3.2
+Version: 2.4.1
 Summary: Remote control Behringer X-Air | Midas MR mixers through OSC
-Home-page: https://github.com/onyx-and-iris/xair-api-python
 License: MIT
-Author: onyx-and-iris
+Author: Onyx and Iris
 Author-email: code@onyxandiris.online
-Requires-Python: >=3.10,<4.0
+Requires-Python: <4.0,>=3.10
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: python-osc (>=1.9.3,<2.0.0)
+Requires-Dist: tomli (>=2.0.1,<3.0) ; python_version < "3.11"
 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
@@ -58,18 +57,18 @@ import xair_api
 
 
 def main():
-    kind_id = "XR18"
-    ip = "<ip address>"
+    kind_id = 'XR18'
+    ip = '<ip address>'
 
     with xair_api.connect(kind_id, ip=ip) as mixer:
-        mixer.strip[8].config.name = "sm7b"
+        mixer.strip[8].config.name = 'sm7b'
         mixer.strip[8].mix.on = True
         print(
-            f"strip 09 ({mixer.strip[8].config.name}) on has been set to {mixer.strip[8].mix.on}"
+            f'strip 09 ({mixer.strip[8].config.name}) on has been set to {mixer.strip[8].mix.on}'
         )
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     main()
 ```
 
@@ -132,6 +131,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:
@@ -162,6 +165,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.
@@ -322,8 +332,8 @@ Send an OSC command directly to the mixer
 for example:
 
 ```python
-mixer.send("/ch/01/mix/on", 1)
-mixer.send("/bus/2/config/name", "somename")
+mixer.send('/ch/01/mix/on', 1)
+mixer.send('/bus/2/config/name', 'somename')
 ```
 
 Query the value of a command:
@@ -333,7 +343,7 @@ Query the value of a command:
 for example:
 
 ```python
-print(mixer.query("/ch/01/mix/on"))
+print(mixer.query('/ch/01/mix/on'))
 ```
 
 ### Errors

{xair_api-2.3.2 → xair_api-2.4.1}/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
@@ -40,18 +39,18 @@ import xair_api
 
 
 def main():
-    kind_id = "XR18"
-    ip = "<ip address>"
+    kind_id = 'XR18'
+    ip = '<ip address>'
 
     with xair_api.connect(kind_id, ip=ip) as mixer:
-        mixer.strip[8].config.name = "sm7b"
+        mixer.strip[8].config.name = 'sm7b'
         mixer.strip[8].mix.on = True
         print(
-            f"strip 09 ({mixer.strip[8].config.name}) on has been set to {mixer.strip[8].mix.on}"
+            f'strip 09 ({mixer.strip[8].config.name}) on has been set to {mixer.strip[8].mix.on}'
         )
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     main()
 ```
 
@@ -114,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:
@@ -144,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.
@@ -304,8 +314,8 @@ Send an OSC command directly to the mixer
 for example:
 
 ```python
-mixer.send("/ch/01/mix/on", 1)
-mixer.send("/bus/2/config/name", "somename")
+mixer.send('/ch/01/mix/on', 1)
+mixer.send('/bus/2/config/name', 'somename')
 ```
 
 Query the value of a command:
@@ -315,7 +325,7 @@ Query the value of a command:
 for example:
 
 ```python
-print(mixer.query("/ch/01/mix/on"))
+print(mixer.query('/ch/01/mix/on'))
 ```
 
 ### Errors

xair_api-2.4.1/pyproject.toml

@@ -0,0 +1,139 @@
+[project]
+name = "xair-api"
+version = "2.4.1"
+description = "Remote control Behringer X-Air | Midas MR mixers through OSC"
+authors = [
+    {name = "Onyx and Iris",email = "code@onyxandiris.online"}
+]
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = "<4.0,>=3.10"
+dependencies = [
+    "python-osc (>=1.9.3,<2.0.0)",
+    "tomli (>=2.0.1,<3.0) ; python_version < '3.11'"
+]
+
+[tool.poetry.requires-plugins]
+poethepoet = "^0.32.1"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.4"
+pytest-randomly = "^3.16.0"
+ruff = "^0.8.6"
+tox = "^4.23.2"
+virtualenv-pyenv = "^0.5.0"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poe.tasks]
+obs.script = "scripts:ex_obs"
+sends.script = "scripts:ex_sends"
+headamp.script = "scripts:ex_headamp"
+xair.script = "scripts:test_xair"
+x32.script = "scripts:test_x32"
+all.script = "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/
+
+[testenv:obs]
+setenv = VIRTUALENV_DISCOVERY=pyenv
+allowlist_externals = poetry
+deps = obsws-python
+commands =
+  poetry install -v --without dev
+  poetry run python examples/xair_obs/
+"""
+
+[tool.ruff]
+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",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.10
+target-version = "py310"
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Unlike Black, use single quotes for strings.
+quote-style = "single"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = [
+    "E402",
+    "F401",
+]

{xair_api-2.3.2 → xair_api-2.4.1}/xair_api/__init__.py

@@ -1,3 +1,3 @@
 from .xair import request_remote_obj as connect
 
-_ALL__ = ["connect"]
+_ALL__ = ['connect']

{xair_api-2.3.2 → xair_api-2.4.1}/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
@@ -7,34 +8,40 @@ from .rtn import FxRtn as IFxRtn
 class Bus(IBus):
     @property
     def address(self):
-        return f"/bus/{str(self.index).zfill(2)}"
+        return f'/bus/{str(self.index).zfill(2)}'
 
 
 class AuxRtn(IAuxRtn):
     @property
     def address(self):
-        return f"/auxin/{str(self.index).zfill(2)}"
+        return f'/auxin/{str(self.index).zfill(2)}'
 
 
 class FxRtn(IFxRtn):
     @property
     def address(self):
-        return f"/fxrtn/{str(self.index).zfill(2)}"
+        return f'/fxrtn/{str(self.index).zfill(2)}'
 
 
 class MainStereo(ILR):
     @property
     def address(self) -> str:
-        return "/main/st"
+        return '/main/st'
 
 
 class MainMono(ILR):
     @property
     def address(self) -> str:
-        return "/main/m"
+        return '/main/m'
 
 
 class Matrix(ILR):
     @property
     def address(self) -> str:
-        return f"/mtx/{str(self.index).zfill(2)}"
+        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.3.2 → xair_api-2.4.1}/xair_api/bus.py

@@ -16,10 +16,10 @@ class IBus(abc.ABC):
         self.logger = logger.getChild(self.__class__.__name__)
 
     def getter(self, param: str):
-        return self._remote.query(f"{self.address}/{param}")
+        return self._remote.query(f'{self.address}/{param}')
 
     def setter(self, param: str, val: int):
-        self._remote.send(f"{self.address}/{param}", val)
+        self._remote.send(f'{self.address}/{param}', val)
 
     @abc.abstractmethod
     def address(self):
@@ -39,12 +39,12 @@ class Bus(IBus):
         Returns a Bus class of a kind.
         """
         BUS_cls = type(
-            f"Bus{remote.kind}",
+            f'Bus{remote.kind}',
             (cls,),
             {
                 **{
                     _cls.__name__.lower(): type(
-                        f"{_cls.__name__}{remote.kind}", (_cls, cls), {}
+                        f'{_cls.__name__}{remote.kind}', (_cls, cls), {}
                     )(remote, index)
                     for _cls in (
                         Config,
@@ -56,11 +56,11 @@ class Bus(IBus):
                         Group,
                     )
                 },
-                "mute": mute_prop(),
+                'mute': mute_prop(),
             },
         )
         return BUS_cls(remote, index)
 
     @property
     def address(self) -> str:
-        return f"/bus/{self.index}"
+        return f'/bus/{self.index}'

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

@@ -15,10 +15,10 @@ class IConfig(abc.ABC):
         self.logger = logger.getChild(self.__class__.__name__)
 
     def getter(self, param: str):
-        return self._remote.query(f"{self.address}/{param}")
+        return self._remote.query(f'{self.address}/{param}')
 
     def setter(self, param: str, val: int):
-        self._remote.send(f"{self.address}/{param}", val)
+        self._remote.send(f'{self.address}/{param}', val)
 
     @abc.abstractmethod
     def address(self):
@@ -36,37 +36,37 @@ class Config(IConfig):
         Returns a Config class of a kind.
         """
         LINKS_cls = _make_links_mixins[remote.kind.id_]
-        MUTEGROUP_cls = type("MuteGroup", (Config.MuteGroup, cls), {})
-        MONITOR_cls = type("ConfigMonitor", (Config.Monitor, cls), {})
+        MUTEGROUP_cls = type('MuteGroup', (Config.MuteGroup, cls), {})
+        MONITOR_cls = type('ConfigMonitor', (Config.Monitor, cls), {})
         CONFIG_cls = type(
-            f"Config{remote.kind}",
+            f'Config{remote.kind}',
             (cls, LINKS_cls),
             {
-                "mute_group": tuple(MUTEGROUP_cls(remote, i) for i in range(4)),
-                "monitor": MONITOR_cls(remote),
+                'mute_group': tuple(MUTEGROUP_cls(remote, i) for i in range(4)),
+                'monitor': MONITOR_cls(remote),
             },
         )
         return CONFIG_cls(remote)
 
     @property
     def address(self) -> str:
-        return "/config"
+        return '/config'
 
     @property
     def amixenable(self) -> bool:
-        return self.getter("mute")[0] == 1
+        return self.getter('mute')[0] == 1
 
     @amixenable.setter
     def amixenable(self, val: bool):
-        self.setter("amixenable", 1 if val else 0)
+        self.setter('amixenable', 1 if val else 0)
 
     @property
     def amixlock(self) -> bool:
-        return self.getter("amixlock")[0] == 1
+        return self.getter('amixlock')[0] == 1
 
     @amixlock.setter
     def amixlock(self, val: bool):
-        self.setter("amixlock", 1 if val else 0)
+        self.setter('amixlock', 1 if val else 0)
 
     class MuteGroup:
         def __init__(self, remote, i):
@@ -76,128 +76,128 @@ class Config(IConfig):
         @property
         def address(self) -> str:
             root = super(Config.MuteGroup, self).address
-            return f"{root}/mute"
+            return f'{root}/mute'
 
         @property
         def on(self) -> bool:
-            return self.getter(f"{self.i}")[0] == 1
+            return self.getter(f'{self.i}')[0] == 1
 
         @on.setter
         def on(self, val: bool):
-            self.setter(f"{self.i}", 1 if val else 0)
+            self.setter(f'{self.i}', 1 if val else 0)
 
     class Monitor:
         @property
         def address(self) -> str:
             root = super(Config.Monitor, self).address
-            return f"{root}/solo"
+            return f'{root}/solo'
 
         @property
         @util.db_from
         def level(self) -> float:
-            return self.getter("level")[0]
+            return self.getter('level')[0]
 
         @level.setter
         @util.db_to
         def level(self, val: float):
-            self.setter("level", val)
+            self.setter('level', val)
 
         @property
         def source(self) -> int:
-            return int(self.getter("source")[0])
+            return int(self.getter('source')[0])
 
         @source.setter
         def source(self, val: int):
-            self.setter("source", val)
+            self.setter('source', val)
 
         @property
         def sourcetrim(self) -> float:
-            return round(util.lin_get(-18, 18, self.getter("sourcetrim")[0]), 1)
+            return round(util.lin_get(-18, 18, self.getter('sourcetrim')[0]), 1)
 
         @sourcetrim.setter
         def sourcetrim(self, val: float):
             if not -18 <= val <= 18:
                 self.logger.warning(
-                    f"sourcetrim got {val}, expected value in range -18.0 to 18.0"
+                    f'sourcetrim got {val}, expected value in range -18.0 to 18.0'
                 )
-            self.setter("sourcetrim", util.lin_set(-18, 18, val))
+            self.setter('sourcetrim', util.lin_set(-18, 18, val))
 
         @property
         def chmode(self) -> bool:
-            return self.getter("chmode")[0] == 1
+            return self.getter('chmode')[0] == 1
 
         @chmode.setter
         def chmode(self, val: bool):
-            self.setter("chmode", 1 if val else 0)
+            self.setter('chmode', 1 if val else 0)
 
         @property
         def busmode(self) -> bool:
-            return self.getter("busmode")[0] == 1
+            return self.getter('busmode')[0] == 1
 
         @busmode.setter
         def busmode(self, val: bool):
-            self.setter("busmode", 1 if val else 0)
+            self.setter('busmode', 1 if val else 0)
 
         @property
         def dimgain(self) -> int:
-            return int(util.lin_get(-40, 0, self.getter("dimatt")[0]))
+            return int(util.lin_get(-40, 0, self.getter('dimatt')[0]))
 
         @dimgain.setter
         def dimgain(self, val: int):
             if not -40 <= val <= 0:
                 self.logger.warning(
-                    f"dimgain got {val}, expected value in range -40 to 0"
+                    f'dimgain got {val}, expected value in range -40 to 0'
                 )
-            self.setter("dimatt", util.lin_set(-40, 0, val))
+            self.setter('dimatt', util.lin_set(-40, 0, val))
 
         @property
         def dim(self) -> bool:
-            return self.getter("dim")[0] == 1
+            return self.getter('dim')[0] == 1
 
         @dim.setter
         def dim(self, val: bool):
-            self.setter("dim", 1 if val else 0)
+            self.setter('dim', 1 if val else 0)
 
         @property
         def mono(self) -> bool:
-            return self.getter("mono")[0] == 1
+            return self.getter('mono')[0] == 1
 
         @mono.setter
         def mono(self, val: bool):
-            self.setter("mono", 1 if val else 0)
+            self.setter('mono', 1 if val else 0)
 
         @property
         def mute(self) -> bool:
-            return self.getter("mute")[0] == 1
+            return self.getter('mute')[0] == 1
 
         @mute.setter
         def mute(self, val: bool):
-            self.setter("mute", 1 if val else 0)
+            self.setter('mute', 1 if val else 0)
 
         @property
         def dimfpl(self) -> bool:
-            return self.getter("dimfpl")[0] == 1
+            return self.getter('dimfpl')[0] == 1
 
         @dimfpl.setter
         def dimfpl(self, val: bool):
-            self.setter("dimfpl", 1 if val else 0)
+            self.setter('dimfpl', 1 if val else 0)
 
 
 def _make_links_mixin(kind):
     """Creates a links mixin"""
     return type(
-        f"Links{kind}",
+        f'Links{kind}',
         (),
         {
-            "link_eq": bool_prop("linkcfg/eq"),
-            "link_dyn": bool_prop("linkcfg/dyn"),
-            "link_fader_mute": bool_prop("linkcfg/fdrmute"),
+            'link_eq': bool_prop('linkcfg/eq'),
+            'link_dyn': bool_prop('linkcfg/dyn'),
+            'link_fader_mute': bool_prop('linkcfg/fdrmute'),
             **{
-                f"chlink{i}_{i+1}": bool_prop(f"chlink/{i}-{i+1}")
+                f'chlink{i}_{i+1}': bool_prop(f'chlink/{i}-{i+1}')
                 for i in range(1, kind.num_strip, 2)
             },
             **{
-                f"buslink{i}_{i+1}": bool_prop(f"buslink/{i}-{i+1}")
+                f'buslink{i}_{i+1}': bool_prop(f'buslink/{i}-{i+1}')
                 for i in range(1, kind.num_bus, 2)
             },
         },