swept-crkbd/README.md

114 lines
5.3 KiB
Markdown
Raw Normal View History

2022-05-28 21:00:19 -07:00
# Swept Corne
2022-06-07 13:19:39 -07:00
![front of a built swept](gallery/IMG_7887.JPG)
![back of a built swept](gallery/IMG_7886.JPG)
![swept v0.1 pcb](gallery/sweptv0.1.png)
2022-05-28 21:00:19 -07:00
## What is the swept corne?
2022-05-28 21:00:19 -07:00
The Swept Corne is a mix between the [Sweep](https://github.com/davidphilipbarr/Sweep) (which is itself a version of the [Ferris](https://github.com/pierrechevalier83/ferris)) and the [Corne](https://github.com/foostan/crkbd).
2022-05-28 20:46:35 -07:00
## Motivation
2022-05-28 21:00:19 -07:00
I made the jump from a 60% qwerty keyboard to colemak mod-dh on a sweep. After getting up to speed both with the new layout and form factor I realized that to reach peak productivity I'd need a few more keys and the corne was the obvious choice but the non-choc spacing,
2022-05-28 20:46:35 -07:00
lack support for a power switch and the less aggresive staggering made me miss the sweep, so I decided to take the sweep as a starting point and add the extra keys by keeping it wireless friendly. The [Corne-is Zen](https://lowprokb.ca/products/corne-ish-zen) has similar
2022-05-28 21:00:19 -07:00
goals but up to this point has only been available through group buys and is closed source.
2022-05-28 20:46:35 -07:00
## What are the different types?
2022-05-28 21:00:19 -07:00
There's currently only one version of the swept with choc spacing as well as an on-off switch and no TRRS connector, this is to have the reset switch in a more comfortable position.
## Components list
To build and use a Swept you will need
* 1x PCB Kit (Instructions on how to order below).
* 2 nice!nanos. [Typeractive](https://typeractive.xyz/) has good prices, as well as fast shipping and processing.
* 2 batteries. From [Typeractive](https://typeractive.xyz/products/lithium-battery-110mah).
* 2 Mill-Max sockets with pins. Make sure you get the high-profile ones, low-profile still fits a battery underneath but there's less space. [Typeractive](https://typeractive.xyz/products/machine-sockets-and-pins) carries the correct size.
* 42 Choc v1 switches. You can get them from [MKUltra](https://mkultra.click/choc-switches).
* 84 Mill-Max 3305 or 7305 sockets, you can get either model from [prevailkey](https://prevailkeyco.com/products/3305-mill-max-sockets?variant=42568596193534). These are optional but you can use them to make your board hot-swap. I recommend getting some extra ones because they're very easy to lose.
* 42 smd diodes. From [MKUltra](https://mkultra.click/diode-1n4148-sod-123f/) for flush SOD-123F form factor, or from [Boardsource](https://boardsource.xyz/store/5ec9fc5d64caf04f83aa646c) for glass smd form factor; the former ones might be easier to solder for some people. I recommend getting some extra ones because they're very easy to lose.
* 42 keycaps. You can get them from [MKUltra](https://mkultra.click/mbk-choc-keycaps) or [Boardsource](https://boardsource.xyz/store/5f6ef2d68e3bf05ab838f918). I recommend getting a least a couple of homing keys, available from both providers.
* 2x reset switches ([B3U-1000P(M)](https://github.com/davidphilipbarr/Sweep/issues/20)). [This kit](https://www.amazon.com/dp/B07LCBLB8N?psc=1&ref=ppx_yo2ov_dt_b_product_details) includes switches that fit.
2022-05-28 20:46:35 -07:00
* Rubber feet, [these](https://www.amazon.com/dp/B07CNQC695?psc=1&ref=ppx_yo2ov_dt_b_product_details) work great.
* 2x power switches. [these](https://www.amazon.com/Gikfun-Switch-Toggle-Arduino-AE1073/dp/B01GFFGA4I/ref=psdc_495324_t1_B07SJWWYZP) work great.
* 1 USB C cable.
Note: All purchase links are for the US, PRs with links for other countries are welcome.
## Ordering The PCB
To order the PCB the following settings are recommended:
|Detail|Value|
|---|---|
|Gerber file|`Swept_vX.zip`|
|Base material|FR-4|
|Layers|2|
|Dimension|261.1 mm * 90.7 mm|
|Different design|2|
|Delivery format|Panel by customer|
|PCB thickness|1.6mm|
|PCB color|(Personal preference)|
|Silkscreen|(Personal preference)|
|Surface finish|(Personal preference)|
|Outer copper weight|1oz|
|Gold Fingers|No|
|Confirm production file|No|
|Castellated holes|No|
|Remove order number|Yes|
Find the different versions on the releases page.
1: Settings are for [JLCPCB](https://jlcpcb.com/), but could work for other manufacturers.
2: Settings are taken from [Kyek's video guide](https://www.youtube.com/watch?v=fBPu7AyDtkM&t=17s).
## How do I make this thing?
2022-05-28 20:46:35 -07:00
Build video coming soon.
2022-06-13 15:44:14 -07:00
## What if I want one but I don't want to build it?
Visit [my Etsy shop](https://www.etsy.com/listing/1235225784/custom-swept-corne-split-wireless) to get one built by me.
## Firmware
2022-05-28 20:46:35 -07:00
Firmware for zmk and nice!nano is called ["Corne"](https://zmk.dev/docs/hardware/).
2022-06-07 13:24:24 -07:00
[My personal configuration](https://github.com/AYM1607/corne-zmk-config). Tested on the v0.1 version.
## Changelog
2022-06-22 19:14:49 -07:00
The following versioning schema will be followed as closely as possible.
- Major versions: Changes to the form factor.
- Minor versions: Changes that affect the build processs, e.g. Position or orientation of components.
- Patch versions: No change to the build process.
2022-06-22 19:09:01 -07:00
### v0.2.0 (Still untested)
- Introduced the Swept Corne 3x5
- All the diodes now face the same way on both boards.
2022-06-19 21:21:20 -07:00
### v0.1.2 (Recommended version)
2022-06-22 19:14:49 -07:00
- Updated silk screen to make the battery polarity easier to read.
2022-06-19 21:21:20 -07:00
### v0.1.1
2022-06-03 23:34:16 -07:00
2022-06-13 15:44:14 -07:00
- Deleted extra holes from the switch footprint which might be causing manufacturers to charge extra.
2022-06-03 23:34:16 -07:00
### v0.1
Differences from the original Sweep:
- Added an extra pinky column.
2022-05-30 03:33:57 -07:00
- Added an extra thumb key.
- Converted from direct to switch connections to matrix with diodes keeping compatibility with the corne.
## Who made this?
2022-05-28 20:46:35 -07:00
* [AYM1607](https://github.com/AYM1607)