qmk_firmware

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

readme.md (2108B)


      1 # xdboards/recon
      2 
      3 ![xdboards/recon](https://imgur.com/a/HcjT4yq)
      4 
      5 A split low profile keyboard with hotswap sockets that is built around the Sea-Picro microcontroller for it's dedicated RGB pin.
      6 
      7 * Keyboard Maintainer: [Daniel Weeks](https://github.com/Xanimos)
      8 * Hardware Supported: Recon PCB, Sea-Picro, backwards compatibility with ProMicro pin layout.
      9 * Hardware Availability: [xdboards.xyz shop](https://www.xdboards.xyz)
     10 
     11 Make example for this keyboard (after setting up your build environment):
     12 
     13     make xdboards/recon:default
     14 
     15 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).
     16 
     17 ## Bootloader
     18 
     19 Enter the bootloader in 2 ways:
     20 
     21 * **Physical reset button**: Briefly press the button on the side of the PCB
     22 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
     23 * **Boot Magic**: Hold down the boot magic key while plugging in the USB cable
     24 
     25 ## Setup for Sea-Picro microcontrollers
     26 
     27 To take advantage of the dedicated 5v RGB pin on the sea-picro you must create your keymap
     28 and then add a `rules.mk` file and copy and paste the following:
     29 ```
     30 CONVERT_TO = rp2040_ce
     31 USE_SEA_PICRO_RGB_PIN = yes
     32 ```
     33 
     34 If you do not want to use the dedicated 5v RGB header then follow the Setup for non Sea-Picro microcontrollers.
     35 
     36 ## Setup for non Sea-Picro microcontrollers
     37 
     38 Solder the "Pro-Micro Compatibility" jumper on the bottom of both boards.
     39 
     40 In your keymap directory:
     41   - add/modify a `rules.mk` file
     42     - Remove or set `CONVERT_TO` to desired converter see [QMK Documentation](https://docs.qmk.fm/#/feature_converters)
     43     - Remove or set `USE_SEA_PICRO_RGB_PIN` to `no`
     44 
     45 
     46 ## Setup for Underglow rgb only
     47 
     48 
     49 Solder the "Per-Key RGB Skip" jumper on the bottom of both boards. Do not install per key RGBs.
     50 
     51 In your keymap directory:
     52   - add/modify a `config.h` file and insert 
     53     ```
     54     #define RGB_MATRIX_SPLIT { 5, 5 }
     55     #define RGB_MATRIX_LED_COUNT 10
     56     ```
     57