Skip to content

Commit 17a12e7

Browse files
committed
Update README and add build guide.
1 parent 04b6fb8 commit 17a12e7

File tree

2 files changed

+67
-90
lines changed

2 files changed

+67
-90
lines changed

README.md

Lines changed: 20 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,37 @@
11
# TEMPEST
2-
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/thrly/tempest) ![Maintenance](https://img.shields.io/maintenance/yes/2025)
32

43
_a 36-key split ergonomic keyboard_
54

6-
![TEMPEST keyboard](images/tempest.jpg)
7-
8-
## Design
9-
10-
- Five columns, three rows, three thumb keys.
11-
- Column stagger and splay on the pinky and ring columns.
12-
- Powered by nice!nano / pro micro microcontroller.
13-
- Designed for wireless use + battery.
14-
- Low profile v1 Choc switches.
15-
- Reversible PCB.
16-
- Uses some components (JST plug, power switch, reset) from the Typeractive Corne design.
17-
- Layout designed with [Ergogen](https://ergogen.ceoloide.com/) (see [config.yaml](./ergogen/config.yaml)).
18-
- PCB designed with [KiCad](https://www.kicad.org/) (v 9).
19-
20-
> [!NOTE]
21-
> Despite the footprint for it, there is no display on the current version (1.1). The display header pins are not connected correctly. See issue [#7](https://github.com/thrly/tempest/issues/7). You could probably hand-wire the holes to the microcontroller to fix though.
22-
23-
![TEMPEST keyboard](images/tempest-2.jpg)
24-
25-
## Bill of Materials (BOM)
26-
27-
| Quantity | Part | Notes |
28-
| -------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
29-
| 2 | TEMPEST PCBs (reversible) from [gerbers .zip file](/tempest%201-1%20gerbers.zip) | order from [JLCPCB](https://jlcpcb.com/) or similar |
30-
| 2 | nice!nano | or other Pro Micro controller (see note about spring headers) |
31-
| 2 | [LiPo battery](https://typeractive.xyz/products/lithium-battery-110mah) | see nice!nano documentation for reccomendations, with 2-pin JST plug |
32-
| 2 | 2-pin JST plug | 2.0mm pin spacing, black are annoyingly harder to find than white |
33-
| 2 | Miniature Alps SPDT switch (7 pin) | Power on/off |
34-
| 2 | Miniature momentary button (side mount) | Reset |
35-
| 4 | 12-pin headers (5mm height) | MAC8 XB-3-5 from [Typeractive](https://typeractive.xyz/products/no-solder-spring-headers?variant=47196312502503) |
36-
| 36 | 1N4148W SMD diodes |
37-
| 36 | Kailh choc switches (v1) |
38-
| 36 | Kailh choc hotswap sockets |
39-
| 36 | Choc keycaps |
40-
41-
### Optional: Display
42-
43-
| Quantity | Part | Notes |
44-
| -------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------- |
45-
| 2 | nice!view display |
46-
| 2 | 5-pin header (7mm height) | MAC8 XB-3-7 from [Typeractive](https://typeractive.xyz/products/no-solder-spring-headers?variant=47196312535271) |
47-
48-
### Optional: Case
49-
50-
| Quantity | Part | Notes |
51-
| -------- | -------------------- | ------------------------------------------------------------- |
52-
| 2 | case .stl | Mirror for right side; PLA; 0.12 mm layer height; >50% infill |
53-
| 2 | key plate STL | Mirror for right side; PLA; 0.12 mm layer height; >50% infill |
54-
| 2 | stick-on rubber feet | or tenting legs from aliexpress |
55-
| 10 | M2 standoffs | height: 4 mm |
56-
| 20 | M2 bolts | height: 4 mm |
57-
58-
## Build guide
5+
![Maintenance](https://img.shields.io/maintenance/yes/2025) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/thrly/tempest)
596

60-
The build for the TEMPEST is simple and broadly follows the same steps outlined in [Typeractive's Corne build](https://docs.typeractive.xyz/build-guides/corne-wireless). Theirs is well-written and documented, so read that for now.
7+
![TEMPEST keyboard](images/tempest-white.jpg)
618

62-
Some important notes, however:
63-
64-
> [!IMPORTANT]
65-
> Microcontroller should be placed **facing DOWN** (i.e. facing the board).
66-
67-
> [!NOTE]
68-
> The microcontroller pin holes on the board have been narrowed (to 0.85mm) to enable the use of no-solder spring headers (MAC8 XB-3-5, as found from [Typeractive](https://typeractive.xyz/products/no-solder-spring-headers?variant=47196312502503)). These headers will fit the nice!nano, but other Pro Micro controllers may have pin holes that are too wide for these spring headers.
69-
70-
> [!IMPORTANT]
71-
> Ensure that you solder the jumper pads for microcontroller, display, and battery plug closed **on the BACK side of the board** (i.e. the same side you're soldering your hotswap switch plugs and diodes).
72-
73-
## Other Information
74-
75-
### Ergogen
76-
77-
The ergogen files are contained in the ergogen/ folder. See [here](https://docs.ergogen.xyz/usage) for guidance on building from ergogen.
9+
## Design
7810

79-
Ergogen was used mainly as a layout tool for the keys and wiring nets. Some of the footprints for things like MCU, switches, plugs, etc. may have been manually tweaked in the KiCad PCB editor, so don't expect the Ergogen render to be completely the same as the final PCB version.
11+
- Five columns, three rows, three thumb keys
12+
- Column stagger and splay on the pinky and ring columns
13+
- Powered by nice!nano / pro micro microcontroller
14+
- Designed for wireless use + battery
15+
- Low profile v1 Choc switches + hotswap sockets
16+
- Reversible PCB
17+
- Uses some components (JST plug, power switch, reset) from the Typeractive Corne design
18+
- Layout designed with [Ergogen](https://ergogen.ceoloide.com/) (see [config.yaml](./ergogen/config.yaml))
19+
- PCB designed with [KiCad](https://www.kicad.org/) (v 9)
20+
- Simple 3D-printable case
8021

8122
> [!NOTE]
82-
> Some of the ergogen/ceoloide footprint files used here have been modified slightly from the [originals](https://github.com/ceoloide/ergogen-footprints). Run locally, not on the ergogen web app.
83-
84-
### Ordering the PCB
85-
86-
Use the Gerber .zip file for PCB fabrication (i.e. JLPCB, PCBWay).
23+
> Despite the footprint for it, there is **no working display** on the current version (1.1). The display header pins are not connected correctly. See issue [#7](https://github.com/thrly/tempest/issues/7). You could probably hand-wire the holes to the microcontroller pins to fix though...
8724
88-
#### Suggested fabrication options
89-
90-
- FR-4 PCB, 1.6 mm
91-
- LeadFree HASL
92-
93-
Latest KiCad PCB is included, or files can be generated using Ergogen.
25+
![TEMPEST keyboard](images/tempest.jpg)
9426

95-
![TEMPEST PCB Image](images/tempest-pcb-v1-1.png)
27+
## Firmware
9628

97-
> Tempest PCB v1.1
29+
TEMPEST was designed to be used with ZMK. [You can find the ZMK-config repository and a keymap here.](https://github.com/thrly/tempest-zmk)
9830

99-
### Case
10031

101-
Files for a simple 3D-printed case included. Pictured case was printed in Matte PLA, with 0.12 layer height and 100% infill.
32+
## Build Guide
10233

103-
> [!TIP]
104-
> Alternatively, use the back-plate and top-plate exports from ergogen to order FR-4 plates along with your PCB. You can also use the DXF exports to design your own 3D-printed case/plates easily.
34+
[Details on the build and case can be found here.](/build-guide.md)
10535

10636
## Influences
10737

@@ -118,6 +48,6 @@ TEMPEST is inspired by and takes influence from:
11848

11949
If you build Tempest, I'd _love_ to hear how you get on with it. Please say hello via [thrly.com](https://www.thrly.com) or [instagram](https://www.instagram.com/thrly.xy/).
12050

121-
![Tempest Wave](/images/wave.png)
51+
<img src="https://github.com/thrly/tempest/blob/8db28c0fb310842e8c9dc7b95e4b05a694a6e47c/images/wave.png" width=50%>
12252

12353
<a href="https://ko-fi.com/C0C22GIO8" target="_blank"><img height="42" alt="Buy Me a Coffee at ko-fi.com" src="https://storage.ko-fi.com/cdn/kofi1.png?v=6"></a>

build-guide.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Build Guide
2+
3+
The build for the TEMPEST is simple and broadly follows the same steps outlined in [Typeractive's Corne build](https://docs.typeractive.xyz/build-guides/corne-wireless). Theirs is well-written and documented, so read that for now.
4+
5+
Some important notes, however:
6+
7+
> [!IMPORTANT]
8+
> Microcontroller should be placed **facing DOWN** (i.e. facing the board).
9+
10+
> [!NOTE]
11+
> The microcontroller pin holes on the board have been narrowed (to 0.85mm) to enable the use of no-solder spring headers (MAC8 XB-3-5, as found from [Typeractive](https://typeractive.xyz/products/no-solder-spring-headers?variant=47196312502503)). These headers will fit the nice!nano, but other Pro Micro controllers may have pin holes that are too wide for these spring headers.
12+
13+
> [!IMPORTANT]
14+
> Ensure that you solder the jumper pads for microcontroller, display, and battery plug closed **on the BACK side of the board** (i.e. the same side you're soldering your hotswap switch plugs and diodes).
15+
16+
![TEMPEST keyboard](images/tempest-2.jpg)
17+
18+
## Case
19+
20+
Files for a simple 3D-printed case included [here](/case/). Reccomended print in Matte PLA, with 0.12 layer height. Infill is not really relevant as the walls are thin.
21+
22+
> [!TIP]
23+
> Alternatively, use the back-plate and top-plate exports from ergogen to order FR-4 plates along with your PCB. You can also use the DXF exports to design your own 3D-printed case/plates easily.
24+
25+
## Ergogen
26+
27+
The ergogen YAML and footprints are contained in the [ergogen](/ergogen/) directory. With the ergogen cli tool installed, use `ergogen .` to build. See [here](https://docs.ergogen.xyz/usage) for guidance.
28+
29+
Ergogen was used mainly as a layout tool for the keys and wiring nets. Some of the footprints for things like MCU, switches, plugs, etc. may have been manually tweaked in the KiCad PCB editor, so don't expect the Ergogen render to be completely the same as the final PCB version.
30+
31+
> [!NOTE]
32+
> Some of the ergogen/ceoloide footprint files used here have been modified slightly from the [originals](https://github.com/ceoloide/ergogen-footprints). Run locally, not on the ergogen web app.
33+
34+
## Ordering the PCB
35+
36+
Use [tempest_gerbers_v1.zip](/tempest_gerbers_v1.zip) for PCB fabrication (i.e. JLPCB, PCBWay).
37+
38+
### Suggested fabrication options
39+
40+
- FR-4 PCB, 1.6 mm
41+
- LeadFree HASL
42+
43+
Latest [KiCad_PCB file](/tempest_pcb_v1.1.kicad_pcb) is included, or files can be generated using Ergogen.
44+
45+
![TEMPEST PCB Image](images/tempest-pcb-v1-1.png)
46+
47+
> Tempest PCB v1.1

0 commit comments

Comments
 (0)