From 4a36e4a2ce98eeff96915c7f2c50454638d862f9 Mon Sep 17 00:00:00 2001 From: onyx-and-iris <75868496+onyx-and-iris@users.noreply.github.com> Date: Mon, 7 Nov 2022 18:36:59 +0000 Subject: [PATCH] major ver bump CHANGELOG updated to reflect changes --- CHANGELOG.md | 23 +++++++++++++++++++++++ README.md | 4 ++-- pyproject.toml | 2 +- 3 files changed, 26 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bb21ad3..b45dc40 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,29 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass - [x] +## [2.0.0] - 2022-11-07 + +Some support for the X32 mixer has been added using an adapter module but the code related to the XAir api has been left largely untouched. +However, a couple of changes have been made which are breaking, they are as follows: + +### Changed + +- FX class added to fx module. This now deals with osc addresses that begin with "/fx/". Call it with mixer.fx. +- FxRtn class added to rtn module. This now deals with addresses that begin with "/rtn/". Call it with mixer.fxreturn +- Aux class renamed to AuxRtn in rtn module. Call it with mixer.auxreturn. + +These changes were made to better resemble the underlying osc api and to better describe the function of the classes. + +### Added + +- A small number of X32 tests. More will be added. XAir tests moved into it's own test module. +- XAirRemote lower level section added to README. +- Links to OSC command documentation added to README. + +### Removed + +- mixer.aux was renamed to mixer.auxreturn + ## [1.1.0] - 2022-09-05 ### Added diff --git a/README.md b/README.md index be2d0d5..c0bf927 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ if __name__ == "__main__": ## API -Currently the following devices are support: +Currently the following devices are supported: - `MR18` - `XR18` @@ -287,7 +287,7 @@ for example: ```python mixer.send("/ch/01/mix/on", 1) -mixer.send("/mtx/06/config/name", "somename") +mixer.send("/bus/2/config/name", "somename") ``` Query the value of a command: diff --git a/pyproject.toml b/pyproject.toml index 472c17f..b5fc2b2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "xair-api" -version = "1.1.1" +version = "2.0.0" description = "Remote control Behringer X-Air | Midas MR mixers through OSC" authors = ["onyx-and-iris "] license = "MIT"