From 0be1f3568a7e43035d17c5bd08b957cc60a690f2 Mon Sep 17 00:00:00 2001 From: velvettear Date: Fri, 11 Mar 2022 16:06:28 +0100 Subject: [PATCH] updated docs --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4271c7b..074e9b8 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,12 @@ to set a value for a pedal POST arguments **must** contain the parameters `id` a {"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` +`curl -X POST -d "id=8" -d "value=127" localhost:3000/pedals/1` **only pedal controls with midi bindings can be controlled!** + +### bypass +| url | GET | POST | +| - | - | - | +| /bypass | | toggle full bypass (switch to default pedalboard / back to last used pedalboard) | +| /bypass/`id` | | toggle bypass of a pedal by `id` | \ No newline at end of file