Skip to content

9-key hot-swappable mechanical macropad powered by Seeed XIAO RP2040

License

Notifications You must be signed in to change notification settings

palmacas/MacroBoard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MacroBoard

MacroBoard

MacroBoard is a 9-key hot-swappable mechanical macropad powered by Seeed Studio XIAO RP2040. The keyboard has 9 Kailh hot-swappable sockets compatible with any 3-pin or 5-pin MX switch, giving you the ability to choose the switches that suit you best. The keyboard also includes a rotary encoder with a push button and each key is backlit with an RGB LED.

Features

  • Uses Seeed XIAO RP2040, a small form factor board based on the Raspberry Pi RP2040 microcontroller.
  • Supports MicroPython and CircuitPython.
  • Kailh hot-swappable sockets compatible with 3-pin and 5-pin MX switches.
  • Rotary quadrature encoder with push button.
  • SK6812 reverse-mounted addressable RGB LEDs to backlight each key.
  • Power and communication through a USB-C type port.
  • Compatible with KMK keyboard firmware.
  • Compatible with Windows, macOS, and Linux operating systems.
  • Dimensions: 61mm x 81mm x 31mm (without case), 66mm x 86mm x 35mm (with 3D-printed case).

Hardware Overview

MacroBoard

Getting Started

To set up the keyboard to work with CircuitPython and KMK Firmware, follow these steps:

CircuitPython Installation

  1. Enter Bootloader Mode
    • Press and hold the "BOOT" button.
    • Connect the Seeed XIAO RP2040 to your computer while still holding the button.
    • Your computer should now show a new drive, RPI-RP2.
  2. Download the firmware for Seeed Studio XIAO RP2040.
  3. Drag the .uf2 file to the drive RPI-RP2.
  4. Check the drive. The name should now have changed to CIRCUITPY.

NeoPixel Support

  1. Download the file neopixel.py and copy it to the root directory on drive CIRCUITPY.

KMK Installation

  1. Download the KMK Firmware repository as a ZIP file.
  2. Extract all files from de ZIP file and copy the kmk folder to the root directory on drive CIRCUITPY.
  3. Download the files code.py and boot.py from the firmware folder.
  4. Copy the files to the drive CIRCUITPY.
  5. Restart the keyboard by pressing the "RESET" button or disconnecting and reconnecting to the computer.

Keyboard Configuration

The key mapping defines the function and behavior of each key using a keycode or set of keycodes. The following code, which can be found in the file code.py, shows the key mapping for MacroBoard.

# Keymap
keyboard.keymap = [
    [KC.LCTRL(KC.LSHIFT(KC.TAB)), KC.LCTRL(KC.M), KC.LCTRL(KC.TAB),
     KC.MEDIA_PREV_TRACK, KC.MEDIA_PLAY_PAUSE, KC.MEDIA_NEXT_TRACK,
     KC.LCTRL(KC.C), KC.LCTRL(KC.V), KC.LGUI(KC.SPACE),
    ]
]

In this example, the keys in the first row can switch between browser tabs and mute a tab. The keys in the second row can control the media player, and the keys in the third row function as Ctrl+C, Ctrl+V, and GUI+SPACE.

COLUMN 1 COLUMN 2 COLUMN 3
ROW 1 CTRL+SHIFT+TAB CTRL+M CTRL+TAB
ROW 2 PREV TRACK PLAY/PAUSE NEXT TRACK
ROW 3 CTRL+C CTRL+V GUI+SPACE

You can find a list of all available keycodes at the KMK Firmware's wiki.

Disclaimer

The CircuitPython firmware, KMK Firmware, and NeoPixel library are managed and maintained by their respective developers.


More information:
MacroBoard – Design and Assembly [Spanish]
MacroBoard – Configuration [Spanish]