Updated documentations. No changes to keymap.c functions. (#18530)

master^2
syntax-magic 2022-09-29 10:33:23 -07:00 committed by GitHub
parent b51b3681b7
commit 49128d6b85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 83 additions and 4 deletions

View File

@ -81,9 +81,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* RIGHTFN
* ,-----------------------------------------------------------------------------------.
* | | | | | | | | F12 | F11 | F10 | F9 |Scllck|
* | | | | | | | | F12 | F11 | F10 | F9 | Pause|
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | Ctrl | | | | | | | F8 | F7 | F6 | F5 | Pause|
* | Ctrl | | | | | | | F8 | F7 | F6 | F5 |Scllck|
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | Shift| | | | | | | F4 | F3 | F2 | F1 | |
* |------+------+------+------+------+------+------+------+------+------+------+------|

View File

@ -1,3 +1,82 @@
# Dan's kprepublic bm40 layout
# Dan's KPrepublic BM40 Keymap
Dan's personal keymap with LED indicator support.
>This is my personal keymap with an LED indicator support for num lock, caps lock and scroll lock.
![](https://i.imgur.com/2yclc1B.jpg)
> * Case: Poseidon PSD40 Case
> * Plate: Brass
> * Keycaps: WOB ABS Cherry Profile
> * Switches: Gazzew Boba u4t (62g 2 stage long spring)
### BM40 LED INDEX
**_Numlock (11) Capslock (12) Scroll lock (23)_**
| | _A_ | _B_ | _C_ | _D_ | _E_ | _F_ | _G_ | _H_ | _I_ | _J_ | _K_ | _L_ |
|---------|---:|---:|---:|---:|---:|---:|---:|---:|---:|---:|---:|---:|
| **_1_** | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 |
| **_2_** | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 |
| **_3_** | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 |
| **_4_** |    36 |    37 |    38 |     39 |     40 |    41 |        |    42 |    43 |    44 |    45 |    46 |
## LED INDICATOR EXAMPLES
![](https://i.imgur.com/qpkRNio.jpg)
![](https://i.imgur.com/GfG252J.jpg)
> * Case: SM Keyboards Planck/Niu Mini Acrylic Case
> * Plate: Acrylic
> * Keycaps: Drop + biip MT3 Extended 2048 Katakana
> * Switches: Everglide Aqua King V3 (62g 2 stage long spring)
<br /><br />
## KEYMAP LAYOUT EXAMPLES
### ALPHA
| | _A_ | _B_ | _C_ | _D_ | _E_ | _F_ | _G_ | _H_ | _I_ | _J_ | _K_ | _L_ |
|---------|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|
| **_1_** | TAB | Q | W | E | R | T | Y | U | I | O | P | BSP |
| **_2_** | CTL | A | S | D | F | G | H | J | K | L | ; | ' |
| **_3_** | SFT | Z | X | C | V | B | N | M | , | . | / | RET |
| **_4_** | &nbsp;ESC | KOR | WIN | &nbsp;&nbsp;ALT | &nbsp;&nbsp;&nbsp;FN | &nbsp;SPC | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;- | &nbsp;&nbsp;&nbsp;&nbsp;= | DEL | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\ | ENT |
>This is a base layer for typing.
<br />
### LEFTFN MO(FN)
| | _A_ | _B_ | _C_ | _D_ | _E_ | _F_ | _G_ | _H_ | _I_ | _J_ | _K_ | _L_ |
|---------|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|
| **_1_** | \` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | BSP |
| **_2_** | CTL | LFT | DN | UP | RHT | C+/ | HAN | [ | ] | ) | : | " |
| **_3_** | SFT | PGU | PGD | HOM | END | CAP | PRN | ( | , | . | / | RET |
| **_4_** | RGB | [ | ] | &nbsp;ALT | TRN | &nbsp;SPC || &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_ | &nbsp;&nbsp;&nbsp;&nbsp;+ | &nbsp;INS | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | ENT |
>This is the layer dedicated to number, symbol and navigation keys. ie) arrow keys
<br />
### RIGHTFN MO(-)
| | _A_ | _B_ | _C_ | _D_ | _E_ | _F_ | _G_ | _H_ | _I_ | _J_ | _K_ | _L_ |
|---------|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|
| **_1_** | | | | | | | | F12 | F11 | F10 | F9 | PAU |
| **_2_** | CTL | | | | | | | F8 | F7 | F6 | F5 | SCL |
| **_3_** | SFT | | | | | | | F4 | F3 | F2 | F1 | |
| **_4_** | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;ALT&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;SPC | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;TRN | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|
>This layer contains function rows.
<br />
### NUMPAD MO(ESC)
| | _A_ | _B_ | _C_ | _D_ | _E_ | _F_ | _G_ | _H_ | _I_ | _J_ | _K_ | _L_ |
|---------|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|
| **_1_** | * | 7 | 8 | 9 | NUM | | | | | | | BSP |
| **_2_** | ALT | 4 | 5 | 6 | RET | | | | | | | |
| **_3_** | - | 1 | 2 | 3 | BSP | | | | | | | RET |
| **_4_** | TRN | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;, | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;. | &nbsp;&nbsp;&nbsp;0 | SPC | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;LY1 | &nbsp;LY2 | &nbsp;LY3 | &nbsp;LY4 | &nbsp;LY5 |
>This layer is the numpad.
<br />
There are other dedicated layers for gaming that are not included here.
If you are interested, check out keymap.c!