gitlab-profile/README.md
2023-08-29 17:37:46 +00:00

103 lines
4.2 KiB
Markdown

![keyboard layout](https://gitlab.com/noisy_cricket/gitlab-profile/-/raw/main/noisy_cricket_icon.png?inline=false)
# The Noisy Cricket (Mini Gaming Keyboard)
A minimal keyboard with just the basic keys for gaming on the go. Mostly targeted at FPS games with a focus on `W` `A` `S` `D`.
The layout can be customimzed via the QMK firware. The default layout looks like this:
```
╔═══╤═══╤═══╤═══╤═══╤═══╤═══╗
║Esc│ 1 │ 2 │ 3 │ 4 │ 5 │Del║
╟───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───╢
║ Tab │ Q │ W │ E │ R │Enter║
╟─────┴┬──┴┬──┴┬──┴┬──┴┐ ║
║Shift │ A │ S │ D │ F │ ║
╟───┬──┴┬──┴┬──┴┬──┴───┴┬───╢
║Ctl│Fn │ C │ V │ Space │Mut║
╚═══╧═══╧═══╧═══╧═══════╧═══╝
```
The `Mute` key is a rotary encoder that also controlles volume.
- [KLE][kle]
When shopping for key caps, you need the following:
- 7x R4 1u (`Esc`, `1`, `2`, `3`, `4`, `5`, `Delete`)
- 1x R3 1.5u (`Tab`)
- 4x R3 1u (`Q`, `W`, `E`, `R`)
- 1x ISO Enter
- 1x R2 1.75u (`Shift`)
- 4x R2 1u (`A`, `S`, `D`, `F`)
- 4x R1 1u (`Ctrl`, `Fn`, `C`, `V`)
- 1x R1 2u (`Space`)
Obviously you can ignore the rows when shopping for uniform key caps. 😉
The USB Vendor ID for noisy cricket is 1209 and Product ID is 4237. You can find it here: https://pid.codes/1209/4237/
# Build
## 1. Get all parts
Order PCBs from PCB Repository, Get gerber files here: https://gitlab.com/noisy_cricket/pcb/-/releases/rev2
See BOM here: https://octopart.com/bom-tool/6LG2ivlW
_Find cheap SK6812MINI-E here: https://www.aliexpress.com/item/4000475685852.html_
Other parts needed:
- Alps EC11 or Bourns PEC11L compatible rotary encoder: https://keycapsss.com/keyboard-parts/parts/59/rotary-encoder-with-switch-ec11?number=KC10028_KS
- Encoder knob: https://www.aliexpress.com/item/32744496347.html
- Kailh compatible hot swap sockets: https://www.aliexpress.com/item/1005003166749340.html
- MX compatible keyboard switches: https://www.aliexpress.com/item/1005005209738936.html
- Threaded inserts M2x2 (OD 3.2mm): https://www.aliexpress.com/item/1005004873154281.html
- Screws
- M2x4mm: https://www.aliexpress.com/item/32810852732.html
- M2x3mm: https://www.aliexpress.com/item/32810852732.html
- M2x3+3: https://www.aliexpress.com/item/1005003328519584.html
- M2x3: https://www.aliexpress.com/item/1005002044837898.html
- Cherry compatible keycaps: https://www.aliexpress.com/item/1005004572499792.html
## 2. Solder PCB
Solder the Microcontroller first with a heat gun or heat plate. Then solder crystal next to it. You'll need t firmly press the crystal down so it makes a good connection. Then solder everything else by hand.
## 3. Software
Flash QMK firmware from firmware repo: https://gitlab.com/noisy_cricket/qmk-firmware/
```shell
git clone https://gitlab.com/noisy_cricket/qmk-firmware/
cd qmk-firmware
git checkout noisy_cricket
```
Connect the board and execute this:
```shell
make noisy_cricket:default:flash
# or with the QMK tool: qmk flash -kb noisy_cricket -km default
```
## 4. Case
- Get 3D printable case files from https://gitlab.com/noisy_cricket/cad
- Run `make 3mf` to generate printable files
- Print `upper_case.3mf`
- Print `lower_case.3mf`
- Print `plate.3mf` or run `make dxf` and CNC cut `plate.dxf` out of aluminium or brass
- Optionally: CNC `weight.dxf` to further increase the weight of the case
- Optionally: CNC the lower and upper case from wood with the included STEP files
## 5. Finalize
Now put everything together and enjoy your new mini gaming keyboard.
---
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
[kle]: http://www.keyboard-layout-editor.com/#/gists/65536ad311175e9202de815243b8fe98