Updated Readme

This commit is contained in:
Christoffer Martinsson 2024-11-16 21:00:19 +01:00
parent 2649c5066a
commit f698e4b7f3

View File

@ -1,5 +1,68 @@
# CMDR keyboard 51
![image](mCAD/cmdr-keyboard-51-v1.png)
## Layout
```cpp
Layer 0
--------------------------------------------- ---------------------------------------------
| Tab | Q | W | E | R | T | F1 | | F4 | Y | U | I | O | P | Å |
| LCtrl | A | S | D | F | G | F2 | | F5 | H | J | K | L | Ö | Ä |
| Shift | Z | X | C | V | B | F3 |-----| F6 | N | M | , | . | - | Shift |
--------------------| Alt | Fn | Spc | BSpc| Gui |Enter| Spc | Fn |AG+Fn|--------------------
-------------------------------------------------------
Layer 1 (Fn)
--------------------------------------------- ---------------------------------------------
| Esc | F1 | F2 | F3 | F4 | F5 | F1 | | F4 | F6 | F7 | F8 | F9 | F10 | |
| LCtrl | 1 | 2 | 3 | 4 | 5 | F2 | | F5 | 6 | 7 | 8 | 9 | 0 | |
| Shift | 6 | 7 | 8 | 9 | 0 | F3 |-----| F6 | < | ´ | ' | ¨ | + | Shift |
--------------------| Alt | Fn | Spc | BSpc| Gui |Enter| Spc | Fn |AG+Fn|--------------------
-------------------------------------------------------
Layer 2 (Fn + Fn)
--------------------------------------------- ---------------------------------------------
| F11 | F12 | F13 | F14 | F15 | F16 | F1 | | F4 | § |GuiLK| | | CpLk| |
| LCtrl | | | F17 | F18 | F19 | F2 | | F5 | Left| Down| Up |Right| Del | |
| Shift | F20 | F21 | F22 | F23 | F24 | F3 |-----| F6 | Home| PgD | PgU | End | Ins | Shift |
--------------------| Alt | Fn | Spc | BSpc| Gui |Enter| Spc | Fn |AG+Fn|--------------------
-------------------------------------------------------
```
## Features
- 51 keys "Split" keyboard layout. 36 finger buttons and 9 thumb buttons and 6 function buttons.
- Extreme low profile (only one pcb).
- Cost efficient solution with one pcb and one 3D printed cover.
- Function keys with total of three layer support (Primary + 2fn layers).
- Status indication -
- LED off = Normal mode
- LED flashing = Caps Lock activated
- LED on = Gui key lock activated
## Build environment rp2040 Zero
Rust embedded, rp2040 HAL
- Cargo (cargo.toml)
- Flashing via rp2040 USB bootloader
- Pressing reset/boot button on rp2040 Zero board
- Pressing all four corners on the keyboard
## Hardware
[Schematics](build/cmdr_mainboard_v1.pdf)
- 1x rp2040 Zero
- 45x Cherry MX compatible switches
- 6x Kailh Choc low profile switches
- 51x 1N4148 diodes
- 1x PCB [Gerber files](build/cmdr_mainboard_51_gerber_v1.zip)
- 1x MCU cover (optional) [STL file](build/cmdr_keyboard_51_Cover.stl)
- 1x 6x3 Cherry MX mounting jig (optional) [STL file](build/cmdr_mounting_jig-MountingJig.stl)
# CMDR keyboard 42 # CMDR keyboard 42
![image](mCAD/cmdr-keyboard-42-v1_photo.jpg)
![image](mCAD/cmdr-keyboard-42-v1_photo_2.jpg) ![image](mCAD/cmdr-keyboard-42-v1_photo_2.jpg)
## Layout ## Layout
@ -14,17 +77,17 @@
------------------- ------------------- ------------------- -------------------
Layer 1 (Fn) Layer 1 (Fn)
--------------------------------------- --------------------------------------- --------------------------------------- ---------------------------------------
| Esc | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | | | Esc | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | BSpc |
| LCtrl | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | | | LCtrl | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Enter |
| Shift | 6 | 7 | 8 | 9 | 0 | | < | ´ | ' | ¨ | + | Shift | | Shift | 6 | 7 | 8 | 9 | 0 | | < | ´ | ' | ¨ | + | Shift |
--------------------| Alt | Fn | BSpc| |Enter| Fn |AG+Fn|-------------------- --------------------| Alt | Fn | Spc | | Gui | Fn |AG+Fn|--------------------
------------------- ------------------- ------------------- -------------------
Layer 2 (Fn + Fn) Layer 2 (Fn + Fn)
--------------------------------------- --------------------------------------- --------------------------------------- ---------------------------------------
| F11 | F12 | F13 | F14 | F15 | F16 | | § |GuiLK| Gui | | CpLk| | | F11 | F12 | F13 | F14 | F15 | F16 | | § |GuiLK| Gui | | CpLk| BSpc |
| LCtrl | | | F17 | F18 | F19 | | Left| Down| Up |Right| Del | | | LCtrl | | | F17 | F18 | F19 | | Left| Down| Up |Right| Del | Enter |
| Shift | F20 | F21 | F22 | F23 | F24 | | Home| PgD | PgU | End | Ins | Shift | | Shift | F20 | F21 | F22 | F23 | F24 | | Home| PgD | PgU | End | Ins | Shift |
--------------------| Alt | Fn | Gui | |Enter| Fn |AG+Fn|-------------------- --------------------| Alt | Fn | Spc | | Gui | Fn |AG+Fn|--------------------
------------------- ------------------- ------------------- -------------------
``` ```
@ -40,6 +103,7 @@
- LED on = Gui key lock activated - LED on = Gui key lock activated
## Build environment TeensyLC ## Build environment TeensyLC
C/C++, Teensy arduino framework C/C++, Teensy arduino framework
- Platformio (platformio.ini) - Platformio (platformio.ini)
@ -48,6 +112,7 @@ C/C++, Teensy arduino framework
- Pressing all four corners on the keyboard - Pressing all four corners on the keyboard
## Build environment rp2040 Zero ## Build environment rp2040 Zero
Rust embedded, rp2040 HAL Rust embedded, rp2040 HAL
- Cargo (cargo.toml) - Cargo (cargo.toml)