qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (2103B)


      1 # Adafruit MacroPad RP2040
      2 
      3 ![AdafruitMacropad](https://i.imgur.com/dSBSwcJh.jpeg)
      4 
      5 A RP2040-powered Macropad with a 3x4 layout.
      6 
      7 - Keyboard Maintainer: [Jpe230](https://github.com/jpe230/) 
      8 - Hardware Supported: Adafruit MacroPad RP2040
      9 - Hardware Availability: [Barebones kit](https://www.adafruit.com/product/5100) [Starter Kit](https://www.adafruit.com/product/5128)
     10 
     11 Make example for this board (after setting up your build environment):
     12 
     13 ```sh
     14 qmk compile -kb adafruit/macropad -km default
     15 ```
     16 
     17 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
     18 
     19 ## Features
     20 
     21 - Raspberry Pi RP2040 Chip + 8MB Flash memory - Dual-core Cortex M0+ at ~130MHz with 264KB of RAM.
     22 - 3x4 Mechanical key switch sockets - accepts any Cherry MX-compatible switches. Individually tied to GPIO pins (not matrix wired)
     23 - One NeoPixel RGB LED per switch, on north side.
     24 - Rotary encoder, 20 detents per rotation, with push-switch on GPIO pin. Push switch is also used for entering bootloader mode when held down on power-up or reset.
     25 - 128x64 SH1106 Monochrome OLED display - On high-speed hardware SPI port for quick updates.
     26 - 8mm Speaker/Buzzer - With Class D amplifier and RC filter, can be used to make simple beeps and sounds effects. (Unsupported for now)
     27 - STEMMA QT Connector - Allows adding any I2C sensors/displays/devices with plug-and-play cables.
     28 - Reset button - On the side, for quick restarting, press it twice to enter bootloader.
     29 - Four M3 mounting bosses - Make custom enclosures easily.
     30 
     31 ## Bootloader
     32 
     33 Enter the bootloader in 4 ways:
     34 
     35 * **Bootmagic reset**: Hold down the key just below the rotary encoder push-button on power-up.
     36 * **Physical reset button**: Press twice the button on the side while the board is connected.
     37 * **BOOT button** Hold down the rotary encoder push-button on power-up or reset.
     38 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available.