From ad86894ae7d5fbb7aed697d9f576cd186bfd1c9c Mon Sep 17 00:00:00 2001 From: Erovia Date: Sun, 25 Oct 2020 15:23:42 +0000 Subject: Rename keyboard-level readmes to lower-case (#10759) This is the recommendation in the [PR Checklist](https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs) and it will make working with them easier in the CLI/API/etc. --- keyboards/4pplet/aekiso60/README.md | 14 -- keyboards/4pplet/aekiso60/readme.md | 14 ++ keyboards/4pplet/steezy60/README.md | 14 -- keyboards/4pplet/steezy60/readme.md | 14 ++ keyboards/4pplet/waffling60/README.md | 14 -- keyboards/4pplet/waffling60/readme.md | 14 ++ keyboards/acheron/shark/README.md | 17 --- keyboards/acheron/shark/readme.md | 17 +++ keyboards/ai03/README.md | 4 - keyboards/ai03/readme.md | 4 + keyboards/aplx6/README.md | 41 ------ keyboards/aplx6/readme.md | 41 ++++++ keyboards/ashpil/modelm_usbc/README.md | 14 -- keyboards/ashpil/modelm_usbc/readme.md | 14 ++ keyboards/bemeier/bmek/README.md | 30 ---- keyboards/bemeier/bmek/readme.md | 30 ++++ keyboards/catch22/README.md | 17 --- keyboards/catch22/readme.md | 17 +++ keyboards/chili/README.md | 15 -- keyboards/chili/readme.md | 15 ++ keyboards/converter/adb_usb/README.md | 84 ----------- keyboards/converter/adb_usb/readme.md | 84 +++++++++++ keyboards/converter/m0110_usb/README.md | 51 ------- keyboards/converter/m0110_usb/readme.md | 51 +++++++ keyboards/converter/usb_usb/README.md | 69 --------- keyboards/converter/usb_usb/ble/README.md | 30 ---- keyboards/converter/usb_usb/ble/readme.md | 30 ++++ keyboards/converter/usb_usb/readme.md | 69 +++++++++ keyboards/converter/xt_usb/README.md | 17 --- keyboards/converter/xt_usb/readme.md | 17 +++ keyboards/db/db63/README.md | 21 --- keyboards/db/db63/readme.md | 21 +++ keyboards/fc660c/README.md | 167 --------------------- keyboards/fc660c/readme.md | 167 +++++++++++++++++++++ keyboards/fc980c/README.md | 185 ------------------------ keyboards/fc980c/readme.md | 185 ++++++++++++++++++++++++ keyboards/flehrad/bigswitch/README.md | 16 -- keyboards/flehrad/bigswitch/readme.md | 16 ++ keyboards/handwired/42/README.md | 15 -- keyboards/handwired/42/readme.md | 15 ++ keyboards/handwired/aplx2/README.md | 34 ----- keyboards/handwired/aplx2/readme.md | 34 +++++ keyboards/handwired/cans12er/README.md | 18 --- keyboards/handwired/cans12er/readme.md | 18 +++ keyboards/handwired/d48/README.md | 87 ----------- keyboards/handwired/d48/readme.md | 87 +++++++++++ keyboards/handwired/k8split/README.md | 21 --- keyboards/handwired/k8split/readme.md | 21 +++ keyboards/handwired/qc60/README.md | 21 --- keyboards/handwired/qc60/readme.md | 21 +++ keyboards/handwired/rs60/README.md | 27 ---- keyboards/handwired/rs60/readme.md | 27 ++++ keyboards/handwired/videowriter/README.md | 61 -------- keyboards/handwired/videowriter/readme.md | 61 ++++++++ keyboards/handwired/wulkan/README.md | 14 -- keyboards/handwired/wulkan/readme.md | 14 ++ keyboards/handwired/xealousbrown/README.md | 17 --- keyboards/handwired/xealousbrown/readme.md | 17 +++ keyboards/jj40/README.md | 21 --- keyboards/jj40/readme.md | 21 +++ keyboards/jj50/README.md | 21 --- keyboards/jj50/readme.md | 21 +++ keyboards/kabedon/kabedon78s/README.md | 13 -- keyboards/kabedon/kabedon78s/readme.md | 13 ++ keyboards/kabedon/kabedon980/README.md | 18 --- keyboards/kabedon/kabedon980/readme.md | 18 +++ keyboards/keebio/chocopad/README.md | 14 -- keyboards/keebio/chocopad/readme.md | 14 ++ keyboards/keebio/dilly/README.md | 14 -- keyboards/keebio/dilly/readme.md | 14 ++ keyboards/keebio/tragicforce68/README.md | 18 --- keyboards/keebio/tragicforce68/readme.md | 18 +++ keyboards/kinesis/nguyenvietyen/README.md | 109 -------------- keyboards/kinesis/nguyenvietyen/readme.md | 109 ++++++++++++++ keyboards/kingly_keys/soap/README.md | 16 -- keyboards/kingly_keys/soap/readme.md | 16 ++ keyboards/kona_classic/README.md | 47 ------ keyboards/kona_classic/readme.md | 47 ++++++ keyboards/lets_split_eh/README.md | 13 -- keyboards/lets_split_eh/readme.md | 13 ++ keyboards/mechmini/v1/README.md | 19 --- keyboards/mechmini/v1/readme.md | 19 +++ keyboards/mechmini/v2/README.md | 22 --- keyboards/mechmini/v2/readme.md | 22 +++ keyboards/mschwingen/modelm/README.md | 25 ---- keyboards/mschwingen/modelm/readme.md | 25 ++++ keyboards/noxary/README.md | 11 -- keyboards/noxary/readme.md | 11 ++ keyboards/nullbitsco/nibble/README.md | 19 --- keyboards/nullbitsco/nibble/readme.md | 19 +++ keyboards/percent/skog/README.md | 17 --- keyboards/percent/skog/readme.md | 17 +++ keyboards/switchplate/README.md | 4 - keyboards/switchplate/readme.md | 4 + keyboards/terrazzo/README.md | 125 ---------------- keyboards/terrazzo/readme.md | 125 ++++++++++++++++ keyboards/thevankeyboards/bananasplit/README.md | 14 -- keyboards/thevankeyboards/bananasplit/readme.md | 14 ++ keyboards/tkc/m0lly/README.md | 17 --- keyboards/tkc/m0lly/readme.md | 17 +++ keyboards/tkc/osav2/README.md | 15 -- keyboards/tkc/osav2/readme.md | 15 ++ keyboards/tkc/tkc1800/README.md | 17 --- keyboards/tkc/tkc1800/readme.md | 17 +++ keyboards/wheatfield/split75/README.md | 28 ---- keyboards/wheatfield/split75/readme.md | 28 ++++ keyboards/winkeyless/bface/README.md | 19 --- keyboards/winkeyless/bface/readme.md | 19 +++ keyboards/xiaomi/mk02/README.md | 104 ------------- keyboards/xiaomi/mk02/readme.md | 104 +++++++++++++ keyboards/ymd75/README.md | 22 --- keyboards/ymd75/readme.md | 22 +++ keyboards/ymdk/bface/README.md | 22 --- keyboards/ymdk/bface/readme.md | 22 +++ keyboards/ymdk/ymd09/README.md | 15 -- keyboards/ymdk/ymd09/readme.md | 15 ++ 116 files changed, 1954 insertions(+), 1954 deletions(-) delete mode 100644 keyboards/4pplet/aekiso60/README.md create mode 100644 keyboards/4pplet/aekiso60/readme.md delete mode 100644 keyboards/4pplet/steezy60/README.md create mode 100644 keyboards/4pplet/steezy60/readme.md delete mode 100644 keyboards/4pplet/waffling60/README.md create mode 100644 keyboards/4pplet/waffling60/readme.md delete mode 100644 keyboards/acheron/shark/README.md create mode 100644 keyboards/acheron/shark/readme.md delete mode 100644 keyboards/ai03/README.md create mode 100644 keyboards/ai03/readme.md delete mode 100644 keyboards/aplx6/README.md create mode 100644 keyboards/aplx6/readme.md delete mode 100644 keyboards/ashpil/modelm_usbc/README.md create mode 100644 keyboards/ashpil/modelm_usbc/readme.md delete mode 100755 keyboards/bemeier/bmek/README.md create mode 100755 keyboards/bemeier/bmek/readme.md delete mode 100644 keyboards/catch22/README.md create mode 100644 keyboards/catch22/readme.md delete mode 100644 keyboards/chili/README.md create mode 100644 keyboards/chili/readme.md delete mode 100644 keyboards/converter/adb_usb/README.md create mode 100644 keyboards/converter/adb_usb/readme.md delete mode 100644 keyboards/converter/m0110_usb/README.md create mode 100644 keyboards/converter/m0110_usb/readme.md delete mode 100644 keyboards/converter/usb_usb/README.md delete mode 100644 keyboards/converter/usb_usb/ble/README.md create mode 100644 keyboards/converter/usb_usb/ble/readme.md create mode 100644 keyboards/converter/usb_usb/readme.md delete mode 100644 keyboards/converter/xt_usb/README.md create mode 100644 keyboards/converter/xt_usb/readme.md delete mode 100644 keyboards/db/db63/README.md create mode 100644 keyboards/db/db63/readme.md delete mode 100644 keyboards/fc660c/README.md create mode 100644 keyboards/fc660c/readme.md delete mode 100644 keyboards/fc980c/README.md create mode 100644 keyboards/fc980c/readme.md delete mode 100644 keyboards/flehrad/bigswitch/README.md create mode 100644 keyboards/flehrad/bigswitch/readme.md delete mode 100644 keyboards/handwired/42/README.md create mode 100644 keyboards/handwired/42/readme.md delete mode 100644 keyboards/handwired/aplx2/README.md create mode 100644 keyboards/handwired/aplx2/readme.md delete mode 100644 keyboards/handwired/cans12er/README.md create mode 100644 keyboards/handwired/cans12er/readme.md delete mode 100644 keyboards/handwired/d48/README.md create mode 100644 keyboards/handwired/d48/readme.md delete mode 100644 keyboards/handwired/k8split/README.md create mode 100644 keyboards/handwired/k8split/readme.md delete mode 100644 keyboards/handwired/qc60/README.md create mode 100644 keyboards/handwired/qc60/readme.md delete mode 100644 keyboards/handwired/rs60/README.md create mode 100644 keyboards/handwired/rs60/readme.md delete mode 100644 keyboards/handwired/videowriter/README.md create mode 100644 keyboards/handwired/videowriter/readme.md delete mode 100644 keyboards/handwired/wulkan/README.md create mode 100644 keyboards/handwired/wulkan/readme.md delete mode 100644 keyboards/handwired/xealousbrown/README.md create mode 100644 keyboards/handwired/xealousbrown/readme.md delete mode 100644 keyboards/jj40/README.md create mode 100644 keyboards/jj40/readme.md delete mode 100644 keyboards/jj50/README.md create mode 100644 keyboards/jj50/readme.md delete mode 100644 keyboards/kabedon/kabedon78s/README.md create mode 100644 keyboards/kabedon/kabedon78s/readme.md delete mode 100644 keyboards/kabedon/kabedon980/README.md create mode 100644 keyboards/kabedon/kabedon980/readme.md delete mode 100644 keyboards/keebio/chocopad/README.md create mode 100644 keyboards/keebio/chocopad/readme.md delete mode 100644 keyboards/keebio/dilly/README.md create mode 100644 keyboards/keebio/dilly/readme.md delete mode 100644 keyboards/keebio/tragicforce68/README.md create mode 100644 keyboards/keebio/tragicforce68/readme.md delete mode 100644 keyboards/kinesis/nguyenvietyen/README.md create mode 100644 keyboards/kinesis/nguyenvietyen/readme.md delete mode 100644 keyboards/kingly_keys/soap/README.md create mode 100644 keyboards/kingly_keys/soap/readme.md delete mode 100644 keyboards/kona_classic/README.md create mode 100644 keyboards/kona_classic/readme.md delete mode 100644 keyboards/lets_split_eh/README.md create mode 100644 keyboards/lets_split_eh/readme.md delete mode 100644 keyboards/mechmini/v1/README.md create mode 100644 keyboards/mechmini/v1/readme.md delete mode 100644 keyboards/mechmini/v2/README.md create mode 100644 keyboards/mechmini/v2/readme.md delete mode 100644 keyboards/mschwingen/modelm/README.md create mode 100644 keyboards/mschwingen/modelm/readme.md delete mode 100644 keyboards/noxary/README.md create mode 100644 keyboards/noxary/readme.md delete mode 100644 keyboards/nullbitsco/nibble/README.md create mode 100644 keyboards/nullbitsco/nibble/readme.md delete mode 100644 keyboards/percent/skog/README.md create mode 100644 keyboards/percent/skog/readme.md delete mode 100644 keyboards/switchplate/README.md create mode 100644 keyboards/switchplate/readme.md delete mode 100644 keyboards/terrazzo/README.md create mode 100644 keyboards/terrazzo/readme.md delete mode 100644 keyboards/thevankeyboards/bananasplit/README.md create mode 100644 keyboards/thevankeyboards/bananasplit/readme.md delete mode 100644 keyboards/tkc/m0lly/README.md create mode 100644 keyboards/tkc/m0lly/readme.md delete mode 100644 keyboards/tkc/osav2/README.md create mode 100644 keyboards/tkc/osav2/readme.md delete mode 100644 keyboards/tkc/tkc1800/README.md create mode 100644 keyboards/tkc/tkc1800/readme.md delete mode 100644 keyboards/wheatfield/split75/README.md create mode 100644 keyboards/wheatfield/split75/readme.md delete mode 100644 keyboards/winkeyless/bface/README.md create mode 100644 keyboards/winkeyless/bface/readme.md delete mode 100644 keyboards/xiaomi/mk02/README.md create mode 100644 keyboards/xiaomi/mk02/readme.md delete mode 100644 keyboards/ymd75/README.md create mode 100644 keyboards/ymd75/readme.md delete mode 100644 keyboards/ymdk/bface/README.md create mode 100644 keyboards/ymdk/bface/readme.md delete mode 100644 keyboards/ymdk/ymd09/README.md create mode 100644 keyboards/ymdk/ymd09/readme.md diff --git a/keyboards/4pplet/aekiso60/README.md b/keyboards/4pplet/aekiso60/README.md deleted file mode 100644 index 42c3d3421d..0000000000 --- a/keyboards/4pplet/aekiso60/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# AEKISO60 - -A 60% PCB enabling use of ISO AEK keycaps and ALPS switches - -More info: https://geekhack.org/index.php?topic=103627.0 - -* Keyboard Maintainer: [4pplet](https://github.com/4pplet) -* Hardware Supported: AEKISO60 Rev A - -Make example for this keyboard (after setting up your build environment): - - make 4pplet/aekiso60/rev_a:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). \ No newline at end of file diff --git a/keyboards/4pplet/aekiso60/readme.md b/keyboards/4pplet/aekiso60/readme.md new file mode 100644 index 0000000000..42c3d3421d --- /dev/null +++ b/keyboards/4pplet/aekiso60/readme.md @@ -0,0 +1,14 @@ +# AEKISO60 + +A 60% PCB enabling use of ISO AEK keycaps and ALPS switches + +More info: https://geekhack.org/index.php?topic=103627.0 + +* Keyboard Maintainer: [4pplet](https://github.com/4pplet) +* Hardware Supported: AEKISO60 Rev A + +Make example for this keyboard (after setting up your build environment): + + make 4pplet/aekiso60/rev_a:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). \ No newline at end of file diff --git a/keyboards/4pplet/steezy60/README.md b/keyboards/4pplet/steezy60/README.md deleted file mode 100644 index 34245b84ef..0000000000 --- a/keyboards/4pplet/steezy60/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# Steezy60 - -A 60% PCB with a ton of layout options for SMK and Alps switches - -More info: https://geekhack.org/index.php?topic=103531.0 - -* Keyboard Maintainer: [4pplet](https://github.com/4pplet) -* Hardware Supported: Steezy60 Rev A - -Make example for this keyboard (after setting up your build environment): - - make 4pplet/steezy60/rev_a:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). \ No newline at end of file diff --git a/keyboards/4pplet/steezy60/readme.md b/keyboards/4pplet/steezy60/readme.md new file mode 100644 index 0000000000..34245b84ef --- /dev/null +++ b/keyboards/4pplet/steezy60/readme.md @@ -0,0 +1,14 @@ +# Steezy60 + +A 60% PCB with a ton of layout options for SMK and Alps switches + +More info: https://geekhack.org/index.php?topic=103531.0 + +* Keyboard Maintainer: [4pplet](https://github.com/4pplet) +* Hardware Supported: Steezy60 Rev A + +Make example for this keyboard (after setting up your build environment): + + make 4pplet/steezy60/rev_a:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). \ No newline at end of file diff --git a/keyboards/4pplet/waffling60/README.md b/keyboards/4pplet/waffling60/README.md deleted file mode 100644 index a6b56a69ea..0000000000 --- a/keyboards/4pplet/waffling60/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# waffling60 - -A 60% PCB for MX switches, one hot swap and one solder-pcb version with decent layout support. - -More info: https://geekhack.org/index.php?topic=103531.0 - -* Keyboard Maintainer: [4pplet](https://github.com/4pplet) -* Hardware Supported: [waffling60](https://github.com/4pplet/waffling60) - -Make example for this keyboard (after setting up your build environment): - - make 4pplet/steezy60/rev_a:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). \ No newline at end of file diff --git a/keyboards/4pplet/waffling60/readme.md b/keyboards/4pplet/waffling60/readme.md new file mode 100644 index 0000000000..a6b56a69ea --- /dev/null +++ b/keyboards/4pplet/waffling60/readme.md @@ -0,0 +1,14 @@ +# waffling60 + +A 60% PCB for MX switches, one hot swap and one solder-pcb version with decent layout support. + +More info: https://geekhack.org/index.php?topic=103531.0 + +* Keyboard Maintainer: [4pplet](https://github.com/4pplet) +* Hardware Supported: [waffling60](https://github.com/4pplet/waffling60) + +Make example for this keyboard (after setting up your build environment): + + make 4pplet/steezy60/rev_a:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). \ No newline at end of file diff --git a/keyboards/acheron/shark/README.md b/keyboards/acheron/shark/README.md deleted file mode 100644 index 962a73c6d1..0000000000 --- a/keyboards/acheron/shark/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Acheron Aχξρων 40-SM-O-MX-TH-WI (Codename "SharkPCB") QMK firmware - -

- -

- -This is the QMK firmware repository for the Shark, updated until [revision Alpha](https://github.com/Gondolindrim/SharkPCB/releases/tag/Alpha). - -The SharkPCB is an Open-Hardware guidelines compliant PCB which files can be found at [this link](https://github.com/Gondolindrim/SharkPCB). Its designer and maintainer is [Gondolindrim](https://github.com/Gondolindrim). - -See the [AcheronDocs](https://gondolindrim.github.io/AcheronDocs/shark/intro.html) page for the SharkPCB full documentation. - -Make example for this keyboard (after setting up your build environment): - - make acheron/shark:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/acheron/shark/readme.md b/keyboards/acheron/shark/readme.md new file mode 100644 index 0000000000..962a73c6d1 --- /dev/null +++ b/keyboards/acheron/shark/readme.md @@ -0,0 +1,17 @@ +# Acheron Aχξρων 40-SM-O-MX-TH-WI (Codename "SharkPCB") QMK firmware + +

+ +

+ +This is the QMK firmware repository for the Shark, updated until [revision Alpha](https://github.com/Gondolindrim/SharkPCB/releases/tag/Alpha). + +The SharkPCB is an Open-Hardware guidelines compliant PCB which files can be found at [this link](https://github.com/Gondolindrim/SharkPCB). Its designer and maintainer is [Gondolindrim](https://github.com/Gondolindrim). + +See the [AcheronDocs](https://gondolindrim.github.io/AcheronDocs/shark/intro.html) page for the SharkPCB full documentation. + +Make example for this keyboard (after setting up your build environment): + + make acheron/shark:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/ai03/README.md b/keyboards/ai03/README.md deleted file mode 100644 index 90bd219289..0000000000 --- a/keyboards/ai03/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# ai03 -QMK folders for PCB commissions. - -Website: [ai03 Keyboard Designs](https://kb.ai03.me/) \ No newline at end of file diff --git a/keyboards/ai03/readme.md b/keyboards/ai03/readme.md new file mode 100644 index 0000000000..90bd219289 --- /dev/null +++ b/keyboards/ai03/readme.md @@ -0,0 +1,4 @@ +# ai03 +QMK folders for PCB commissions. + +Website: [ai03 Keyboard Designs](https://kb.ai03.me/) \ No newline at end of file diff --git a/keyboards/aplx6/README.md b/keyboards/aplx6/README.md deleted file mode 100644 index 55e73ea2da..0000000000 --- a/keyboards/aplx6/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# Aplx6 - -![Front](https://i.imgur.com/flhSvAG.png) -![Back](https://i.imgur.com/PXqNmUh.png) - -A stylish (2x3) 6-key MediaPad for your music and browser shortcuts. Designed to be assembled as a sandwich with a blank PCB, using M2.5 screws and spacers, your choice of MX- or Alps-compatible switches, and 1N4148 diodes. - - -## RGB Underglow (WS2812) - -Just wire them to any of the unused ProMicro pins. Don't forget to edit-uncomment the `config.h` and the `rules.mk` for RGB underglow support, or even add your own functions and modes. Used pins can be found in `config.h` or in the [KiCad Schematic](https://github.com/Aplyard/Aplx6/blob/master/kiCad/xd6.sch). All ProMicro pins can be found [here](https://golem.hu/article/pro-micro-pinout/) along with the +2 pins mod. - -* Keyboard Maintainer: [Aplyard](https://github.com/Aplyard) -* Hardware Supported: Aplx6 PCB, Pro Micro (ATmega32U4) -* Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx6) - -Make example for this keyboard (after setting up your build environment): - - make aplx6:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). - ---- -****Designed in**:** -[KiCad](https://github.com/KiCad) - -**Components Footprints & Libraries :** -[keebs.pretty](https://github.com/egladman/keebs.pretty) -[keyboard_parts.pretty -](https://github.com/tmk/keyboard_parts.pretty) -[ProMicro KiCad](https://github.com/Biacco42/ProMicroKiCad) - -**Usefull Links:** -[Qmk Online Configurator](https://config.qmk.fm/#) - -**Alternatives of qmk that worked for me:** -[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/) -[Keyboard Plate & Case Builder](http://builder.swillkb.com/) -[Firmware Builder](https://kbfirmware.com/) - ---- diff --git a/keyboards/aplx6/readme.md b/keyboards/aplx6/readme.md new file mode 100644 index 0000000000..55e73ea2da --- /dev/null +++ b/keyboards/aplx6/readme.md @@ -0,0 +1,41 @@ +# Aplx6 + +![Front](https://i.imgur.com/flhSvAG.png) +![Back](https://i.imgur.com/PXqNmUh.png) + +A stylish (2x3) 6-key MediaPad for your music and browser shortcuts. Designed to be assembled as a sandwich with a blank PCB, using M2.5 screws and spacers, your choice of MX- or Alps-compatible switches, and 1N4148 diodes. + + +## RGB Underglow (WS2812) + +Just wire them to any of the unused ProMicro pins. Don't forget to edit-uncomment the `config.h` and the `rules.mk` for RGB underglow support, or even add your own functions and modes. Used pins can be found in `config.h` or in the [KiCad Schematic](https://github.com/Aplyard/Aplx6/blob/master/kiCad/xd6.sch). All ProMicro pins can be found [here](https://golem.hu/article/pro-micro-pinout/) along with the +2 pins mod. + +* Keyboard Maintainer: [Aplyard](https://github.com/Aplyard) +* Hardware Supported: Aplx6 PCB, Pro Micro (ATmega32U4) +* Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx6) + +Make example for this keyboard (after setting up your build environment): + + make aplx6:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +--- +****Designed in**:** +[KiCad](https://github.com/KiCad) + +**Components Footprints & Libraries :** +[keebs.pretty](https://github.com/egladman/keebs.pretty) +[keyboard_parts.pretty +](https://github.com/tmk/keyboard_parts.pretty) +[ProMicro KiCad](https://github.com/Biacco42/ProMicroKiCad) + +**Usefull Links:** +[Qmk Online Configurator](https://config.qmk.fm/#) + +**Alternatives of qmk that worked for me:** +[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/) +[Keyboard Plate & Case Builder](http://builder.swillkb.com/) +[Firmware Builder](https://kbfirmware.com/) + +--- diff --git a/keyboards/ashpil/modelm_usbc/README.md b/keyboards/ashpil/modelm_usbc/README.md deleted file mode 100644 index 261d97ab49..0000000000 --- a/keyboards/ashpil/modelm_usbc/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# USB C Model M - -![modelm_usbc](https://raw.githubusercontent.com/ashpil/Model-M-Type-C-Controller/master/images/render.png) - -This is a configuration of QMK intended to be used with the [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller "USB C Model M alt controller"). Many thanks to iw0rm3r for working on a similar project and providing the foundation for this! - -* Keyboard Maintainer: [ashpil](https://github.com/ashpil) -* Hardware Supported: [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller) - -Make example for this keyboard (after setting up your build environment): - - make ashpil/modelm_usbc:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/ashpil/modelm_usbc/readme.md b/keyboards/ashpil/modelm_usbc/readme.md new file mode 100644 index 0000000000..261d97ab49 --- /dev/null +++ b/keyboards/ashpil/modelm_usbc/readme.md @@ -0,0 +1,14 @@ +# USB C Model M + +![modelm_usbc](https://raw.githubusercontent.com/ashpil/Model-M-Type-C-Controller/master/images/render.png) + +This is a configuration of QMK intended to be used with the [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller "USB C Model M alt controller"). Many thanks to iw0rm3r for working on a similar project and providing the foundation for this! + +* Keyboard Maintainer: [ashpil](https://github.com/ashpil) +* Hardware Supported: [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller) + +Make example for this keyboard (after setting up your build environment): + + make ashpil/modelm_usbc:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/bemeier/bmek/README.md b/keyboards/bemeier/bmek/README.md deleted file mode 100755 index 3437a5afdd..0000000000 --- a/keyboards/bemeier/bmek/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# BMEK - -![BMEK](https://i.imgur.com/p1KFi6ql.jpg) - -BMEK combines the best of HHKB & Alice-likes. All PCB and case design files are open source. - -* Keyboard Maintainer: [Bemeier](https://github.com/Bemeier) -* Hardware Supported: BMEK PCB rev1, rev2, rev3 -* Hardware Availability: Case & PCB files: [github.com/bemeier/bmek](https://github.com/bemeier/bmek) - -Make example for this keyboard, for an hhkb-like layout and keymap (after setting up your build environment): - - make bemeier/bmek/rev3:default - -Make the VIA compatible firmware: - - make bemeier/bmek/rev3:via - -The ```rev3```, denotes the version of the PCB. -Check on the PCB to find out which version you have, and set it to rev1, rev2 or rev3 accordingly (the BMEK group buy PCBs are all rev3). - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). - -# Layouts - -Starting with rev3 (the version of the PCB to be shipped in the GB), the following layout options are supported: - -![layouts](https://i.imgur.com/XuFxwthl.png) - -Note that the keymap shown above may not accurately reflect the default keymap of the firmware (see the keymaps folder). diff --git a/keyboards/bemeier/bmek/readme.md b/keyboards/bemeier/bmek/readme.md new file mode 100755 index 0000000000..3437a5afdd --- /dev/null +++ b/keyboards/bemeier/bmek/readme.md @@ -0,0 +1,30 @@ +# BMEK + +![BMEK](https://i.imgur.com/p1KFi6ql.jpg) + +BMEK combines the best of HHKB & Alice-likes. All PCB and case design files are open source. + +* Keyboard Maintainer: [Bemeier](https://github.com/Bemeier) +* Hardware Supported: BMEK PCB rev1, rev2, rev3 +* Hardware Availability: Case & PCB files: [github.com/bemeier/bmek](https://github.com/bemeier/bmek) + +Make example for this keyboard, for an hhkb-like layout and keymap (after setting up your build environment): + + make bemeier/bmek/rev3:default + +Make the VIA compatible firmware: + + make bemeier/bmek/rev3:via + +The ```rev3```, denotes the version of the PCB. +Check on the PCB to find out which version you have, and set it to rev1, rev2 or rev3 accordingly (the BMEK group buy PCBs are all rev3). + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +# Layouts + +Starting with rev3 (the version of the PCB to be shipped in the GB), the following layout options are supported: + +![layouts](https://i.imgur.com/XuFxwthl.png) + +Note that the keymap shown above may not accurately reflect the default keymap of the firmware (see the keymaps folder). diff --git a/keyboards/catch22/README.md b/keyboards/catch22/README.md deleted file mode 100644 index 8d4a22398f..0000000000 --- a/keyboards/catch22/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Catch 22 Budget Hotswap Macropad - -GB by /u/rockydbull run in July 2018, PCB designed with help from /u/Kilgarah. - -Designed to be a budget project board to enjoy hotswapping/switch testing/macro making fun. The board is controlled by a pro micro clone made famous by other projects like the lets split, iris, and nyquist and allows for full QMK implementation. Each Catch22 kit will contain: - - * 2 pcbs (one to solder to and one to be a base)(green color) - * 1 pcb material switch plate( green color) with cut out for pcb mount cherry stabilizers - * 40 throughhole diodes (22 for the pcb and the remaining as extras in case you lose one and to use to make the pro micro removeable without desoldering) - * 22 Kailh hotswap sockets - * 1 smd reset button - * 1 dip socket to mount between the pcb and pro micro if you choose to make it removeable without desoldering - * 5 (12mm) m2 standoffs - * 10 m2 screws - * Genuine Cherry pcb mount 2u stabilizer - * 4 rubber bumpons - * Pro Micro is included in kit diff --git a/keyboards/catch22/readme.md b/keyboards/catch22/readme.md new file mode 100644 index 0000000000..8d4a22398f --- /dev/null +++ b/keyboards/catch22/readme.md @@ -0,0 +1,17 @@ +# Catch 22 Budget Hotswap Macropad + +GB by /u/rockydbull run in July 2018, PCB designed with help from /u/Kilgarah. + +Designed to be a budget project board to enjoy hotswapping/switch testing/macro making fun. The board is controlled by a pro micro clone made famous by other projects like the lets split, iris, and nyquist and allows for full QMK implementation. Each Catch22 kit will contain: + + * 2 pcbs (one to solder to and one to be a base)(green color) + * 1 pcb material switch plate( green color) with cut out for pcb mount cherry stabilizers + * 40 throughhole diodes (22 for the pcb and the remaining as extras in case you lose one and to use to make the pro micro removeable without desoldering) + * 22 Kailh hotswap sockets + * 1 smd reset button + * 1 dip socket to mount between the pcb and pro micro if you choose to make it removeable without desoldering + * 5 (12mm) m2 standoffs + * 10 m2 screws + * Genuine Cherry pcb mount 2u stabilizer + * 4 rubber bumpons + * Pro Micro is included in kit diff --git a/keyboards/chili/README.md b/keyboards/chili/README.md deleted file mode 100644 index a383f98fb0..0000000000 --- a/keyboards/chili/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# YDKB Chili - -[Chili PCB](https://i.imgur.com/fKi896a.jpg) - -The YDKB Chili is a Cherry G80-3000 replacement PCB utilizing the ATmega32U4 microcontroller. - -* Keyboard Maintainer: QMK community -* Hardware Supported: YDKB Chili -* Hardware Availability: [TaoBao](https://item.taobao.com/item.htm?id=565823984744) - -Make example for this keyboard (after setting up your build environment): - - make chili:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/chili/readme.md b/keyboards/chili/readme.md new file mode 100644 index 0000000000..a383f98fb0 --- /dev/null +++ b/keyboards/chili/readme.md @@ -0,0 +1,15 @@ +# YDKB Chili + +[Chili PCB](https://i.imgur.com/fKi896a.jpg) + +The YDKB Chili is a Cherry G80-3000 replacement PCB utilizing the ATmega32U4 microcontroller. + +* Keyboard Maintainer: QMK community +* Hardware Supported: YDKB Chili +* Hardware Availability: [TaoBao](https://item.taobao.com/item.htm?id=565823984744) + +Make example for this keyboard (after setting up your build environment): + + make chili:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/converter/adb_usb/README.md b/keyboards/converter/adb_usb/README.md deleted file mode 100644 index 8de9b9ad46..0000000000 --- a/keyboards/converter/adb_usb/README.md +++ /dev/null @@ -1,84 +0,0 @@ -ADB-to-USB Keyboard Converter -============================= -This firmware converts Apple Desktop Bus (ADB) keyboard protocol to USB so that you can use an ADB keyboard on a modern computer. It works on the PJRC Teensy 2.0 and other USB AVR MCUs (ATMega32U4, AT90USB64/128, etc) and needs at least 10KB of flash memory. - - -This is a port of the TMK ADB-to-USB converter to QMK. For information on QMK, please consult the following: -https://github.com/qmk/qmk_firmware -https://docs.qmk.fm - - -Wiring ------- -Connect the VCC, GND, and DATA lines of the ADB keyboard to the controller (Teensy 2.0 or similar). By default the DATA line uses port PD0. The Power SW line is unused by the converter. - -ADB female socket from the front: - - ,--_--. - / o4 3o \ 1: DATA - | o2 1o | 2: Power SW - - === - 3: VCC - `-___-' 4: GND - -This converter uses AVR's internal pull-up, but it seems to be too weak, in particular when you want to use a long or coiled cable. Using an external pull-up resistor (1K-10K Ohm) between the DATA and VCC lines is strongly recommended. - -Pull-up resistor: - - Keyboard Converter - ,------. - 5V------+------|VCC | - | | | - [R] | | - | | | - Signal--+------|PD0 | - | | - GND------------|GND | - `------' - R: 1K Ohm resistor - - -Define following macros for ADB connection in config.h if you use other than port PD0. - - ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT - - -Building the Firmware ------------------------------------------- -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). - - -Keymap ------- -To build the default keymap run this command: - - $ make converter/adb_usb:default - -You may add your own keymap to the converter/adb_usb/keymaps directory, as you would with any other QMK-powered keyboard. - -To build your custom keymap, change the build command to: - - $ make converter/adb_usb:my_keymap - -Where 'my_keymap' is the name of your custom keymap directory. - - -Locking Caps Lock ----------------- -Many old ADB keyboards use a locking switch for the caps lock key. This converter supports the locking caps lock key by default. - - -Notes ------ -Non-extended ADB keyboards make no distinction between the left and right modifiers, -i.e. the keycode for the left modifier will be sent even if the right modifier - -The Apple Extended Keyboard and Apple Extended Keyboard II can differentiate between the left and right modifiers except for the GUI key (Windows/Command). - -Most ADB keyboards have no diodes in its matrix so they are not NKRO, -though the ADB protocol itself supports it. See protocol/adb.c for more info. - - -QMK Port Changelog ---------- -- 2018/09/16 - Initial release. -- 2018/12/23 - Fixed lock LED support. diff --git a/keyboards/converter/adb_usb/readme.md b/keyboards/converter/adb_usb/readme.md new file mode 100644 index 0000000000..8de9b9ad46 --- /dev/null +++ b/keyboards/converter/adb_usb/readme.md @@ -0,0 +1,84 @@ +ADB-to-USB Keyboard Converter +============================= +This firmware converts Apple Desktop Bus (ADB) keyboard protocol to USB so that you can use an ADB keyboard on a modern computer. It works on the PJRC Teensy 2.0 and other USB AVR MCUs (ATMega32U4, AT90USB64/128, etc) and needs at least 10KB of flash memory. + + +This is a port of the TMK ADB-to-USB converter to QMK. For information on QMK, please consult the following: +https://github.com/qmk/qmk_firmware +https://docs.qmk.fm + + +Wiring +------ +Connect the VCC, GND, and DATA lines of the ADB keyboard to the controller (Teensy 2.0 or similar). By default the DATA line uses port PD0. The Power SW line is unused by the converter. + +ADB female socket from the front: + + ,--_--. + / o4 3o \ 1: DATA + | o2 1o | 2: Power SW + - === - 3: VCC + `-___-' 4: GND + +This converter uses AVR's internal pull-up, but it seems to be too weak, in particular when you want to use a long or coiled cable. Using an external pull-up resistor (1K-10K Ohm) between the DATA and VCC lines is strongly recommended. + +Pull-up resistor: + + Keyboard Converter + ,------. + 5V------+------|VCC | + | | | + [R] | | + | | | + Signal--+------|PD0 | + | | + GND------------|GND | + `------' + R: 1K Ohm resistor + + +Define following macros for ADB connection in config.h if you use other than port PD0. + + ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT + + +Building the Firmware +------------------------------------------ +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + + +Keymap +------ +To build the default keymap run this command: + + $ make converter/adb_usb:default + +You may add your own keymap to the converter/adb_usb/keymaps directory, as you would with any other QMK-powered keyboard. + +To build your custom keymap, change the build command to: + + $ make converter/adb_usb:my_keymap + +Where 'my_keymap' is the name of your custom keymap directory. + + +Locking Caps Lock +---------------- +Many old ADB keyboards use a locking switch for the caps lock key. This converter supports the locking caps lock key by default. + + +Notes +----- +Non-extended ADB keyboards make no distinction between the left and right modifiers, +i.e. the keycode for the left modifier will be sent even if the right modifier + +The Apple Extended Keyboard and Apple Extended Keyboard II can differentiate between the left and right modifiers except for the GUI key (Windows/Command). + +Most ADB keyboards have no diodes in its matrix so they are not NKRO, +though the ADB protocol itself supports it. See protocol/adb.c for more info. + + +QMK Port Changelog +--------- +- 2018/09/16 - Initial release. +- 2018/12/23 - Fixed lock LED support. diff --git a/keyboards/converter/m0110_usb/README.md b/keyboards/converter/m0110_usb/README.md deleted file mode 100644 index 2e8a2eaef1..0000000000 --- a/keyboards/converter/m0110_usb/README.md +++ /dev/null @@ -1,51 +0,0 @@ -# M0110(A) keyboard converter - -This is a port of the original M0110 converter from TMK to QMK. The original converter was designed to work with **ATmega32U2** and **ATmega32U4** based microcontrollers to convert Apple M0110/M0110A keyboards and M0120 numpads to USB. This port has been tested to be compatible with the [**Adafruit Feather 32U4 BLE**](https://learn.adafruit.com/adafruit-feather-32u4-bluefruit-le). - - -## Enabling Bluetooth for the Adafruit Feather 32U4 BLE - -Simply add `BLUETOOTH = AdafruitBLE` to your `rules.mk` file. This enables code specifically for the Adafruit Feather 32U4 BLE. If enabled, the device will use the `PRODUCT` and `DESCRIPTION` values from `config.h` for the device name displayed by the Feather on host devices. You can simply change these values to change the device name. - - -## Pins - -This port utilizes the same pins that the TMK converter used. `PD1` is used for `CLOCK` and `PD0` is used for the `DATA` from the keyboard. These pins can be changed in `config.h`. - - -## Other important hardware notes from the original TMK converter Readme: ->### Hardware ->-------- ->You can buy preassembled [TMK converter] or make yourown with AVR dev board like PJRC [Teensy]. -> ->Port of the MCU `PD1` is assigned to `CLOCK` line and `PD0` to `DATA` by default, you can change pin configuration with editing `config.h`. -> ->[![M0110 Converter](http://i.imgur.com/yEp2eRim.jpg)](http://i.imgur.com/yEp2eRi.jpg) -> ->#### 4P4C phone handset cable ->Note that original cable used with Mac is **straight** while phone handset cable is **crossover**. -> -> -> ->[Teensy]: http://www.pjrc.com/teensy/ ->[TMK converter]: https://geekhack.org/index.php?topic=72052.0 -> -> ->#### Socket Pinout ->- -> ->![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png) -> -> ->#### Pull-up Resistor ->You may need pull-up resistors on signal lines(`CLOCK`, `DATA`) in particular when you have long or coiled cable. **1k-10k Ohm** will be OK >for this purpose. In that case the converter may not read signal from keyboard correctly without pull-up resistors. -> - -[**View the original TMK converter Readme**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb)\ -[**View the original TMK converter Repository**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb) - - -## QMK Port Changelog - -- 2018/08/01 - Original Release - diff --git a/keyboards/converter/m0110_usb/readme.md b/keyboards/converter/m0110_usb/readme.md new file mode 100644 index 0000000000..2e8a2eaef1 --- /dev/null +++ b/keyboards/converter/m0110_usb/readme.md @@ -0,0 +1,51 @@ +# M0110(A) keyboard converter + +This is a port of the original M0110 converter from TMK to QMK. The original converter was designed to work with **ATmega32U2** and **ATmega32U4** based microcontrollers to convert Apple M0110/M0110A keyboards and M0120 numpads to USB. This port has been tested to be compatible with the [**Adafruit Feather 32U4 BLE**](https://learn.adafruit.com/adafruit-feather-32u4-bluefruit-le). + + +## Enabling Bluetooth for the Adafruit Feather 32U4 BLE + +Simply add `BLUETOOTH = AdafruitBLE` to your `rules.mk` file. This enables code specifically for the Adafruit Feather 32U4 BLE. If enabled, the device will use the `PRODUCT` and `DESCRIPTION` values from `config.h` for the device name displayed by the Feather on host devices. You can simply change these values to change the device name. + + +## Pins + +This port utilizes the same pins that the TMK converter used. `PD1` is used for `CLOCK` and `PD0` is used for the `DATA` from the keyboard. These pins can be changed in `config.h`. + + +## Other important hardware notes from the original TMK converter Readme: +>### Hardware +>-------- +>You can buy preassembled [TMK converter] or make yourown with AVR dev board like PJRC [Teensy]. +> +>Port of the MCU `PD1` is assigned to `CLOCK` line and `PD0` to `DATA` by default, you can change pin configuration with editing `config.h`. +> +>[![M0110 Converter](http://i.imgur.com/yEp2eRim.jpg)](http://i.imgur.com/yEp2eRi.jpg) +> +>#### 4P4C phone handset cable +>Note that original cable used with Mac is **straight** while phone handset cable is **crossover**. +> +> +> +>[Teensy]: http://www.pjrc.com/teensy/ +>[TMK converter]: https://geekhack.org/index.php?topic=72052.0 +> +> +>#### Socket Pinout +>- +> +>![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png) +> +> +>#### Pull-up Resistor +>You may need pull-up resistors on signal lines(`CLOCK`, `DATA`) in particular when you have long or coiled cable. **1k-10k Ohm** will be OK >for this purpose. In that case the converter may not read signal from keyboard correctly without pull-up resistors. +> + +[**View the original TMK converter Readme**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb)\ +[**View the original TMK converter Repository**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb) + + +## QMK Port Changelog + +- 2018/08/01 - Original Release + diff --git a/keyboards/converter/usb_usb/README.md b/keyboards/converter/usb_usb/README.md deleted file mode 100644 index 594a9be877..0000000000 --- a/keyboards/converter/usb_usb/README.md +++ /dev/null @@ -1,69 +0,0 @@ -USB to USB keyboard protocol converter -====================================== -A small device to connect between your USB keyboard and your PC that makes (almost) every keyboard fully programmable. -Original code from the [TMK firmware](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb). Ported to QMK by [Balz Guenat](https://github.com/BalzGuenat). - -Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat) -Hardware Supported: [Hasu's USB-USB converter](https://geekhack.org/index.php?topic=69169.0), [Pro Micro + USB Host Shield](https://geekhack.org/index.php?topic=80421.0), maybe more -Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built - -Make example for this keyboard (after setting up your build environment): - - make converter/usb_usb:default - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. - -Note that you have to choose the right hardware variant as your subproject, otherwise you will probably have issues. - -Troubleshooting & Known Issues ------------------------------- -If something doesn't work, it's probably because of the CPU clock. -Be sure to select the correct subproject (the middle part of the `make` argument) according to your hardware. -If you are sure you have this correct, try changeing the default in `usb_usb/rules.mk` or overriding the value in the `rules.mk` of your keymap. - -The Pro Micro variant uses a 3.3V Pro Micro and thus runs at 8MHz, hence the following line in `usb_usb/pro_micro/rules.mk`: -`F_CPU = 8000000` -The converter sold by Hasu runs at 16MHz and so the corresponding line in `usb_usb/hasu/rules.mk` is: -`F_CPU = 16000000` - -Getting the Hardware --------------------- -There are two options to get a converter: You can buy one from Hasu or build one yourself. - -### Buy a Converter -You can buy a fully assembled converter from me here: -https://geekhack.org/index.php?topic=69169.0 - -### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0 -Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron. -- http://arduino.cc/en/Main/ArduinoBoardLeonardo -- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ - -Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified. -- http://arduino.cc/en/Main/ArduinoUSBHostShield -- https://www.sparkfun.com/products/9947 - -Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing. -- [Build guide](https://geekhack.org/index.php?topic=80421.0) -- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ -- https://www.sparkfun.com/products/12587 -- https://www.pjrc.com/teensy/td_libs_USBHostShield.html - -Limitations ----------- -Only supports 'HID Boot protocol'. -Note that the converter can host only USB "boot protocol" keyboard(6KRO), not NKRO, it is possible to support NKRO keyboard but you will need to write HID report parser for that. Every NKRO keyboard can have different HID report and it is difficult to support all kind of NKRO keyboards in the market. - -Resources --------- -- [Hasu's main thread for the converter](https://geekhack.org/index.php?topic=69169.0) -- [Build guide for the Pro Micro variant](https://geekhack.org/index.php?topic=80421.0) -- [Original TMK version of the converter](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb) -- [USB Host Shield 2.0](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) -- [USB Host Shield 2.0 source](https://github.com/felis/USB_Host_Shield_2.0) -- [Arduino USB Host Shield (with bootst converter)](http://arduino.cc/en/Main/ArduinoUSBHostShield) -- [Arduino source](https://github.com/arduino/Arduino) -- [Initial release of TMK USB-USB converter](https://geekhack.org/index.php?topic=33057.msg653549#msg653549) -- [Teensy/Arduino + Host Shield](http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854) -- [Arduino-based hardware keyboard remapper - Colemak forum](http://forum.colemak.com/viewtopic.php?id=1561) -- [Teensy + Host Shield](http://www.pjrc.com/teensy/td_libs_USBHostShield.html) diff --git a/keyboards/converter/usb_usb/ble/README.md b/keyboards/converter/usb_usb/ble/README.md deleted file mode 100644 index 0ee7223fd4..0000000000 --- a/keyboards/converter/usb_usb/ble/README.md +++ /dev/null @@ -1,30 +0,0 @@ -QMK BLE Adapter -=============== -A small device that reads USB keyboard input and passes it on over Bluetooth LE HID. - -![Picture of Adapter](https://i.imgur.com/O3VwBBJ.png) - -Hardware --------- -The hardware is relatively easy to assemble. Just follow the schematic and don't forget to [cut the VBUS jumper](https://www.pjrc.com/teensy/td_libs_USBHostShield_4a.jpg). - -Schematic: -![Schematic](https://i.imgur.com/s1Ia9We.png) - -Part list: -* [Adafruit Feather 32u4 Bluefruit LE](https://www.adafruit.com/product/2829) -* [USB Host Mini](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) -* [Pololu 5V Step-Up Voltage Regulator U3V12F5](https://www.pololu.com/product/2115) -* [Lithium Ion Battery - 3.7v 2000mAh](https://www.adafruit.com/product/2011) -* Some sort of switch to be able to turn it off - -Building and Flashing ---------------------- - -``` -make converter-usb_usb-ble -``` - -``` -make converter-usb_usb-ble-avrdude -``` \ No newline at end of file diff --git a/keyboards/converter/usb_usb/ble/readme.md b/keyboards/converter/usb_usb/ble/readme.md new file mode 100644 index 0000000000..0ee7223fd4 --- /dev/null +++ b/keyboards/converter/usb_usb/ble/readme.md @@ -0,0 +1,30 @@ +QMK BLE Adapter +=============== +A small device that reads USB keyboard input and passes it on over Bluetooth LE HID. + +![Picture of Adapter](https://i.imgur.com/O3VwBBJ.png) + +Hardware +-------- +The hardware is relatively easy to assemble. Just follow the schematic and don't forget to [cut the VBUS jumper](https://www.pjrc.com/teensy/td_libs_USBHostShield_4a.jpg). + +Schematic: +![Schematic](https://i.imgur.com/s1Ia9We.png) + +Part list: +* [Adafruit Feather 32u4 Bluefruit LE](https://www.adafruit.com/product/2829) +* [USB Host Mini](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) +* [Pololu 5V Step-Up Voltage Regulator U3V12F5](https://www.pololu.com/product/2115) +* [Lithium Ion Battery - 3.7v 2000mAh](https://www.adafruit.com/product/2011) +* Some sort of switch to be able to turn it off + +Building and Flashing +--------------------- + +``` +make converter-usb_usb-ble +``` + +``` +make converter-usb_usb-ble-avrdude +``` \ No newline at end of file diff --git a/keyboards/converter/usb_usb/readme.md b/keyboards/converter/usb_usb/readme.md new file mode 100644 index 0000000000..594a9be877 --- /dev/null +++ b/keyboards/converter/usb_usb/readme.md @@ -0,0 +1,69 @@ +USB to USB keyboard protocol converter +====================================== +A small device to connect between your USB keyboard and your PC that makes (almost) every keyboard fully programmable. +Original code from the [TMK firmware](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb). Ported to QMK by [Balz Guenat](https://github.com/BalzGuenat). + +Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat) +Hardware Supported: [Hasu's USB-USB converter](https://geekhack.org/index.php?topic=69169.0), [Pro Micro + USB Host Shield](https://geekhack.org/index.php?topic=80421.0), maybe more +Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built + +Make example for this keyboard (after setting up your build environment): + + make converter/usb_usb:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. + +Note that you have to choose the right hardware variant as your subproject, otherwise you will probably have issues. + +Troubleshooting & Known Issues +------------------------------ +If something doesn't work, it's probably because of the CPU clock. +Be sure to select the correct subproject (the middle part of the `make` argument) according to your hardware. +If you are sure you have this correct, try changeing the default in `usb_usb/rules.mk` or overriding the value in the `rules.mk` of your keymap. + +The Pro Micro variant uses a 3.3V Pro Micro and thus runs at 8MHz, hence the following line in `usb_usb/pro_micro/rules.mk`: +`F_CPU = 8000000` +The converter sold by Hasu runs at 16MHz and so the corresponding line in `usb_usb/hasu/rules.mk` is: +`F_CPU = 16000000` + +Getting the Hardware +-------------------- +There are two options to get a converter: You can buy one from Hasu or build one yourself. + +### Buy a Converter +You can buy a fully assembled converter from me here: +https://geekhack.org/index.php?topic=69169.0 + +### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0 +Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron. +- http://arduino.cc/en/Main/ArduinoBoardLeonardo +- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ + +Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified. +- http://arduino.cc/en/Main/ArduinoUSBHostShield +- https://www.sparkfun.com/products/9947 + +Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing. +- [Build guide](https://geekhack.org/index.php?topic=80421.0) +- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ +- https://www.sparkfun.com/products/12587 +- https://www.pjrc.com/teensy/td_libs_USBHostShield.html + +Limitations +---------- +Only supports 'HID Boot protocol'. +Note that the converter can host only USB "boot protocol" keyboard(6KRO), not NKRO, it is possible to support NKRO keyboard but you will need to write HID report parser for that. Every NKRO keyboard can have different HID report and it is difficult to support all kind of NKRO keyboards in the market. + +Resources +-------- +- [Hasu's main thread for the converter](https://geekhack.org/index.php?topic=69169.0) +- [Build guide for the Pro Micro variant](https://geekhack.org/index.php?topic=80421.0) +- [Original TMK version of the converter](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb) +- [USB Host Shield 2.0](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) +- [USB Host Shield 2.0 source](https://github.com/felis/USB_Host_Shield_2.0) +- [Arduino USB Host Shield (with bootst converter)](http://arduino.cc/en/Main/ArduinoUSBHostShield) +- [Arduino source](https://github.com/arduino/Arduino) +- [Initial release of TMK USB-USB converter](https://geekhack.org/index.php?topic=33057.msg653549#msg653549) +- [Teensy/Arduino + Host Shield](http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854) +- [Arduino-based hardware keyboard remapper - Colemak forum](http://forum.colemak.com/viewtopic.php?id=1561) +- [Teensy + Host Shield](http://www.pjrc.com/teensy/td_libs_USBHostShield.html) diff --git a/keyboards/converter/xt_usb/README.md b/keyboards/converter/xt_usb/README.md deleted file mode 100644 index 40b265a189..0000000000 --- a/keyboards/converter/xt_usb/README.md +++ /dev/null @@ -1,17 +0,0 @@ -XT to USB keyboard converter -============================== -This is a port of TMK's converter/xt_usb to QMK. - -This firmware converts XT keyboard protocol to USB.(It supports Scan Code Set 1.) - - -Connect Wires -------------- -1. Connect **Vcc** and **GND**. -2. Connect **Clock** and **Data** line. **Clock** is on `PD1`, **Data** on `PD0` by default. And optionally you can use `PB7` for **Reset**.(Compatible to Soarer's converter) To change pin configuration edit `config.h`. -3. You need pull-up resistor. **1K-10K Ohm** will be OK. - - -XT keyboard protocol resource ------------------------------- -https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol diff --git a/keyboards/converter/xt_usb/readme.md b/keyboards/converter/xt_usb/readme.md new file mode 100644 index 0000000000..40b265a189 --- /dev/null +++ b/keyboards/converter/xt_usb/readme.md @@ -0,0 +1,17 @@ +XT to USB keyboard converter +============================== +This is a port of TMK's converter/xt_usb to QMK. + +This firmware converts XT keyboard protocol to USB.(It supports Scan Code Set 1.) + + +Connect Wires +------------- +1. Connect **Vcc** and **GND**. +2. Connect **Clock** and **Data** line. **Clock** is on `PD1`, **Data** on `PD0` by default. And optionally you can use `PB7` for **Reset**.(Compatible to Soarer's converter) To change pin configuration edit `config.h`. +3. You need pull-up resistor. **1K-10K Ohm** will be OK. + + +XT keyboard protocol resource +------------------------------ +https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol diff --git a/keyboards/db/db63/README.md b/keyboards/db/db63/README.md deleted file mode 100644 index e886bed0a1..0000000000 --- a/keyboards/db/db63/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# DB63 - -A 65% keyboard hotswap with RGB that runs ps2avrgb natively, with USB C, RGB underglow and backlight. - -* Keyboard Maintainer: QMK Community -* Hardware Supported: DB63 (ATmega32A) -* [Keyboard layout](http://www.keyboard-layout-editor.com/#/gists/dadea703fc8bfc87dc7c480de9f3ef38) - -Make example for this keyboard (after setting up your build environment): - - make db/db63:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make db/db63:default:flash - -**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Escape* while plugging in the keyboard. (*All backlight LEDs will flash which indicate the board is in bootloader mode.*) - -**Tips**: Another trick to enable the board in reset mode is using BootMapper Client->Options->Set Bootloader. (*This is only available for the first time, before flashing QMK Firmware.*) - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/db/db63/readme.md b/keyboards/db/db63/readme.md new file mode 100644 index 0000000000..e886bed0a1 --- /dev/null +++ b/keyboards/db/db63/readme.md @@ -0,0 +1,21 @@ +# DB63 + +A 65% keyboard hotswap with RGB that runs ps2avrgb natively, with USB C, RGB underglow and backlight. + +* Keyboard Maintainer: QMK Community +* Hardware Supported: DB63 (ATmega32A) +* [Keyboard layout](http://www.keyboard-layout-editor.com/#/gists/dadea703fc8bfc87dc7c480de9f3ef38) + +Make example for this keyboard (after setting up your build environment): + + make db/db63:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make db/db63:default:flash + +**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Escape* while plugging in the keyboard. (*All backlight LEDs will flash which indicate the board is in bootloader mode.*) + +**Tips**: Another trick to enable the board in reset mode is using BootMapper Client->Options->Set Bootloader. (*This is only available for the first time, before flashing QMK Firmware.*) + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/fc660c/README.md b/keyboards/fc660c/README.md deleted file mode 100644 index 638c559577..0000000000 --- a/keyboards/fc660c/README.md +++ /dev/null @@ -1,167 +0,0 @@ -FC660C Alt Controller -================= - -This file and the entire QMK port of this board are based on its TMK implementation: https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc980c - ------------- - -- Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat) -- Hardware Supported: Hasu's Alt Controller (see below) -- Hardware Availability: https://geekhack.org/index.php?topic=90317.0 - -Make example for this keyboard (after setting up your build environment): - - make fc660c:default - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. - -To flash the firmware, press the reset button on the controller and run: - - sudo make fc660c:default:dfu - --------- - -Thread on Geekhack: https://geekhack.org/index.php?topic=88439.0 - -Also: https://geekhack.org/index.php?topic=88720.0 - - -Actuation Point adjustment --------------------------- -You can adjust the actuation point of the keys by setting `ACTUATION_DEPTH_ADJUSTMENT` in `config.h`. -A value above 0 will result in a deeper, less sensitive actuation whereas a value above 1 will result in a more shallow, more sensitive actuation. -Be careful with this setting and use small values (+/-5). -See the `actuation-point-example` keymap of the `fc980c` keyboard for an example. -For more information, inspect the `fc660c_i2c` branch of TMK [here](https://github.com/tmk/tmk_keyboard/tree/fc660c_i2c). -Functionality for writing to the EEPROM has deliberately not been included to reduce the chance of people messing up their boards. - - -Pinouts -------- - - |Switch |Controller | - | board | board |Description |Schematic |ATmega32u4 - |--------|-----------|--------------------------------------|-----------|------------ - | 1 |20 | FG |FG |GND - | 2 |19 | GND |GND |GND - | 3 |18 | GND |GND |GND - | 4 |17 | 3.3V |V33 |3.3V/5V - | 5 |16 | 5V |Vcc |5V - | 6 |15 |*Z6-TP1684-4-HYS(o) |FBSTB |PC7 - | 7 |14 |*Z6-TP1684-2-KEY(i) |OUT |PC6 - | 8 |13 |*Z2-AD5258-5-SCL(I2C) |SCL |PD0(TWI) - | 9 |12 |*Z2-AD5258-4-SDA(I2C) |SDA |PD1(TWI) - |10 |11 |*Z4-LV4051A-6-~EN(Col 0-7) |INH_1 |PB4 - |11 |10 |*Z5-LV4051A-6-~EN(Col 8-F) |INH_2 |PB3 - |12 | 9 |+Z7-LV07A-5 (LV4051A-9-C) |SEL_C |PB2 - |13 | 8 |+Z7-LV07A-1 (LV4051A-10-B) |SEL_B |PB1 - |14 | 7 |+Z7-LV07A-3 (LV4051A-11-A) |SEL_A |PB0 - |15 | 6 |+Z3-LVC138A-3-C |COL4 |PD6 - |16 | 5 |+Z3-LVC138A-2-B |COL3 |PD5 - |17 | 4 |+Z3-LVC138A-1-A |COL2 |PD4 - |18 | 3 |+Z3-LVC138A-4-~G2A Z6-TP1684-5-~EN |COL1 |PD7 - |19 | 2 |+Z7-LV07A-11-~InsertLED |LED1 |PB5 - |20 | 1 |+Z7-LV07A-13-~CapsLED |LED2 |PB6 - -``` -* 5V intferface -+ 3.3V interface -``` - -- Connector on Switch board: https://i.imgur.com/Zi89xO5.jpg -- Connector on Controller board: https://i.imgur.com/9SZUzYo.jpg - - -Key Matrix ----------- -Row5-7 have no key, you can omit scaning on those lines. Topre original controller scans those rows for some reason. - - | |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |A |B |C |D |E |F | - |----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----| - | 0|Q |W |E |Tab |R |U |T |Y |O |P |[ |I |] | |\ |Del | - | 1|1 |2 |3 |Esc |4 |7 |5 |6 |9 |0 |- |8 |= | |BSpc|Ins | - | 2| |LWin|LAlt|LCtl| | | |Spc |RAlt| |RCtl| |Fn |Down|Left|Rght| - | 3| |Z |X |LSft|C |N |V |B |, |. |/ |M |RSft|Up | | | - | 4|A |S |D |Caps|F |J |G |H |L |; |' |K | | |Entr| | - | 5| | | | | | | | | | | | | | | | | - | 6| | | | | | | | | | | | | | | | | - | 7| | | | | | | | | | | | | | | | | - -Logic analyzer pics: -- http://i.imgur.com/9XoNTev.png -- https://i.imgur.com/5FCP1Ay.png - -This code emuluates what original cotnroller does for matrix scan. -- https://github.com/tmk/tmk_keyboard/blob/master/keyboard/fc660c/fc660c.c - - -### Row designation -LV138A(Z3) selects a row line and gives strobe by enabling with ~G2A(18). - - |Row |A/17|B/16|C/15| - |----|----|----|----| - |0 |0 |0 |0 | - |1 |1 |0 |0 | - |2 |0 |1 |0 | - |3 |1 |1 |0 | - |4 |0 |0 |1 | - |5 |1 |0 |1 | - |6 |0 |1 |1 | - |7 |1 |1 |1 | - - -### Column designation -LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches. - - |Col |A/14|B/13|C/12|Z4-EN/10|Z5-EN/11| - |----|----|----|----|--------|--------| - |0 |0 |0 |0 |0 |1 | - |1 |1 |0 |0 |0 |1 | - |2 |0 |1 |0 |0 |1 | - |3 |1 |1 |0 |0 |1 | - |4 |0 |0 |1 |0 |1 | - |5 |1 |0 |1 |0 |1 | - |6 |0 |1 |1 |0 |1 | - |7 |1 |1 |1 |0 |1 | - |8 |0 |0 |0 |1 |0 | - |9 |1 |0 |0 |1 |0 | - |A |0 |1 |0 |1 |0 | - |B |1 |1 |0 |1 |0 | - |C |0 |0 |1 |1 |0 | - |D |1 |0 |1 |1 |0 | - |E |0 |1 |1 |1 |0 | - |F |1 |1 |1 |1 |0 | - - -FCC documents -------------- -https://fccid.io/RPKFC660C - -- schematic: https://fccid.io/pdf.php?id=1888185 -- part list: https://fccid.io/pdf.php?id=1888184 - - -Datasheets ----------- -- Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf -- LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf -- LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf -- LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf -- AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf - - -3.3V power supply ------------------ -LV07A and LVC138A are 5V-tolerant and can be powered with 5V, the keyboard will work only with 5V power supply. It may not be completely safe to operate LV138A with 5V Vcc, its datasheet says: - -> Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability. - -Digipot AD5258 --------------- -Controller can operate AD5258 via I2C to change actuation point of keys. This may make keyboard unusable accidentally and it will be difficult to recovery in some situation. For safety firmware doesn't support it at this point, though. - -Lower value of RDAC register causes shallower actuation point. - -Resources ---------- -- Pics: https://imgur.com/a/UTR8Z diff --git a/keyboards/fc660c/readme.md b/keyboards/fc660c/readme.md new file mode 100644 index 0000000000..638c559577 --- /dev/null +++ b/keyboards/fc660c/readme.md @@ -0,0 +1,167 @@ +FC660C Alt Controller +================= + +This file and the entire QMK port of this board are based on its TMK implementation: https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc980c + +------------ + +- Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat) +- Hardware Supported: Hasu's Alt Controller (see below) +- Hardware Availability: https://geekhack.org/index.php?topic=90317.0 + +Make example for this keyboard (after setting up your build environment): + + make fc660c:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. + +To flash the firmware, press the reset button on the controller and run: + + sudo make fc660c:default:dfu + +-------- + +Thread on Geekhack: https://geekhack.org/index.php?topic=88439.0 + +Also: https://geekhack.org/index.php?topic=88720.0 + + +Actuation Point adjustment +-------------------------- +You can adjust the actuation point of the keys by setting `ACTUATION_DEPTH_ADJUSTMENT` in `config.h`. +A value above 0 will result in a deeper, less sensitive actuation whereas a value above 1 will result in a more shallow, more sensitive actuation. +Be careful with this setting and use small values (+/-5). +See the `actuation-point-example` keymap of the `fc980c` keyboard for an example. +For more information, inspect the `fc660c_i2c` branch of TMK [here](https://github.com/tmk/tmk_keyboard/tree/fc660c_i2c). +Functionality for writing to the EEPROM has deliberately not been included to reduce the chance of people messing up their boards. + + +Pinouts +------- + + |Switch |Controller | + | board | board |Description |Schematic |ATmega32u4 + |--------|-----------|--------------------------------------|-----------|------------ + | 1 |20 | FG |FG |GND + | 2 |19 | GND |GND |GND + | 3 |18 | GND |GND |GND + | 4 |17 | 3.3V |V33 |3.3V/5V + | 5 |16 | 5V |Vcc |5V + | 6 |15 |*Z6-TP1684-4-HYS(o) |FBSTB |PC7 + | 7 |14 |*Z6-TP1684-2-KEY(i) |OUT |PC6 + | 8 |13 |*Z2-AD5258-5-SCL(I2C) |SCL |PD0(TWI) + | 9 |12 |*Z2-AD5258-4-SDA(I2C) |SDA |PD1(TWI) + |10 |11 |*Z4-LV4051A-6-~EN(Col 0-7) |INH_1 |PB4 + |11 |10 |*Z5-LV4051A-6-~EN(Col 8-F) |INH_2 |PB3 + |12 | 9 |+Z7-LV07A-5 (LV4051A-9-C) |SEL_C |PB2 + |13 | 8 |+Z7-LV07A-1 (LV4051A-10-B) |SEL_B |PB1 + |14 | 7 |+Z7-LV07A-3 (LV4051A-11-A) |SEL_A |PB0 + |15 | 6 |+Z3-LVC138A-3-C |COL4 |PD6 + |16 | 5 |+Z3-LVC138A-2-B |COL3 |PD5 + |17 | 4 |+Z3-LVC138A-1-A |COL2 |PD4 + |18 | 3 |+Z3-LVC138A-4-~G2A Z6-TP1684-5-~EN |COL1 |PD7 + |19 | 2 |+Z7-LV07A-11-~InsertLED |LED1 |PB5 + |20 | 1 |+Z7-LV07A-13-~CapsLED |LED2 |PB6 + +``` +* 5V intferface ++ 3.3V interface +``` + +- Connector on Switch board: https://i.imgur.com/Zi89xO5.jpg +- Connector on Controller board: https://i.imgur.com/9SZUzYo.jpg + + +Key Matrix +---------- +Row5-7 have no key, you can omit scaning on those lines. Topre original controller scans those rows for some reason. + + | |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |A |B |C |D |E |F | + |----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----| + | 0|Q |W |E |Tab |R |U |T |Y |O |P |[ |I |] | |\ |Del | + | 1|1 |2 |3 |Esc |4 |7 |5 |6 |9 |0 |- |8 |= | |BSpc|Ins | + | 2| |LWin|LAlt|LCtl| | | |Spc |RAlt| |RCtl| |Fn |Down|Left|Rght| + | 3| |Z |X |LSft|C |N |V |B |, |. |/ |M |RSft|Up | | | + | 4|A |S |D |Caps|F |J |G |H |L |; |' |K | | |Entr| | + | 5| | | | | | | | | | | | | | | | | + | 6| | | | | | | | | | | | | | | | | + | 7| | | | | | | | | | | | | | | | | + +Logic analyzer pics: +- http://i.imgur.com/9XoNTev.png +- https://i.imgur.com/5FCP1Ay.png + +This code emuluates what original cotnroller does for matrix scan. +- https://github.com/tmk/tmk_keyboard/blob/master/keyboard/fc660c/fc660c.c + + +### Row designation +LV138A(Z3) selects a row line and gives strobe by enabling with ~G2A(18). + + |Row |A/17|B/16|C/15| + |----|----|----|----| + |0 |0 |0 |0 | + |1 |1 |0 |0 | + |2 |0 |1 |0 | + |3 |1 |1 |0 | + |4 |0 |0 |1 | + |5 |1 |0 |1 | + |6 |0 |1 |1 | + |7 |1 |1 |1 | + + +### Column designation +LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches. + + |Col |A/14|B/13|C/12|Z4-EN/10|Z5-EN/11| + |----|----|----|----|--------|--------| + |0 |0 |0 |0 |0 |1 | + |1 |1 |0 |0 |0 |1 | + |2 |0 |1 |0 |0 |1 | + |3 |1 |1 |0 |0 |1 | + |4 |0 |0 |1 |0 |1 | + |5 |1 |0 |1 |0 |1 | + |6 |0 |1 |1 |0 |1 | + |7 |1 |1 |1 |0 |1 | + |8 |0 |0 |0 |1 |0 | + |9 |1 |0 |0 |1 |0 | + |A |0 |1 |0 |1 |0 | + |B |1 |1 |0 |1 |0 | + |C |0 |0 |1 |1 |0 | + |D |1 |0 |1 |1 |0 | + |E |0 |1 |1 |1 |0 | + |F |1 |1 |1 |1 |0 | + + +FCC documents +------------- +https://fccid.io/RPKFC660C + +- schematic: https://fccid.io/pdf.php?id=1888185 +- part list: https://fccid.io/pdf.php?id=1888184 + + +Datasheets +---------- +- Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf +- LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf +- LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf +- LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf +- AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf + + +3.3V power supply +----------------- +LV07A and LVC138A are 5V-tolerant and can be powered with 5V, the keyboard will work only with 5V power supply. It may not be completely safe to operate LV138A with 5V Vcc, its datasheet says: + +> Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability. + +Digipot AD5258 +-------------- +Controller can operate AD5258 via I2C to change actuation point of keys. This may make keyboard unusable accidentally and it will be difficult to recovery in some situation. For safety firmware doesn't support it at this point, though. + +Lower value of RDAC register causes shallower actuation point. + +Resources +--------- +- Pics: https://imgur.com/a/UTR8Z diff --git a/keyboards/fc980c/README.md b/keyboards/fc980c/README.md deleted file mode 100644 index 61dcf6ee96..0000000000 --- a/keyboards/fc980c/README.md +++ /dev/null @@ -1,185 +0,0 @@ - - -FC980C Alt Controller -===================== - -This file and the entire QMK port of this board are based on its TMK implementation: https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc980c - ------------- - -- Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat) -- Hardware Supported: Hasu's Alt Controller (see below) -- Hardware Availability: https://geekhack.org/index.php?topic=90104.0 - -Make example for this keyboard (after setting up your build environment): - - make fc980c:default - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. - -To flash the firmware, press the reset button on the controller and run: - - sudo make fc980c:default:dfu - ------------ - -This controller replaces original controller of Leopold FC980C and makes the keyboard programmable. - -Discuss this here: https://geekhack.org/index.php?topic=90681.0 - -The keyboard is very similar electronically to its sibling model FC660C you can also refer this. - -FC660C Alt Controller: https://geekhack.org/index.php?topic=88439.0 - - -Actuation Point adjustment --------------------------- -You can adjust the actuation point of the keys by setting `ACTUATION_DEPTH_ADJUSTMENT` in `config.h`. -A value above 0 will result in a deeper, less sensitive actuation whereas a value above 1 will result in a more shallow, more sensitive actuation. -Be careful with this setting and use small values (+/-5). -See the `actuation-point-example` keymap for an example. -For more information, inspect the `fc660c_i2c` branch of TMK [here](https://github.com/tmk/tmk_keyboard/tree/fc660c_i2c). -Functionality for writing to the EEPROM has deliberately not been included to reduce the chance of people messing up their boards. - - -Hardware --------- -This project uses common and familiar ATmega32u4 but any microcontroller with 5V I/O will work. - -- Schematic of Alt controller: schematic.pdf - - -Pin configuration ------------------ -Connector bridging between switch board and controller is Hirose DF14A-20P-1.25H. - - |Switch |Controller | - | board | board |Description |Function |ATmega32u4 - |--------|-----------|--------------------------------------|-----------|------------ - | 1 |20 | FG |FG |GND - | 2 |19 | GND |GND |GND - | 3 |18 | GND |GND |GND - | 4 |17 | 3.3V |V33 |3.3V/5V - | 5 |16 | 5V |Vcc |5V - | 6 |15 |*Z6-TP1684-4-HYS(o) |KEY_HYS |PC7 - | 7 |14 |*Z6-TP1684-2-KEY(i) |KEY_STATE |PC6 - | 8 |13 |*Z7-AD5258-5-SCL(I2C) |I2C_SCL |PD0(TWI) - | 9 |12 |*Z7-AD5258-4-SDA(I2C) |I2C_SDA |PD1(TWI) - |10 |11 |*Z5/4-LV4051A-6-~EN(Lo:Z5 Hi:Z4) |COL_bit3 |PB3 - |11 |10 |+Z3-LV07A-5 (LV4051A-9-C) |COL_bit2 |PB2 - |12 | 9 |+Z3-LV07A-1 (LV4051A-10-B) |COL_bit1 |PB1 - |13 | 8 |+Z3-LV07A-3 (LV4051A-11-A) |COL_bit0 |PB0 - |14 | 7 |+Z1-LVC138A-3-C |ROW_bit2 |PD6 - |15 | 6 |+Z1-LVC138A-2-B |ROW_bit1 |PD5 - |16 | 5 |+Z1-LVC138A-1-A |ROW_bit0 |PD4 - |17 | 4 |+Z1-LVC138A-4-~G2A Z6-TP1684-5-~EN |KEY_ENABLE |PD7 - |18 | 3 |+Q4-NPN-B-NumLock_LED(Hi:On) |LED_NUML |PB4 - |19 | 2 |+Q3-NPN-B-CapsLock_LED(Hi:On) |LED_CAPS |PB5 - |20 | 1 |+Q2-NPN-B-ScrollLock_LED(Hi:On) |LED_SCRL |PB6 - -``` -* 5V intferface -+ 3.3V interface -``` - - -Switch matrix -------------- - - | |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |A |B |C |D |E |F | - |----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----| - | 0|Left|RCtl|RAlt| |Down|P. |Righ|P0 |X |LGui|` |V | |Esc |M |Spc | - | 1|Fn |. | | |P1 |PEnt|P2 |P3 |Z |LAlt|LCtl|C |K | |N |B | - | 2|' |/ |, | |P4 |P+ |P5 |P6 |D |A |LSft|F |J |F1 |H |G | - | 3|RSft|; |L |] |Up | | | |S |Q |Caps|R |I |F3 |U |T | - | 4| | | | | | | | | | | | | | | | | - | 5|= |- |0 |\ |NLck|BSpc|P/ |P* |3 |2 | |4 |9 |F2 |7 |6 | - | 6|[ |P |O |Ent |P7 |P- |P8 |P9 |W |1 |Tab |E |8 |F4 |Y |5 | - | 7|F11 |F10 |F9 |F12 |Del |PgDn|Ins |PgUp| | | | |F8 |F5 |F7 |F6 | - - -Row designation ---------------- -LV138A(Z1) selects one of 8 row lines and gives strobe by enabling with ~G2A(17). - - |ROW |bit0|bit1|bit2| - |----|----|----|----| - |0 |0 |0 |0 | - |1 |1 |0 |0 | - |2 |0 |1 |0 | - |3 |1 |1 |0 | - |4 |0 |0 |1 | - |5 |1 |0 |1 | - |6 |0 |1 |1 | - |7 |1 |1 |1 | - - -Column designation ------------------- -LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches. - - |COL |bit0|bit1|bit2|bit3| - |----|----|----|----|----| - |0 |0 |0 |0 |0 | - |1 |1 |0 |0 |0 | - |2 |0 |1 |0 |0 | - |3 |1 |1 |0 |0 | - |4 |0 |0 |1 |0 | - |5 |1 |0 |1 |0 | - |6 |0 |1 |1 |0 | - |7 |1 |1 |1 |0 | - |8 |0 |0 |0 |1 | - |9 |1 |0 |0 |1 | - |A |0 |1 |0 |1 | - |B |1 |1 |0 |1 | - |C |0 |0 |1 |1 | - |D |1 |0 |1 |1 | - |E |0 |1 |1 |1 | - |F |1 |1 |1 |1 | - - -Firmware --------- -Just `make` to build firmware. And consult with wiki for further information. - -- https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc660c -- https://github.com/tmk/tmk_keyboard/wiki - - -Datasheets ----------- -- Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf -- LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf -- LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf -- LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf -- AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf -- JST S5B-PH-SM4: http://www.jst-mfg.com/product/pdf/eng/ePH.pdf -- Hirose UX60SC-MB-5S8: https://www.hirose.com/product/en/products/UX/UX60SC-MB-5S8%2880%29/ -- Tr(E42) for LED?: http://www.bklighting.com/cimages/specs-758.pdf -- TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/goodjob/TY1252series.pdf - - -3.3V power supply ------------------ -LV07A and LVC138A are 5V-tolerant and can be powered with 5V, the keyboard will work only with 5V power supply. It may not be completely safe to operate LV138A with 5V Vcc, its datasheet says: - -> Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability. - - -Digipot AD5258 --------------- -Controller can operate AD5258 via I2C to change actuation point of keys. This may make keyboard unusable accidentally and it will be difficult to recovery in some situation. For safety firmware doesn't support it at this point, though. - -Lower value of RDAC register causes shallower actuation point. - - -USB connector board -------------------- -The keyboard has USB receptacle on small separate 1.0mm-thick PCB. USB receptacle is Hirose UX60SC-MB-5S8 while wire-to-PCB connector is TYU TU1252WNR-05S. - -http://i.imgur.com/Nucn6h9.jpg - - -Resources ---------- -- Pics: http://imgur.com/a/HhyIq diff --git a/keyboards/fc980c/readme.md b/keyboards/fc980c/readme.md new file mode 100644 index 0000000000..61dcf6ee96 --- /dev/null +++ b/keyboards/fc980c/readme.md @@ -0,0 +1,185 @@ + + +FC980C Alt Controller +===================== + +This file and the entire QMK port of this board are based on its TMK implementation: https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc980c + +------------ + +- Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat) +- Hardware Supported: Hasu's Alt Controller (see below) +- Hardware Availability: https://geekhack.org/index.php?topic=90104.0 + +Make example for this keyboard (after setting up your build environment): + + make fc980c:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. + +To flash the firmware, press the reset button on the controller and run: + + sudo make fc980c:default:dfu + +----------- + +This controller replaces original controller of Leopold FC980C and makes the keyboard programmable. + +Discuss this here: https://geekhack.org/index.php?topic=90681.0 + +The keyboard is very similar electronically to its sibling model FC660C you can also refer this. + +FC660C Alt Controller: https://geekhack.org/index.php?topic=88439.0 + + +Actuation Point adjustment +-------------------------- +You can adjust the actuation point of the keys by setting `ACTUATION_DEPTH_ADJUSTMENT` in `config.h`. +A value above 0 will result in a deeper, less sensitive actuation whereas a value above 1 will result in a more shallow, more sensitive actuation. +Be careful with this setting and use small values (+/-5). +See the `actuation-point-example` keymap for an example. +For more information, inspect the `fc660c_i2c` branch of TMK [here](https://github.com/tmk/tmk_keyboard/tree/fc660c_i2c). +Functionality for writing to the EEPROM has deliberately not been included to reduce the chance of people messing up their boards. + + +Hardware +-------- +This project uses common and familiar ATmega32u4 but any microcontroller with 5V I/O will work. + +- Schematic of Alt controller: schematic.pdf + + +Pin configuration +----------------- +Connector bridging between switch board and controller is Hirose DF14A-20P-1.25H. + + |Switch |Controller | + | board | board |Description |Function |ATmega32u4 + |--------|-----------|--------------------------------------|-----------|------------ + | 1 |20 | FG |FG |GND + | 2 |19 | GND |GND |GND + | 3 |18 | GND |GND |GND + | 4 |17 | 3.3V |V33 |3.3V/5V + | 5 |16 | 5V |Vcc |5V + | 6 |15 |*Z6-TP1684-4-HYS(o) |KEY_HYS |PC7 + | 7 |14 |*Z6-TP1684-2-KEY(i) |KEY_STATE |PC6 + | 8 |13 |*Z7-AD5258-5-SCL(I2C) |I2C_SCL |PD0(TWI) + | 9 |12 |*Z7-AD5258-4-SDA(I2C) |I2C_SDA |PD1(TWI) + |10 |11 |*Z5/4-LV4051A-6-~EN(Lo:Z5 Hi:Z4) |COL_bit3 |PB3 + |11 |10 |+Z3-LV07A-5 (LV4051A-9-C) |COL_bit2 |PB2 + |12 | 9 |+Z3-LV07A-1 (LV4051A-10-B) |COL_bit1 |PB1 + |13 | 8 |+Z3-LV07A-3 (LV4051A-11-A) |COL_bit0 |PB0 + |14 | 7 |+Z1-LVC138A-3-C |ROW_bit2 |PD6 + |15 | 6 |+Z1-LVC138A-2-B |ROW_bit1 |PD5 + |16 | 5 |+Z1-LVC138A-1-A |ROW_bit0 |PD4 + |17 | 4 |+Z1-LVC138A-4-~G2A Z6-TP1684-5-~EN |KEY_ENABLE |PD7 + |18 | 3 |+Q4-NPN-B-NumLock_LED(Hi:On) |LED_NUML |PB4 + |19 | 2 |+Q3-NPN-B-CapsLock_LED(Hi:On) |LED_CAPS |PB5 + |20 | 1 |+Q2-NPN-B-ScrollLock_LED(Hi:On) |LED_SCRL |PB6 + +``` +* 5V intferface ++ 3.3V interface +``` + + +Switch matrix +------------- + + | |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |A |B |C |D |E |F | + |----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----| + | 0|Left|RCtl|RAlt| |Down|P. |Righ|P0 |X |LGui|` |V | |Esc |M |Spc | + | 1|Fn |. | | |P1 |PEnt|P2 |P3 |Z |LAlt|LCtl|C |K | |N |B | + | 2|' |/ |, | |P4 |P+ |P5 |P6 |D |A |LSft|F |J |F1 |H |G | + | 3|RSft|; |L |] |Up | | | |S |Q |Caps|R |I |F3 |U |T | + | 4| | | | | | | | | | | | | | | | | + | 5|= |- |0 |\ |NLck|BSpc|P/ |P* |3 |2 | |4 |9 |F2 |7 |6 | + | 6|[ |P |O |Ent |P7 |P- |P8 |P9 |W |1 |Tab |E |8 |F4 |Y |5 | + | 7|F11 |F10 |F9 |F12 |Del |PgDn|Ins |PgUp| | | | |F8 |F5 |F7 |F6 | + + +Row designation +--------------- +LV138A(Z1) selects one of 8 row lines and gives strobe by enabling with ~G2A(17). + + |ROW |bit0|bit1|bit2| + |----|----|----|----| + |0 |0 |0 |0 | + |1 |1 |0 |0 | + |2 |0 |1 |0 | + |3 |1 |1 |0 | + |4 |0 |0 |1 | + |5 |1 |0 |1 | + |6 |0 |1 |1 | + |7 |1 |1 |1 | + + +Column designation +------------------ +LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches. + + |COL |bit0|bit1|bit2|bit3| + |----|----|----|----|----| + |0 |0 |0 |0 |0 | + |1 |1 |0 |0 |0 | + |2 |0 |1 |0 |0 | + |3 |1 |1 |0 |0 | + |4 |0 |0 |1 |0 | + |5 |1 |0 |1 |0 | + |6 |0 |1 |1 |0 | + |7 |1 |1 |1 |0 | + |8 |0 |0 |0 |1 | + |9 |1 |0 |0 |1 | + |A |0 |1 |0 |1 | + |B |1 |1 |0 |1 | + |C |0 |0 |1 |1 | + |D |1 |0 |1 |1 | + |E |0 |1 |1 |1 | + |F |1 |1 |1 |1 | + + +Firmware +-------- +Just `make` to build firmware. And consult with wiki for further information. + +- https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc660c +- https://github.com/tmk/tmk_keyboard/wiki + + +Datasheets +---------- +- Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf +- LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf +- LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf +- LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf +- AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf +- JST S5B-PH-SM4: http://www.jst-mfg.com/product/pdf/eng/ePH.pdf +- Hirose UX60SC-MB-5S8: https://www.hirose.com/product/en/products/UX/UX60SC-MB-5S8%2880%29/ +- Tr(E42) for LED?: http://www.bklighting.com/cimages/specs-758.pdf +- TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/goodjob/TY1252series.pdf + + +3.3V power supply +----------------- +LV07A and LVC138A are 5V-tolerant and can be powered with 5V, the keyboard will work only with 5V power supply. It may not be completely safe to operate LV138A with 5V Vcc, its datasheet says: + +> Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability. + + +Digipot AD5258 +-------------- +Controller can operate AD5258 via I2C to change actuation point of keys. This may make keyboard unusable accidentally and it will be difficult to recovery in some situation. For safety firmware doesn't support it at this point, though. + +Lower value of RDAC register causes shallower actuation point. + + +USB connector board +------------------- +The keyboard has USB receptacle on small separate 1.0mm-thick PCB. USB receptacle is Hirose UX60SC-MB-5S8 while wire-to-PCB connector is TYU TU1252WNR-05S. + +http://i.imgur.com/Nucn6h9.jpg + + +Resources +--------- +- Pics: http://imgur.com/a/HhyIq diff --git a/keyboards/flehrad/bigswitch/README.md b/keyboards/flehrad/bigswitch/README.md deleted file mode 100644 index 1a0fb155a7..0000000000 --- a/keyboards/flehrad/bigswitch/README.md +++ /dev/null @@ -1,16 +0,0 @@ -Big Switch PCB by flehrad -========================= - -Designed by Don of the Board Podcast and sold as a kit by [keeb.io](https://keeb.io/collections/frontpage/products/big-switch-pcb?variant=7507922845726) - -### PCB Files - -https://github.com/flehrad/Big-Switch-PCB - -make: flehrad/bigswitch:default - -### Technical Specifications - - * Uses a atmega32u4 pro micro or pin compatible MCU - * Pins B5 and B6 connect to the pins on the Big Switch - * Optionally you may add a RGB strip to pin D3 for data and take power from VCC and GND diff --git a/keyboards/flehrad/bigswitch/readme.md b/keyboards/flehrad/bigswitch/readme.md new file mode 100644 index 0000000000..1a0fb155a7 --- /dev/null +++ b/keyboards/flehrad/bigswitch/readme.md @@ -0,0 +1,16 @@ +Big Switch PCB by flehrad +========================= + +Designed by Don of the Board Podcast and sold as a kit by [keeb.io](https://keeb.io/collections/frontpage/products/big-switch-pcb?variant=7507922845726) + +### PCB Files + +https://github.com/flehrad/Big-Switch-PCB + +make: flehrad/bigswitch:default + +### Technical Specifications + + * Uses a atmega32u4 pro micro or pin compatible MCU + * Pins B5 and B6 connect to the pins on the Big Switch + * Optionally you may add a RGB strip to pin D3 for data and take power from VCC and GND diff --git a/keyboards/handwired/42/README.md b/keyboards/handwired/42/README.md deleted file mode 100644 index 20fb67aa7e..0000000000 --- a/keyboards/handwired/42/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# 42 - -42-keys ergonomic keyboard running on Adafruit Feather BLE. - -![42](https://github.com/nglgzz/42/raw/master/42.jpg) - -Keyboard Maintainer: [Angelo Gazzola (nglgzz)](https://github.com/nglgzz) -Hardware Supported: 42 (rev2, rev3), Feather 32u4 BLE -Hardware Availability: [GitHub](https://github.com/nglgzz/42/) - -Make example for this keyboard (after setting up your build environment): - - make handwired/42:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/42/readme.md b/keyboards/handwired/42/readme.md new file mode 100644 index 0000000000..20fb67aa7e --- /dev/null +++ b/keyboards/handwired/42/readme.md @@ -0,0 +1,15 @@ +# 42 + +42-keys ergonomic keyboard running on Adafruit Feather BLE. + +![42](https://github.com/nglgzz/42/raw/master/42.jpg) + +Keyboard Maintainer: [Angelo Gazzola (nglgzz)](https://github.com/nglgzz) +Hardware Supported: 42 (rev2, rev3), Feather 32u4 BLE +Hardware Availability: [GitHub](https://github.com/nglgzz/42/) + +Make example for this keyboard (after setting up your build environment): + + make handwired/42:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/aplx2/README.md b/keyboards/handwired/aplx2/README.md deleted file mode 100644 index 424d964817..0000000000 --- a/keyboards/handwired/aplx2/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Aplx2 - -![Front](https://i.imgur.com/cN4WfaQl.jpg) - -A simple 2% keyboard for osu!. Designed to be assembled as a sandwich with a Pro Micro, using M3 x 16mm screws, your choice of MX- or Alps-compatible switches, and 1N4148 diodes. - -**Layout:** -The default layout is: Z , X . -Used pins can be found in `config.h`. All ProMicro pins can be found [here](https://cdn.sparkfun.com/datasheets/Dev/Arduino/Boards/ProMicro16MHzv1.pdf). - -* Keyboard Maintainer: [Aplyard](https://github.com/Aplyard) -* Hardware Supported: Pro Micro (ATmega32U4) -* Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx2), [Thingiverse](https://www.thingiverse.com/thing:4294608) - -Make example for this keyboard (after setting up your build environment): - - make handwired/aplx2:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). - ---- -**Designed in:** -Fusion360 -[Keyboard Plate & Case Builder](http://builder.swillkb.com/) - - -**Usefull Links:** -[Qmk Online Configurator](https://config.qmk.fm/#) - -**Alternatives of qmk that worked for me:** -[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/) -[Firmware Builder](https://kbfirmware.com/) - ---- diff --git a/keyboards/handwired/aplx2/readme.md b/keyboards/handwired/aplx2/readme.md new file mode 100644 index 0000000000..424d964817 --- /dev/null +++ b/keyboards/handwired/aplx2/readme.md @@ -0,0 +1,34 @@ +# Aplx2 + +![Front](https://i.imgur.com/cN4WfaQl.jpg) + +A simple 2% keyboard for osu!. Designed to be assembled as a sandwich with a Pro Micro, using M3 x 16mm screws, your choice of MX- or Alps-compatible switches, and 1N4148 diodes. + +**Layout:** +The default layout is: Z , X . +Used pins can be found in `config.h`. All ProMicro pins can be found [here](https://cdn.sparkfun.com/datasheets/Dev/Arduino/Boards/ProMicro16MHzv1.pdf). + +* Keyboard Maintainer: [Aplyard](https://github.com/Aplyard) +* Hardware Supported: Pro Micro (ATmega32U4) +* Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx2), [Thingiverse](https://www.thingiverse.com/thing:4294608) + +Make example for this keyboard (after setting up your build environment): + + make handwired/aplx2:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +--- +**Designed in:** +Fusion360 +[Keyboard Plate & Case Builder](http://builder.swillkb.com/) + + +**Usefull Links:** +[Qmk Online Configurator](https://config.qmk.fm/#) + +**Alternatives of qmk that worked for me:** +[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/) +[Firmware Builder](https://kbfirmware.com/) + +--- diff --git a/keyboards/handwired/cans12er/README.md b/keyboards/handwired/cans12er/README.md deleted file mode 100644 index 5ecb2d2c26..0000000000 --- a/keyboards/handwired/cans12er/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# Cans12er -![Cans12er](https://i.imgur.com/ZsO6QSI.jpg) - -A 12-key, orthogonal keypad designed by Can! - -* Keyboard Maintainer: [Can](https://github.com/canbaytok) -* Hardware Supported: Pro Micro Atmega32u4 -* Hardware Availability: DIY with the [open-source design files](https://github.com/canbaytok/Cans12er) - -Schematic can be found here: [EasyEDA](https://easyeda.com/senordoenermann/mediapad) - -Build Instructions can be found here: [canbaytok/Cans12er](https://github.com/canbaytok/Cans12er) - -Make example for this keyboard (after setting up your build environment): - - make handwired/cans12er:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/cans12er/readme.md b/keyboards/handwired/cans12er/readme.md new file mode 100644 index 0000000000..5ecb2d2c26 --- /dev/null +++ b/keyboards/handwired/cans12er/readme.md @@ -0,0 +1,18 @@ +# Cans12er +![Cans12er](https://i.imgur.com/ZsO6QSI.jpg) + +A 12-key, orthogonal keypad designed by Can! + +* Keyboard Maintainer: [Can](https://github.com/canbaytok) +* Hardware Supported: Pro Micro Atmega32u4 +* Hardware Availability: DIY with the [open-source design files](https://github.com/canbaytok/Cans12er) + +Schematic can be found here: [EasyEDA](https://easyeda.com/senordoenermann/mediapad) + +Build Instructions can be found here: [canbaytok/Cans12er](https://github.com/canbaytok/Cans12er) + +Make example for this keyboard (after setting up your build environment): + + make handwired/cans12er:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/d48/README.md b/keyboards/handwired/d48/README.md deleted file mode 100644 index a20b8a4251..0000000000 --- a/keyboards/handwired/d48/README.md +++ /dev/null @@ -1,87 +0,0 @@ -# D48 - -![Proton C based handwired 40% keyboard](https://i.imgur.com/2wCYuno.jpg) - -A Proton C based handwired 48 key keyboard with 2 rotary encoders, I2C OLED, WS2812 strip, buzzer & clock! - -- Keyboard Maintainer: Andrew Dunai -- Hardware Supported: Proton C handwired - -Make example for this keyboard (after setting up your build environment): - - make handwired/d48:default - -## Details - -- Proton C based handwired keyboard -- 2x custom 1.25mm stainless steel plates -- Kailh Choc White (clicky) -- 2x rotary encoders -- 0.91" 128x32 I2C OLED -- Small buzzer mounted inside (still waiting for the AST1109MLTRQ boys) -- WS2812 strip (14 LEDs) -- DS1307 I2C module real-time clock - -Build process: [album](https://imgur.com/gallery/zZZGdDw) - -## Pinout - -![D48 pinout](https://imgur.com/QoStCvD.jpg) - -## Challenges - -I'm very happy with the result, but at some point Proton C was driving me nuts. - -I did a lot of trial and error during assembly & programming. -There were a lot of *yet* undocumented caveats, -so I'll outline them here so that you guys can avoid the same issues I had. - -## Matrix & encoders - -Although this is a 48-key board with a 12-col & 4-row matrix, I've decided to add an extra row above the first one -to make my matrix 12x5 and wire encoders' push buttons as 2 extra keys, thus making it a total of 50 (12x4 + 2 encoders). -I used 2 columns (9 & 12) for those buttons. - -So, a first row actually has 2 buttons on columns 9 & 12 (because encoders are located near those columns). -Encoders' push buttons are also configured via QMK's keymap. - -Check out the `d48.h` & `config.h` for pins used & keymap macro definition. - -## I2C/OLED - -Most of the stuff worked out of the box, except me choosing the right pins for my OLED. - -On the Proton C pinout, there are 3 labels for I2C and for some reason -there are 2 pairs of SDA/SCL for I2C1 channel: `B8`/`B9` (rear left side) and `B6`/`B7` (rear right side). -I'm not sure if this is a mistake or if I was doing something wrong. So initially I picked `B8`/`B9` -which were not working. When I switched to B6/B7, things worked like a charm. -Later I used B9 for matrix row. No issues so far. - -Oh, and by the way, while using `B8`/`B9`, keyboard was sometimes *swallowing* quick keypresses. -I believe this was due to I(2)C timeouts (because incorrect pins were used for OLED). - -## Buzzer - -It turns out once you switch on `AUDIO_ENABLE`, you cannot use A4 & A5 because they interfere with the buzzer. -My guess is that buzzer uses DAC channels (not sure why both). - -I couldn't find this in documentation. Honestly, Proton C has almost zero documentation and this was -the biggest challenge. Anyway, apart from almost going crazy from those challenges, I really liked it! - -## RGB - -I used pin `A15` for my WS28128 RGB strip. - -## D1307 real-time clock - -Connecting DS1307 RTC was a piece of cake: same I2 pins as OLED (SDA/SCL), GND to GND and power to Proton C VUSB pin (5v). - -## Other issues - -- `B5` could not be used for matrix. -- `TAP_CODE_DELAY` had to be increased to 10 to fix `tap_code(KC_VOLU/KC_VOLD)` calls being swallowed in encoder callback. -- Be extremely attentive about the pinout: keep in mind that **the official Proton C pinout displays the rear of the board, not the front.** Being used to front pinouts, I ended up soldering entire matrix to the wrong side, so I had to desolder every wire and connect it to the opposite side. - -## Conclusion - -I had a lot of fun. The layout was inspired by the Planck THK. Feel free to ask any questions! diff --git a/keyboards/handwired/d48/readme.md b/keyboards/handwired/d48/readme.md new file mode 100644 index 0000000000..a20b8a4251 --- /dev/null +++ b/keyboards/handwired/d48/readme.md @@ -0,0 +1,87 @@ +# D48 + +![Proton C based handwired 40% keyboard](https://i.imgur.com/2wCYuno.jpg) + +A Proton C based handwired 48 key keyboard with 2 rotary encoders, I2C OLED, WS2812 strip, buzzer & clock! + +- Keyboard Maintainer: Andrew Dunai +- Hardware Supported: Proton C handwired + +Make example for this keyboard (after setting up your build environment): + + make handwired/d48:default + +## Details + +- Proton C based handwired keyboard +- 2x custom 1.25mm stainless steel plates +- Kailh Choc White (clicky) +- 2x rotary encoders +- 0.91" 128x32 I2C OLED +- Small buzzer mounted inside (still waiting for the AST1109MLTRQ boys) +- WS2812 strip (14 LEDs) +- DS1307 I2C module real-time clock + +Build process: [album](https://imgur.com/gallery/zZZGdDw) + +## Pinout + +![D48 pinout](https://imgur.com/QoStCvD.jpg) + +## Challenges + +I'm very happy with the result, but at some point Proton C was driving me nuts. + +I did a lot of trial and error during assembly & programming. +There were a lot of *yet* undocumented caveats, +so I'll outline them here so that you guys can avoid the same issues I had. + +## Matrix & encoders + +Although this is a 48-key board with a 12-col & 4-row matrix, I've decided to add an extra row above the first one +to make my matrix 12x5 and wire encoders' push buttons as 2 extra keys, thus making it a total of 50 (12x4 + 2 encoders). +I used 2 columns (9 & 12) for those buttons. + +So, a first row actually has 2 buttons on columns 9 & 12 (because encoders are located near those columns). +Encoders' push buttons are also configured via QMK's keymap. + +Check out the `d48.h` & `config.h` for pins used & keymap macro definition. + +## I2C/OLED + +Most of the stuff worked out of the box, except me choosing the right pins for my OLED. + +On the Proton C pinout, there are 3 labels for I2C and for some reason +there are 2 pairs of SDA/SCL for I2C1 channel: `B8`/`B9` (rear left side) and `B6`/`B7` (rear right side). +I'm not sure if this is a mistake or if I was doing something wrong. So initially I picked `B8`/`B9` +which were not working. When I switched to B6/B7, things worked like a charm. +Later I used B9 for matrix row. No issues so far. + +Oh, and by the way, while using `B8`/`B9`, keyboard was sometimes *swallowing* quick keypresses. +I believe this was due to I(2)C timeouts (because incorrect pins were used for OLED). + +## Buzzer + +It turns out once you switch on `AUDIO_ENABLE`, you cannot use A4 & A5 because they interfere with the buzzer. +My guess is that buzzer uses DAC channels (not sure why both). + +I couldn't find this in documentation. Honestly, Proton C has almost zero documentation and this was +the biggest challenge. Anyway, apart from almost going crazy from those challenges, I really liked it! + +## RGB + +I used pin `A15` for my WS28128 RGB strip. + +## D1307 real-time clock + +Connecting DS1307 RTC was a piece of cake: same I2 pins as OLED (SDA/SCL), GND to GND and power to Proton C VUSB pin (5v). + +## Other issues + +- `B5` could not be used for matrix. +- `TAP_CODE_DELAY` had to be increased to 10 to fix `tap_code(KC_VOLU/KC_VOLD)` calls being swallowed in encoder callback. +- Be extremely attentive about the pinout: keep in mind that **the official Proton C pinout displays the rear of the board, not the front.** Being used to front pinouts, I ended up soldering entire matrix to the wrong side, so I had to desolder every wire and connect it to the opposite side. + +## Conclusion + +I had a lot of fun. The layout was inspired by the Planck THK. Feel free to ask any questions! diff --git a/keyboards/handwired/k8split/README.md b/keyboards/handwired/k8split/README.md deleted file mode 100644 index 01c3365abc..0000000000 --- a/keyboards/handwired/k8split/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# k8split -![left](https://raw.githubusercontent.com/Ckath/k8split/master/k8split_left.png) -![right](https://raw.githubusercontent.com/Ckath/k8split/master/k8split_right.png) - -my personal 8x6(x2) split keyboard, aiming to be a mostly normal keyboard layout with plenty of keys. see the hardware repo for more info. - -* Keyboard Maintainer: [Ckath](https://github.com/Ckath) -* Hardware: https://github.com/Ckath/k8split - -Make example for this keyboard (after setting up your build environment): - - make handwired/k8split:default - -Flashing (both halves are separate keyboards and the default layout is just for debugging): - - # left - make handwired/k8split:left:flash - # right - make handwired/k8split:right:flash - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/k8split/readme.md b/keyboards/handwired/k8split/readme.md new file mode 100644 index 0000000000..01c3365abc --- /dev/null +++ b/keyboards/handwired/k8split/readme.md @@ -0,0 +1,21 @@ +# k8split +![left](https://raw.githubusercontent.com/Ckath/k8split/master/k8split_left.png) +![right](https://raw.githubusercontent.com/Ckath/k8split/master/k8split_right.png) + +my personal 8x6(x2) split keyboard, aiming to be a mostly normal keyboard layout with plenty of keys. see the hardware repo for more info. + +* Keyboard Maintainer: [Ckath](https://github.com/Ckath) +* Hardware: https://github.com/Ckath/k8split + +Make example for this keyboard (after setting up your build environment): + + make handwired/k8split:default + +Flashing (both halves are separate keyboards and the default layout is just for debugging): + + # left + make handwired/k8split:left:flash + # right + make handwired/k8split:right:flash + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/qc60/README.md b/keyboards/handwired/qc60/README.md deleted file mode 100644 index 4fdd9ba6ef..0000000000 --- a/keyboards/handwired/qc60/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# QC60 - -![qc60 layout](https://i.imgur.com/BAW1VGc.png) - -A split 60% staggered keyboard made by Peioris. - -Keyboard Maintainer: [Peioris](https://github.com/coarse) -Hardware Supported: [QC60 PCB](https://imgur.com/6tIxJ1N), Pro Micro -Hardware Availability: N/A at the moment - -Handwiring Resources: [Pro Micro Wiring](https://imgur.com/UycEYlG), [Keymapping](http://www.keyboard-layout-editor.com/#/gists/a54720ecfd934155b179657938e8e87b) - -Make example for this keyboard (after setting up your build environment): - - make handwired/qc60/proto:default - -Example of flashing this keyboard: - - make handwired/qc60/proto:avrdude - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/qc60/readme.md b/keyboards/handwired/qc60/readme.md new file mode 100644 index 0000000000..4fdd9ba6ef --- /dev/null +++ b/keyboards/handwired/qc60/readme.md @@ -0,0 +1,21 @@ +# QC60 + +![qc60 layout](https://i.imgur.com/BAW1VGc.png) + +A split 60% staggered keyboard made by Peioris. + +Keyboard Maintainer: [Peioris](https://github.com/coarse) +Hardware Supported: [QC60 PCB](https://imgur.com/6tIxJ1N), Pro Micro +Hardware Availability: N/A at the moment + +Handwiring Resources: [Pro Micro Wiring](https://imgur.com/UycEYlG), [Keymapping](http://www.keyboard-layout-editor.com/#/gists/a54720ecfd934155b179657938e8e87b) + +Make example for this keyboard (after setting up your build environment): + + make handwired/qc60/proto:default + +Example of flashing this keyboard: + + make handwired/qc60/proto:avrdude + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/rs60/README.md b/keyboards/handwired/rs60/README.md deleted file mode 100644 index 07c967e276..0000000000 --- a/keyboards/handwired/rs60/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# rs60: Handwired Slim Preonic Clone - -I wanted a preonic layout but with a very low profile. As Jack is still working on the Preonic PCB for Kailh Choc switches, I figured I could try to handwire one myself. It's my first custom keyboard, so I had a lot to learn. - -First I designed the case in fusion 360. I wanted to build it using acrylic, constrained myself to standard acrylic sheet thickness. - -![](https://imgur.com/NscS7Rd.jpg) - -You can download the model [here](https://a360.co/2OqiKLm). - -To test my design I 3D printed the parts. - -![](https://imgur.com/MSF7zLS.jpg) - -The result was encouraging, so I decided to build a prototype out of the printed plates using Kailh Choc brown switches. I tried to make the handwiring job as flat as possible so it can fit in my design. - -![](https://i.imgur.com/67yZx0V.jpg) -![](https://i.imgur.com/ft72Cgj.jpg) - -I designed switch plate and the middle plates so that they would be glued together. The middle plate has inserts to attach the bottom plate using m8 screws. - -![](https://i.imgur.com/GstTohI.jpg) - -The end result is not too bad, but there is a few things I would do differently. Gluing 3D printed plates wasn't a good idea. The switch layer is so thin, that it bends when all the switches are slotted. As a result, the keyboard is not entirely flat. I will replace the bottom plate by a metal one so I get more weight and rigidity. - -Even with acrylic, I think I will have the same issue. I might switch to screws + bolts that go all the way through. - diff --git a/keyboards/handwired/rs60/readme.md b/keyboards/handwired/rs60/readme.md new file mode 100644 index 0000000000..07c967e276 --- /dev/null +++ b/keyboards/handwired/rs60/readme.md @@ -0,0 +1,27 @@ +# rs60: Handwired Slim Preonic Clone + +I wanted a preonic layout but with a very low profile. As Jack is still working on the Preonic PCB for Kailh Choc switches, I figured I could try to handwire one myself. It's my first custom keyboard, so I had a lot to learn. + +First I designed the case in fusion 360. I wanted to build it using acrylic, constrained myself to standard acrylic sheet thickness. + +![](https://imgur.com/NscS7Rd.jpg) + +You can download the model [here](https://a360.co/2OqiKLm). + +To test my design I 3D printed the parts. + +![](https://imgur.com/MSF7zLS.jpg) + +The result was encouraging, so I decided to build a prototype out of the printed plates using Kailh Choc brown switches. I tried to make the handwiring job as flat as possible so it can fit in my design. + +![](https://i.imgur.com/67yZx0V.jpg) +![](https://i.imgur.com/ft72Cgj.jpg) + +I designed switch plate and the middle plates so that they would be glued together. The middle plate has inserts to attach the bottom plate using m8 screws. + +![](https://i.imgur.com/GstTohI.jpg) + +The end result is not too bad, but there is a few things I would do differently. Gluing 3D printed plates wasn't a good idea. The switch layer is so thin, that it bends when all the switches are slotted. As a result, the keyboard is not entirely flat. I will replace the bottom plate by a metal one so I get more weight and rigidity. + +Even with acrylic, I think I will have the same issue. I might switch to screws + bolts that go all the way through. + diff --git a/keyboards/handwired/videowriter/README.md b/keyboards/handwired/videowriter/README.md deleted file mode 100644 index ef8471aa91..0000000000 --- a/keyboards/handwired/videowriter/README.md +++ /dev/null @@ -1,61 +0,0 @@ -# QMK-based firmware for Magnavox Videowriter keyboard -Matrix layout is based on info from this [article](https://deskthority.net/workshop-f7/magnavox-videowriter-keyboard-cleanup-and-conversion-t19687.html). - -![Videowriter](https://i.imgur.com/zNTHmZa.jpg) - -Magnavox Videowriter keyboard conversion project: direct connection of Pro Micro to the matrix. - -* Keyboard Maintainer: [DmNosachev](https://github.com/DmNosachev) -* Hardware Supported: Alps-based [Magnavox Videowriter keyboard](https://deskthority.net/wiki/Magnavox_VideoWriter), Pro Micro 16MHz 5V MCU board (you can use any MCU which is supported by QMK and has 18 or more IO). - -Make example for this keyboard (after setting up your build environment): - - make handwired/videowriter:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). - -# Modding - -## Matrix - -Videowriter has 8x10 matrix: - -| col/row | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | -|---------|----------|-----------|-----------|-----------|----------|-----------|-----------|---------| -| 0 | | | | | | | 51 LShift | 39 Caps | -| 1 | 08 Copy | 07 Find | 06 Split | 05 Center | 04 Page | 03 Spell | 02 Print | 01 Menu | -| 2 | 16 5 | 15 4 | 14 3 | 13 2 | 12 1 | 11 Delete | 10 GoTo | 09 Move | -| 3 | 24 BkSpc | 23 Equals | 22 Minus | 21 0 | 20 9 | 19 8 | 18 7 | 17 6 | -| 4 | 32 U | 31 Y | 30 T | 29 R | 28 E | 27 W | 26 Q | 25 Tab | -| 5 | 41 S | 40 A | 38 Return | 37 ] | 36 [ | 35 P | 34 O | 33 I | -| 6 | 49 ; | 48 L | 47 K | 46 J | 45 H | 44 G | 43 F | 42 D | -| 7 | 58 M | 57 N | 56 B | 55 V | 54 C | 53 X | 52 Z | 50 " | -| 8 | 67 Left | 66 Up | 65 Insert | 64 Space | 63 Style | 61 / | 60 . | 59 , | -| 9 | | | 62 RShift | 72 Undo | 71 Help | 70 Do | 69 Right | 68 Down | - -## Separating Shift keys -Initially left and right Shift keys are connected in parrallel. You need to cut the traces from right Shift (switch 62) and wire it to column 2 (switch 65, right pin) and row 9 (switch 71, bottom pin). - -![Right shift](https://i.imgur.com/ttdTVtC.jpg) - -## Stock components removal -SN74LS145N IC (BCD-to-decimal decoder, drives matrix rows), NEC D8049HC IC (MCU, drives matrix columns) and resistor array need to be desoldered from the PCB. You need to shorten the 4 diodes (D2–D5) in the bottom right corner of the PCB (solder a wire between their pins). -I've also removed two electrolytic capacitors and some ceramic capacitors just to free an additional space. - -Optional: add diodes between each switch and corresponding row for NKRO. If you choose not to add them, create `config.h` file in your personal keymap folder and add `#define MATRIX_HAS_GHOST` to it. - -## Pro Micro -Suggested mount position for the Pro Micro: - -![PCB bottom side](https://i.imgur.com/bb7zZD0.jpg) - -1. Solder two 8-pin headers to the Pro Micro (pin D1-B5 on the left side and pins F4-B6 on the right side). -2. Solder the Pro Micro to the Videowriter's PCB. -3. Solder 6 wire bridges (pink color on the photo). -4. By this point rows 0-4 and all columns will be already in place. -5. Connect rows 5-9 (see right side of the PCB) to the corresponding pins of the Pro Micro using additional wires. -6. Optional: connect a push button between Reset and Ground pins. - -![PCB top side](https://i.imgur.com/PVEXIxj.jpg) - -Compile and flash the firmware. Use matrix [debug mode](https://docs.qmk.fm/#/feature_command) if something is wrong. diff --git a/keyboards/handwired/videowriter/readme.md b/keyboards/handwired/videowriter/readme.md new file mode 100644 index 0000000000..ef8471aa91 --- /dev/null +++ b/keyboards/handwired/videowriter/readme.md @@ -0,0 +1,61 @@ +# QMK-based firmware for Magnavox Videowriter keyboard +Matrix layout is based on info from this [article](https://deskthority.net/workshop-f7/magnavox-videowriter-keyboard-cleanup-and-conversion-t19687.html). + +![Videowriter](https://i.imgur.com/zNTHmZa.jpg) + +Magnavox Videowriter keyboard conversion project: direct connection of Pro Micro to the matrix. + +* Keyboard Maintainer: [DmNosachev](https://github.com/DmNosachev) +* Hardware Supported: Alps-based [Magnavox Videowriter keyboard](https://deskthority.net/wiki/Magnavox_VideoWriter), Pro Micro 16MHz 5V MCU board (you can use any MCU which is supported by QMK and has 18 or more IO). + +Make example for this keyboard (after setting up your build environment): + + make handwired/videowriter:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +# Modding + +## Matrix + +Videowriter has 8x10 matrix: + +| col/row | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | +|---------|----------|-----------|-----------|-----------|----------|-----------|-----------|---------| +| 0 | | | | | | | 51 LShift | 39 Caps | +| 1 | 08 Copy | 07 Find | 06 Split | 05 Center | 04 Page | 03 Spell | 02 Print | 01 Menu | +| 2 | 16 5 | 15 4 | 14 3 | 13 2 | 12 1 | 11 Delete | 10 GoTo | 09 Move | +| 3 | 24 BkSpc | 23 Equals | 22 Minus | 21 0 | 20 9 | 19 8 | 18 7 | 17 6 | +| 4 | 32 U | 31 Y | 30 T | 29 R | 28 E | 27 W | 26 Q | 25 Tab | +| 5 | 41 S | 40 A | 38 Return | 37 ] | 36 [ | 35 P | 34 O | 33 I | +| 6 | 49 ; | 48 L | 47 K | 46 J | 45 H | 44 G | 43 F | 42 D | +| 7 | 58 M | 57 N | 56 B | 55 V | 54 C | 53 X | 52 Z | 50 " | +| 8 | 67 Left | 66 Up | 65 Insert | 64 Space | 63 Style | 61 / | 60 . | 59 , | +| 9 | | | 62 RShift | 72 Undo | 71 Help | 70 Do | 69 Right | 68 Down | + +## Separating Shift keys +Initially left and right Shift keys are connected in parrallel. You need to cut the traces from right Shift (switch 62) and wire it to column 2 (switch 65, right pin) and row 9 (switch 71, bottom pin). + +![Right shift](https://i.imgur.com/ttdTVtC.jpg) + +## Stock components removal +SN74LS145N IC (BCD-to-decimal decoder, drives matrix rows), NEC D8049HC IC (MCU, drives matrix columns) and resistor array need to be desoldered from the PCB. You need to shorten the 4 diodes (D2–D5) in the bottom right corner of the PCB (solder a wire between their pins). +I've also removed two electrolytic capacitors and some ceramic capacitors just to free an additional space. + +Optional: add diodes between each switch and corresponding row for NKRO. If you choose not to add them, create `config.h` file in your personal keymap folder and add `#define MATRIX_HAS_GHOST` to it. + +## Pro Micro +Suggested mount position for the Pro Micro: + +![PCB bottom side](https://i.imgur.com/bb7zZD0.jpg) + +1. Solder two 8-pin headers to the Pro Micro (pin D1-B5 on the left side and pins F4-B6 on the right side). +2. Solder the Pro Micro to the Videowriter's PCB. +3. Solder 6 wire bridges (pink color on the photo). +4. By this point rows 0-4 and all columns will be already in place. +5. Connect rows 5-9 (see right side of the PCB) to the corresponding pins of the Pro Micro using additional wires. +6. Optional: connect a push button between Reset and Ground pins. + +![PCB top side](https://i.imgur.com/PVEXIxj.jpg) + +Compile and flash the firmware. Use matrix [debug mode](https://docs.qmk.fm/#/feature_command) if something is wrong. diff --git a/keyboards/handwired/wulkan/README.md b/keyboards/handwired/wulkan/README.md deleted file mode 100644 index c6ea77389e..0000000000 --- a/keyboards/handwired/wulkan/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# wulkan - -Handwired 40% keyboard build with Proton C. - -Keyboard Maintainer: [Napoleon Wulkan](https://github.com/wulkan) -Hardware Supported: Proton C -Hardware Availability: [OLKB.com](https://olkb.com) - - -Make example for this keyboard (after setting up your build environment): - - make handwired/wulkan:default:dfu-util - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/wulkan/readme.md b/keyboards/handwired/wulkan/readme.md new file mode 100644 index 0000000000..c6ea77389e --- /dev/null +++ b/keyboards/handwired/wulkan/readme.md @@ -0,0 +1,14 @@ +# wulkan + +Handwired 40% keyboard build with Proton C. + +Keyboard Maintainer: [Napoleon Wulkan](https://github.com/wulkan) +Hardware Supported: Proton C +Hardware Availability: [OLKB.com](https://olkb.com) + + +Make example for this keyboard (after setting up your build environment): + + make handwired/wulkan:default:dfu-util + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/handwired/xealousbrown/README.md b/keyboards/handwired/xealousbrown/README.md deleted file mode 100644 index 970f9444c4..0000000000 --- a/keyboards/handwired/xealousbrown/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# XealouS Brown - -My first handwired keyboard. Originally used TMK, now ported in full glory to QMK. - -Build log at: -https://sites.google.com/site/xaelous/keyboards/handwired-keyboard - -Make example for this keyboard (after setting up your build environment): - - make handwired/xealousbrown:default - - -The brief list of speedhacks to make this keyboard blazing fast: -1) bit-bash implementation of scanning rows, columns. Very short delay between pin waiting. -2) Compiling with a few extra flags -3) Eager-per-key Debouncing algorithm (no 5ms delay before message is sent) -4) 1000hz polling diff --git a/keyboards/handwired/xealousbrown/readme.md b/keyboards/handwired/xealousbrown/readme.md new file mode 100644 index 0000000000..970f9444c4 --- /dev/null +++ b/keyboards/handwired/xealousbrown/readme.md @@ -0,0 +1,17 @@ +# XealouS Brown + +My first handwired keyboard. Originally used TMK, now ported in full glory to QMK. + +Build log at: +https://sites.google.com/site/xaelous/keyboards/handwired-keyboard + +Make example for this keyboard (after setting up your build environment): + + make handwired/xealousbrown:default + + +The brief list of speedhacks to make this keyboard blazing fast: +1) bit-bash implementation of scanning rows, columns. Very short delay between pin waiting. +2) Compiling with a few extra flags +3) Eager-per-key Debouncing algorithm (no 5ms delay before message is sent) +4) 1000hz polling diff --git a/keyboards/jj40/README.md b/keyboards/jj40/README.md deleted file mode 100644 index 5f4d2c8a99..0000000000 --- a/keyboards/jj40/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# jj40 - -![jj40](https://ae01.alicdn.com/kf/HTB18bq6bOERMeJjSspiq6zZLFXar.jpg?size=359506&height=562&width=750&hash=663a22d0109e2416ec8f54a7658686da) - -A compact 40% (12x4) ortholinear keyboard kit made and KPRepublic on AliExpress. - -* Keyboard Maintainer: [QMK Community](https://github.com/qmk) -* Hardware Supported: Atmega32A -* Hardware Availability: [AliExpress](https://www.aliexpress.com/store/product/jj40-Custom-Mechanical-Keyboard-40-PCB-programmed-40-planck-layouts-bface-firmware-gh40/3034003_32828781103.html) - -Make example for this keyboard (after setting up your build environment): - - make jj40:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make jj40:default:flash - -**Reset Key**: Hold down the *Top Right Key* key, commonly programmed as *Backspace* while plugging in the keyboard. - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/jj40/readme.md b/keyboards/jj40/readme.md new file mode 100644 index 0000000000..5f4d2c8a99 --- /dev/null +++ b/keyboards/jj40/readme.md @@ -0,0 +1,21 @@ +# jj40 + +![jj40](https://ae01.alicdn.com/kf/HTB18bq6bOERMeJjSspiq6zZLFXar.jpg?size=359506&height=562&width=750&hash=663a22d0109e2416ec8f54a7658686da) + +A compact 40% (12x4) ortholinear keyboard kit made and KPRepublic on AliExpress. + +* Keyboard Maintainer: [QMK Community](https://github.com/qmk) +* Hardware Supported: Atmega32A +* Hardware Availability: [AliExpress](https://www.aliexpress.com/store/product/jj40-Custom-Mechanical-Keyboard-40-PCB-programmed-40-planck-layouts-bface-firmware-gh40/3034003_32828781103.html) + +Make example for this keyboard (after setting up your build environment): + + make jj40:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make jj40:default:flash + +**Reset Key**: Hold down the *Top Right Key* key, commonly programmed as *Backspace* while plugging in the keyboard. + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/jj50/README.md b/keyboards/jj50/README.md deleted file mode 100644 index 9719f01eca..0000000000 --- a/keyboards/jj50/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# JJ50 - -![JJ50 + SA Vilebloom (w/ Sakurios) by u/rendleshift](https://i.imgur.com/SwYZ4wol.jpg) - -A compact 50% (5x12) ortholinear keyboard made and sold by KPrepublic. - -* Keyboard Maintainer: [QMK Community](https://github.com/qmk) -* Hardware Supported: Atmega32A -* Hardware Availability: [AliExpress](https://www.aliexpress.com/item/jj50-v1-0-Custom-Mechanical-Keyboard-50-PCB-programmed-50-preonic-layouts-bface-firmware-with-rgb/32848915277.html); [KPrepublic](https://kprepublic.com/collections/jj50-50/products/jj50-50-custom-keyboard-pcb-similar-with-preonic) - -Make example for this keyboard (after setting up your build environment): - - make jj50:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make jj50:default:flash - -**Reset Key**: Hold down the key `Backspace` (`Key below the top right key`) while plugging in the keyboard. - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/jj50/readme.md b/keyboards/jj50/readme.md new file mode 100644 index 0000000000..9719f01eca --- /dev/null +++ b/keyboards/jj50/readme.md @@ -0,0 +1,21 @@ +# JJ50 + +![JJ50 + SA Vilebloom (w/ Sakurios) by u/rendleshift](https://i.imgur.com/SwYZ4wol.jpg) + +A compact 50% (5x12) ortholinear keyboard made and sold by KPrepublic. + +* Keyboard Maintainer: [QMK Community](https://github.com/qmk) +* Hardware Supported: Atmega32A +* Hardware Availability: [AliExpress](https://www.aliexpress.com/item/jj50-v1-0-Custom-Mechanical-Keyboard-50-PCB-programmed-50-preonic-layouts-bface-firmware-with-rgb/32848915277.html); [KPrepublic](https://kprepublic.com/collections/jj50-50/products/jj50-50-custom-keyboard-pcb-similar-with-preonic) + +Make example for this keyboard (after setting up your build environment): + + make jj50:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make jj50:default:flash + +**Reset Key**: Hold down the key `Backspace` (`Key below the top right key`) while plugging in the keyboard. + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/kabedon/kabedon78s/README.md b/keyboards/kabedon/kabedon78s/README.md deleted file mode 100644 index 6fd1420e5f..0000000000 --- a/keyboards/kabedon/kabedon78s/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# Kabe Don 78S - -This is a special-shaped keyboard with smaller keyboard and more functions,Includes RGB LEDs Underglow - -* Keyboard Maintainer: [370490639](https://github.com/370490639) -* Hardware Supported: Kabe Don 78s -* Hardware Availability: Kabe Don 78S - -Make example for this keyboard (after setting up your build environment): - - make kabedon/kabedon78s:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/kabedon/kabedon78s/readme.md b/keyboards/kabedon/kabedon78s/readme.md new file mode 100644 index 0000000000..6fd1420e5f --- /dev/null +++ b/keyboards/kabedon/kabedon78s/readme.md @@ -0,0 +1,13 @@ +# Kabe Don 78S + +This is a special-shaped keyboard with smaller keyboard and more functions,Includes RGB LEDs Underglow + +* Keyboard Maintainer: [370490639](https://github.com/370490639) +* Hardware Supported: Kabe Don 78s +* Hardware Availability: Kabe Don 78S + +Make example for this keyboard (after setting up your build environment): + + make kabedon/kabedon78s:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/kabedon/kabedon980/README.md b/keyboards/kabedon/kabedon980/README.md deleted file mode 100644 index 7adb75ad07..0000000000 --- a/keyboards/kabedon/kabedon980/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# Kabe Don 980 - -![Kabe Don 980](http://qungz.photo.store.qq.com/qun-qungz/V53LJWsQ407RKV3X7gmf3M0Ih23R00WB/V5bCQA1OTY5NTEwNjOx0B5fOCOlAQ!!/800?w5=2133&h5=1599&rf=viewer_421) - -A mechanical keyboard PCB in the same layout as the Leopold FC980M, sold by Kabe Don Peripherals on Taobao. -This PCB use Kailh hot swap sockets. -KabeDon980 Includes RGB Underglow. -Aluminium Alloy and Translucent Case. - -* Keyboard Maintainer: [370490639](https://github.com/370490639) -* Hardware Supported: Kabe Don 980 -* Hardware Availability: [Kabe Don 980](https://item.taobao.com/item.htm?spm=a1z10.1-c.w4023-17458066155.8.81406bd0J97pHX&id=614156027788) - -Make example for this keyboard (after setting up your build environment): - - make kabedon/kabedon980:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/kabedon/kabedon980/readme.md b/keyboards/kabedon/kabedon980/readme.md new file mode 100644 index 0000000000..7adb75ad07 --- /dev/null +++ b/keyboards/kabedon/kabedon980/readme.md @@ -0,0 +1,18 @@ +# Kabe Don 980 + +![Kabe Don 980](http://qungz.photo.store.qq.com/qun-qungz/V53LJWsQ407RKV3X7gmf3M0Ih23R00WB/V5bCQA1OTY5NTEwNjOx0B5fOCOlAQ!!/800?w5=2133&h5=1599&rf=viewer_421) + +A mechanical keyboard PCB in the same layout as the Leopold FC980M, sold by Kabe Don Peripherals on Taobao. +This PCB use Kailh hot swap sockets. +KabeDon980 Includes RGB Underglow. +Aluminium Alloy and Translucent Case. + +* Keyboard Maintainer: [370490639](https://github.com/370490639) +* Hardware Supported: Kabe Don 980 +* Hardware Availability: [Kabe Don 980](https://item.taobao.com/item.htm?spm=a1z10.1-c.w4023-17458066155.8.81406bd0J97pHX&id=614156027788) + +Make example for this keyboard (after setting up your build environment): + + make kabedon/kabedon980:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/keebio/chocopad/README.md b/keyboards/keebio/chocopad/README.md deleted file mode 100644 index 3cdb3b3b9c..0000000000 --- a/keyboards/keebio/chocopad/README.md +++ /dev/null @@ -1,14 +0,0 @@ -Chocopad -======== - -A 4x4 macropad keyboard using Kailh PG1350 Lower Profile Choc switches. - -Keyboard Maintainer: Keebio -Hardware Supported: Chocopad PCB, Arduino Pro Micro -Hardware Availability: [Keebio](https://keeb.io) - -Make example for this keyboard (after setting up your build environment): - - make keebio/chocopad:default - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. diff --git a/keyboards/keebio/chocopad/readme.md b/keyboards/keebio/chocopad/readme.md new file mode 100644 index 0000000000..3cdb3b3b9c --- /dev/null +++ b/keyboards/keebio/chocopad/readme.md @@ -0,0 +1,14 @@ +Chocopad +======== + +A 4x4 macropad keyboard using Kailh PG1350 Lower Profile Choc switches. + +Keyboard Maintainer: Keebio +Hardware Supported: Chocopad PCB, Arduino Pro Micro +Hardware Availability: [Keebio](https://keeb.io) + +Make example for this keyboard (after setting up your build environment): + + make keebio/chocopad:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. diff --git a/keyboards/keebio/dilly/README.md b/keyboards/keebio/dilly/README.md deleted file mode 100644 index 74139eaeae..0000000000 --- a/keyboards/keebio/dilly/README.md +++ /dev/null @@ -1,14 +0,0 @@ -Dilly -===== - -A 3x10 ortholinear keyboard using Kailh PG1350 Lower Profile Choc switches. - -Keyboard Maintainer: Keebio -Hardware Supported: Dilly PCB, Arduino Pro Micro -Hardware Availability: [Keebio](https://keeb.io) - -Make example for this keyboard (after setting up your build environment): - - make keebio/dilly:default - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. diff --git a/keyboards/keebio/dilly/readme.md b/keyboards/keebio/dilly/readme.md new file mode 100644 index 0000000000..74139eaeae --- /dev/null +++ b/keyboards/keebio/dilly/readme.md @@ -0,0 +1,14 @@ +Dilly +===== + +A 3x10 ortholinear keyboard using Kailh PG1350 Lower Profile Choc switches. + +Keyboard Maintainer: Keebio +Hardware Supported: Dilly PCB, Arduino Pro Micro +Hardware Availability: [Keebio](https://keeb.io) + +Make example for this keyboard (after setting up your build environment): + + make keebio/dilly:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. diff --git a/keyboards/keebio/tragicforce68/README.md b/keyboards/keebio/tragicforce68/README.md deleted file mode 100644 index c3ea92d7ad..0000000000 --- a/keyboards/keebio/tragicforce68/README.md +++ /dev/null @@ -1,18 +0,0 @@ -Tragicforce 68 -=============== - -Magicforce 68 with [Tragicforce 68 replacement PCB](https://keeb.io/products/mf68-magicforce-68-pcb-replacement-kit) from Keebio. - -Keyboard Maintainer: [Keebio](https://keeb.io) -Hardware Supported: Pro Micro -Hardware Availability: [Keebio](https://keeb.io) - -Make example for this keyboard (after setting up your build environment): - - make keebio/tragicforce68:default - -Example of flashing this keyboard: - - make keebio/tragicforce68:default:avrdude - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. diff --git a/keyboards/keebio/tragicforce68/readme.md b/keyboards/keebio/tragicforce68/readme.md new file mode 100644 index 0000000000..c3ea92d7ad --- /dev/null +++ b/keyboards/keebio/tragicforce68/readme.md @@ -0,0 +1,18 @@ +Tragicforce 68 +=============== + +Magicforce 68 with [Tragicforce 68 replacement PCB](https://keeb.io/products/mf68-magicforce-68-pcb-replacement-kit) from Keebio. + +Keyboard Maintainer: [Keebio](https://keeb.io) +Hardware Supported: Pro Micro +Hardware Availability: [Keebio](https://keeb.io) + +Make example for this keyboard (after setting up your build environment): + + make keebio/tragicforce68:default + +Example of flashing this keyboard: + + make keebio/tragicforce68:default:avrdude + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. diff --git a/keyboards/kinesis/nguyenvietyen/README.md b/keyboards/kinesis/nguyenvietyen/README.md deleted file mode 100644 index fc5390b036..0000000000 --- a/keyboards/kinesis/nguyenvietyen/README.md +++ /dev/null @@ -1,109 +0,0 @@ -# Viet's Kinesis + Pro Micro - -July 2020 - -This work is inspired by `alvicstep`'s solution. Instead of hooking up the Kinesis to a Teensy 2, this one hooks it up to a Pro Micro. - -## Kinesis Board Layout -The following is a reinterpretation of [@chrisandreae](https://github.com/chrisandreae/keyboard-firmware/blob/public/hardware/kinesis.h)'s work. - -### Used Pins -* 8 columns mapped to output pins 21 - 28 -* 16 rows mapped to 4 input pins: pin 39 - 36. Rows are traversed by iterating and setting 16 values from 0000 to 1111. -* 4 leds (e.g. capslock) mapped to input pin 1 - 4 -* keypad key mapped to pin 5 -* program key mapped to pin 6 -* `VCC` mapped to pin 40 - -### Matrix Configuration -The matrix configuration of the columns and rows on my Advantage is as follows: - -| | row 0 | row 1 | row 2 | row 3 | row 4 | row 5 | row 6 | row 7 | row 8 | row 9 | row A | row B | row C | row D | row E | row F | -| ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | -| col0 | F6 | F8 | F7 | 5% | 4$ | 3# | 2@ | 1! | =+ | | | | | | | | -| col1 | F3 | F5 | F4 | T | R | E | W | Q | Tab | | | | | | | | -| col2 | Esc | F2 | F1 | G | F | D | S | A | CapsLk | | | | | | | | -| col3 | F9 | F11 | F10 | B | V | C | X | Z | LShift | Up | | Down | | [{ | ]} | | -| col4 | F12 | ScrLk | PrtSc | Right | | Left | Insert | ~ | | 6^ | 7& | 8* | | 9( | 0) | -_ | -| col5 | Pause | | | LAlt | | Home | | End | | Y | U | I | | O | P | `\|` | -| col6 | | | | LCtrl | Delete | Bksp | RCtrl | Enter | Space | H | J | K | | L | ;: | '" | -| col7 | | | | | RGUI | | PageUp | | PageDn | N | M | ,< | | .> | /? | RShift | - -(this is a modified copy from [@alvicstep](https://github.com/qmk/qmk_firmware/blob/master/keyboards/kinesis/alvicstep/alvicstep.h)) - -In the code, keypad and program keys are mapped respectively to col0 and col1 of row C, the 12th row. - -### Omitted Pins -There are pins that we currently omit: -* serial eeprom clock line mapped to pin 7 -* serial eeprom data line mapped to pin 8 -* EEPROM write protect mapped to pin 10. -* foot switch 1 mapped to pin 11 -* PS/2 clock mapped to pin 12 -* PS/2 data mapped to pin 13 -* foot switch 2 mapped to pin 17 -* foot switch 3 mapped to pin 15 -* audio mapped to pin 32 - -### DIP Socket -Here's an ASCII drawing of the 40 pin DIP socket. -``` - DL2 1 40 VCC - DR1 2 39 A - DR2 3 38 B - DL1 4 37 C - KPD 5 36 G - PGM 6 35 - SCL 7 34 - SDA 8 33 - RST 9 32 BUZZ - WP 10 31 EA - FS1 11 30 ALE - CLOCK 12 29 PSEN - DATA 13 28 r8 - 14 27 r7 - FS3 15 26 r6 - 16 25 r5 - FS2 17 24 r4 - XTAL1 18 23 r3 - XTAL2 19 22 r2 - GND 20 21 r1 -``` -(this is copied from [@wjanssens](https://raw.githubusercontent.com/wjanssens/tmk_keyboard/master/keyboard/kinesis/doc/readme.txt)) - -## Pin Mapping to Pro Micro - -The following table is ordered by physical Arduino pin order. - -| Arduino | Kinesis | Meaning | -| ------- | ------- | ------- | -| D3 | 36 | G | -| D2 | 37 | C | -| GND | | | -| GND | | | -| D1 | 38 | B | -| D0 | 39 | A | -| D4 | 1 | DL2 | -| C6 | 2 | DR1 | -| D7 | 3 | DR2 | -| E6 | 4 | DL1 | -| B4 | 5 | KPD | -| B5 | 6 | PGM | -| B6 | 21 | r1 | -| B2 | 22 | r2 | -| B3 | 23 | r3 | -| B1 | 24 | r4 | -| F7 | 25 | r5 | -| F6 | 26 | r6 | -| F5 | 27 | r7 | -| F4 | 28 | r8 | -| VCC | 40 | | -| RESET | | | -| GND | 20 | | -| RAW | | | - -## Notes - -* The rows are multiplexed. Instead of reading them out, one sets the row value and corresponding column values are returned through r1-r8. -* On my keyboard, the keypad and program key have dedicated pins. Since row 12 had no mapping in the physical matrix, there's a code override injects the keypad and program pins to the first two bits in the matrix. -* I've experimented with debouncing approaches. The current setting delivers a snappier feeling than Kinesis's factory default for me. diff --git a/keyboards/kinesis/nguyenvietyen/readme.md b/keyboards/kinesis/nguyenvietyen/readme.md new file mode 100644 index 0000000000..fc5390b036 --- /dev/null +++ b/keyboards/kinesis/nguyenvietyen/readme.md @@ -0,0 +1,109 @@ +# Viet's Kinesis + Pro Micro + +July 2020 + +This work is inspired by `alvicstep`'s solution. Instead of hooking up the Kinesis to a Teensy 2, this one hooks it up to a Pro Micro. + +## Kinesis Board Layout +The following is a reinterpretation of [@chrisandreae](https://github.com/chrisandreae/keyboard-firmware/blob/public/hardware/kinesis.h)'s work. + +### Used Pins +* 8 columns mapped to output pins 21 - 28 +* 16 rows mapped to 4 input pins: pin 39 - 36. Rows are traversed by iterating and setting 16 values from 0000 to 1111. +* 4 leds (e.g. capslock) mapped to input pin 1 - 4 +* keypad key mapped to pin 5 +* program key mapped to pin 6 +* `VCC` mapped to pin 40 + +### Matrix Configuration +The matrix configuration of the columns and rows on my Advantage is as follows: + +| | row 0 | row 1 | row 2 | row 3 | row 4 | row 5 | row 6 | row 7 | row 8 | row 9 | row A | row B | row C | row D | row E | row F | +| ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | ----- | +| col0 | F6 | F8 | F7 | 5% | 4$ | 3# | 2@ | 1! | =+ | | | | | | | | +| col1 | F3 | F5 | F4 | T | R | E | W | Q | Tab | | | | | | | | +| col2 | Esc | F2 | F1 | G | F | D | S | A | CapsLk | | | | | | | | +| col3 | F9 | F11 | F10 | B | V | C | X | Z | LShift | Up | | Down | | [{ | ]} | | +| col4 | F12 | ScrLk | PrtSc | Right | | Left | Insert | ~ | | 6^ | 7& | 8* | | 9( | 0) | -_ | +| col5 | Pause | | | LAlt | | Home | | End | | Y | U | I | | O | P | `\|` | +| col6 | | | | LCtrl | Delete | Bksp | RCtrl | Enter | Space | H | J | K | | L | ;: | '" | +| col7 | | | | | RGUI | | PageUp | | PageDn | N | M | ,< | | .> | /? | RShift | + +(this is a modified copy from [@alvicstep](https://github.com/qmk/qmk_firmware/blob/master/keyboards/kinesis/alvicstep/alvicstep.h)) + +In the code, keypad and program keys are mapped respectively to col0 and col1 of row C, the 12th row. + +### Omitted Pins +There are pins that we currently omit: +* serial eeprom clock line mapped to pin 7 +* serial eeprom data line mapped to pin 8 +* EEPROM write protect mapped to pin 10. +* foot switch 1 mapped to pin 11 +* PS/2 clock mapped to pin 12 +* PS/2 data mapped to pin 13 +* foot switch 2 mapped to pin 17 +* foot switch 3 mapped to pin 15 +* audio mapped to pin 32 + +### DIP Socket +Here's an ASCII drawing of the 40 pin DIP socket. +``` + DL2 1 40 VCC + DR1 2 39 A + DR2 3 38 B + DL1 4 37 C + KPD 5 36 G + PGM 6 35 + SCL 7 34 + SDA 8 33 + RST 9 32 BUZZ + WP 10 31 EA + FS1 11 30 ALE + CLOCK 12 29 PSEN + DATA 13 28 r8 + 14 27 r7 + FS3 15 26 r6 + 16 25 r5 + FS2 17 24 r4 + XTAL1 18 23 r3 + XTAL2 19 22 r2 + GND 20 21 r1 +``` +(this is copied from [@wjanssens](https://raw.githubusercontent.com/wjanssens/tmk_keyboard/master/keyboard/kinesis/doc/readme.txt)) + +## Pin Mapping to Pro Micro + +The following table is ordered by physical Arduino pin order. + +| Arduino | Kinesis | Meaning | +| ------- | ------- | ------- | +| D3 | 36 | G | +| D2 | 37 | C | +| GND | | | +| GND | | | +| D1 | 38 | B | +| D0 | 39 | A | +| D4 | 1 | DL2 | +| C6 | 2 | DR1 | +| D7 | 3 | DR2 | +| E6 | 4 | DL1 | +| B4 | 5 | KPD | +| B5 | 6 | PGM | +| B6 | 21 | r1 | +| B2 | 22 | r2 | +| B3 | 23 | r3 | +| B1 | 24 | r4 | +| F7 | 25 | r5 | +| F6 | 26 | r6 | +| F5 | 27 | r7 | +| F4 | 28 | r8 | +| VCC | 40 | | +| RESET | | | +| GND | 20 | | +| RAW | | | + +## Notes + +* The rows are multiplexed. Instead of reading them out, one sets the row value and corresponding column values are returned through r1-r8. +* On my keyboard, the keypad and program key have dedicated pins. Since row 12 had no mapping in the physical matrix, there's a code override injects the keypad and program pins to the first two bits in the matrix. +* I've experimented with debouncing approaches. The current setting delivers a snappier feeling than Kinesis's factory default for me. diff --git a/keyboards/kingly_keys/soap/README.md b/keyboards/kingly_keys/soap/README.md deleted file mode 100644 index 0e32244d2f..0000000000 --- a/keyboards/kingly_keys/soap/README.md +++ /dev/null @@ -1,16 +0,0 @@ -SOAP -=== - -![SOAP](https://i.imgur.com/6h6O4QP.png) - -A Sanitary, "SOAP" Themed, Macro Pad by [Garret G.](https://github.com/TheRoyalSweatshirt) a.k.a. [/u/The_Royal](https://www.reddit.com/user/The_Royal) - -Keyboard Maintainer: [Garret G.](https://github.com/TheRoyalSweatshirt) a.k.a. [/u/The_Royal](https://www.reddit.com/user/The_Royal/) of Reddit. -Hardware Supported: SOAP rev1.0, rev2.0 PCB -Hardware Availability: [Kingly-Keys.xyz](https://kingly-keys.xyz/) - (Through GB) - -Make example for this keyboard (after setting up your build environment): - - make kingly_keys/soap:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs) diff --git a/keyboards/kingly_keys/soap/readme.md b/keyboards/kingly_keys/soap/readme.md new file mode 100644 index 0000000000..0e32244d2f --- /dev/null +++ b/keyboards/kingly_keys/soap/readme.md @@ -0,0 +1,16 @@ +SOAP +=== + +![SOAP](https://i.imgur.com/6h6O4QP.png) + +A Sanitary, "SOAP" Themed, Macro Pad by [Garret G.](https://github.com/TheRoyalSweatshirt) a.k.a. [/u/The_Royal](https://www.reddit.com/user/The_Royal) + +Keyboard Maintainer: [Garret G.](https://github.com/TheRoyalSweatshirt) a.k.a. [/u/The_Royal](https://www.reddit.com/user/The_Royal/) of Reddit. +Hardware Supported: SOAP rev1.0, rev2.0 PCB +Hardware Availability: [Kingly-Keys.xyz](https://kingly-keys.xyz/) - (Through GB) + +Make example for this keyboard (after setting up your build environment): + + make kingly_keys/soap:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs) diff --git a/keyboards/kona_classic/README.md b/keyboards/kona_classic/README.md deleted file mode 100644 index 0ea5b00ea3..0000000000 --- a/keyboards/kona_classic/README.md +++ /dev/null @@ -1,47 +0,0 @@ -Kona Classic -=== - -![Kona Classic](http://i.imgur.com/7twIpuB.jpg) - - -The Kona Classic is a 60% layout + left Function keys. Using a Teensy as the controller, the Kona Classic is provided as a do-it-yourself kit for left f-key enthusiasts. - -Keyboard Maintainer: [Maximillian Hill](https://github.com/DangerousParts) -Hardware Supported: Teensy 2.0 -Hardware Availability: Via GB - -Layouts that are preconfigured are shown here: - -Default: -![Default](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/default.png) - -ANSI: -![ANSI](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi.png) - -ANSI_split: -![ANSI w/ Split Space](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi_split.png) - -ANSI_arrows: -![ANSI w/ Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi_arrows.png) - -ANSI_split_arrows: -![ANSI w/ Split Space & Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi_split_arrows.png) - -ISO: -![ISO](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso.png) - -ISO_split: -![ISO w/ Split Space](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso_split.png) - -ISO_arrows: -![ISO w/ Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso_arrows.png) - -ISO_split_arrows: -![ISO w/ Split Space & Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso_split_arrows.png) - - -Make example for this keyboard (after setting up your build environment): - - make kona_classic:default - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. diff --git a/keyboards/kona_classic/readme.md b/keyboards/kona_classic/readme.md new file mode 100644 index 0000000000..0ea5b00ea3 --- /dev/null +++ b/keyboards/kona_classic/readme.md @@ -0,0 +1,47 @@ +Kona Classic +=== + +![Kona Classic](http://i.imgur.com/7twIpuB.jpg) + + +The Kona Classic is a 60% layout + left Function keys. Using a Teensy as the controller, the Kona Classic is provided as a do-it-yourself kit for left f-key enthusiasts. + +Keyboard Maintainer: [Maximillian Hill](https://github.com/DangerousParts) +Hardware Supported: Teensy 2.0 +Hardware Availability: Via GB + +Layouts that are preconfigured are shown here: + +Default: +![Default](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/default.png) + +ANSI: +![ANSI](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi.png) + +ANSI_split: +![ANSI w/ Split Space](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi_split.png) + +ANSI_arrows: +![ANSI w/ Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi_arrows.png) + +ANSI_split_arrows: +![ANSI w/ Split Space & Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi_split_arrows.png) + +ISO: +![ISO](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso.png) + +ISO_split: +![ISO w/ Split Space](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso_split.png) + +ISO_arrows: +![ISO w/ Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso_arrows.png) + +ISO_split_arrows: +![ISO w/ Split Space & Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso_split_arrows.png) + + +Make example for this keyboard (after setting up your build environment): + + make kona_classic:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. diff --git a/keyboards/lets_split_eh/README.md b/keyboards/lets_split_eh/README.md deleted file mode 100644 index 180cb33d73..0000000000 --- a/keyboards/lets_split_eh/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# Let's Split Eh? - -![Let's Split Eh?](https://i.imgur.com/VMQG4qw.jpg?1) - -This is a split 40% ortho board. It is the exact same footprint and the Let's Split keyboard by wootpatoot. This board has USB-C / RGB Underglow / and is all on-board. Meant as a drop-in replacement for the V2 Let's Split. - -Keyboard Maintainer: [Christopher Poole (That-Canadian)](https://github.com/That-Canadian) - -Make example for this keyboard (after setting up your build environment): - - make lets_split_eh/eh:default - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. \ No newline at end of file diff --git a/keyboards/lets_split_eh/readme.md b/keyboards/lets_split_eh/readme.md new file mode 100644 index 0000000000..180cb33d73 --- /dev/null +++ b/keyboards/lets_split_eh/readme.md @@ -0,0 +1,13 @@ +# Let's Split Eh? + +![Let's Split Eh?](https://i.imgur.com/VMQG4qw.jpg?1) + +This is a split 40% ortho board. It is the exact same footprint and the Let's Split keyboard by wootpatoot. This board has USB-C / RGB Underglow / and is all on-board. Meant as a drop-in replacement for the V2 Let's Split. + +Keyboard Maintainer: [Christopher Poole (That-Canadian)](https://github.com/That-Canadian) + +Make example for this keyboard (after setting up your build environment): + + make lets_split_eh/eh:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. \ No newline at end of file diff --git a/keyboards/mechmini/v1/README.md b/keyboards/mechmini/v1/README.md deleted file mode 100644 index 902948c24d..0000000000 --- a/keyboards/mechmini/v1/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Mechmini V1 - -A 40% ortholinear/staggered keyboard, that was originally bootmapper and can be ported to QMK following this readme. This version is no longer in production [More info on MECHKEYS](https://mechkeys.ca). - -* Keyboard Maintainer: QMK Community -* Hardware Supported: Mechmini 1 PCB -* Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca) - -Make example for this keyboard (after setting up your build environment): - - make mechmini/v1:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make mechmini/v1:default:flash - -**Reset Key**: Hold down the key commonly programmed as *L_Ctrl* while plugging in the keyboard. - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/mechmini/v1/readme.md b/keyboards/mechmini/v1/readme.md new file mode 100644 index 0000000000..902948c24d --- /dev/null +++ b/keyboards/mechmini/v1/readme.md @@ -0,0 +1,19 @@ +# Mechmini V1 + +A 40% ortholinear/staggered keyboard, that was originally bootmapper and can be ported to QMK following this readme. This version is no longer in production [More info on MECHKEYS](https://mechkeys.ca). + +* Keyboard Maintainer: QMK Community +* Hardware Supported: Mechmini 1 PCB +* Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca) + +Make example for this keyboard (after setting up your build environment): + + make mechmini/v1:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make mechmini/v1:default:flash + +**Reset Key**: Hold down the key commonly programmed as *L_Ctrl* while plugging in the keyboard. + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/mechmini/v2/README.md b/keyboards/mechmini/v2/README.md deleted file mode 100644 index fdc9fef9bf..0000000000 --- a/keyboards/mechmini/v2/README.md +++ /dev/null @@ -1,22 +0,0 @@ -Mechmini 2.0 -============ - -A 40% compact ortholinear/staggered keyboard. - -Version 2 (Mechmini 2.0) was shipped powered by QMK [More info on MECHKEYS](https://mechkeys.ca). - -Keyboard Maintainer: [TurboMech](https://github.com/TurboMech) - -Hardware Supported: Mechmini 2.0 keyboard - -Hardware Availability: [MECHKEYS Mechmini 2.0](https://mechkeys.ca/collections/keyboards/products/mechmini-2-0) - -Make example for this keyboard (after setting up your build environment), this will make the Mechmini 2.0 default keymap (split space): - - make mechmini/v2:default - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. - -## Mechmini Notes - -There are 2 versions of the Mechmini keyboard. Please read the readme for the version you have for make instructions. diff --git a/keyboards/mechmini/v2/readme.md b/keyboards/mechmini/v2/readme.md new file mode 100644 index 0000000000..fdc9fef9bf --- /dev/null +++ b/keyboards/mechmini/v2/readme.md @@ -0,0 +1,22 @@ +Mechmini 2.0 +============ + +A 40% compact ortholinear/staggered keyboard. + +Version 2 (Mechmini 2.0) was shipped powered by QMK [More info on MECHKEYS](https://mechkeys.ca). + +Keyboard Maintainer: [TurboMech](https://github.com/TurboMech) + +Hardware Supported: Mechmini 2.0 keyboard + +Hardware Availability: [MECHKEYS Mechmini 2.0](https://mechkeys.ca/collections/keyboards/products/mechmini-2-0) + +Make example for this keyboard (after setting up your build environment), this will make the Mechmini 2.0 default keymap (split space): + + make mechmini/v2:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. + +## Mechmini Notes + +There are 2 versions of the Mechmini keyboard. Please read the readme for the version you have for make instructions. diff --git a/keyboards/mschwingen/modelm/README.md b/keyboards/mschwingen/modelm/README.md deleted file mode 100644 index f4cb360625..0000000000 --- a/keyboards/mschwingen/modelm/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# atmega32U4 board for IBM Model M - -![modelm](https://raw.githubusercontent.com/mschwingen/hardware/master/modelm-usb/images/PCB.jpg) - -This is a configuration of QMK intended to be used with the [Model M USB PCB](https://github.com/mschwingen/hardware/tree/master/modelm-usb). - -* Keyboard Maintainer: [Michael Schwingen](https://github.com/mschwingen/) -* Hardware Supported: [Model M USB PCB](https://github.com/mschwingen/hardware/tree/master/modelm-usb) -* Hardware Availability: need to build your own. - -Make example for this keyboard (after setting up your build environment), run one of: - - make mschwingen/modelm/led_wired:default - make mschwingen/modelm/led_ffc:default - make mschwingen/modelm/led_ws2812:default - -flash: - - make mschwingen/modelm/led_wired:default:flash - make mschwingen/modelm/led_ffc:default:flash - make mschwingen/modelm/led_ws2812:default:flash - -Bootloader: do not use the QMK bootloader, use the bootloader from [here](https://github.com/mschwingen/modelm-lufa-bootloader) - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/mschwingen/modelm/readme.md b/keyboards/mschwingen/modelm/readme.md new file mode 100644 index 0000000000..f4cb360625 --- /dev/null +++ b/keyboards/mschwingen/modelm/readme.md @@ -0,0 +1,25 @@ +# atmega32U4 board for IBM Model M + +![modelm](https://raw.githubusercontent.com/mschwingen/hardware/master/modelm-usb/images/PCB.jpg) + +This is a configuration of QMK intended to be used with the [Model M USB PCB](https://github.com/mschwingen/hardware/tree/master/modelm-usb). + +* Keyboard Maintainer: [Michael Schwingen](https://github.com/mschwingen/) +* Hardware Supported: [Model M USB PCB](https://github.com/mschwingen/hardware/tree/master/modelm-usb) +* Hardware Availability: need to build your own. + +Make example for this keyboard (after setting up your build environment), run one of: + + make mschwingen/modelm/led_wired:default + make mschwingen/modelm/led_ffc:default + make mschwingen/modelm/led_ws2812:default + +flash: + + make mschwingen/modelm/led_wired:default:flash + make mschwingen/modelm/led_ffc:default:flash + make mschwingen/modelm/led_ws2812:default:flash + +Bootloader: do not use the QMK bootloader, use the bootloader from [here](https://github.com/mschwingen/modelm-lufa-bootloader) + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/noxary/README.md b/keyboards/noxary/README.md deleted file mode 100644 index 8dbd85f7ef..0000000000 --- a/keyboards/noxary/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Noxary Firmware - -All files related to firmware of Noxary Keyboards designed by [Rozakiin](https://github.com/rozakiin). - -### Keyboards - -- [268](./268/): Original repo [here](https://github.com/Rozakiin/Noxary_Firmware). Imported by kind [permission](https://github.com/Rozakiin/Noxary_Firmware/issues/1) of @rozakiin - -- [268.2](./268_2/): Original repo [here](https://github.com/Rozakiin/Noxary_Firmware). Imported by kind [permission](https://github.com/Rozakiin/Noxary_Firmware/issues/1) of @rozakiin - -- [x268](./x268/): Original repo [here](https://github.com/Rozakiin/Noxary_Firmware). Imported by kind [permission](https://github.com/Rozakiin/Noxary_Firmware/issues/1) of @rozakiin diff --git a/keyboards/noxary/readme.md b/keyboards/noxary/readme.md new file mode 100644 index 0000000000..8dbd85f7ef --- /dev/null +++ b/keyboards/noxary/readme.md @@ -0,0 +1,11 @@ +# Noxary Firmware + +All files related to firmware of Noxary Keyboards designed by [Rozakiin](https://github.com/rozakiin). + +### Keyboards + +- [268](./268/): Original repo [here](https://github.com/Rozakiin/Noxary_Firmware). Imported by kind [permission](https://github.com/Rozakiin/Noxary_Firmware/issues/1) of @rozakiin + +- [268.2](./268_2/): Original repo [here](https://github.com/Rozakiin/Noxary_Firmware). Imported by kind [permission](https://github.com/Rozakiin/Noxary_Firmware/issues/1) of @rozakiin + +- [x268](./x268/): Original repo [here](https://github.com/Rozakiin/Noxary_Firmware). Imported by kind [permission](https://github.com/Rozakiin/Noxary_Firmware/issues/1) of @rozakiin diff --git a/keyboards/nullbitsco/nibble/README.md b/keyboards/nullbitsco/nibble/README.md deleted file mode 100644 index 92825847d6..0000000000 --- a/keyboards/nullbitsco/nibble/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# NIBBLE - -![NIBBLE](https://nullbits.co/static/img/nibble1.jpg) - -A unique, tweakable 65% keyboard kit built by nullbits. [More info at nullbits.co](https://nullbits.co/nibble/) - -* Keyboard Maintainer: [Jay Greco](https://github.com/jaygreco) -* Hardware Supported: NIBBLE Rev1, Pro Micro comaptible MCUs. -* Hardware Availability: [nullbits.co](https://nullbits.co/) - -Note: If you are seeing issues with MacOS and keyboard hangs after sleep, make sure `NO_USB_STARTUP_CHECK = yes` is set in your rules.mk. - -Adds experimental "Remote Keyboard" functionality, which forwards keystrokes from an external macropad, keyboard, or numpad over UART/TRRS, removing the need for an additional USB connection. - -Make example for this keyboard (after setting up your build environment): - - make nullbitsco/nibble:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/nullbitsco/nibble/readme.md b/keyboards/nullbitsco/nibble/readme.md new file mode 100644 index 0000000000..92825847d6 --- /dev/null +++ b/keyboards/nullbitsco/nibble/readme.md @@ -0,0 +1,19 @@ +# NIBBLE + +![NIBBLE](https://nullbits.co/static/img/nibble1.jpg) + +A unique, tweakable 65% keyboard kit built by nullbits. [More info at nullbits.co](https://nullbits.co/nibble/) + +* Keyboard Maintainer: [Jay Greco](https://github.com/jaygreco) +* Hardware Supported: NIBBLE Rev1, Pro Micro comaptible MCUs. +* Hardware Availability: [nullbits.co](https://nullbits.co/) + +Note: If you are seeing issues with MacOS and keyboard hangs after sleep, make sure `NO_USB_STARTUP_CHECK = yes` is set in your rules.mk. + +Adds experimental "Remote Keyboard" functionality, which forwards keystrokes from an external macropad, keyboard, or numpad over UART/TRRS, removing the need for an additional USB connection. + +Make example for this keyboard (after setting up your build environment): + + make nullbitsco/nibble:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/percent/skog/README.md b/keyboards/percent/skog/README.md deleted file mode 100644 index 9f76110cde..0000000000 --- a/keyboards/percent/skog/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Skog TKL - -* Keyboard Maintainer: QMK Community -* Hardware Supported: Skog PCB -* Hardware Availability: - -Make example for this keyboard (after setting up your build environment): - - make percent/skog:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make percent/skog:default:flash - -**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Pause* while plugging in the keyboard. - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/percent/skog/readme.md b/keyboards/percent/skog/readme.md new file mode 100644 index 0000000000..9f76110cde --- /dev/null +++ b/keyboards/percent/skog/readme.md @@ -0,0 +1,17 @@ +# Skog TKL + +* Keyboard Maintainer: QMK Community +* Hardware Supported: Skog PCB +* Hardware Availability: + +Make example for this keyboard (after setting up your build environment): + + make percent/skog:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make percent/skog:default:flash + +**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Pause* while plugging in the keyboard. + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/switchplate/README.md b/keyboards/switchplate/README.md deleted file mode 100644 index 166853f285..0000000000 --- a/keyboards/switchplate/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Switchplate Peripherals -All keyboards under the Switchplate Peripherals brand - -Website: [here](https://switchplate.co/) \ No newline at end of file diff --git a/keyboards/switchplate/readme.md b/keyboards/switchplate/readme.md new file mode 100644 index 0000000000..166853f285 --- /dev/null +++ b/keyboards/switchplate/readme.md @@ -0,0 +1,4 @@ +# Switchplate Peripherals +All keyboards under the Switchplate Peripherals brand + +Website: [here](https://switchplate.co/) \ No newline at end of file diff --git a/keyboards/terrazzo/README.md b/keyboards/terrazzo/README.md deleted file mode 100644 index 08cecd6a64..0000000000 --- a/keyboards/terrazzo/README.md +++ /dev/null @@ -1,125 +0,0 @@ -# Terrazzo - -![Terrazzo](https://i.imgur.com/W91ixck.jpg) - -Terrazzo is a 40% pro micro keyboard kit with a fun, hot-swapable LED module. It is offered in both staggered and ortholinear variations, each with multiple layout options. A left hand macro column has 4 positions for switches or rotary encoders. - -Extended layout options and multiple encoder support will require use of an Elite-C controller. Key switch support is MX soldered only. - -* Keyboard Maintainer: MsMustard, [Anne Demey](https://github.com/ademey) -* Hardware Supported: Terrazzo v1 & v2 PCB in staggered and ortholinear - -Make example for this keyboard (after setting up your build environment): - -- `make terrazzo:default` Split spacebar staggered layout -- `make terrazzo:ortho` 2 x 2u spacebar ortho layout -- `make terrazzo:ortho_mit` 2u spacebar ortho layout -- `make terrazzo:ortho_all` All 1u ortho layout - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). - -## Parts List -- 1 PCB (staggered or ortho) -- 1 LED module ([red](https://www.digikey.com/product-detail/en/adafruit-industries-llc/3134/1528-1699-ND/6058480), [green](https://www.digikey.com/product-detail/en/adafruit-industries-llc/3136/1528-1701-ND/6058482), [yellow](https://www.digikey.com/short/zbttp5), [blue](https://www.digikey.com/product-detail/en/adafruit-industries-llc/3137/1528-1702-ND/6058483), or [white](https://www.digikey.com/product-detail/en/adafruit-industries-llc/3138/1528-1703-ND/6058484)) -- [1 Rotary encoder](https://www.digikey.com/short/zbttzn) -- 1 Knurled knob ([black](https://www.digikey.com/short/zbttz4) or [silver](https://www.digikey.com/short/zbttz4)) -- [SMD diodes](https://www.digikey.com/short/zbttzr) -- [Reset switch](https://www.digikey.com/short/zbttz1) -- Mill-max female headers ([12](https://www.digikey.com/short/zbtt42) & [5](https://www.digikey.com/short/zbttmt) pins) and [through-hole diodes](https://www.digikey.com/short/zbttmj) to aid in socketing a pro micro -- Mill-max [male](https://www.digikey.com/short/zbttm5) & [female](https://www.digikey.com/short/zbttm4) headers for LED module - -## Custom Keycodes - -Terrazzo has several custom keycodes for LED control. - -| Key | Description | -|-----|-------------| -| `TZ_NXT` | Next Animation | -| `TZ_PRV` | Previous Animation | -| `TZ_OFF` | LED Off | - -## LED Animations - -LED animations for Terrazzo are reactive to keyboard input. Each key press or encoder turn increments an internal counter, looping through the number of individual LEDs. - -This counter (`terrazzo_led_index`) is used as a seed for the animation functions, along with a boolean indicating the direction. Turning the encoder counter-clockwise, or pressing backspace will decrement the counter, allowing for animations to reverse or display alternative frames. - -The current animations are: - -- DINO: It's like your internet went out -- DOT: Just a single led at a time, for debugging -- HEART: Love you too -- OUTRUN: Driving into the sunset -- PAC_DUDE: Vintage arcade fun -- STRIPES: Just a nice gradient -- WPM_CHART: 2 digit readout with lights indicating speed, each pixel = 2 wpm - -Not all animations are enabled by default. You can enable or disable animations in the `config.h` file to limit firmware size. - -``` -// #define DISABLE_TERRAZZO_EFFECT_STRIPES -// #define DISABLE_TERRAZZO_EFFECT_DINO -// #define DISABLE_TERRAZZO_EFFECT_OUTRUN -#define DISABLE_TERRAZZO_EFFECT_PAC_DUDE -#define DISABLE_TERRAZZO_EFFECT_HEART -// #define DISABLE_TERRAZZO_EFFECT_WPM_CHART -#define DISABLE_TERRAZZO_EFFECT_DOT -``` - -## Microcontroller Support - -Terrazzo is designed for use with a Pro Micro (or compatible, like Bit-C), or an Elite-C. The extra pinouts of an Elite-C are required for the ortho MIT and ALL layouts and multiple encoders. By default the firmware is set up for an Elite-C. For a Pro Micro some changes to `config.h` are needed. - -Change number of rows from 9 to 8. -``` -#define MATRIX_ROWS 8 -``` - -Change pinouts, Pro Micro does not have the "F0" pin. -``` -#define MATRIX_ROW_PINS { D2, D7, E6, B4, B5, B6, B2, B3 } -``` - -Set encoder to just top or bottom position. -``` -#define ENCODERS_PAD_A { C6 } -#define ENCODERS_PAD_B { D4 } -``` - -## Encoder Setup - -Terrazzo has 4 positions for encoders in the left-hand column. Up to 3 may be used at a time, but this requires the extra pins of an Elite-C. Please refer to `config.h` for examples of pin configurations. - -The default keymaps are setup for one encoder. Encoders can change behavior based on the current layer. Here, on the "NAV" layer, the encoder changes volume instead of scrolling. - -```c -void encoder_update_user(uint8_t index, bool clockwise) { - terrazzo_scroll_pixel(clockwise); - switch(get_highest_layer(layer_state)) { - case _NAV: - // Change volume when on nav layer - clockwise ? tap_code(KC_AUDIO_VOL_UP) : tap_code(KC_AUDIO_VOL_DOWN); - break; - default: - // Default encoder behavior of Page Up and Down - clockwise ? tap_code(KC_PGDN) : tap_code(KC_PGUP); - break; - } -} -``` - -If using multiple encoders, the `index` param can be used to distingish which is providing input. - -```c -void encoder_update_user(uint8_t index, bool clockwise) { - terrazzo_scroll_pixel(clockwise); - switch(index) { - case 0: - clockwise ? tap_code(KC_PGDN) : tap_code(KC_PGUP); - break; - case 1: - clockwise ? tap_code(KC_AUDIO_VOL_UP) : tap_code(KC_AUDIO_VOL_DOWN); - break; - } -} -``` \ No newline at end of file diff --git a/keyboards/terrazzo/readme.md b/keyboards/terrazzo/readme.md new file mode 100644 index 0000000000..08cecd6a64 --- /dev/null +++ b/keyboards/terrazzo/readme.md @@ -0,0 +1,125 @@ +# Terrazzo + +![Terrazzo](https://i.imgur.com/W91ixck.jpg) + +Terrazzo is a 40% pro micro keyboard kit with a fun, hot-swapable LED module. It is offered in both staggered and ortholinear variations, each with multiple layout options. A left hand macro column has 4 positions for switches or rotary encoders. + +Extended layout options and multiple encoder support will require use of an Elite-C controller. Key switch support is MX soldered only. + +* Keyboard Maintainer: MsMustard, [Anne Demey](https://github.com/ademey) +* Hardware Supported: Terrazzo v1 & v2 PCB in staggered and ortholinear + +Make example for this keyboard (after setting up your build environment): + +- `make terrazzo:default` Split spacebar staggered layout +- `make terrazzo:ortho` 2 x 2u spacebar ortho layout +- `make terrazzo:ortho_mit` 2u spacebar ortho layout +- `make terrazzo:ortho_all` All 1u ortho layout + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +## Parts List +- 1 PCB (staggered or ortho) +- 1 LED module ([red](https://www.digikey.com/product-detail/en/adafruit-industries-llc/3134/1528-1699-ND/6058480), [green](https://www.digikey.com/product-detail/en/adafruit-industries-llc/3136/1528-1701-ND/6058482), [yellow](https://www.digikey.com/short/zbttp5), [blue](https://www.digikey.com/product-detail/en/adafruit-industries-llc/3137/1528-1702-ND/6058483), or [white](https://www.digikey.com/product-detail/en/adafruit-industries-llc/3138/1528-1703-ND/6058484)) +- [1 Rotary encoder](https://www.digikey.com/short/zbttzn) +- 1 Knurled knob ([black](https://www.digikey.com/short/zbttz4) or [silver](https://www.digikey.com/short/zbttz4)) +- [SMD diodes](https://www.digikey.com/short/zbttzr) +- [Reset switch](https://www.digikey.com/short/zbttz1) +- Mill-max female headers ([12](https://www.digikey.com/short/zbtt42) & [5](https://www.digikey.com/short/zbttmt) pins) and [through-hole diodes](https://www.digikey.com/short/zbttmj) to aid in socketing a pro micro +- Mill-max [male](https://www.digikey.com/short/zbttm5) & [female](https://www.digikey.com/short/zbttm4) headers for LED module + +## Custom Keycodes + +Terrazzo has several custom keycodes for LED control. + +| Key | Description | +|-----|-------------| +| `TZ_NXT` | Next Animation | +| `TZ_PRV` | Previous Animation | +| `TZ_OFF` | LED Off | + +## LED Animations + +LED animations for Terrazzo are reactive to keyboard input. Each key press or encoder turn increments an internal counter, looping through the number of individual LEDs. + +This counter (`terrazzo_led_index`) is used as a seed for the animation functions, along with a boolean indicating the direction. Turning the encoder counter-clockwise, or pressing backspace will decrement the counter, allowing for animations to reverse or display alternative frames. + +The current animations are: + +- DINO: It's like your internet went out +- DOT: Just a single led at a time, for debugging +- HEART: Love you too +- OUTRUN: Driving into the sunset +- PAC_DUDE: Vintage arcade fun +- STRIPES: Just a nice gradient +- WPM_CHART: 2 digit readout with lights indicating speed, each pixel = 2 wpm + +Not all animations are enabled by default. You can enable or disable animations in the `config.h` file to limit firmware size. + +``` +// #define DISABLE_TERRAZZO_EFFECT_STRIPES +// #define DISABLE_TERRAZZO_EFFECT_DINO +// #define DISABLE_TERRAZZO_EFFECT_OUTRUN +#define DISABLE_TERRAZZO_EFFECT_PAC_DUDE +#define DISABLE_TERRAZZO_EFFECT_HEART +// #define DISABLE_TERRAZZO_EFFECT_WPM_CHART +#define DISABLE_TERRAZZO_EFFECT_DOT +``` + +## Microcontroller Support + +Terrazzo is designed for use with a Pro Micro (or compatible, like Bit-C), or an Elite-C. The extra pinouts of an Elite-C are required for the ortho MIT and ALL layouts and multiple encoders. By default the firmware is set up for an Elite-C. For a Pro Micro some changes to `config.h` are needed. + +Change number of rows from 9 to 8. +``` +#define MATRIX_ROWS 8 +``` + +Change pinouts, Pro Micro does not have the "F0" pin. +``` +#define MATRIX_ROW_PINS { D2, D7, E6, B4, B5, B6, B2, B3 } +``` + +Set encoder to just top or bottom position. +``` +#define ENCODERS_PAD_A { C6 } +#define ENCODERS_PAD_B { D4 } +``` + +## Encoder Setup + +Terrazzo has 4 positions for encoders in the left-hand column. Up to 3 may be used at a time, but this requires the extra pins of an Elite-C. Please refer to `config.h` for examples of pin configurations. + +The default keymaps are setup for one encoder. Encoders can change behavior based on the current layer. Here, on the "NAV" layer, the encoder changes volume instead of scrolling. + +```c +void encoder_update_user(uint8_t index, bool clockwise) { + terrazzo_scroll_pixel(clockwise); + switch(get_highest_layer(layer_state)) { + case _NAV: + // Change volume when on nav layer + clockwise ? tap_code(KC_AUDIO_VOL_UP) : tap_code(KC_AUDIO_VOL_DOWN); + break; + default: + // Default encoder behavior of Page Up and Down + clockwise ? tap_code(KC_PGDN) : tap_code(KC_PGUP); + break; + } +} +``` + +If using multiple encoders, the `index` param can be used to distingish which is providing input. + +```c +void encoder_update_user(uint8_t index, bool clockwise) { + terrazzo_scroll_pixel(clockwise); + switch(index) { + case 0: + clockwise ? tap_code(KC_PGDN) : tap_code(KC_PGUP); + break; + case 1: + clockwise ? tap_code(KC_AUDIO_VOL_UP) : tap_code(KC_AUDIO_VOL_DOWN); + break; + } +} +``` \ No newline at end of file diff --git a/keyboards/thevankeyboards/bananasplit/README.md b/keyboards/thevankeyboards/bananasplit/README.md deleted file mode 100644 index 41d0d407db..0000000000 --- a/keyboards/thevankeyboards/bananasplit/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# BananaSplit60 - -A 60% PCB featuring a split spacebar. - -Keyboard Maintainer: QMK Community -Hardware Supported: BananaSplit60 PCB -Hardware Availability: https://thevankeyboards.com/products/gb-bananasplit-60-keyboard-kit?variant=42149104910 - -Make example for this keyboard (after setting up your build environment): - - make thevankeyboards/bananasplit:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). - diff --git a/keyboards/thevankeyboards/bananasplit/readme.md b/keyboards/thevankeyboards/bananasplit/readme.md new file mode 100644 index 0000000000..41d0d407db --- /dev/null +++ b/keyboards/thevankeyboards/bananasplit/readme.md @@ -0,0 +1,14 @@ +# BananaSplit60 + +A 60% PCB featuring a split spacebar. + +Keyboard Maintainer: QMK Community +Hardware Supported: BananaSplit60 PCB +Hardware Availability: https://thevankeyboards.com/products/gb-bananasplit-60-keyboard-kit?variant=42149104910 + +Make example for this keyboard (after setting up your build environment): + + make thevankeyboards/bananasplit:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + diff --git a/keyboards/tkc/m0lly/README.md b/keyboards/tkc/m0lly/README.md deleted file mode 100644 index 9af80c7e98..0000000000 --- a/keyboards/tkc/m0lly/README.md +++ /dev/null @@ -1,17 +0,0 @@ -The Key Company M0LLY - -[TKC M0LLY](https://cdn.shopify.com/s/files/1/1679/2319/files/Molly_Terminal_1024x1024.jpg?v=1529067702) - - -The Key Company's M0LLY keyboard is inspired by the Apple Macintosh M0110A, and utilizes the AT90USB1286 microcontroller. - -Keyboard Maintainer: [Terry Mathews](https://github.com/TerryMathews/) -Hardware Supported: TKC M0LLY -Hardware Availability: [TheKey.Company](https://thekey.company) - - -Make example for this keyboard (after setting up your build environment): - - make tkc/m0lly:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/tkc/m0lly/readme.md b/keyboards/tkc/m0lly/readme.md new file mode 100644 index 0000000000..9af80c7e98 --- /dev/null +++ b/keyboards/tkc/m0lly/readme.md @@ -0,0 +1,17 @@ +The Key Company M0LLY + +[TKC M0LLY](https://cdn.shopify.com/s/files/1/1679/2319/files/Molly_Terminal_1024x1024.jpg?v=1529067702) + + +The Key Company's M0LLY keyboard is inspired by the Apple Macintosh M0110A, and utilizes the AT90USB1286 microcontroller. + +Keyboard Maintainer: [Terry Mathews](https://github.com/TerryMathews/) +Hardware Supported: TKC M0LLY +Hardware Availability: [TheKey.Company](https://thekey.company) + + +Make example for this keyboard (after setting up your build environment): + + make tkc/m0lly:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/tkc/osav2/README.md b/keyboards/tkc/osav2/README.md deleted file mode 100644 index 749ffe0870..0000000000 --- a/keyboards/tkc/osav2/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# TKC OSA v2 (One Sweet Alice) - -![OSA v2](https://i.imgur.com/U2x7TQ8.jpg) - -The TKC OSA v2 is an ATMega32u4 powered, USB Type C, Alice compatible PCB and was created specifically for the OSA case, but with considerations to make it compatible with the Lubrigante acrylic cases (except for the Type C connector it should also be compatible with original TGR Alice cases). - -* Keyboard Maintainer: [Terry Mathews](https://github.com/TerryMathews/) -* Hardware Supported: TKC OSA v2 PCB -* Hardware Availability: https://thekey.company/collections/osav2-keyboard - -Make example for this keyboard (after setting up your build environment): - - make tkc/osav2:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/tkc/osav2/readme.md b/keyboards/tkc/osav2/readme.md new file mode 100644 index 0000000000..749ffe0870 --- /dev/null +++ b/keyboards/tkc/osav2/readme.md @@ -0,0 +1,15 @@ +# TKC OSA v2 (One Sweet Alice) + +![OSA v2](https://i.imgur.com/U2x7TQ8.jpg) + +The TKC OSA v2 is an ATMega32u4 powered, USB Type C, Alice compatible PCB and was created specifically for the OSA case, but with considerations to make it compatible with the Lubrigante acrylic cases (except for the Type C connector it should also be compatible with original TGR Alice cases). + +* Keyboard Maintainer: [Terry Mathews](https://github.com/TerryMathews/) +* Hardware Supported: TKC OSA v2 PCB +* Hardware Availability: https://thekey.company/collections/osav2-keyboard + +Make example for this keyboard (after setting up your build environment): + + make tkc/osav2:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/tkc/tkc1800/README.md b/keyboards/tkc/tkc1800/README.md deleted file mode 100644 index 5382b91b3c..0000000000 --- a/keyboards/tkc/tkc1800/README.md +++ /dev/null @@ -1,17 +0,0 @@ -The Key Company TKC1800 - -[TKC1800 Image Gallery](https://imgur.com/a/Xlttp) - - -The Key Company TKC1800 is a Cherry 1800 form factor replacement PCB utilizing the AT90USB1286 microcontroller. - -Keyboard Maintainer: [Terry Mathews](https://github.com/TerryMathews/) -Hardware Supported: TKC1800 PCB -Hardware Availability: [TheKey.Company](https://thekey.company/collections/tkc-1800) - - -Make example for this keyboard (after setting up your build environment): - - make tkc/tkc1800:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/tkc/tkc1800/readme.md b/keyboards/tkc/tkc1800/readme.md new file mode 100644 index 0000000000..5382b91b3c --- /dev/null +++ b/keyboards/tkc/tkc1800/readme.md @@ -0,0 +1,17 @@ +The Key Company TKC1800 + +[TKC1800 Image Gallery](https://imgur.com/a/Xlttp) + + +The Key Company TKC1800 is a Cherry 1800 form factor replacement PCB utilizing the AT90USB1286 microcontroller. + +Keyboard Maintainer: [Terry Mathews](https://github.com/TerryMathews/) +Hardware Supported: TKC1800 PCB +Hardware Availability: [TheKey.Company](https://thekey.company/collections/tkc-1800) + + +Make example for this keyboard (after setting up your build environment): + + make tkc/tkc1800:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/wheatfield/split75/README.md b/keyboards/wheatfield/split75/README.md deleted file mode 100644 index ec8c7ee9ea..0000000000 --- a/keyboards/wheatfield/split75/README.md +++ /dev/null @@ -1,28 +0,0 @@ -# split75 - -![split75](https://i1.wp.com/mechboards.co.uk/wp-content/uploads/2019/10/HTB1qf0aSOLaK1RjSZFxq6ymPFXae.jpg) - -This is a port of the QMK firmware for the split75 keyboard, also known as the ve.a taobao split clone. It runs on -ps2avrGB firmware, like the [ps2avrGB keyboard](https://www.keyclack.com/product/gb-ps2avrgb/) or the ones sold -by [Winkeyless](http://winkeyless.kr/product/ps2avrgb-parts/). - -Original work performed by Michael L. Walker, all credit goes to him. I've tidied up the keymap (removed 3 extra keys), a couple of functions, info.json and this Readme. - -* Keyboard Maintainer: [Michael L. Walker](https://github.com/walkerstop) -* Hardware Availability: https://a.aliexpress.com/_BT9raf https://item.taobao.com/item.htm?id=556970472669&toSite=main - -Make example for this keyboard (after setting up your build environment): - - make wheatfield/split75:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make wheatfield/split75:default:flash - -or - - bootloadHID -r split75_default.hex - -**Reset Key**: Hold down the key located at 3rd left position in the bottom row, commonly programmed as Left Control while plugging in the keyboard. - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/wheatfield/split75/readme.md b/keyboards/wheatfield/split75/readme.md new file mode 100644 index 0000000000..ec8c7ee9ea --- /dev/null +++ b/keyboards/wheatfield/split75/readme.md @@ -0,0 +1,28 @@ +# split75 + +![split75](https://i1.wp.com/mechboards.co.uk/wp-content/uploads/2019/10/HTB1qf0aSOLaK1RjSZFxq6ymPFXae.jpg) + +This is a port of the QMK firmware for the split75 keyboard, also known as the ve.a taobao split clone. It runs on +ps2avrGB firmware, like the [ps2avrGB keyboard](https://www.keyclack.com/product/gb-ps2avrgb/) or the ones sold +by [Winkeyless](http://winkeyless.kr/product/ps2avrgb-parts/). + +Original work performed by Michael L. Walker, all credit goes to him. I've tidied up the keymap (removed 3 extra keys), a couple of functions, info.json and this Readme. + +* Keyboard Maintainer: [Michael L. Walker](https://github.com/walkerstop) +* Hardware Availability: https://a.aliexpress.com/_BT9raf https://item.taobao.com/item.htm?id=556970472669&toSite=main + +Make example for this keyboard (after setting up your build environment): + + make wheatfield/split75:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make wheatfield/split75:default:flash + +or + + bootloadHID -r split75_default.hex + +**Reset Key**: Hold down the key located at 3rd left position in the bottom row, commonly programmed as Left Control while plugging in the keyboard. + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/winkeyless/bface/README.md b/keyboards/winkeyless/bface/README.md deleted file mode 100644 index ab39a97db0..0000000000 --- a/keyboards/winkeyless/bface/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# B.face - -A 60% keyboard with RGB that runs ps2avrgb natively. Please note that the B.face and B.fake have different switch matrices. Firmware on one, will not work on the other. - -* Keyboard Maintainer: QMK Community -* Hardware Supported: B.face PCB -* Hardware Availability: [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/) - -Make example for this keyboard (after setting up your build environment): - - make winkeyless/bface:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make winkeyless/bface:default:flash - -**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard. - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/winkeyless/bface/readme.md b/keyboards/winkeyless/bface/readme.md new file mode 100644 index 0000000000..ab39a97db0 --- /dev/null +++ b/keyboards/winkeyless/bface/readme.md @@ -0,0 +1,19 @@ +# B.face + +A 60% keyboard with RGB that runs ps2avrgb natively. Please note that the B.face and B.fake have different switch matrices. Firmware on one, will not work on the other. + +* Keyboard Maintainer: QMK Community +* Hardware Supported: B.face PCB +* Hardware Availability: [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/) + +Make example for this keyboard (after setting up your build environment): + + make winkeyless/bface:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make winkeyless/bface:default:flash + +**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard. + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/xiaomi/mk02/README.md b/keyboards/xiaomi/mk02/README.md deleted file mode 100644 index 2dea99ff19..0000000000 --- a/keyboards/xiaomi/mk02/README.md +++ /dev/null @@ -1,104 +0,0 @@ -# Xiaomi Yuemi Pro MK02 - -A tenkeyless keyboard sold under Xiaomi brand. It uses an STM32F072C8T6 microcontroller and can be flashed with QMK. - -LED backlight is currently not supported. - -* Keyboard Maintainer: [@xyzz](https://github.com/xyzz) -* Hardware Supported: Xiaomi Yuemi Pro MK02 -* Hardware Availability: Aliexpress - -Make example for this keyboard (after setting up your build environment): - - make xiaomi/mk02:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). - -## Installation - -Please understand that following these steps will void your warranty and might irrecoverably damage your keyboard. - -### Installing the bootloader - -You only need to do this step once (unless you destroy your user bootloader which is not possible so long as you follow these steps correctly). - -Unplug the keyboard. Disassemble the keyboard and look at the area around the MCU. Make sure your keyboard looks the same as in the picture and that the chip says STM32F072C8T6 on it: - -![mcu](https://i.imgur.com/HM8tUWU.jpg) - -Using a piece of wire, connect TP28 (indicated in red) and 3v3 (square pad indicated in green) together with tweezers or a piece of wire. Make sure to not touch the case with your wire when shorting!!! Don't push it all the way through the hole. - -Plug the keyboard in with the wire connected. You should see the following device appear: -``` -[5067851.560317] usb 2-1.5.3.1: new full-speed USB device number 6 using ehci-pci -[5067851.670006] usb 2-1.5.3.1: New USB device found, idVendor=0483, idProduct=df11, bcdDevice=22.00 -[5067851.670010] usb 2-1.5.3.1: New USB device strings: Mfr=1, Product=2, SerialNumber=3 -[5067851.670013] usb 2-1.5.3.1: Product: STM32 BOOTLOADER -[5067851.670015] usb 2-1.5.3.1: Manufacturer: STMicroelectronics -[5067851.670017] usb 2-1.5.3.1: SerialNumber: FFFFFFFEFFFF -``` - -If you don't see this, you did something wrong. Disconnect the keyboard and try again. - -If you do see this, remove the wire before continuing. - -Make a backup of internal flash memory in case you'd like to revert to the original firmware in the future: -``` -dfu-util -d 0483:df11 -a 0 -s 0x08000000 -U flash-backup.bin -``` - -Ensure the dumped flash is correct: -``` -strings flash.bin | grep KB -``` -(You should see 2 entries of "USB KB") - -Finally, flash the bootloader ([jumploader-xiaomi_mk02-padded.bin](https://github.com/xyzz/stm32f072-keyboard-jumploader/releases/download/r1/jumploader-xiaomi_mk02-padded.bin)) with: -``` -dfu-util -d 0483:df11 -a 0 -s 0x08000000:leave -D jumploader-xiaomi_mk02-padded.bin -``` - -At this point the keyboard should reboot into bootloader mode; if it doesn't, wait a couple seconds and replug the USB cable. - -### Installing the firmware - -To install QMK, first boot into bootloader mode as detailed below. When the keyboard boots in bootloader mode, you should see the following device: - -``` -[5067851.560317] usb 2-1.5.3.1: new full-speed USB device number 6 using ehci-pci -[5067851.670006] usb 2-1.5.3.1: New USB device found, idVendor=0483, idProduct=df11, bcdDevice=22.00 -[5067851.670010] usb 2-1.5.3.1: New USB device strings: Mfr=1, Product=2, SerialNumber=3 -[5067851.670013] usb 2-1.5.3.1: Product: STM32 BOOTLOADER -[5067851.670015] usb 2-1.5.3.1: Manufacturer: STMicroelectronics -[5067851.670017] usb 2-1.5.3.1: SerialNumber: FFFFFFFEFFFF -``` - -Flash the keyboard normally by executing: - -``` -make xiaomi/mk02:default:flash -``` - -Warning! If you flash the firmware manually by using `dfu-util`, make sure to use the following arguments: - -``` --d 0483:df11 -a 0 -s 0x08002000:leave -``` - -If you don't, you'll blow away the user bootloader and will have to repeat the installation steps. - -## Booting into bootloader - -To boot into bootloader, do either of the following: -- map a RESET key in your keymap and tap it, or -- hold spacebar while plugging in the keyboard. - -If neither of these work, you must have blown away the user bootloader somehow and will need to repeat the installation guide from the first step. - -## Restoring the original firmware - -If you wish to restore the original firmware, boot into the bootloader and then execute: - -``` -dfu-util -d 0483:df11 -a 0 -s 0x08000000:leave -D flash-backup.bin -``` diff --git a/keyboards/xiaomi/mk02/readme.md b/keyboards/xiaomi/mk02/readme.md new file mode 100644 index 0000000000..2dea99ff19 --- /dev/null +++ b/keyboards/xiaomi/mk02/readme.md @@ -0,0 +1,104 @@ +# Xiaomi Yuemi Pro MK02 + +A tenkeyless keyboard sold under Xiaomi brand. It uses an STM32F072C8T6 microcontroller and can be flashed with QMK. + +LED backlight is currently not supported. + +* Keyboard Maintainer: [@xyzz](https://github.com/xyzz) +* Hardware Supported: Xiaomi Yuemi Pro MK02 +* Hardware Availability: Aliexpress + +Make example for this keyboard (after setting up your build environment): + + make xiaomi/mk02:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +## Installation + +Please understand that following these steps will void your warranty and might irrecoverably damage your keyboard. + +### Installing the bootloader + +You only need to do this step once (unless you destroy your user bootloader which is not possible so long as you follow these steps correctly). + +Unplug the keyboard. Disassemble the keyboard and look at the area around the MCU. Make sure your keyboard looks the same as in the picture and that the chip says STM32F072C8T6 on it: + +![mcu](https://i.imgur.com/HM8tUWU.jpg) + +Using a piece of wire, connect TP28 (indicated in red) and 3v3 (square pad indicated in green) together with tweezers or a piece of wire. Make sure to not touch the case with your wire when shorting!!! Don't push it all the way through the hole. + +Plug the keyboard in with the wire connected. You should see the following device appear: +``` +[5067851.560317] usb 2-1.5.3.1: new full-speed USB device number 6 using ehci-pci +[5067851.670006] usb 2-1.5.3.1: New USB device found, idVendor=0483, idProduct=df11, bcdDevice=22.00 +[5067851.670010] usb 2-1.5.3.1: New USB device strings: Mfr=1, Product=2, SerialNumber=3 +[5067851.670013] usb 2-1.5.3.1: Product: STM32 BOOTLOADER +[5067851.670015] usb 2-1.5.3.1: Manufacturer: STMicroelectronics +[5067851.670017] usb 2-1.5.3.1: SerialNumber: FFFFFFFEFFFF +``` + +If you don't see this, you did something wrong. Disconnect the keyboard and try again. + +If you do see this, remove the wire before continuing. + +Make a backup of internal flash memory in case you'd like to revert to the original firmware in the future: +``` +dfu-util -d 0483:df11 -a 0 -s 0x08000000 -U flash-backup.bin +``` + +Ensure the dumped flash is correct: +``` +strings flash.bin | grep KB +``` +(You should see 2 entries of "USB KB") + +Finally, flash the bootloader ([jumploader-xiaomi_mk02-padded.bin](https://github.com/xyzz/stm32f072-keyboard-jumploader/releases/download/r1/jumploader-xiaomi_mk02-padded.bin)) with: +``` +dfu-util -d 0483:df11 -a 0 -s 0x08000000:leave -D jumploader-xiaomi_mk02-padded.bin +``` + +At this point the keyboard should reboot into bootloader mode; if it doesn't, wait a couple seconds and replug the USB cable. + +### Installing the firmware + +To install QMK, first boot into bootloader mode as detailed below. When the keyboard boots in bootloader mode, you should see the following device: + +``` +[5067851.560317] usb 2-1.5.3.1: new full-speed USB device number 6 using ehci-pci +[5067851.670006] usb 2-1.5.3.1: New USB device found, idVendor=0483, idProduct=df11, bcdDevice=22.00 +[5067851.670010] usb 2-1.5.3.1: New USB device strings: Mfr=1, Product=2, SerialNumber=3 +[5067851.670013] usb 2-1.5.3.1: Product: STM32 BOOTLOADER +[5067851.670015] usb 2-1.5.3.1: Manufacturer: STMicroelectronics +[5067851.670017] usb 2-1.5.3.1: SerialNumber: FFFFFFFEFFFF +``` + +Flash the keyboard normally by executing: + +``` +make xiaomi/mk02:default:flash +``` + +Warning! If you flash the firmware manually by using `dfu-util`, make sure to use the following arguments: + +``` +-d 0483:df11 -a 0 -s 0x08002000:leave +``` + +If you don't, you'll blow away the user bootloader and will have to repeat the installation steps. + +## Booting into bootloader + +To boot into bootloader, do either of the following: +- map a RESET key in your keymap and tap it, or +- hold spacebar while plugging in the keyboard. + +If neither of these work, you must have blown away the user bootloader somehow and will need to repeat the installation guide from the first step. + +## Restoring the original firmware + +If you wish to restore the original firmware, boot into the bootloader and then execute: + +``` +dfu-util -d 0483:df11 -a 0 -s 0x08000000:leave -D flash-backup.bin +``` diff --git a/keyboards/ymd75/README.md b/keyboards/ymd75/README.md deleted file mode 100644 index cb2bcbdd51..0000000000 --- a/keyboards/ymd75/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# YMD75 / MT84 - -75% keyboard from YMDK. YMDK sell the board and name it "YMD75", however revision 1 of the PCB has "MT84" printed on both sides. - -* Keyboard Maintainer: [Wayne K Jones](github.com/WarmCatUK) -* Hardware Supported: - - rev1 (ATmega32a) - - rev2 (ATmega32a) - - rev3 (ATmega32u4) -* Hardware Availability: - -Make example for this keyboard (after setting up your build environment): - - make ymd75/rev1:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make ymd75/rev1:default:flash - -**Reset Key**: Hold down the key located at *Key below the top right key*, commonly programmed as *Backspace* while plugging in the keyboard. On PCB revision 2, enter the bootloader by holding `L_CTRL` while plugging in the keyboard. - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/ymd75/readme.md b/keyboards/ymd75/readme.md new file mode 100644 index 0000000000..cb2bcbdd51 --- /dev/null +++ b/keyboards/ymd75/readme.md @@ -0,0 +1,22 @@ +# YMD75 / MT84 + +75% keyboard from YMDK. YMDK sell the board and name it "YMD75", however revision 1 of the PCB has "MT84" printed on both sides. + +* Keyboard Maintainer: [Wayne K Jones](github.com/WarmCatUK) +* Hardware Supported: + - rev1 (ATmega32a) + - rev2 (ATmega32a) + - rev3 (ATmega32u4) +* Hardware Availability: + +Make example for this keyboard (after setting up your build environment): + + make ymd75/rev1:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make ymd75/rev1:default:flash + +**Reset Key**: Hold down the key located at *Key below the top right key*, commonly programmed as *Backspace* while plugging in the keyboard. On PCB revision 2, enter the bootloader by holding `L_CTRL` while plugging in the keyboard. + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/ymdk/bface/README.md b/keyboards/ymdk/bface/README.md deleted file mode 100644 index d99d4f9fb0..0000000000 --- a/keyboards/ymdk/bface/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# The YMDK Bface - -![ymdk_bface](https://i.imgur.com/qhFxN0g.jpg) - -A 60% keyboard that runs ps2avrgb natively and fits the popular GH60 form factor. Another "bfake" or clone of the original B.face PCB by [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/). This PCB has slightly different switch matrix than the origninal B.face, and is also different than the bfake. It commonly comes as the PCB in 60% keyboard kits sold by YMDK on Aliexpress. - -* Keyboard Maintainer: QMK Community -* Hardware Supported: White Bface Mini USB PCB with 12 RGB LEDs on the bottom. -* Hardware Availability: [Shenzhen YMD Tech Co. (YMDK) on Aliexpress](https://www.aliexpress.com/item/32799437588.html) -* Case capability: You can not use generic GH60 plastic cases with this board as RGB LEDs on the bottom is messing with the supportive ribs of the case, just like on DZ60. - -Make example for this keyboard (after setting up your build environment): - - make ymdk/bface:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make ymdk/bface:default:flash - -This board has a pair of jumper holes on the left edge of the PCB marked "Jb", near TAB and CAPS LOCK. If you short the contacts with tweezers or wire the board will enter into the bootloader and you can flash it. - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/ymdk/bface/readme.md b/keyboards/ymdk/bface/readme.md new file mode 100644 index 0000000000..d99d4f9fb0 --- /dev/null +++ b/keyboards/ymdk/bface/readme.md @@ -0,0 +1,22 @@ +# The YMDK Bface + +![ymdk_bface](https://i.imgur.com/qhFxN0g.jpg) + +A 60% keyboard that runs ps2avrgb natively and fits the popular GH60 form factor. Another "bfake" or clone of the original B.face PCB by [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/). This PCB has slightly different switch matrix than the origninal B.face, and is also different than the bfake. It commonly comes as the PCB in 60% keyboard kits sold by YMDK on Aliexpress. + +* Keyboard Maintainer: QMK Community +* Hardware Supported: White Bface Mini USB PCB with 12 RGB LEDs on the bottom. +* Hardware Availability: [Shenzhen YMD Tech Co. (YMDK) on Aliexpress](https://www.aliexpress.com/item/32799437588.html) +* Case capability: You can not use generic GH60 plastic cases with this board as RGB LEDs on the bottom is messing with the supportive ribs of the case, just like on DZ60. + +Make example for this keyboard (after setting up your build environment): + + make ymdk/bface:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make ymdk/bface:default:flash + +This board has a pair of jumper holes on the left edge of the PCB marked "Jb", near TAB and CAPS LOCK. If you short the contacts with tweezers or wire the board will enter into the bootloader and you can flash it. + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/ymdk/ymd09/README.md b/keyboards/ymdk/ymd09/README.md deleted file mode 100644 index dce883c1f5..0000000000 --- a/keyboards/ymdk/ymd09/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# YMD09 - -![YMD09](https://ae01.alicdn.com/kf/HTB1x6BATYvpK1RjSZPiq6zmwXXai/9-Key-QMK-Hotswap-YMDK-RGB-Support-Macro-Function-Type-C-MX-Switches-Mechanical-Keyboard-Numpad.jpg) - -A 9-key macropad by [YMDK](https://ymdk.aliexpress.com/store/429151) with per-key RGB lighting. - -* Keyboard Maintainer: [Patrick Fruh](https://github.com/kaeltis) -* Hardware Supported: YMD09 -* Hardware Availability: [AliExpress](https://www.aliexpress.com/i/4000510880374.html) - -Make example for this keyboard (after setting up your build environment): - - make ymdk/ymd09:default - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/ymdk/ymd09/readme.md b/keyboards/ymdk/ymd09/readme.md new file mode 100644 index 0000000000..dce883c1f5 --- /dev/null +++ b/keyboards/ymdk/ymd09/readme.md @@ -0,0 +1,15 @@ +# YMD09 + +![YMD09](https://ae01.alicdn.com/kf/HTB1x6BATYvpK1RjSZPiq6zmwXXai/9-Key-QMK-Hotswap-YMDK-RGB-Support-Macro-Function-Type-C-MX-Switches-Mechanical-Keyboard-Numpad.jpg) + +A 9-key macropad by [YMDK](https://ymdk.aliexpress.com/store/429151) with per-key RGB lighting. + +* Keyboard Maintainer: [Patrick Fruh](https://github.com/kaeltis) +* Hardware Supported: YMD09 +* Hardware Availability: [AliExpress](https://www.aliexpress.com/i/4000510880374.html) + +Make example for this keyboard (after setting up your build environment): + + make ymdk/ymd09:default + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). -- cgit v1.2.3