cm/cmdr-keyboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Christoffer Martinsson 2025-03-11 10:30:08 +01:00
parent e399379c90
commit 911a60b438
1 changed files with 23 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -21,7 +21,7 @@
------------------ ----------------- ------------------ ------------------ ----------------- ------------------
Layer 2 (Fn + Fn) Layer 2 (Fn + Fn)
-------------------------------------- ------ ------ -------------------------------------- -------------------------------------- ------ ------ --------------------------------------
| Esc | F11 | F12 | F13 | F14 | || M1 | | M4 || § | | | | CpLk| Del | | Esc | F11 | F12 | F13 | F14 | || M1 | | M4 || § | SLOK| | | CpLk| Del |
| LCtrl | F15 | F16 | F17 | F18 | F19 || M2 | | M5 || Left| Down| Up |Right| | Enter | | LCtrl | F15 | F16 | F17 | F18 | F19 || M2 | | M5 || Left| Down| Up |Right| | Enter |
| Shift | F20 | F21 | F22 | F23 | F24 || M3 |-----| M6 || Home| PgD | PgU | End | Ins | Shift | | Shift | F20 | F21 | F22 | F23 | F24 || M3 |-----| M6 || Home| PgD | PgU | End | Ins | Shift |
--------------------| Alt | Fn | Spc || BSpc| Gui |Enter|| Spc | Fn |AG+Fn|-------------------- --------------------| Alt | Fn | Spc || BSpc| Gui |Enter|| Spc | Fn |AG+Fn|--------------------
@ -35,9 +35,12 @@
- Cost efficient solution with one pcb and one 3D printed cover. - Cost efficient solution with one pcb and one 3D printed cover.
- Function keys with total of three layer support (Primary + 2fn layers). - Function keys with total of three layer support (Primary + 2fn layers).
- Status indication - - Status indication -
- LED off = Normal mode - LED green = Normal mode
- LED flashing = Caps Lock activated - LED green flashing = waiting for USB enumeration
- LED on = Gui key lock activated - LED blue on = sticky lock initiated
- LED blue flashing = sticky lock activated
- LED red = error
- LED red flashing = Caps Lock activated
## Build environment rp2040 Zero ## Build environment rp2040 Zero
@ -46,7 +49,7 @@ Rust embedded, rp2040 HAL
- Cargo (cargo.toml) - Cargo (cargo.toml)
- Flashing via rp2040 USB bootloader - Flashing via rp2040 USB bootloader
- Pressing reset/boot button on rp2040 Zero board - Pressing reset/boot button on rp2040 Zero board
- Pressing all four corners on the keyboard - Pressing upper left corner on the keyboard when connecting the usb cable
## Hardware ## Hardware
@ -62,7 +65,6 @@ Rust embedded, rp2040 HAL
# CMDR keyboard 42 # CMDR keyboard 42
![image](mCAD/cmdr-keyboard-42-v1_photo.png)
![image](mCAD/cmdr-keyboard-42-v1_photo_2.jpg) ![image](mCAD/cmdr-keyboard-42-v1_photo_2.jpg)
## Layout ## Layout
@ -72,22 +74,22 @@ Rust embedded, rp2040 HAL
--------------------------------------- --------------------------------------- --------------------------------------- ---------------------------------------
| Tab | Q | W | E | R | T | | Y | U | I | O | P | Å | | Tab | Q | W | E | R | T | | Y | U | I | O | P | Å |
| LCtrl | A | S | D | F | G | | H | J | K | L | Ö | Ä | | LCtrl | A | S | D | F | G | | H | J | K | L | Ö | Ä |
| Shift | Z | X | C | V | B | | N | M | , | . | - | Shift | | Shift | Z | X | C | V | B | | N | M | ,; | .: | -_ | Shift |
--------------------| Alt | Fn | Spc | |Enter| Fn |AG+Fn|-------------------- --------------------| Alt | Fn | Spc | |Enter| Fn |AG+Fn|--------------------
------------------- ------------------- ------------------- -------------------
Layer 1 (Fn) Layer 1 (Fn)
--------------------------------------- --------------------------------------- --------------------------------------- ---------------------------------------
| Esc | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | BSpc | | Esc | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | BSpc |
| LCtrl | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Enter | | 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 | Spc | | Gui | Fn |AG+Fn|-------------------- --------------------| Alt | Fn | Spc | | BSpc| Fn |AG+Fn|--------------------
------------------- ------------------- ------------------- -------------------
Layer 2 (Fn + Fn) Layer 2 (Fn + Fn)
--------------------------------------- --------------------------------------- --------------------------------------- ---------------------------------------
| F11 | F12 | F13 | F14 | F15 | F16 | | § |GuiLK| Gui | | CpLk| BSpc | | F11 | F12 | F13 | F14 | F15 | F16 | | § | SLOK| Gui | | CpLk| BSpc |
| LCtrl | | | F17 | F18 | F19 | | Left| Down| Up |Right| Del | Enter | | 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 | Spc | | Gui | Fn |AG+Fn|-------------------- --------------------| Alt | Fn | Spc | | BSpc| Fn |AG+Fn|--------------------
------------------- ------------------- ------------------- -------------------
``` ```
@ -98,18 +100,12 @@ Rust embedded, rp2040 HAL
- Cost efficient solution with one pcb and one 3D printed cover. - Cost efficient solution with one pcb and one 3D printed cover.
- Function keys with total of three layer support (Primary + 2fn layers). - Function keys with total of three layer support (Primary + 2fn layers).
- Status indication - - Status indication -
- LED off = Normal mode - LED green = Normal mode
- LED flashing = Caps Lock activated - LED green flashing = waiting for USB enumeration
- LED on = Gui key lock activated - LED blue on = sticky lock initiated
- LED blue flashing = sticky lock activated
## Build environment TeensyLC - LED red = error
- LED red flashing = Caps Lock activated
C/C++, Teensy arduino framework
- Platformio (platformio.ini)
- Flashing via Teensy USB bootloader
- Pressing boot button on teensy
- Pressing all four corners on the keyboard
## Build environment rp2040 Zero ## Build environment rp2040 Zero
@ -118,16 +114,16 @@ Rust embedded, rp2040 HAL
- Cargo (cargo.toml) - Cargo (cargo.toml)
- Flashing via rp2040 USB bootloader - Flashing via rp2040 USB bootloader
- Pressing reset/boot button on rp2040 Zero board - Pressing reset/boot button on rp2040 Zero board
- Pressing all four corners on the keyboard - Pressing upper left corner on the keyboard when connecting the usb cable
## Hardware ## Hardware
[Schematics](build/cmdr_mainboard_v1.pdf) [Schematics](build/cmdr_mainboard_v1.pdf)
- 1x TeensyLC alt 1x rp2040 Zero - 1x rp2040 Zero (please see patch instruction)
- 36x Cherry MX compatible switches - 36x Cherry MX compatible switches
- 6x Kailh Choc low profile switches - 6x Kailh Choc low profile switches
- 42x 1N4148 diodes - 42x 1N4148 diodes
- 1x PCB [Gerber files](build/cmdr_mainboard_gerber_v1.zip) - 1x PCB [Gerber files](build/cmdr_mainboard_gerber_v1.zip) (please see patch instructions)
- 1x MCU cover (optional) [STL file](build/cmdr_keyboard-Cover.stl) - 1x MCU cover (optional) [STL file](build/cmdr_keyboard-Cover.stl)
- 1x 6x3 Cherry MX mounting jig (optional) [STL file](build/cmdr_mounting_jig-MountingJig.stl) - 1x 6x3 Cherry MX mounting jig (optional) [STL file](build/cmdr_mounting_jig-MountingJig.stl)