Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
1 contributor

Users who have contributed to this file

215 lines (126 sloc) 7.92 KB

Build Guide

Parts

Required

Item Count Remark
PCB 2
Plate 2 sets
ProMicro 2
TRRS Jack 2
TRS(3 pole) cable 1 TRRS(4 pole) cable works too.
Tact switch 2
Diode 42 You need SMD for low profile.
Key Switch 42
Key Cap 42 1u x 40, 1.5u x 2
Spacer M2 6mm 10 use 3mm for low profile
Spacer M2 8mm or 10mm 4
Screw M2 28
Rubber foot 10

Optional

Item Count Remark
OLED Module 1 or 2
4x1 Pin Male Header 2 For OLED
4x1 Pin Female Socket 2 For OLED
SK6812MINI 54 Front side x 42, back side x 12
Addressable LED Strip 2 exclusive with SK6812MINI

image

Soldering

PCB is reversible; use one for the left hand side and the other for the right.

Diodes

For non Low Profile keyswitches

Solder diodes as indicated in the picture. You can place it on either side, but front side is recommended if you implement under-glow LED. You can use SMD diodes too.

image

Diode has polarity; make sure to match the polarity with PCB silkscreen.

<- Before | After ->

image

For Low Profile Keyswitches

If you use low profile keyswitches, you have to implement SMD diodes on the back side. Otherwise, diodes will interfere with top plate.

LEDs (Optional)

Implement LEDs under keyswitches (No. 7 through 27) upward facing, and others (No. 1 through 6) on the back side(under-glow), as indicated in the picture.

image

For No.7 to 27 LEDs, Install LEDs from the back side as shown below. Note the 'o' silkscreen marking and use them as a guide to implement LEDs in the direction.

image

For No. 1 to 6 LEDs, solder the pattern on the side of the device (highlighted in pink on the picture) and the PCB pattern(blue on the picture). Apply flux and take small amount of solder with a soldering iron and press it on the edge of the patterns.

image

LEDs are connected in the order of the number on the picture above. If it turns on only halfway, it is likely that first LED that doesn't turn on or the last LED that turns on is not implemented correctly.

Jumpers for OLED modules (optional)

To use OLED modules, short circuit the jumper patterns. Only short circuit the front side

image

TRRS socket, reset switch, OLED header sockets.

Install TRRS sockets and reset switches as in the picture. For OLEDs, also implement pin sockets.

image

ProMicro

Implement pin headers in the white frame, then install ProMicro with its backside up. (The picture is the right hand side, but it's the same for the left hand side - pins into the through holes in the white frame, backside up.)

image

OLED Module

Implement pin header onto the OLED modules, then insert them into the pin sockets.

image

Adjust the height of the spacer accordingly to the height of pin header. Most common pin header/socket and 10mm spacers are used in the picture.

Use socket to Mount ProMicro

With using sockets for mounting ProMicro, you can replace it easily when it breaks. Two methods are introduced here.

Using Spring Loaded Header

Refer to Helix Buildguide

ProMicro kit with spring loaded headers is available at Yusha-Kobo

https://yushakobo.jp/shop/promicro-spring-pinheader/

Using OLEDs available at Yusha-Kobo which come with low profile header, together with and 8mm spacers, you can build them think and gap-less.

img_4141

Using Pin Sockets

Low profile pin sockets are available from Akizuki Denshi etc. Requires some work.

http://akizukidenshi.com/catalog/g/gC-03138/

Install a couple of 12x1 pin sockets on a breadboard.

img_4130

Using male 12x1 pin headers, fixate ProMicro onto the pin sockets.

img_4131

Remove plastic pin holders, solder the pins to ProMicro, and then cut extra pins.

img_4132

Comparison

Spring loaded headers can make the height lower.

img_4134

Comparing pin-headers in the picture. Headers come with OLED available at Yusha-Kobo are lower.

img_4137

Testing

It is recommended to test the ProMicro and OLED modules before installing key switches because rework would be difficult after that.

First, build QMK Firmware for built for Crkbd and install on ProMicro.

image

Using the default keymap, OLED will show information on the keyswitches being pressed. Check the connections by short-circuiting key-switch soldering pads with tweezers. Check all of them. If you have mounted LEDs, also make sure all of them are turned on.

image

Keyswitches and Top Plate

Sandwich top-plate with PCB and key-switches.

image

Bottom Plate

Use 3mm spacers for low-profile, Attach bottom plate to the PCB using 6mm (3mm for low-profile) spacers. Then attach six rubber feet.

image

Keycaps

Lastly install keycaps.

lrg_dsc03895

Firmware

Setup firmware build environment following the instructions here: https://docs.qmk.fm/#/newbs_getting_started

Then build firmware for Crkbd with this command:

make crkbd:default

To flash the firmware image you have just built, execute this:

make crkbd:default:avrdude

You will see . after a message like below. While you see . is being printed on the screen, push the reset switch twice.

(snip)

Checking file size of crkbd_rev1_default.hex                                                        [OK]
 * File size is fine - 27328/28672
Copying crkbd_rev1_default.hex to qmk_firmware folder                                               [OK]
Detecting USB port, reset your controller now........

Flash the firmware to the other side as well.

That's it.

You can’t perform that action at this time.