qmk_firmware

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

readme.md (1989B)


      1 # snes_macropad
      2 
      3 ![Completed Build](https://i.imgur.com/WzzPJ3Yh.jpg)
      4 *Completed Build*
      5 
      6 ![Completed Build, closer with RGB off](https://i.imgur.com/D7ki7Kkh.jpg)
      7 *Completed Build, closer with RGB off*
      8 
      9 ![PCB and FR4 top/bottom plates](https://i.imgur.com/TgOev7lh.jpg)
     10 *PCB and FR4 top/bottom plates*
     11 
     12 The SNES Macropad is, as it sounds, a macropad that features a SNES connector. In addition it has a qwiic connector and a 3.5mm jack for 3.3V I2C (not audio), allowing additional expansion.
     13 
     14 This QMK implementation exposes the SNES controller as a part of the keyboard, meaning you can map the controller to do anything a qmk keyboard can. The layout is thus a 4x6 keyboard logically, split with the 3 first rows being on the macro pad and the 3 following being buttons on the snes controller.
     15 
     16 * Keyboard Maintainer: [JBarberU](https://github.com/jbarberu)
     17 * Hardware Supported: SNES Macropad Rev 1, with a Raspberry Pi Pico Lite (AliExpress clone of Raspberry Pico with fewer grounds and all GPIO's exposed on the headers)
     18 * Hardware Availability: The SNES Macro pad can be found [here](https://www.tindie.com/products/jbarberu/snes-macropad/) either as a kit, partially built or fully built.
     19 
     20 Make example for this keyboard (after setting up your build environment):
     21 
     22     make snes_macropad:default
     23 
     24 Flashing example for this keyboard:
     25 
     26     make snes_macropad:default:flash
     27 
     28 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).
     29 
     30 ## Bootloader
     31 
     32 Enter the bootloader in 3 ways:
     33 
     34 * **Physical bootsel button**: Hold down the bootsel button on the RPi Pico while plugging in the keyboard, or while pressing the reset button
     35 * **Physical reset button**: Quickly double press the reset button
     36 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available