Browse Source

add some usage notes to docs

Thomas Buck 6 months ago
parent
commit
aae110b378
5 changed files with 41 additions and 2 deletions
  1. 1
    0
      docs/src/SUMMARY.md
  2. 10
    1
      docs/src/loopstation.md
  3. 10
    0
      docs/src/midi.md
  4. 4
    0
      docs/src/pcb2.md
  5. 16
    1
      docs/src/usage.md

+ 1
- 0
docs/src/SUMMARY.md View File

@@ -24,3 +24,4 @@
24 24
 - [Usage Guide](./usage.md)
25 25
   - [Loop Station](./loopstation.md)
26 26
   - [Drum Machine](./drummachine.md)
27
+  - [MIDI](./midi.md)

+ 10
- 1
docs/src/loopstation.md View File

@@ -1,3 +1,12 @@
1 1
 # Loop Station
2 2
 
3
-**TODO**: work in progress
3
+In this mode the first three buttons play each corresponding output channel.
4
+
5
+The fourth button, with the LED always lit, is the record button.
6
+Hold it down for a while and release it to set the length of the loop.
7
+
8
+Notes played while the record button is held will be looped.
9
+
10
+The top-right button below the encoder clears the recorded loop.
11
+
12
+You can modify the loop length using the encoder menu.

+ 10
- 0
docs/src/midi.md View File

@@ -0,0 +1,10 @@
1
+# MIDI
2
+
3
+The MIDI mode is only available when a computer is connected via USB to the Raspberry Pi Pico.
4
+
5
+You only have two settings in this mode, the receive and transmit MIDI channels, ranging from 1 to 16.
6
+
7
+Notes received on the selected Rx channel will be played on the output channels.
8
+Velocity is ignored.
9
+
10
+Any pressed note buttons are sent on the selected Tx channel.

+ 4
- 0
docs/src/pcb2.md View File

@@ -8,6 +8,10 @@ It is planned to be used without a case.
8 8
 
9 9
 You can [download the Gerber files to order PCBs online](./plot/fab_pcb2.zip).
10 10
 
11
+**Warning:**
12
+Revision 1 is missing diodes on the button matrix.
13
+So when holding down three or more buttons simultaneously you get ghosting on other buttons.
14
+
11 15
 ## Bill of Materials
12 16
 
13 17
 These are all the parts required to assemble the V2 PCB.

+ 16
- 1
docs/src/usage.md View File

@@ -1,3 +1,18 @@
1 1
 # Usage Guide
2 2
 
3
-**TODO**: work in progress
3
+Turn on LARS using the power switch on the PCB.
4
+
5
+In normal operation, the bottom of the display always shows the battery level in percent, and the voltage.
6
+Take care to **turn off the device** and recharge it when the **percentage reaches zero**!
7
+
8
+The top of the screen shows the currently selected setting and its value.
9
+Press the encoder to switch to the next available setting, or turn the encoder to change the value of the currently selected setting.
10
+
11
+The available settings depend on the current mode.
12
+Take a look at the sub-page for each mode for details.
13
+
14
+You can hold down some buttons while powering on the device to get different effects:
15
+
16
+* hold the `REC` button to skip the boot animation
17
+* hold the encoder `Click` button to show version information of the firmware
18
+* hold both `REC` and `Click` to enter the button test mode

Loading…
Cancel
Save