velvettear/pbc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

extended readme

Browse source
This commit is contained in:
Daniel Sommer 2022-02-08 14:38:21 +01:00
parent 187b4beb70
commit 21c14af77a
1 changed files with 36 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -5,3 +5,38 @@ pedal board control
## description
control your MODEP pedalboard(s) via http requests
## api
### banks
| url | GET | POST |
| - | - | - |
| /banks | get available banks | |
| /banks/`id` | get bank by `id` | |
### pedalboards
| url | GET | POST |
| - | - | - |
| /pedalboards | list available pedalboards | |
| /pedalboards/default | get default pedalboard | |
| /pedalboards/current | get current pedalboard | |
| /pedalboards/`id` | get pedalboard by `id` | switch to pedalboard by `id` |
### pedals
| url | GET | POST |
| - | - | - | - |
| /pedals | get the current pedalboard's pedals | |
| /pedals/`id` | get the current pedalboard's pedal by `id` | set values of current pedalboard's pedal by %id |
**note:**
to set a value for a pedal POST arguments **must** contain the parameters `id` and `value` where `id` is the id of one of the pedal's controls.
**example - turn bypass on/off:**
`curl localhost:3000/pedals/1`
```
{"id":1,"name":"ZamComp","controls":[{"id":0,"name":"att","value":"10.000000"},{"id":1,"name":"rel","value":"80.000000"},{"id":2,"name":"kn","value":"0.000000"},{"id":3,"name":"rat","value":"4.000000"},{"id":4,"name":"thr","value":"0.000000"},{"id":5,"name":"mak","value":"0.000000"},{"id":6,"name":"slew","value":"1.000000"},{"id":7,"name":"sidech","value":"0.000000"},{"id":8,"name":":bypass","value":1,"midi":{"channel":0,"controller":0}}]}
```
in this case the pedal's bypass is turned on and has the id "8"; now let's turn if off:
`curl -X POST -d "id=8&value=127" localhost:3000/pedals/1`
**only pedal controls with midi bindings can be controlled!**