onyx_online/vban-cmd-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vban-cmd-python.git synced 2025-04-03 20:33:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: onyx_online:dab519be9fea22196b864f7b2c7cc0d8e4e89400
Branches Tags
onyx_online:dev
onyx_online:add-event-stop-object
onyx_online:main
...
compare: onyx_online:94fa33cebfd13a68a022d6e0b7ff8e2597d41764
Branches Tags
onyx_online:dev
onyx_online:add-event-stop-object
onyx_online:main

3 Commits
dab519be9f ... 94fa33cebf

Author SHA1 Message Date
onyx-and-iris
94fa33cebf md fix 2023-07-13 08:58:06 +01:00
onyx-and-iris
ef105d878b fix logging example 2023-07-13 08:52:42 +01:00
onyx-and-iris
956f759e73 add Logging section to README. 2023-07-13 08:50:24 +01:00
1 changed files with 17 additions and 2 deletions
Show Stats Expand all files Collapse all files

19
README.md
View File

@ -506,12 +506,27 @@ Returns a `VbanRtPacket`. Designed to be used internally by the interface but av
States not guaranteed to be current (requires use of dirty parameters to confirm).
### `Errors`
## Errors
- `errors.VBANCMDError`: Exception raised when general errors occur.
- `errors.VBANCMDConnectionError`: Exception raised when connection/timeout errors occur.
### `Tests`
## Logging
It's possible to see the messages sent by the interface's setters and getters, may be useful for debugging.
example:
```python
import vban_cmd
logging.basicConfig(level=logging.DEBUG)
opts = {"ip": "ip.local", "port": 6980, "streamname": "Command1"}
with vban_cmd.api('banana', **opts) as vban:
...
```
## Tests
First make sure you installed the [development dependencies](https://github.com/onyx-and-iris/vban-cmd-python#installation)