Kabbone/corne
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #163 from waffle87/doc_touchup

Browse Source 
Cherry V3 EN build guide touchup
This commit is contained in:
Kosuke Adachi 2022-04-07 08:47:30 +09:00 committed by GitHub
commit bad13902b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 86 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

180
corne-cherry/doc/v3/buildguide_en.md
View File

@ -11,38 +11,39 @@ https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.m
| Name | Count | Remarks | | Name | Count | Remarks |
|:-|:-|:-| |:-|:-|:-|
| PCB | 1 set | | | PCB | 1 set | |
| Top plate | 2 sheets | | | Top plate | 2 sheets | 1.5mm-3mm thick |
| Bottom plate | 2 sheets | | | Bottom plate | 2 sheets | |
| OLED protective plate | 2 sheets | | | OLED cover | 2 sheets | |
| ProMicro | 2 sheets | | | ProMicro | 2 | Alternative: [Elite-C](https://deskthority.net/wiki/Elite-C) |
| TRRS jack | 2 | | | TRRS jack | 2 | |
| Tact switch | 2 | | | Reset switch | 2 | |
| Diodes | 42 | Only SMD parts are supported | | Diodes | 42 | SMD Only (SOD-123 Package) |
| PCB sockets | 42 | Compatible with Kailh and Gateron | | PCB sockets | 42 | Compatible with Kailh and Gateron |
| Key switches | 42 | Only compatible with CherryMX | | Key switches | 42 | Only compatible with MX style |
| Keycaps | 42 pcs | 1u 40 pcs, 1.5u 2 pcs | | Keycaps | 42 pieces | 1u 40 pcs, 1.5u 2 pcs |
| Spacer M2 7.5mm | 10 pieces | | | Spacer M2 7.5mm | 10 pieces | For Case assembly |
| Spacer M2 9mm | 4 pieces | | | Spacer M2 9mm | 4 pieces | For OLED cover |
| Screw M2 4mm | 28 screws | | | Screw M2 4mm | 28 screws | |
| Cushion rubber | 8 pieces | | | Rubber feet | 8 pieces | |
| TRRS (4 poles) cable | 1 | TRS (3 poles) cable is also acceptable | | TRRS (4 poles) cable | 1 | TRS (3 poles) cable is also compatible |
| Micro USB cable | 1 | | | Micro USB cable | 1 | Avoid charge-only cables |
### Optional ### Optional
| Name | Count | Remarks | | Name | Count | Remarks |
|:-|:-|:-| |:-|:-|:-|
| OLED module | 2 sheets | | | OLED module | 2 | |
| Pin header for OLED module 4 series 1.5mm | 2 | | | SK6812MINI-E | 42 | LEDs for Backlight |
| 4 pin sockets for OLED module 2.5mm | 2 | |
| SK6812MINI-E | 42 pieces | LEDs for Back light |
| WS2812B | 12 | LEDs for Undergrow | | WS2812B | 12 | LEDs for Undergrow |
| [Microcontroller/OLED Sockets](https://www.digikey.com/en/products/detail/315-43-112-41-003000/ED4764-12-ND/4455232) | 1 | Alternative: [2.54 1row femal sliv](https://www.aliexpress.com/item/4001122376295.html) option |
| [Microcontroller Pins](https://www.digikey.com/en/products/detail/mill-max-manufacturing-corp/3320-0-00-15-00-00-03-0/4147392) | 48 | Alternative: Diode/Resistor legs |
| [OLED Headers](https://www.digikey.com/en/products/detail/mill-max-manufacturing-corp/350-10-164-00-006000/357045) | 1 | Soldered to OLED module |
## Advance preparation ## Firmware preparation
If you build the firmware yourself, If you build the firmware yourself, it will take some time to set up the environment,
it will take some time to set up the environment, so it's best to start at the beginning.\
so it's best to start at the beginning. \ It is recommended to flash ProMicro's prior to soldering.\
For more information, For more information,
please see <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>. please see <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>.
@ -57,11 +58,11 @@ Make sure it is the same as your PCB.
The PCB comes with a frame for manufacturing reasons. The PCB comes with a frame for manufacturing reasons.
You can fold it by hand to remove it, but if it is difficult, You can fold it by hand to remove it, but if it is difficult,
make a cut in the joint \* with a cutter or similar, make a cut in the joint\* with a cutter or similar,
to make it easier to remove. to make it easier to remove.
In addition, the joint can be cleaned with a file. In addition, the joint can be cleaned with a file.
\* *Joint part: There are a total of 8 parts, \**Joint part: There are a total of 8 parts,
which are marked in red in the image below.* which are marked in red in the image below.*
![confirm_remove_frame](assets/confirm_remove_frame.jpg) ![confirm_remove_frame](assets/confirm_remove_frame.jpg)
@ -70,50 +71,43 @@ which are marked in red in the image below.*
### Diodes ### Diodes
Solder diodes for SMD components. Since SMD parts are very small, fine-tip/reverse-action tweezers are recommended.
Since SMD parts are very small,
it is convenient to have tweezers and counter-acting tweezers.
**The diode has a fixed mounting direction**, **The diodes have a specific orientation**, so install with "|" marking on the diode
so solder it so that the "|" mark on the part faces the "|" on the diode mark "|◁". facing the "|" on the PCB marking: "|◁"
In addition, Corne's PCB has all the same diode mounting orientations.
![build_diode](assets/build_diode.jpg) ![build_diode](assets/build_diode.jpg)
<details> <details>
<summary>TIPS: Tips for installing SMD parts</summary> <summary>TIPS: Tips for installing SMD parts</summary>
The trick is to attach the SMD parts, but first, as a spare solder, Begin with applying solder to only one pad.
put the solder on only one side of the pad.
![tips_building_smd_01](https://user-images.githubusercontent.com/736191/54487435-79330280-48d9-11e9-9138-525d8ee68144.jpg) ![tips_building_smd_01](https://user-images.githubusercontent.com/736191/54487435-79330280-48d9-11e9-9138-525d8ee68144.jpg)
Next, solder one leg of the diode so that the spare solder melts. Next, place SMD component while heating solder. At this time,
At this time,
it is recommended to use [reverse-action tweezers](https://www.alimed.com/_resources/cache/images/product/70895A_850x480-pad.jpg), it is recommended to use [reverse-action tweezers](https://www.alimed.com/_resources/cache/images/product/70895A_850x480-pad.jpg),
so that you can hold the SMD part firmly without applying force, so that you can hold the SMD part firmly without applying force,
and concentrate on alignment and soldering instead. and concentrate on alignment and soldering instead.
Also, if the soldering iron is too hot or the solder is touched too long, Also, if the soldering iron is too hot or the solder is touched too long,
the flux contained in the solder may evaporate and form an undesirable pile solder, the flux contained in the solder may evaporate and form a poor solder joint,
but since it can be repaired later, but it can be repaired later,
so at this point you should only care about attaching parts. so at this point you should only care about attaching parts.
It's okay. It's okay.
![tips_building_smd_02](https://user-images.githubusercontent.com/736191/54487436-79330280-48d9-11e9-856e-f3f5b9f58414.jpg) ![tips_building_smd_02](https://user-images.githubusercontent.com/736191/54487436-79330280-48d9-11e9-856e-f3f5b9f58414.jpg)
It is okay if the diode does not float when viewed from the side It is okay if the SMD component is not flush with the PCB when viewed from the side.
when one foot is attached. If it is floating, press the SMD component down with tweezers or your finger and reheat the solder.
If it floats, press the diode with tweezers or your fingers
and reheat the soldered part with a soldering iron to clean it.
![tips_building_smd_03](https://user-images.githubusercontent.com/736191/54487437-79330280-48d9-11e9-996d-a578e767c12c.jpg) ![tips_building_smd_03](https://user-images.githubusercontent.com/736191/54487437-79330280-48d9-11e9-996d-a578e767c12c.jpg)
Then solder the other pin. Then solder the other contacts.
Be careful not to apply too much solder, Be careful not to apply too much solder,
as a small amount is sufficient. as a small amount is sufficient.
If you have applied too much, If you have applied too much,
you can remove it with a suction pump, blotting wire you can remove it with a suction pump, solder wick,
or by scooping it with a soldering iron. or by picking it up with a soldering iron.
If the amount of solder on the preliminary solder side is small, If the amount of solder on the preliminary solder side is small,
additional soldering is performed, and if it is a heap, additional soldering is performed, and if it is a heap,
@ -131,28 +125,24 @@ The diode is completed by soldering 42 pieces in total on the left and right.
Solder the SK6812MINI-E and WS2812B. Solder the SK6812MINI-E and WS2812B.
First, check the state after installation.
![build_led_front_overview](assets/build_led_front_overview.jpg) ![build_led_front_overview](assets/build_led_front_overview.jpg)
All soldering is done from the back side, but the SK6812MINI-E is for Backlight All soldering is done from the back side, but the SK6812MINI-E is for Backlight
(the front side is shining) and the WS2812B is for Undergrow (the back side is shining). (the front side is shining) and the WS2812B is for Undergrow (the back side is shining).
![build_led_back_overview](assets/build_led_back_overview.jpg) ![build_led_back_overview](assets/build_led_back_overview.jpg)
#### WS2812B (Undergrow) #### WS2812B (Undergrow)
First, solder the WS2812B. First, solder the WS2812B.
Solder with the corners of the recesses on the WS2812B Match recessed corner of the LED with marked corner on the PCB as shown below.
and the corner marks on the PCB aligned as shown below. Refer to **TIPS: Tips for installing SMD parts** section above as similar soldering
**TIPS: As I introduced in Tips for Installing SMD Parts**, procedure is followed.
I think that you can attach it well with spare solder.
In addition, his PCB of Corne has the same mounting orientation of his WS2812B.
![build_led_undergrow](assets/build_led_undergrow.jpg) ![build_led_undergrow](assets/build_led_undergrow.jpg)
He soldered a total of 12 pieces on the left and right, and he completed the WS2812B. WS2812B LED soldering is completed after 12 are installed on left and right.
![build_led_undergrow_overview](assets/build_led_undergrow_overview.jpg) ![build_led_undergrow_overview](assets/build_led_undergrow_overview.jpg)
@ -160,21 +150,17 @@ He soldered a total of 12 pieces on the left and right, and he completed the WS2
Then solder the SK6812MINI-E. Then solder the SK6812MINI-E.
Solder the SK6812MINI-E with the missing corners aligned with the PCB corners Match the notched corner of the LED with the marked corner on the PCB as show below.
as shown below. Refer to **TIPS: Tips for installing SMD parts** section above as similar soldering
**TIPS: As I introduced in Tips for Installing SMD Parts**, procedure is followed.
I think that you can attach it well with spare solder. These are more resilient than the SK6812MINI LEDs,
It is harder to break than the SK6812MINI, but still may be damaged if directly exposed to the heat of a soldering iron.
but it may be damaged if it is directly exposed to the heat of a soldering iron. ~320°C seems to be an ok temperature, evne if all four legs are soldered
If the temperature is about 320°C one after another.
with a soldering iron with a temperature control function,
it seems that there is no problem even if four legs are soldered continuously.
All Corne PCBs have the same mounting orientation for the SK6812MINI-E.
![build_led_backlight](assets/build_led_backlight.jpg) ![build_led_backlight](assets/build_led_backlight.jpg)
SK6812MINI-E is completed by soldering a total of 42 pieces on the left and right. SK6812MINI-E LED soldering is completed after 42 are installed on left and right.
![build_led_back_overview](assets/build_led_back_overview.jpg) ![build_led_back_overview](assets/build_led_back_overview.jpg)
@ -185,17 +171,15 @@ and OLED pin socket as shown in the picture below.
![build_trrs_reset_oled](assets/build_trrs_reset_oled.jpg) ![build_trrs_reset_oled](assets/build_trrs_reset_oled.jpg)
Since it is a part that easily slips off, Since these parts may fall off when soldering, you can affix them with masking tape.
you can solder it while holding the part by hand,
or fix it with masking tape and then solder it.
### ProMicro ### ProMicro
Solder ProMicro in the following orientation Solder headers to PCB. Then solder ProMicro to headers, with components facing PCB as shown below.
![build_promicro](assets/build_promicro.jpg) ![build_promicro](assets/build_promicro.jpg)
If you use spring-loaded pin headers (e.g. Conthrough), If you use [spring-loaded pin headers](https://shop.yushakobo.jp/collections/all-keyboard-parts/products/31),
you do not need to solder the back side. you do not need to solder the back side.
Please refer to the [Helix Build Guide]( Please refer to the [Helix Build Guide](
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro) https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
@ -205,69 +189,55 @@ for details on how to use spring-loaded pin headers.
### OLED module ### OLED module
Insert the pin header into the pin socket for OLED first, Insert the pin header into the socket first, then solder the OLED module
and then solder the pin header and OLED module. to the pin header.
At this time, the OLED module is easy to float, Note: Solder one pin to OLED module, then reheat solder to confirm OLED module is level,
so be careful not to float it while pressing it with your finger. then solder remaining pins.
![build_oled](assets/build_oled.jpg) ![build_oled](assets/build_oled.jpg)
### Firmware
Write the firmware to ProMicro by referring to the following. \
<https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
### Operation check ### Operation check
We recommend that you check the operation when the ProMicro and OLED module are attached. Now is a good time to test your keyboard to help isolate potential problems.
If you do it at the very end, it will be difficult to isolate the problem.
To check the operation, To check the operation, connect left and right sides with TRRS cable,
connect the left hand side to the PC with MicroUSB, then connect left side to the computer with USB cable.
and connect the left hand side and the right hand side with the TRRS cable. If it is done correctly so far, shorting a hotswap socket pad with tweezers will
Since there may be defects such as jacks, output out a keypress and it will be displayed on the OLED module.
be sure to connect the left and right instead of one by one
before checking the operation.
If it is done correctly so far,
if you short the pad to attach the PCB socket with tweezers etc.,
the key pressed on the OLED module will be displayed.
### PCB socket ### Switch Sockets
Solder the PCB socket according to the mark as shown below. Solder hotswap sockets according to mark on PCB as shown below.
All the PCB sockets are listed below, Refer to **TIPS: Tips for installing SMD parts** section above as similar soldering
but I'm not really into it, procedure is followed.
so attach them one by one.
**TIPS: As I introduced in Tips for Installing SMD Parts**,
I think that you can attach it well with spare solder.
![build_socket](assets/build_socket.jpg) ![build_socket](assets/build_socket.jpg)
The PCB socket is completed by soldering a total of 42 left and right. Switch Socket soldering is completed after 42 are installed on left and right.
![build_socket_overview](assets/build_socket_overview.jpg) ![build_socket_overview](assets/build_socket_overview.jpg)
### OLED protective plate ### OLED protective cover
Attach the OLED protective plate with M2 9mm spacers and M2 screws. Attach the OLED protective cover with M2 9mm spacers and M2 screws.
![build_oled_plate_front](assets/build_oled_plate_front.jpg) ![build_oled_plate_front](assets/build_oled_plate_front.jpg)
![build_oled_plate_back](assets/build_oled_plate_back.jpg) ![build_oled_plate_back](assets/build_oled_plate_back.jpg)
### Plates, switches ### Plates & Switches
After attaching the key switch to the top plate, Place a few key switches into the top plate, then line up and press into PCB socket.
fit the key switch into the socket.
If you attach all the key switches to the top plate first, If you attach all the key switches to the top plate first,
it will be more difficult to fit them in the socket, it will be more difficult to fit them in the PCB sockets all at once.
so it is easier to attach only the end key switches first. So it is recommended to do a few to begin with.
![build_top_plate_switches](assets/build_top_plate_switches.jpg) ![build_top_plate_switches](assets/build_top_plate_switches.jpg)
Install the M2 7.5mm spacer and M2 screws on the top plate. Install the M2 7.5mm spacer and M2 screws on the top plate.
![build_screws_spacers_front](assets/build_screws_spacers_front.jpg) ![build_screws_spacers_front](assets/build_screws_spacers_front.jpg)
It is easy to screw the spacer after inserting it into the hole from the back side. It is easy to screw the spacer in after inserting it into the hole from the back side.
![build_screws_spacers_back](assets/build_screws_spacers_back.jpg) ![build_screws_spacers_back](assets/build_screws_spacers_back.jpg)
@ -275,10 +245,10 @@ Attach the bottom plate with M2 screws.
![build_bottom_plate](assets/build_bottom_plate.jpg) ![build_bottom_plate](assets/build_bottom_plate.jpg)
Install the cushion rubber in the following positions. Install the rubber feet in the following positions.
![build_cushion_rubbers](assets/build_cushion_rubbers.jpg) ![build_cushion_rubbers](assets/build_cushion_rubbers.jpg)
That's it. That's it!
![build_finish](assets/build_finish.jpg) ![build_finish](assets/build_finish.jpg)

25
doc/firmware_en.md
View File

@ -30,7 +30,7 @@ And enable the check box for "**Auto-Flash**".
![qmk_toolbox_flash](assets/qmk_toolbox_flash.jpg) ![qmk_toolbox_flash](assets/qmk_toolbox_flash.jpg)
With the keyboard connected via USB, With the keyboard connected via USB,
press the reset button to start flashing the firmware. \ press the reset button **twice** or short **GND & RST** pins on ProMicro to start flashing the firmware. \
If you see the message, it's done. If you see the message, it's done.
![qmk_toolbox_flashed](assets/qmk_toolbox_flashed.jpg) ![qmk_toolbox_flashed](assets/qmk_toolbox_flashed.jpg)
@ -48,25 +48,22 @@ Once the environment is ready,
build the firmware for Crkbd with the following command. build the firmware for Crkbd with the following command.
``` ```
make crkbd/rev1/common:via make crkbd:via
``` ```
When the build is completed, When the build is completed,
execute the following command. execute the following command to flash.
``` ```
make crkbd/rev1/common:via:avrdude make crkbd:via:avrdude
``` ```
When you execute it, When you execute it,
you will see the following log, you will see the following output (`.`'s progressively appearing).
and you can progress by `.`s appearing. Press the reset switch **twice** or short **GND & RST** pins on ProMicro during this time to complete the firmware writing.
Press the reset switch **twice** during this time to complete the firmware writing. Depending on the ProMicro, it may be only require pressing reset switch once.
Depending on the ProMicro, it may be one time.
``` ```
<Omitted>
Checking file size of crkbd_rev1_default.hex [OK] Checking file size of crkbd_rev1_default.hex [OK]
* File size is fine-27328/28672 * File size is fine-27328/28672
Copying crkbd_rev1_default.hex to qmk_firmware folder [OK] Copying crkbd_rev1_default.hex to qmk_firmware folder [OK]
@ -95,9 +92,9 @@ When VIA is opened with the keyboard plugged in, the following window will appea
![via_begin](assets/via_begin.jpg) ![via_begin](assets/via_begin.jpg)
### KEYMAP / CONFIGURE ### Configure
In this screen, you can change the key map. In this screen, you can change the keymap.
There are several types of keys that can be changed There are several types of keys that can be changed
and you can find them in the "1" area. and you can find them in the "1" area.
@ -107,7 +104,7 @@ VIA instantly changes the keymap.
![via_keymap_configure](assets/via_keymap_configure.jpg) ![via_keymap_configure](assets/via_keymap_configure.jpg)
### KEYMAP / TESTER ### Tester
In this screen, you can test the operation of the keymap. In this screen, you can test the operation of the keymap.
@ -121,7 +118,7 @@ It is easier to check the operation of each switch after build.
![via_keymap_tester_matrix](assets/via_keymap_tester_matrix.jpg) ![via_keymap_tester_matrix](assets/via_keymap_tester_matrix.jpg)
### LIGHTING ### Lighting
In this screen, you can change the pattern and color of the LEDs. In this screen, you can change the pattern and color of the LEDs.