aboutsummaryrefslogtreecommitdiff
path: root/keyboards/xdboards/recon/readme.md
blob: 49dbddbbfb19ea3e35af3343e3b56d21ae6f2096 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# xdboards/recon

![xdboards/recon](https://imgur.com/a/HcjT4yq)

A split low profile keyboard with hotswap sockets that is built around the Sea-Picro microcontroller for it's dedicated RGB pin.

* Keyboard Maintainer: [Daniel Weeks](https://github.com/Xanimos)
* Hardware Supported: Recon PCB, Sea-Picro, backwards compatibility with ProMicro pin layout.
* Hardware Availability: [xdboards.xyz shop](https://www.xdboards.xyz)

Make example for this keyboard (after setting up your build environment):

    make xdboards/recon:default

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).

## Bootloader

Enter the bootloader in 2 ways:

* **Physical reset button**: Briefly press the button on the side of the PCB
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
* **Boot Magic**: Hold down the boot magic key while plugging in the USB cable

## Setup for Sea-Picro microcontrollers

To take advantage of the dedicated 5v RGB pin on the sea-picro you must create your keymap
and then add a `rules.mk` file and copy and paste the following:
```
CONVERT_TO = rp2040_ce
USE_SEA_PICRO_RGB_PIN = yes
```

If you do not want to use the dedicated 5v RGB header then follow the Setup for non Sea-Picro microcontrollers.

## Setup for non Sea-Picro microcontrollers

Solder the "Pro-Micro Compatibility" jumper on the bottom of both boards.

In your keymap directory:
  - add/modify a `rules.mk` file
    - Remove or set `CONVERT_TO` to desired converter see [QMK Documentation](https://docs.qmk.fm/#/feature_converters)
    - Remove or set `USE_SEA_PICRO_RGB_PIN` to `no`


## Setup for Underglow rgb only


Solder the "Per-Key RGB Skip" jumper on the bottom of both boards. Do not install per key RGBs.

In your keymap directory:
  - add/modify a `config.h` file and insert 
    ```
    #define RGB_MATRIX_SPLIT { 5, 5 }
    #define RGB_MATRIX_LED_COUNT 10
    ```