Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dkm/pouetpouet-board-r2
https://github.com/dkm/pouetpouet-board-r2
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/dkm/pouetpouet-board-r2
- Owner: dkm
- License: mit
- Created: 2022-06-13T20:10:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-21T17:08:15.000Z (10 months ago)
- Last Synced: 2024-10-28T00:01:59.252Z (about 2 months ago)
- Language: Rust
- Size: 28.5 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PouetPouet
The firmware is [Keyberon](https://github.com/TeXitoi/keyberon), a
pure rust firmware.
The goal was:
* build a custom keyboard from scratch
* continue to learn embedded rust
* have fun
## Features
* ortholinear
* 60 keys, using Cherry MX switches, only 1U keycaps;
* 4 RGB LEDs for status;
* 6 RGB LEDs for backlight;
* USB-C connector;
* 1 STM32F072 MCU, with hardware USB DFU bootloader;
* Only onboard SMD component (except for the switches).
* ESD protection
## Inspiration
* [Keyseebee](https://github.com/TeXitoi/keyseebee) for being the «I will
change it quickly and have something ready in an hour» base project (even if
I ended up redoing most of the hardware design). It was really nice to have a
solid base to learn and bootstrap the project.
* [Typematrix 2030](http://typematrix.com/2030/features.php): I own 2 of them
and really love them. But both are getting old and some keys are not working
correctly (this motivated the keyboard change).
* [Steamvan](https://github.com/jmdaly/steamvan) for some KiCad design ideas;
* [Preonic](https://olkb.com/collections/preonic) as a model: ortholinear, good
balance between size/usability, simple.
## Usefull resources
* [Mechanical Keyboard](https://github.com/help-14/mechanical-keyboard) is a list of DIY keyboards
* [Awesome Mechanical Keyboard](https://github.com/BenRoe/awesome-mechanical-keyboard) is another [«awesome»](https://github.com/topics/awesome) list
* [Masterzen](http://www.masterzen.fr/2020/05/03/designing-a-keyboard-part-1/)
and many others for writing online tutorials for newbies like me.
## Build log
Disclaimer: I'm a software developper, this is my first real PCB design and my first try at SMD soldering: do not take anything here for granted :)
The project started as a quick-hack of Keyseebee to make it simpler but ended up
as a near full redesign. As every DIY project, the goal was to be quick and
simple (spoiler: it was neither).
Half of the parts have been soldered with a soldering iron (TS80P), the other
half with hot air station. Clearly, with my [un]existing soldering skills, the
hot air is a huge win. But I think I would have simply spent more time by only
using the iron. Even the small sod-323 diodes without the `_handsoldering` pads
(mistake) were not a real problem (tricky, but even I could do it). For
reference, I have soldered all SMD components for the second board under 2 hours
with hot air.
The trickiest
part is the USB connector if you don't have a hot air station: the plastic
casing melts with the solder.
* The LEDs are mostly optional, and the 6 used for the backlight are nearly
useless. I did not really study how to insert LEDs for a nice backlight and the
result is not really satisfactory.
* I'll hopefully find time to use plexiglass plate to put below the PCB and
above the visible part. I've added holes for this but never really planed
anything really. If you really want something nice here, you may check this
before.
## Layout
As a typematrix user, I really like the middle column with `backspace/enter/del`
so naturaly I've tried to do something similar. The [initial
layout](http://www.keyboard-layout-editor.com/##@_pcb:true%3B&@_c=%238f00ff&sm=cherry&sb=gateron%3B&=F2%0A%0A%0A%E2%80%94%0A%0A%0A%0A%0A%0A1%0A%22&=F3%0A%0A%0A%3C%0A%0A%0A%0A%0A%0A2%0A%C2%AB&=F4%0A%0A%0A%3E%0A%0A%0A%0A%0A%0A3%0A%C2%BB&=F5%0A%0A%0A%5B%0A%0A%0A%0A%0A%0A4%0A(&=F6%0A%0A%0A%5D%0A%0A%0A%0A%0A%0A5%0A)&_c=%23cf94ff%3B&=F1%0A%0A%0A%0A%0A%0A%0A%0A%0A%23%0A$&_c=%238f00ff%3B&=F7%0A%0A%0A%0A%0A%0A%0A%0A%0A6%0A%2F@&=F8%0A%0A%0A%0A%0A%0A%0A%0A%0A7%0A+&=F9%0A%0A%0A%0A%0A%0A%0A%0A%0A8%0A-&=F10%0A%0A%0A%0A%0A%0A%0A%0A%0A9%0A%2F%2F&=F11%0A%0A%0A%0A%0A%0A%0A%0A%0A0%0A*&_c=%23cf94ff%3B&=F12%0A%0A%0A%0A%0A%0A%0A%0A%0A%C2%B0%0A%2F=%3B&@_c=%234bfad0%3B&=PrtScr%0A%0A%0A%7C%0A%0A%0A%0A%0A%0AB&=VerNum%0A%0A%0A%0A%0A%0A%0A%0A%0A%C3%89&=%0A%0A%0A%2F&%0A%0A%0A%0A%0A%0AP&=%0A%0A%0A%C5%93%0A%0A%0A%0A%0A%0AO&_a:7%3B&=%C3%88&_c=%23fcc0c0&a:4%3B&=Esc%0A%0A%0A%0A%0A%0A%0A%0A%0ATab&_c=%23dbfff7%3B&=Ins%0A%0A%0A%0A%0A%0A%0A%0A%0A!%0A%5E&_c=%234bfad0%3B&=%2F&uArr%2F%3B%0A%0A%0A%0A%0A%0A%0A%0A%0AV&=%2F&dArr%2F%3B%0A%0A%0A%0A%0A%0A%0A%0A%0AD&=7%0A%0A%0A%0A%0A%0A%0A%0A%0AL&=8%0A%0A%0A%0A%0A%0A%0A%0A%0AJ&=9%0A%0A%0A%0A%0A%0A%0A%0A%0AZ%3B&@=%0A%0A%0A%C3%A6%0A%0A%0A%0A%0A%0AA&=%0A%0A%0A%C3%B9%0A%0A%0A%0A%0A%0AU&=%0A%0A%0A%22%0A%0A%0A%0A%0A%0AI&=%0A%0A%0A%E2%82%AC%0A%0A%0A%0A%0A%0AE&_c=%23dbfff7&a:5%3B&=%0A,%0A%0A%0A%0A%0A%2F%3B&_c=%23fcc0c0&a:7%3B&=%3Ci%20class%2F='mss%20mss-Unicode-BackSpace-DeleteLeft-Big-2'%3E%3C%2F%2Fi%3E&_c=%234bfad0&a:4%3B&=%3Ci%20class%2F='kb%20kb-Arrows-Top-2'%3E%3C%2F%2Fi%3E%0A%0A%0A%0A%0A%0A%0A%0A%0AC&=%2F&uarr%2F%3B%0A%0A%0A%0A%0A%0A%0A%0A%0AT&=%3Ci%20class%2F='kb%20kb-Arrows-Bottom-2'%3E%3C%2F%2Fi%3E%0A%0A%0A%0A%0A%0A%0A%0A%0AS&=4%0A%0A%0A%0A%0A%0A%0A%0A%0AR&=5%0A%0A%0A%0A%0A%0A%0A%0A%0AN&=6%0A%0A%0A%0A%0A%0A%0A%0A%0AM%3B&@=%C3%8A%0A%0A%0A%5C%0A%0A%0A%0A%0A%0A%C3%80&=%3Ci%20class%2F='fa%20fa-rotate-left'%3E%3C%2F%2Fi%3E%0A%0A%0A%7B%0A%0A%0A%0A%0A%0AY&=%3Ci%20class%2F='fa%20fa-plus'%3E%3C%2F%2Fi%3E%0A%0A%0A%7D%0A%0A%0A%0A%0A%0AX&_c=%23dbfff7%3B&=%3Ci%20class%2F='fa%20fa-minus'%3E%3C%2F%2Fi%3E%0A%0A%0A%E2%80%A6%0A%0A%0A%0A%0A%0A%2F:%0A.&_c=%234bfad0%3B&=%0A%0A%0A~%0A%0A%0A%0A%0A%0AK&_c=%23fcc0c0&a:7%3B&=%2F&crarr%2F%3B&_c=%23dbfff7&a:4%3B&=%2F&larr%2F%3B%0A%0A%0A%0A%0A%0A%0A%0A%0A%3F%0A'&_c=%234bfad0%3B&=%2F&darr%2F%3B%0A%0A%0A%0A%0A%0A%0A%0A%0AQ&=%2F&rarr%2F%3B%0A%0A%0A%0A%0A%0A%0A%0A%0AG&=1%0A%0A%0A%0A%0A%0A%0A%0A%0AH&=2%0A%0A%0A%0A%0A%0A%0A%0A%0AF&=3%0A%0A%0A%0A%0A%0A%0A%0A%0A%C3%87%3B&@_c=%23ff59d1&a:7%3B&=Ctrl&_c=%238f00ff%3B&=%2F&uArr%2F%3B&=Win&_c=%231500ff&a:4%3B&=%3Ci%20class%2F='fa%20fa-lightbulb-o'%3E%3C%2F%2Fi%3E%0A%0A%0A%0A%0A%0A%0A%0A%0AShift&_c=%238f00ff&a:7%3B&=Alt&_c=%23fcc0c0&a:4%3B&=%0A%0A%0A%2F_%0A%0A%0A%0A%0A%0Anbspc%0Aspc&_c=%238f00ff&a:7%3B&=AltGr&_c=%234bfad0&a:4%3B&=0%0A%0A%0A%0A%0A%0A%0A%0A%0AW&_c=%23dbfff7&a:5%3B&=%0A%25%0A%0A%0A%0A%0A%60&_c=%238f00ff&a:7%3B&=Del&_c=%231500ff%3B&=Shift&_c=%23ff59d1%3B&=Ctrl) has only the `%` and `w` key at different locations:
You can also see how the LEDs are currently used. It's mostly useless/for fun. They may be used someday to measure typing speed or do something else, but in the meantime, they blink like this:
## Bill Of Materials
|Item |Package|Qty|Remarks |Price |
|--------------------------------------------------------------------------|-------|--:|---------------------------------------|-----:|
| PCB | | 1 | [aisler](https://aisler.net/p/BWUOMHHS) (by 3 mini) | 28.80€ |
| 100 nF | 0805 | 5 | aisler* | 0€ |
| PRTR5V0U2X,215 | sot-143| 1 | aisler* | 0.43€ |
| 4.7 uF | 0805 | 2 | aisler* | 0€ |
| 470 Ohm | 0805 | 1 | aisler* | 0€ |
| TLV70233DBVR | sot-23| 1 | aisler* | 0.37€ |
| 74LVC1G34GW,125 | | 1 | aisler* | 0.28€ |
| 0805L050WR (500mA Polyfuse) | 0805 | 1 | aisler* | 1.91€ |
| RS282G05A3SMRT (micro switch) | | 2 | aisler* | 1.26€ |
| 100nF | 0805 | 2 | aisler* | 0€ |
| 5.1 kOhm | 0805 | 3 | aisler* | 0€ |
| 0805L050WR (500mA Polyfuse) | 0805 | 1 | aisler* | 0€ |
| [1N4148WS-7-F](https://fr.rs-online.com/web/p/diodes-de-commutation/7384737/) | sod-323 | 60| rs-online (by 200) | 3.24€ |
| [WS2812B](https://www.aliexpress.com/item/4000750610574.html?spm=a2g0s.9042311.0.0.27424c4dS3DGkH) | | 10| | 1€ |
| [USB TypeC HRO Receptacle](https://www.aliexpress.com/item/33056042016.html?spm=a2g0s.9042311.0.0.1d8b4c4d8WcR7j) | | 1 | by 10 mini | 0.25€ |
| [Gateron Switch 5-pin](https://fr.aliexpress.com/item/32797603005.html?spm=a2g0s.9042311.0.0.72906c37zAMdzk) | | 60| by 65 | 15.24€ |
| [Blank DSA Keycaps](https://fr.aliexpress.com/item/32850729893.html?spm=a2g0s.9042311.0.0.3c4b6c37vkQ3vr) | | 60| by 200 | 15.6€ |
| [STM32F072CBT6](https://fr.aliexpress.com/item/4000419148272.html?spm=a2g0s.9042311.0.0.43286c37wfyZHW) | LQFP48 | 1 | | 2.87€ |
|--------------------------------------------------------------------------|-------|--:|------------------------------------------|------|
|[TPS2553DBVR-1](https://www.digikey.fr/fr/products/detail/texas-instruments/TPS2553DBVR-1/5143873) | PKG? | 1 | FIND | ??€|
|[SK6812-Mini]() | PGK? | 60+4 | FIND | ??€ |
| 100nF | 0805 | 2 | aisler* | 0€ |
| 9.1 kOhm | 0805 | 4 | aisler* | 0€ |
| 68 kOhm | 0805 | 6 | aisler* | 0€ |
|[2N7002](https://www.digikey.fr/fr/products/detail/stmicroelectronics/2N7002/654418) | SOT23-3 | 2 | FIND | ?€ |
| 100uF | 6032 | 1 | FIND | ??€ |
The total for 3 keyboard is 71.25€. Beware that some parts can't be ordered for
the exact amount and you need to buy more (in particular, aisler won't do
anything under 3 units, so you need to spend at least ~90€ for 3 PCBs).
*: Bought using magic match from Aisler. Some components are then
«free» (resistor, capacitor) and some are not.
## Compiling and flashing
Install the complete toolchain and utils:
```shell
curl https://sh.rustup.rs -sSf | sh
rustup target add thumbv6m-none-eabi
rustup component add llvm-tools-preview
cargo install cargo-binutils
sudo apt-get install dfu-util
```
Compile:
Do not omit the `--release` as the debug code will not fit in the memory (the
linker will raise an error).
```shell
cd firmware
cargo objcopy --bin pouetpouet --release -- -O binary pouetpouet.bin
```
To flash using dfu-util, first put the board in dfu mode by pressing
BOOT, pressing and releasing RESET and releasing BOOT. Then:
```shell
dfu-util -d 0483:df11 -a 0 -s 0x08000000:leave -D pouetpouet.bin
```
The fist time, if the write fail, your flash might be protected. To
unprotect:
```shell
dfu-util -d 0483:df11 -a 0 -s 0x08000000:force:unprotect -D pouetpouet.bin
```