Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
marjohloo committed Feb 26, 2023
1 parent e40b138 commit 1e64dc1
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# rpico_rgb_keypad_obs
# rpico_rgb_keypad_obs (v1.0.1)

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).

Demonstration video at: https://vimeo.com/802443378.

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.

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

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

## CircuitPython Installation
## Installation

### CircuitPython

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

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

## rpi_pico_rgb_keypad_osb Installation
### rpi_pico_rgb_keypad_osb

To install the software:

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

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

### OBS Studio Configuration

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.

## code.py Modifications

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

# Notices
## Notices

Copyright (c) 2023 Martin Looker

Expand Down

0 comments on commit 1e64dc1

Please sign in to comment.