forked from davidphilipbarr/Sweep
-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,76 +1,42 @@ | ||
# Sweep | ||
# Swept crkbd | ||
|
||
| Front | Back | | ||
| :---: | :---: | | ||
|  |  | | ||
Pictures pending. | ||
|
||
<span> | ||
<a href="https://discord.gg/czXcTXbsgU"> | ||
<img src="https://discordapp.com/api/guilds/669011382284451861/widget.png?style=shield"> | ||
</a> | ||
<img src="https://img.shields.io/github/last-commit/davidphilipbarr/sweep"> | ||
</span> | ||
## What is the swept crkbd? | ||
|
||
## What is sweep? | ||
The Swept Crkbd 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). | ||
|
||
Sweep is a version of the more fabulous [Ferris](https://github.com/pierrechevalier83/ferris) by [Pierre Chevalier](https://github.com/pierrechevalier83/) that uses a daughter board like a promicro, elite-c, bit-c, nice!nano etc. instead of using onboard components. | ||
## Motivation | ||
|
||
## What are the different types? | ||
|
||
| Device | On/Off Switch<sup>[1]</sup> | Reversible PCB<sup>[2]</sup> | Choc V1 | Choc V2 | Choc Mini | MX & Alps | Choc Spacing<sup>[3]</sup> | Tenting<sup>[4]</sup> | Hot Swap | | ||
| :--- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | | ||
| Sweep2.x | ✔ | | ✔ | | | | ✔ | ✔ | Mill-Max (optional) | | ||
| Sweep Bling LP | ✔ | | ✔ | | | | ✔ | ✔ | Kailh (required) | | ||
| Sweep Bling MX | ✔ | ✔ | | | | ⚠<br/><sup>[5]</sup> | | ✔ | Kailh (required) | | ||
| Sweep High | ✔ | | ✔ | ✔ | | ✔ | | ✔ | | ||
| Sweep Half Swept | ✔ | ✔ | ✔ | | | | ✔ | ✔ | | ||
| Sweep Compact Low | | ✔ | | | ✔ | | ✔ | | | ||
|
||
> Note: All versions support bluetooth with Nice!Nano | ||
*<sup>[1]</sup> An on/off switch is recommended for bluetooth builds.* | ||
*<sup>[2]</sup> With a reversible PCB it's easier to make mistakes during assembly, but it allows you to purchase less boards.* | ||
*<sup>[3]</sup> Choc spaced boards have the switches in a tighter grid. This provides a better final look but is only compatible with some choc keycaps. (e.g. MBK)* | ||
*<sup>[4]</sup> Supports splitkb's [tenting puck.](https://splitkb.com/products/tenting-puck?_pos=1&_psq=tenting%20&_ss=e&_v=1.0)* | ||
*<sup>[5]</sup> MX + kailh hotswap ONLY. Alps are NOT supported.* | ||
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, | ||
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 | ||
goals but is not always in stock and is closed source. | ||
|
||
## What are the different types? | ||
|
||
* Sweep2 - Recommended Choc v1 board with all the features. | ||
* Sweep Bling MX - An MX only Sweep that features Kailh's hotswap sockets and a stacked case. | ||
* Sweep High - Same as the Sweep2 but trades choc spacing for compatibility with more switches and keycaps. | ||
* Sweep Half Swept - Half of a Sweep2 with double pro-micro footprint (letting you avoid having one daughter-board flipped upside-down) | ||
* Sweep Compact Low - The only version that supports Choc minis. | ||
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 Sweep you will need: | ||
To build and use a Swept you will need: | ||
|
||
* 1x PCB Kit | ||
* 2x promicro compatible boards or 2 nice!nanos. | ||
* 34 switches of a compatible type (refer to the compatibility table) | ||
* 34 keycaps | ||
* 2x reset switches (optional; [B3U-1000P(M)](https://github.com/davidphilipbarr/Sweep/issues/20)) | ||
* Some little rubber feet/bumpers | ||
* 2x power switches (optional if supported; MSK 12C02) | ||
* 1x TRRS (not TRS!) cable (wired build only) | ||
* 2x TRRS Jack [PJ-320A] (wired build only) | ||
* 1 USB Cable (depends on your micro-controller choice) | ||
* 1x PCB Kit. | ||
* 2 nice!nanos. | ||
* 42 Choc v1 switches. | ||
* 42 keycaps. | ||
* 2x reset switches ([B3U-1000P(M)](https://github.com/davidphilipbarr/Sweep/issues/20)) If you live in the US, [this kit](https://www.amazon.com/dp/B07LCBLB8N?psc=1&ref=ppx_yo2ov_dt_b_product_details) includes switches that fit. | ||
* 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. | ||
|
||
## How do I make this thing? | ||
|
||
<a href="https://www.youtube.com/watch?v=fBPu7AyDtkM" target="_blank"> | ||
<img src="https://gist.githubusercontent.com/duckyb/337340baa1f0c8bcc06fef7b3b57242b/raw/97e6e0748dd1b8a3fb54fac0a88e84e6b6e0e10a/build-guide-button.svg" height="44"> | ||
</a> | ||
Build video coming soon. | ||
|
||
## Firmware | ||
|
||
The firmware can be found [with the Ferris firmware as part of QMK](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ferris/sweep). | ||
|
||
Firmware for zmk and bluemicro_ble is called ["Cradio"](https://zmk.dev/docs/hardware/). | ||
Firmware for zmk and nice!nano is called ["Corne"](https://zmk.dev/docs/hardware/). | ||
|
||
## Who made this? | ||
|
||
* [Pierre Chevalier](https://github.com/pierrechevalier83) | ||
* [David Barr](https://github.com/davidphilipbarr) | ||
* [Ibnu Daru Aji](https://github.com/ibnuda/) | ||
* [Duccio](https://github.com/duckyb) | ||
* [AYM1607](https://github.com/AYM1607) |