From 735fedf834cfbee6bbd68ded77da21ec284b0233 Mon Sep 17 00:00:00 2001 From: Dennis Potter Date: Tue, 27 Nov 2018 12:57:56 +0100 Subject: [PATCH] Update page 'Home' --- Home.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 1c08265..a4647a4 100644 --- a/Home.md +++ b/Home.md @@ -1,6 +1,6 @@ When running `footpedal-rs --help`, the following instructions are yielded. This wiki will elaborate on these commands. -``` +```bash rust-footswitch 0.1.0 Dennis Potter @@ -21,5 +21,18 @@ SUBCOMMANDS: ``` ## Reading the foot pedal +To read the foot pedal without writing any settings, the subcommand `read` should be used. The help function `footswitch-rs read --help` yields te following information (omitted redundant information): +```bash +USAGE: + footswitch-rs read [FLAGS] [OPTIONS] + +FLAGS: + -a, --all Read all pedals + +OPTIONS: + -p, --pedal ... Specify specific pedals. Possible values: [0 | 1 | 2] +``` + +In other words, to acquire the settings of all pedals, run: `footswitch-rs read --all`. To acquire only information of specific pedal (e.g., 1 and 2), run: `footswitch-rs read --p 1 2`. ## Writing data to the foot pedal \ No newline at end of file