Sweep/README.md

53 lines
2.4 KiB
Markdown
Raw Normal View History

2020-11-24 11:01:55 +01:00
# Sweep
## What is sweep?
2020-11-24 16:07:19 +01:00
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.
2020-11-24 11:01:55 +01:00
## What are the different types?
2021-11-15 17:53:24 +01:00
| Device | Bluetooth Support<sup>[1]</sup> | On/Off Switch | Reversible PCB | Choc V1 | Choc V2 | Choc Mini | MX & Alps | Choc Spacing<sup>[2]</sup> | Tenting<sup>[3]</sup> |
| :--- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
2021-11-20 02:23:55 +01:00
| Sweep2.x | ✔ | ✔ | | ✔ | | | | ✔ | ✔ |
| Sweep High | ✔ | ✔ | | ✔ | ✔ | | ✔ | | ✔ |
2021-11-20 02:23:55 +01:00
| Sweep Half Swept | ✔ | ✔ | ✔ | ✔ | | | | ✔ | ✔ |
| Sweep Compact Low | ✔ | | ✔ | | | ✔ | | ✔ | |
*<sup>[1]</sup> It simply means that it supports the nice!nano. An on/off switch is recommended for bluetooth*
*<sup>[2]</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>[3]</sup> Supports splitkb's [tenting puck](https://splitkb.com/products/tenting-puck?_pos=1&_psq=tenting%20&_ss=e&_v=1.0)*
* Sweep2 - Recommended Choc v1 board with all the features.
* Sweep High - Same as the Sweep2 but trades choc spacing for compatibility with more switches and keycaps.
2021-11-11 16:41:02 +01:00
* 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.
2020-11-24 11:01:55 +01:00
## Firmware
2021-11-20 02:24:52 +01:00
The firmware can be found [with the Ferris firmware as part of QMK](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ferris/sweep).
2020-11-24 11:01:55 +01:00
2021-11-20 02:24:52 +01:00
Firmware for zmk and bluemicro_ble is called ["Cradio"](https://zmk.dev/docs/hardware/).
2021-07-26 11:47:00 +02:00
2020-11-24 11:01:55 +01:00
## BOM
To build a Sweep you will need:
2021-07-26 11:47:00 +02:00
* 2x promicro compatible boards or 2 nice!nanos.
2021-11-11 16:41:02 +01:00
* 34 switches of a compatible type (refer to the compatibility table)
* 34 keycaps
2020-11-24 11:01:55 +01:00
* 2x reset switches (optional)
* Some little rubber feet/bumpers
2021-11-11 16:41:02 +01:00
* Optional (if supported) 2x power switches (MSK 12C02)
2021-10-27 15:55:53 +02:00
## How do I make this thing?
I, lazily, haven't made any documentation, but thankfully there is [this tutorial on youtube](https://www.youtube.com/watch?v=fBPu7AyDtkM) by Kyek.
2020-11-24 11:01:55 +01:00
## Who made this?
* Pierre Chevalier
* David Barr
2020-11-24 16:07:19 +01:00
* [Ibnu Daru Aji](https://github.com/ibnuda/)
2021-11-15 17:55:37 +01:00
* [Duccio](https://github.com/duckyb)