Skip to content

Commit 1e64dc1

Browse files
committed
updated readme
1 parent e40b138 commit 1e64dc1

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# rpico_rgb_keypad_obs
1+
# rpico_rgb_keypad_obs (v1.0.1)
22

33
This project uses a [Pimoroni Pico RGB Keypad Base](https://shop.pimoroni.com/products/pico-rgb-keypad-base) and [Raspberry Pi Pico](https://shop.pimoroni.com/products/raspberry-pi-pico?variant=40059364311123) to create a device that appears as a USB keyboard that can be used to control OBS Studio or other software. The software will also run on a [Pimoroni Keybow 2040](https://shop.pimoroni.com/products/keybow-2040?variant=32399559622739) (with a small code change).
44

5+
Demonstration video at: https://vimeo.com/802443378.
6+
57
The keypads are mapped to keys `F13` through to `F24` (sometimes in combination with `Shift`, `Alt` and `Ctrl` keys), these keys are not usually present on modern keyboards and so should not clash with other applications.
68

79
Keypads can be configured to operate in three different modes:
@@ -46,7 +48,9 @@ The default configuration (which can be changed in software) is:
4648

4749
[Pimoroni Keybow 2040](https://shop.pimoroni.com/products/keybow-2040?variant=32399559622739)
4850

49-
## CircuitPython Installation
51+
## Installation
52+
53+
### CircuitPython
5054

5155
You will need to download the [CircuitPython .uf2](https://circuitpython.org/board/raspberry_pi_pico/) file for the Pico, to install it:
5256

@@ -55,7 +59,7 @@ You will need to download the [CircuitPython .uf2](https://circuitpython.org/boa
5559
3. Copy the downloaded `.uf2` file to the drive
5660
4. The Pico will reboot and mount as a `CIRCUITPY` drive
5761

58-
## rpi_pico_rgb_keypad_osb Installation
62+
### rpi_pico_rgb_keypad_osb
5963

6064
To install the software:
6165

@@ -65,6 +69,10 @@ To install the software:
6569

6670
Note, the required libraries are included in the ZIP file.
6771

72+
### OBS Studio Configuration
73+
74+
To bind the keypads in OBS Studio got into the Settings and select the Hotkeys tab. You can then press the appropriate keypad to bind it to a specific function.
75+
6876
## code.py Modifications
6977

7078
### Keybow 2040
@@ -134,7 +142,7 @@ The code makes use of the following libraries (these are included in the release
134142
* https://github.com/pimoroni/pmk-circuitpython
135143
* lib/pmk/
136144

137-
# Notices
145+
## Notices
138146

139147
Copyright (c) 2023 Martin Looker
140148

0 commit comments

Comments
 (0)