mirror of
https://github.com/onyx-and-iris/vmr-http.git
synced 2026-04-06 09:59:11 +00:00
update README, add links to auto docs.
This commit is contained in:
parent
6476be53c5
commit
cbdfddba09
83
README.md
83
README.md
@ -17,77 +17,20 @@ pip install vmr-http
|
|||||||
uvicorn vmr_http:app
|
uvicorn vmr_http:app
|
||||||
```
|
```
|
||||||
|
|
||||||
## Use
|
|
||||||
|
|
||||||
*Set multiple Strip 0 parameters at once*
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X 'PATCH' \
|
|
||||||
'http://127.0.0.1:8000/strip/0' \
|
|
||||||
-H 'accept: application/json' \
|
|
||||||
-H 'Content-Type: application/json' \
|
|
||||||
-d '{
|
|
||||||
"gain": -38.7,
|
|
||||||
"mute": true,
|
|
||||||
"mono": true,
|
|
||||||
"A1": true,
|
|
||||||
"A2": false,
|
|
||||||
"A5": true,
|
|
||||||
"B1": true,
|
|
||||||
"B3": true
|
|
||||||
}'
|
|
||||||
```
|
|
||||||
|
|
||||||
*Set Strip 1 mute*
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X 'PATCH' \
|
|
||||||
'http://127.0.0.1:8000/strip/1' \
|
|
||||||
-H 'accept: application/json' \
|
|
||||||
-H 'Content-Type: application/json' \
|
|
||||||
-d '{
|
|
||||||
"mute": true,
|
|
||||||
}'
|
|
||||||
```
|
|
||||||
|
|
||||||
*Get Bus 3 gain*
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X 'GET' \
|
|
||||||
'http://127.0.0.1:8000/bus/3/gain' \
|
|
||||||
-H 'accept: application/json'
|
|
||||||
```
|
|
||||||
|
|
||||||
*Get Bus 4 Mode*
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X 'GET' \
|
|
||||||
'http://127.0.0.1:8000/bus/4/mode' \
|
|
||||||
-H 'accept: application/json'
|
|
||||||
```
|
|
||||||
|
|
||||||
*Set Bus 2 Mode*
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X 'PATCH' \
|
|
||||||
'http://127.0.0.1:8000/bus/2/mode' \
|
|
||||||
-H 'accept: application/json' \
|
|
||||||
-H 'Content-Type: application/json' \
|
|
||||||
-d '{
|
|
||||||
"mode": "Composite"
|
|
||||||
}'
|
|
||||||
```
|
|
||||||
|
|
||||||
*Healthcheck*
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X 'GET' \
|
|
||||||
'http://127.0.0.1:8000/health' \
|
|
||||||
-H 'accept: application/json'
|
|
||||||
```
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
FastAPI [generates automatic docs][auto-docs], visit the link in the startup message when you launch the server.
|
FastAPI generates [automatic docs][auto-docs], simply launch the server and then visit:
|
||||||
|
|
||||||
|
*Swagger UI*
|
||||||
|
- http://localhost:8000/docs
|
||||||
|
|
||||||
|
*ReDoc*
|
||||||
|
- http://localhost:8000/redoc
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
`vban-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
||||||
|
|
||||||
[auto-docs]: https://fastapi.tiangolo.com/features/#automatic-docs
|
[auto-docs]: https://fastapi.tiangolo.com/features/#automatic-docs
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user