This project includes QMK files for various keymaps for the Adafruit MacroPad RP2040, which includes 12 RGB LED key switches, a pressable rotary encoder, an OLED screen, and audio output capability.
Configuration for simultaneously controlling the ATEN CS62KM KM switch as well as the ATEN CS1824 and CS1924 KVMP switches.
- The MacroPad connects to the CS62KM, which is then connected to both the CS1824 and CS1924
- This enables the MacroPad to control both the CS1824 and CS1924 by using the CS62KM as an intermediary
- Note that the ATEN CS62KM does not support media keys (see below Keymap), so the MacroPad cannot change the computer volume when it is connected using the CS62KM
Jump to the files here.
Keymap
- OLED Screen = Displays configuration information
- Encoder (ENCODER_DANCE)
- Single-Tap = Illuminate keys and populate OLED screen to show the current configuration for the CS1924 KVMP switch
- Press-Hold = Illuminate key and populate OLED screen to show the current configuration for the CS1824 KVMP switch
- Clockwise Rotation = Volume Up
- Counter-Clockwise Rotation = Volume Down
- Button1 (PORT1_DANCE)
- Single-Tap = Change to port 1 on the CS1924
- Press-Hold = Change to port 1 on the CS1824
- Button2 (PORT2_DANCE)
- Single-Tap = Change to port 2 on the CS1924
- Press-Hold = Change to port 2 on the CS1824
- Button3 (PORT3_DANCE)
- Single-Tap = Change to port 3 on the CS1924
- Press-Hold = Change to port 3 on the CS1824
- Button4 (KVM_1) = Change KVM focus on the CS1924 to port 1
- Button5 (KVM_2) = Change KVM focus on the CS1924 to port 2
- Button6 (KVM_3) = Change KVM focus on the CS1924 to port 3
- Button7 (USB_1) = Change USB hub focus on the CS1924 to port 1
- Button8 (USB_2) = Change USB hub focus on the CS1924 to port 2
- Button9 (USB_3) = Change USB hub focus on the CS1924 to port 3
- Button10 (AUDIO_1) = Change Audio focus on the CS1924 to port 1
- Button11 (AUDIO_2) = Change Audio focus on the CS1924 to port 2
- Button12 (AUDIO_3) = Change Audio focus on the CS1924 to port 3
Configuration for the ATEN CS1924 or CS1824 KVMP switch.
- The MacroPad connects directly to the CS1924 or CS1824 KVMP switch
Jump to the files here.
Keymap
- OLED Screen = Displays configuration information
- Encoder
- Single-Tap = PORT_CHECK = Illuminate keys and populate OLED screen to show the current configuration for the CS1824/CS1924
- Clockwise Rotation = Volume Up
- Counter-Clockwise Rotation = Volume Down
- Button1 (PORT_1) = Change to port 1 on the CS1824/CS1924
- Button2 (PORT_2) = Change to port 2 on the CS1824/CS1924
- Button3 (PORT_3) = Change to port 3 on the CS1824/CS1924
- Button4 (KVM_1) = Change KVM focus on the CS1824/CS1924 to port 1
- Button5 (KVM_2) = Change KVM focus on the CS1824/CS1924 to port 2
- Button6 (KVM_3) = Change KVM focus on the CS1824/CS1924 to port 3
- Button7 (USB_1) = Change USB hub focus on the CS1824/CS1924 to port 1
- Button8 (USB_2) = Change USB hub focus on the CS1824/CS1924 to port 2
- Button9 (USB_3) = Change USB hub focus on the CS1824/CS1924 to port 3
- Button10 (AUDIO_1) = Change Audio focus on the CS1824/CS1924 to port 1
- Button11 (AUDIO_2) = Change Audio focus on the CS1824/CS1924 to port 2
- Button12 (AUDIO_3) = Change Audio focus on the CS1824/CS1924 to port 3
QMK Configurator Method
-
Load the MacroPad RP2040 default configuration in the QMK Configurator.
-
Select the functions for the buttons and click compile.
-
Once the compiling is complete, download and save the firmware uf2 file.
QMK Code-Only Method (Recommended)
General
- Go through The QMK Tutorial. To get started, create a new keymap project within QMK MSYS environment by running
qmk new-keymap -kb [keyboard name] -km [name of project]- Example:
qmk new-keymap -kb adafruit/macropad -km UltraKvmpSwitch
- Example:
- Create the desired keyboard behavior by building content in the keymap.c file.
- Add (or copy from other QMK MacroPad RP2040 efforts) config.h and rules.mk files if needed (most likely YES) into the same location as the keymap.c file.
- When keymap.c and (if applicable) config.h and rules.mk are ready, go back to QMK MSYS and run
qmk compile -j 0 -kb [keyboard name] -km [name of project].- Example:
qmk compile -j 0 -kb adafruit/macropad -km UltraKvmpSwitch
- Example:
- The outputted firmware (uf2 file) is located at
...qmk_firmware\.build\[keyboard_name]_[project_name].uf2- Example:
...qmk_firmware\.build\adafruit_macropad_UltraKvmpSwitch.uf2
- Example:
Creating Images for the OLED Screen
- Create an image (such as a *.png) you want to display on the OLED screen. Note that for best results the image should have white foreground coloring and black background coloring.
- Convert the image to a C byte array using a tool such as image2cpp. Here are some detailed instructions when using image2cpp:
- The "Canvas Size" is the extent of the image as displayed on the OLED screen. Ideally the canvas width and height are multiples of 8 (e.g., 32x32, 64x64).
- Background Color = Black
- Dithering = Binary (though other types will likely work fine)
- Brightness/Alpha Threshold = 128
- Scaling = Scale to fit, keeping proportions
- Center Image = Horizontally and Vertically
- Code Output Format = Plain bytes
- Draw Mode = Vertical - 1 bit per pixel
- The image2cpp tool provides a preview of what the image will look like for the provided Canvas Size.
- Press the "Generate code" button, and a byte array corresponding to the preview image will be created.
- Leverage this created byte array in the
keymap.cfile (see Source for example usage).
CircuitPython Method
Adafruit provides a comprehensive guide that walks through using CircuitPython to build firmware for the MacroPad RP2040. Note that this project currently focuses on using QMK for building the firmware.
Firmware Drag-and-Drop Method
-
Plug the Adafruit MacroPad RP2040 into the computer.
-
Press and hold down on the encoder, and then press the reset button (located to the left of the OLED screen on the side of the board).
-
The MacroPad should enter bootloader mode and a new USB storage device called
RPI-RP2should be available on the computer. -
Drag and drop the desired firmware uf2 file into the RPI-RP2 device.
-
The MacroPad should auto-restart and launch with the new firmware.
- My MacroPad RP2040 was ordered through Adafruit in December 2021
- Additional MacroPad RP2040 resources may be found on Adafruit's website
- Additional QMK resources are compiled in the QMK Syllabus
- QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community (and Hasu)
- Keymap header ASCII art by patorjk
- ForsakenRei for his RP2040-MacroPad project, which was a useful reference
- "Laptop" image created by Dong Gyu Yang from Noun Project