major ver bump

CHANGELOG updated to reflect changes
This commit is contained in:
onyx-and-iris 2022-11-07 18:36:59 +00:00
parent 858275beda
commit 4a36e4a2ce
3 changed files with 26 additions and 3 deletions

View File

@ -11,6 +11,29 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
- [x] - [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 ## [1.1.0] - 2022-09-05
### Added ### Added

View File

@ -57,7 +57,7 @@ if __name__ == "__main__":
## API ## API
Currently the following devices are support: Currently the following devices are supported:
- `MR18` - `MR18`
- `XR18` - `XR18`
@ -287,7 +287,7 @@ for example:
```python ```python
mixer.send("/ch/01/mix/on", 1) 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: Query the value of a command:

View File

@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "xair-api" name = "xair-api"
version = "1.1.1" version = "2.0.0"
description = "Remote control Behringer X-Air | Midas MR mixers through OSC" description = "Remote control Behringer X-Air | Midas MR mixers through OSC"
authors = ["onyx-and-iris <code@onyxandiris.online>"] authors = ["onyx-and-iris <code@onyxandiris.online>"]
license = "MIT" license = "MIT"