onyx_online/xair-api-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/xair-api-python.git synced 2024-09-27 14:56:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

connect_timeout kwarg added to README

Browse Source 
Errors section added to README
This commit is contained in:
onyx-and-iris 2024-02-16 12:37:15 +00:00
parent ed397e57aa
commit 2dc096e306
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -55,7 +55,7 @@ if __name__ == "__main__":
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: 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 - `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. - `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. - 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 ## API
@ -317,6 +318,14 @@ for example:
print(mixer.query("/ch/01/mix/on")) 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` ### `Tests`
Unplug any expensive equipment before running tests. Unplug any expensive equipment before running tests.