Update page 'Home'

master
Dennis Potter 4 years ago
parent 5def97bfa7
commit 735fedf834
  1. 15
      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 <dennis@dennispotter.eu>
@ -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 <pedals>... 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
Loading…
Cancel
Save