diff --git a/README.md b/README.md index 8b6da00..6b625c7 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,18 @@ Crkbd stands for Corne Keyboard. ## Lineup -- corne-classic([JP](corne-classic/doc/buildguide_jp.md)/[EN](corne-classic/doc/buildguide_en.md)): +- corne-classic + ([JP](corne-classic/doc/buildguide_jp.md)/[EN](corne-classic/doc/buildguide_en.md)): Corne for Cherry MX switches -- corne-cherry([JP](corne-cherry/doc/buildguide_jp.md)) ([tilting, JP](corne-cherry/doc/v2/buildguide_tilting_tenting_plate_jp.md)): +- corne-cherry + ([JP](corne-cherry/doc/buildguide_jp.md)/[EN](corne-cherry/doc/buildguide_en.md)) + ([tilting, JP](corne-cherry/doc/v2/buildguide_tilting_tenting_plate_jp.md)/[tilting, EN](corne-cherry/doc/v2/buildguide_tilting_tenting_plate_en.md)): Hotswappable Corne for Cherry MX switches by kailh PCB sockets. -- corne-chocolate([JP](corne-chocolate/doc/buildguide_jp.md)/[EN](corne-chocolate/doc/buildguide_en.md)): +- corne-chocolate + ([JP](corne-chocolate/doc/buildguide_jp.md)/[EN](corne-chocolate/doc/buildguide_en.md)): Hotswappable Corne for Chocolate switches using Kailh PCB hot-swap sockets. -- corne-light([JP](corne-light/doc/buildguide_jp.md)): +- corne-light + ([JP](corne-light/doc/buildguide_jp.md)/[EN](corne-light/doc/buildguide_en.md)): Light-weight Corne (Easy build with a simple PCB). ## Photos diff --git a/corne-cherry/doc/buildguide_en.md b/corne-cherry/doc/buildguide_en.md new file mode 100644 index 0000000..be43794 --- /dev/null +++ b/corne-cherry/doc/buildguide_en.md @@ -0,0 +1,8 @@ +# Build Guide + +This is the Corne Cherry build guide. +The build guide differs depending on the version, +so please choose your own from the following. + +- [v2 build guide](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.md) +- [v3 build guide](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_en.md) \ No newline at end of file diff --git a/corne-cherry/doc/v2/buildguide_en.md b/corne-cherry/doc/v2/buildguide_en.md new file mode 100644 index 0000000..15be985 --- /dev/null +++ b/corne-cherry/doc/v2/buildguide_en.md @@ -0,0 +1,260 @@ +# Build Guide + +This is the build guide for Corne Cherry v2. +[Corne Cherry v3 build guide]( +https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_en.md). + +## Parts + +### Required + +| Name | Number | Remarks | +|:-|:-|:-| +| PCB | 2 sheets | | +| Top plate | 2 sheets | | +| Bottom plate | 2 sheets | PCB type and acrylic type can be selected | +| ProMicro protective plate | 2 sheets | | +| ProMicro | 2 sheets | | +| TRRS jack | 2 | | +| Tact switch | 2 | | +| Diodes | 42 | Only chip parts | +| Kailh PCB Sockets | 42 | | +| Key switches | 42 | Only compatible with CherryMX | +| Keycaps | 42 pcs | 1u 40 pcs, 1.5u 2 pcs | +| OLED module | 2 sheets | | +| 4 pin headers | 2 | | +| 4 pin sockets | 2 | | +| Spacer M2 7.5mm | 10 pieces | | +| Spacer M2 9mm | 4 pieces | | +| Screw M2 4mm | 28 screws | | +| Cushion rubber | 8 pieces | | +| TRS (3-pole) cable | 1 | TRRS (4-pole) cable is also acceptable | +| Micro USB cable | 1 | | + +### Options + +| Name | Number | Remarks | +|:-|:-|:-| +| SK6812MINI | 54 pcs | Upward mounting 42 pcs, Downward mounting 12 pcs | + +![01](https://user-images.githubusercontent.com/736191/54487431-789a6c00-48d9-11e9-9390-a8510b19ba34.jpg) + +## Advance preparation + +If you build the firmware yourself, +it takes time to prepare the environment, +so it is recommended to start first. \ +See for more information. + +## Implementation + +The PCB is reversible, so first decide which one to use, +left or right. + +![02](https://user-images.githubusercontent.com/736191/54487432-789a6c00-48d9-11e9-87ea-3595b2f3ecc2.jpg) + +### Diode + +Solder the diode of the chip part. +You can attach it to either side, but in this build guide, +we will attach it to the back side. +When using [Tilting / Tenting plate]( +https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/buildguide_tilting_tenting_plate_en.md), +be sure to attach it to the back side \_\_. + +Since the chip parts are very small, +it is easier to work with tweezers and counter-acting tweezers. +**The diode is installed in a fixed direction **, +so if you arrange the diode in the same row and row as shown in the photo below, +it will proceed smoothly. + +![03](https://user-images.githubusercontent.com/736191/54487433-789a6c00-48d9-11e9-991b-92264a793ec9.jpg) + +The orientation of the diode is as follows: +Install so that the "|||" mark on the chip part faces the "|" of the diode mark "|◁". + +![04](https://user-images.githubusercontent.com/736191/54487434-79330280-48d9-11e9-82be-a9d98803a417.jpg) + +The trick is to attach the chip parts, but first, as a spare solder, +put the solder only on the right side of the pad. + +![05](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. +At this time, it is recommended to use reverse-action tweezers, +because you can hold the chip parts firmly without exerting force +and you can concentrate on alignment and soldering. +Also, if the soldering iron is too hot or the solder is touched too much, +the flux contained in the solder may evaporate and form a clean pile of solder, +but it can be repaired later, +so at this point you should only be aware of attaching parts. +It's okay. + +![06](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 +when one foot is attached. +If it floats, press the diode with tweezers +or your fingers and reheat the soldered part with a soldering iron to clean it. + +![07](https://user-images.githubusercontent.com/736191/54487437-79330280-48d9-11e9-996d-a578e767c12c.jpg) + +Then solder the other one. +Be careful not to apply too much as a small amount of solder is sufficient. +If you apply too much, you can remove it with a blotting wire +or by scooping it with a soldering iron. + +If the amount of solder on the preliminary solder side is small, +additional soldering is performed, and if it is a mountain, +apply flux from above and heat it to clean it. + +![08](https://user-images.githubusercontent.com/736191/54487438-79cb9900-48d9-11e9-9280-dc72a2087307.jpg) + +### TRRS jack, reset switch + +Solder the TRRS jack and reset switch to the surface of the PCB +as shown in the picture below. +In this build guide, the diode is attached to the back side, +so it is the opposite side. + +![09](https://user-images.githubusercontent.com/736191/54487439-79cb9900-48d9-11e9-9a57-80697fa8b484.jpg) + +### Jumpers and pin sockets for OLED modules + +When using the OLED module, jumper as shown below. +Please note that **only the surface should be jumpered**. + +Solder the pin socket to the same surface. + +![10](https://user-images.githubusercontent.com/736191/54487440-79cb9900-48d9-11e9-95a7-750251e83a89.jpg) + +If the jumper doesn't work, the amount of solder is probably too low +or the flux in the solder has vaporized. +In that case, you can fix a jumper by using a large amount of solder +or applying a separate flux. + +### ProMicro + +Solder the pin header so that it fits into the white frame, +and then solder it with the back side of the Pro Micro facing up. + +![11](https://user-images.githubusercontent.com/736191/54487441-79cb9900-48d9-11e9-9317-e77c4c408a4f.jpg) +![12](https://user-images.githubusercontent.com/736191/54487442-7a642f80-48d9-11e9-85f6-469d8beaa9c0.jpg) + +If you want to use the spring pin header, +please refer to [Helix Build Guide]( +https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro). + +### OLED module + +Insert the pin header into the pin socket for OLED first, +and then solder the pin header and OLED module. +At this time, the OLED module is easy to float, +so be careful not to float it while pressing it with your finger. + +![13](https://user-images.githubusercontent.com/736191/54487443-7a642f80-48d9-11e9-818a-4913b8abe986.jpg) +![14](https://user-images.githubusercontent.com/736191/54487445-7a642f80-48d9-11e9-9bb0-f753a5e4720b.jpg) + +### Operation check + +It is recommended to check the operation when ProMicro and OLED module are attached +(it will be difficult to isolate the problem if you do it at the very end). + +To check the operation, first insert the firmware for crkbd into ProMicro +by referring to the "Firmware" chapter below (be sure to insert it on both sides). + +To check the operation, connect the left hand side to the PC with MicroUSB +and connect the left hand side and the right hand side with the TRS cable. +Since there may be defects such as jacks, +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. + +![15](https://user-images.githubusercontent.com/736191/54487446-7a642f80-48d9-11e9-8bd2-2b413e3e080a.jpg) + +### Kailh PCB Socket + +Fill the pads on both sides of the back with solder. +It is difficult to add it later, so please add more in advance. + +![16](https://user-images.githubusercontent.com/736191/54487447-7afcc600-48d9-11e9-91cb-edd541365180.jpg) + +Insert the socket and attach it by melting the solder you have. +At this time, hold it down with tweezers or your fingers +so that the socket does not float. + +![17](https://user-images.githubusercontent.com/736191/54487448-7afcc600-48d9-11e9-8e72-0449937a2310.jpg) + +Soldering is now complete. +If you want to add an LED as an option, +refer to the "LED" chapter below +(it can be attached even after installing the socket). + +![18](https://user-images.githubusercontent.com/736191/54487449-7afcc600-48d9-11e9-9428-0b949a07afc4.jpg) + +### Plates, switches + +First, insert the switch into the top plate. +It's okay to do it later, but it's easier to put it in first, +because it's necessary to insert the switch from a little bit. + +![19](https://user-images.githubusercontent.com/736191/54487450-7afcc600-48d9-11e9-8160-de5b9c6a405b.jpg) + +Finally, attach the spacers with screws so that the top plate, PCB, +and bottom plate are in that order, +and attach the cushion rubber to the four corners to complete the process. + +![20](https://user-images.githubusercontent.com/736191/54487451-7afcc600-48d9-11e9-8c90-2f2919bf9483.jpg) + +## Firmware + +Write the firmware to ProMicro by referring to the following. \ + + +## LED (optional) + +I will install the SK6812 MINI. + +The SK6812MINI is extremely heat sensitive and breaks easily. +We recommend using a soldering iron with a temperature control function +and working at a temperature of 220°C to 270°C. +Even if the temperature is adjusted, +it will be damaged if the iron is applied to the LED for a long time, +so try to solder as quickly as possible. +The LEDs are soldered four by four, +but it is recommended that you do not do four at a time, +but two at a time to prevent the LED temperature from rising, +as it will be less likely to break. + +First, check the mounting position. + +Solder 1 to 6 so that the back side (Undergrow) shines, +and 7 to 27 so that the front side (Backlight) shines. +Below is the position to install the LED. + +![21](https://user-images.githubusercontent.com/736191/54487452-7b955c80-48d9-11e9-98f7-87490a584274.png) +![22](https://user-images.githubusercontent.com/736191/54487455-7b955c80-48d9-11e9-9498-c841747c5dbc.png) + +Solder 1 to 6 so that the black part circled as shown below is on the bottom +and the silk mark indicated by the arrow is on the top. +Please note that the orientation changes between 1 ~ 3 and 4 ~ 5. + +![23](https://user-images.githubusercontent.com/736191/54487456-7b955c80-48d9-11e9-8541-cecb8c7dc97b.png) + +Solder 7 to 27 so that the largest pad circled +and the silk mark indicated by the arrow are adjacent to each other, +as shown below. + +![24](https://user-images.githubusercontent.com/736191/54487457-7b955c80-48d9-11e9-882d-59ff506d5f02.png) + +If everything can be soldered normally, it will shine as shown below. +If it shines only halfway, the LEDs are connected in numerical order, +so suspect that the LED that does not shine +or the LED in front of it is soldered incorrectly or that the LED is damaged. + +![25](https://user-images.githubusercontent.com/736191/54487458-7c2df300-48d9-11e9-9582-88a60d5b71c0.jpg) + +That's all there is to it. + +![26](https://user-images.githubusercontent.com/736191/54487459-7c2df300-48d9-11e9-8f3c-2c480cef3b03.jpg) diff --git a/corne-cherry/doc/v2/buildguide_tilting_tenting_plate_en.md b/corne-cherry/doc/v2/buildguide_tilting_tenting_plate_en.md new file mode 100644 index 0000000..8feae5b --- /dev/null +++ b/corne-cherry/doc/v2/buildguide_tilting_tenting_plate_en.md @@ -0,0 +1,61 @@ +# Build Guide Tilting / Tenting plate + +## Parts + +| Name | Number | Remarks | +|:-|:-|:-| +| Completed Corne Cherry | 1 set | Corne Chocolate / 3mm top plate is not supported | +| Middle plate 3mm | 2 sheets | | +| Bottom plate 3mm | 2 sheets | | +| Bolt M5 15mm ~ 50mm | 8 bolts | | +| Nut M5 | 16 pieces | | +| Screw M2 6mm | 10 screws | | +| Screw M2 4mm | 10 screws | | +| Spacer M2 3.5mm | 10 pieces | | +| Cushion rubber | 8 pieces | | + +## Advance preparation + +![lrg_dsc05736](https://user-images.githubusercontent.com/736191/53021652-1185c500-349d-11e9-86a8-187298d968f8.JPG) + +Remove the key switch from the finished Corne Cherry +to separate the body from the top plate. +No other parts are needed. + +## Assembly + +![lrg_dsc05737](https://user-images.githubusercontent.com/736191/53021653-121e5b80-349d-11e9-94b6-72067880d42f.JPG) +![lrg_dsc05739](https://user-images.githubusercontent.com/736191/53021654-121e5b80-349d-11e9-9031-728645391232.JPG) + +Check the required parts. +Check the dedicated middle plate and bottom plate, and bolts of various lengths. +In addition, use screws, nuts, spacers, etc. (see the parts section for details). + +![lrg_dsc05742](https://user-images.githubusercontent.com/736191/53021658-12b6f200-349d-11e9-87d0-749a266740ee.JPG) + +Secure the middle plate to the top plate with 6mm screws and 3.5mm spacers. + +![lrg_dsc05744](https://user-images.githubusercontent.com/736191/53021659-12b6f200-349d-11e9-95ff-f252075f5b3c.JPG) +Secure the OLED display protection plate with 4mm screws. + +![lrg_dsc05745](https://user-images.githubusercontent.com/736191/53021660-12b6f200-349d-11e9-8620-f02c399e7106.JPG) + +Secure the body and bottom plate with 4mm screws. + +![lrg_dsc05747](https://user-images.githubusercontent.com/736191/53021661-134f8880-349d-11e9-8dd6-17ff762be93a.JPG) + +Insert an acrylic spacer between the middle plate +and the bottom plate and attach the bolts. + +![lrg_dsc05748](https://user-images.githubusercontent.com/736191/53021662-134f8880-349d-11e9-8d0e-d0b02657436b.JPG) + +It is recommended to temporarily assemble the bolts +and adjust the height before completely fixing them with nuts. +Temporary assembly can be done easily by passing only one nut through the bolt. + +![lrg_dsc05749](https://user-images.githubusercontent.com/736191/53021665-134f8880-349d-11e9-9db8-9952a40eb240.JPG) +![lrg_dsc05750](https://user-images.githubusercontent.com/736191/53021666-134f8880-349d-11e9-9c8e-85615d6dd9b6.JPG) + +It is completed by firmly fixing it so that it is sandwiched between nuts. + +![lrg_dsc05761](https://user-images.githubusercontent.com/736191/53021667-13e81f00-349d-11e9-9bc8-051e68fde6eb.JPG) diff --git a/corne-cherry/doc/v3/buildguide_en.md b/corne-cherry/doc/v3/buildguide_en.md new file mode 100644 index 0000000..cfb949d --- /dev/null +++ b/corne-cherry/doc/v3/buildguide_en.md @@ -0,0 +1,277 @@ +# Build Guide + +This is the build guide for Corne Cherry v3. +[Click here for Corne Cherry v2]( +https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.md). + +## Parts + +### Required + +| Name | Number | Remarks | +|:-|:-|:-| +| PCB | 1 set | | +| Top plate | 2 sheets | | +| Bottom plate | 2 sheets | | +| OLED protective plate | 2 sheets | | +| ProMicro | 2 sheets | | +| TRRS jack | 2 | | +| Tact switch | 2 | | +| Diodes | 42 | Only SMD parts are supported | +| PCB sockets | 42 | Compatible with Kailh and Gateron | +| Key switches | 42 | Only compatible with CherryMX | +| Keycaps | 42 pcs | 1u 40 pcs, 1.5u 2 pcs | +| Spacer M2 7.5mm | 10 pieces | | +| Spacer M2 9mm | 4 pieces | | +| Screw M2 4mm | 28 screws | | +| Cushion rubber | 8 pieces | | +| TRRS (4 poles) cable | 1 | TRS (3 poles) cable is also acceptable | +| Micro USB cable | 1 | | + +### Options + +| Name | Number | Remarks | +|:-|:-|:-| +| OLED module | 2 sheets | | +| Pin header for OLED module 4 series 1.5mm | 2 | | +| 4 pin sockets for OLED module 2.5mm | 2 | | +| SK6812MINI-E | 42 pieces | LEDs for Back light | +| WS2812B | 12 | LEDs for Undergrow | + +## Advance preparation + +If you build the firmware yourself, +it takes time to prepare the environment, +so it is recommended to start first. \ +See +for more information. + +## Verification + +The PCB for Corne Cherry v3 is as follows. +Make sure it is the same as your PCB. + +![confirm_front](assets/confirm_front.jpg) + +![confirm_back](assets/confirm_back.jpg) + +The PCB comes with a frame for manufacturing reasons. +You can fold it by hand to remove it, but if it is difficult, +make a cut in the joint \* with a cutter etc. to make it easier to remove. +In addition, the joint can be cleaned with a file. + +\* *Joint part: There are a total of 8 parts, +which are marked in red in the image below.* + +![confirm_remove_frame](assets/confirm_remove_frame.jpg) + +## Assembly + +### Diode + +Solder diodes for SMD components. +Since SMD parts are very small, +it is convenient to have tweezers and counter-acting tweezers. + +**The diode has a fixed mounting direction**, +and solder it so that the "|" mark on the part faces the "|" on the diode mark "|◁". +In addition, Corne's PCB has all the same diode mounting orientations. + +![build_diode](assets/build_diode.jpg) + +
+TIPS: Tips for installing SMD parts + +The trick is to attach the SMD parts, but first, as a spare solder, +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) + +Next, solder one leg of the diode so that the spare solder melts. +At this time, it is recommended to use reverse-action tweezers, +because you can hold the chip parts firmly without exerting force +and you can concentrate on alignment and soldering. +Also, if the soldering iron is too hot or the solder is touched too much, +the flux contained in the solder may evaporate and form a clean pile of solder, +but it can be repaired later, +so at this point you should only be aware of attaching parts. +It's okay. + +![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 +when one foot is attached. +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) + +Then solder the other one. Be careful not to apply too much, +as a small amount of solder is sufficient. +If you apply too much, you can remove it with a blotting wire +or by scooping it with a soldering iron. + +If the amount of solder on the preliminary solder side is small, +additional soldering is performed, and if it is a mountain, +apply flux from above and heat it to clean it. + +![tips_building_smd_04](https://user-images.githubusercontent.com/736191/54487438-79cb9900-48d9-11e9-9280-dc72a2087307.jpg) + +
+ +The diode is completed by soldering 42 pieces in total on the left and right. + +![build_diode_overview](assets/build_diode_overview.jpg) + +### LED (optional) + +Solder the SK6812MINI-E and WS2812B. + +First, check the state after installation. + +![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 +(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) + +#### WS2812B (Undergrow) + +First, solder the WS2812B. + +Solder with the corners of the recesses on the WS2812B +and the corner marks on the PCB aligned as shown below. +**TIPS: As I introduced in Tips for Installing SMD Parts**, +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) + +He soldered a total of 8 pieces on the left and right, and he completed the WS2812B. + +![build_led_undergrow_overview](assets/build_led_undergrow_overview.jpg) + +#### SK6812MINI-E (Backlight) + +Then solder the SK6812MINI-E. + +Solder the SK6812MINI-E with the missing corners aligned with the PCB corners +as shown below. +**TIPS: As I introduced in Tips for Installing SMD Parts**, +I think that you can attach it well with spare solder. +It is harder to break than the SK6812MINI, +but it may be damaged if it is directly exposed to the heat of a soldering iron. +If the temperature is about 320°C +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) + +SK6812MINI-E is completed by soldering a total of 42 pieces on the left and right. + +![build_led_back_overview](assets/build_led_back_overview.jpg) + +### TRRS jack, reset switch, pin socket for OLED + +Solder the TRRS jack, reset switch (tact switch), +and OLED pin socket as shown in the picture below. + +![build_trrs_reset_oled](assets/build_trrs_reset_oled.jpg) + +Since it is a part that easily slips off, +you can solder it while holding the part by hand, +or fix it with masking tape and then solder it. + +### ProMicro + +Solder ProMicro in the following orientation + +![build_promicro](assets/build_promicro.jpg) + +If you use Conthru, you do not need to solder the back side. +Please refer to [Helix Build Guide]( +https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro) +for details on how to use Consul. + +![build_promicro_conthrough](assets/build_promicro_conthrough.jpg) + +### OLED module + +Insert the pin header into the pin socket for OLED first, +and then solder the pin header and OLED module. +At this time, the OLED module is easy to float, +so be careful not to float it while pressing it with your finger. + +![build_oled](assets/build_oled.jpg) + +## Firmware + +Write the firmware to ProMicro by referring to the following. \ + + +### Operation check + +We recommend that you check the operation when the ProMicro and OLED module are attached. +If you do it at the very end, it will be difficult to isolate the problem. + +To check the operation, connect the left hand side to the PC with MicroUSB, +and connect the left hand side and the right hand side with the TRRS cable. +Since there may be defects such as jacks, +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 + +Solder the PCB socket according to the mark as shown below. +All the PCB sockets are listed below, +but I'm not really into it, +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) + +The PCB socket is completed by soldering a total of 42 left and right. + +![build_socket_overview](assets/build_socket_overview.jpg) + +### OLED protective plate + +Install the OLED protective plate with M2 9mm spacers and M2 screws. + +![build_oled_plate_front](assets/build_oled_plate_front.jpg) +![build_oled_plate_back](assets/build_oled_plate_back.jpg) + +### Plates, switches + +After attaching the key switch to the top plate, +fit the key switch into the socket. +If you attach all the key switches to the top plate first, +it will be more difficult to fit them in the socket, +so it is easier to attach only the end key switches first. +![build_top_plate_switches](assets/build_top_plate_switches.jpg) + +Install the M2 7.5mm spacer and M2 screws on the top plate. + +![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. + +![build_screws_spacers_back](assets/build_screws_spacers_back.jpg) + +Attach the bottom plate with M2 screws. + +![build_bottom_plate](assets/build_bottom_plate.jpg) + +Install the cushion rubber in the following positions. + +![build_cushion_rubbers](assets/build_cushion_rubbers.jpg) + +That's it. + +![build_finish](assets/build_finish.jpg) diff --git a/corne-light/doc/buildguide_en.md b/corne-light/doc/buildguide_en.md new file mode 100644 index 0000000..d65a0a1 --- /dev/null +++ b/corne-light/doc/buildguide_en.md @@ -0,0 +1,8 @@ +# Build Guide + +This is the Corne Light build guide. +The build guide differs depending on the version, +so please choose your own from the following. + +- [v1 build guide](https://github.com/foostan/crkbd/blob/master/corne-light/doc/v1/buildguide_en.md) +- [v2 low-edition build guide](https://github.com/foostan/crkbd/blob/master/corne-light/doc/v2/buildguide_low_edition_en.md) diff --git a/corne-light/doc/v1/buildguide_en.md b/corne-light/doc/v1/buildguide_en.md new file mode 100644 index 0000000..441afeb --- /dev/null +++ b/corne-light/doc/v1/buildguide_en.md @@ -0,0 +1,244 @@ +# Build Guide + +This is the Corne Light build guide. + +## Parts + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name Number Remarks
PCB 1 set + ![PCB](https://user-images.githubusercontent.com/736191/69554623-6be02300-0fe5-11ea-879d-9e4316df0226.JPG) +
Top plate 2 sheets + ![top-plates](https://user-images.githubusercontent.com/736191/69554621-6be02300-0fe5-11ea-9ca2-5556f99fa2e5.JPG) +
Bottom plate 2 sheets + ![bottom-plates](https://user-images.githubusercontent.com/736191/69554622-6be02300-0fe5-11ea-8803-a1c97aae0433.JPG) +
ProMicro protective plate 2 sheets
diode 42 + ![diodes](https://user-images.githubusercontent.com/736191/69554619-6b478c80-0fe5-11ea-9a26-96d617f2b0f6.JPG) +
Spacer M2 7.5mm 10 + ![screws](https://user-images.githubusercontent.com/736191/69554618-6b478c80-0fe5-11ea-8090-b14d989e9d07.JPG) +
Spacer M2 9mm 4
Screw M2 4mm 28
TRRS jack 2 + ![jacks](https://user-images.githubusercontent.com/736191/69554620-6be02300-0fe5-11ea-94ee-6f8f50d800da.JPG) +
Reset switch 2
Rubber feet 8
ProMicro (with conthrough) 2 + https://yushakobo.jp/shop/promicro-spring-pinheader/ +
OLED module (with pin socket) 2 + https://yushakobo.jp/shop/oled/ +
key switch 42
keycap 42
TRRS cable 1 TRS cable is also acceptable
USB cable 1
+ +## Advance preparation + +If you build the firmware yourself, +it takes time to prepare the environment, +so it is recommended to start first. \ +See for more information. + +## Implementation + +### PCB disconnection + +Check the front and back and separate the left and right PCBs +(the photo is the front). + +![assembly-pcb](https://user-images.githubusercontent.com/736191/69554624-6c78b980-0fe5-11ea-9828-3be0af9f27af.JPG) + +This is a jig for bending the legs of a diode. +Separate it if necessary. + +![assembly-tool-of-diodes](https://user-images.githubusercontent.com/736191/69554626-6c78b980-0fe5-11ea-8c4d-ae70374d54bc.JPG) + +* Some versions do not have a jig. + +### diode + +First, bend the legs of the reed type diode. + +* You can clean it by bending it one by one as shown in the picture, + but it is more efficient to bend multiple pieces at the same time + while connected to the tape. + +![assembly-diodes-1](https://user-images.githubusercontent.com/736191/69554627-6c78b980-0fe5-11ea-9f4f-120c28b49953.JPG) + +Attach the diode with the bent leg to the specified position. + +![assembly-diodes-2](https://user-images.githubusercontent.com/736191/69554628-6d115000-0fe5-11ea-8885-e88b5d87a3b1.JPG) + +The diode has an orientation and is installed as shown in the photo. + +* All the diodes to be attached are in the same orientation. + +![assembly-diodes-3](https://user-images.githubusercontent.com/736191/69554629-6d115000-0fe5-11ea-9df5-70e8ab10489f.JPG) + +You can attach it neatly by fixing it with masking tape. + +![assembly-diodes-4](https://user-images.githubusercontent.com/736191/69554632-6d115000-0fe5-11ea-907f-2188aa59094a.JPG) + +Solder from the back side. + +![assembly-diodes-5](https://user-images.githubusercontent.com/736191/69554633-6da9e680-0fe5-11ea-9d5c-751595784d84.JPG) + +If you are fixing with masking tape, +cutting your legs to the limit like this will make soldering easier. + +![assembly-diodes-6](https://user-images.githubusercontent.com/736191/69554634-6da9e680-0fe5-11ea-9051-93f9edd09c9a.JPG) + +With 21 one-handed and two-handed he installs 42 diodes. + +![assembly-diodes-7](https://user-images.githubusercontent.com/736191/69554635-6da9e680-0fe5-11ea-9ee3-b503bc0fcc83.JPG) + +### TRRS jack, reset switch, pin socket + +Install in the specified position. + +* Install the right hand side in the same position + (be careful of mistakes on the front and back). + +![assembly-jacks-resets-pinsockets-1](https://user-images.githubusercontent.com/736191/69554641-6e427d00-0fe5-11ea-87d7-c46056e4fb09.JPG) + +### ProMicro, OLED module + +Install his ProMicro and his OLED module by referring to the [Helix Build Guide]( +https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro). + +![assembly-promicro-oled](https://user-images.githubusercontent.com/736191/69554644-6e427d00-0fe5-11ea-8c6b-9aaa3d2c3f6c.JPG) + +### Write firmware + +Write the firmware to ProMicro by referring to the following. \ + + +### Operation check + +To check the operation, +connect the left hand side to the PC with a USB cable, +and connect the left hand side and the right hand side with a TRRS cable. +Since there may be defects such as jacks, +be sure to connect the left and right +instead of one by one before checking the operation. + +* Since the switch is not attached, + check the operation with tweezers as shown in the photo. + +![check](https://user-images.githubusercontent.com/736191/69554646-6edb1380-0fe5-11ea-8428-afd7bef09c15.JPG) + +### Top plate, key switch + +Attach the key switch to the top plate as shown in the picture. + +* Be careful of the direction of the key switch. + +![assembly-keyswitches-1](https://user-images.githubusercontent.com/736191/69554647-6edb1380-0fe5-11ea-9e17-d4d644f9a60c.JPG) + +We recommend using a 3-pin key switch. + +* Even when using 5 pins, the plastic legs can be separated to make 3 pins. + +![assembly-keyswitches-2](https://user-images.githubusercontent.com/736191/69554648-6edb1380-0fe5-11ea-94fe-cd758f46cfd0.JPG) + +Solder so that there is no gap between the switch and the PCB. + +![assembly-keyswitches-3](https://user-images.githubusercontent.com/736191/69554652-700c4080-0fe5-11ea-8633-afae5e825d02.JPG) +![assembly-keyswitches-4](https://user-images.githubusercontent.com/736191/69554654-700c4080-0fe5-11ea-8514-9a46ba4da38c.JPG) + +### ProMicro Protective Plate, Bottom Plate + +Attach his ProMicro protective plate using an M2 9mm spacer. + +![assembly-plates-1](https://user-images.githubusercontent.com/736191/69554656-700c4080-0fe5-11ea-8083-b55fea60adc9.JPG) + +Install the bottom plate using the M2 7.5mm spacer. + +![assembly-plates-2](https://user-images.githubusercontent.com/736191/69554660-70a4d700-0fe5-11ea-9c46-eb32c7589470.JPG) + +Attach the rubber feet to the four corners. + +![assembly-plates-3](https://user-images.githubusercontent.com/736191/69554661-70a4d700-0fe5-11ea-85c1-acae90ea7725.JPG) + +## Complete + +Attach the keycap and you're done. + +![assembly-finished-1](https://user-images.githubusercontent.com/736191/69654854-d615c800-10b8-11ea-8903-ebf019d7b125.png) +![assembly-finished-2](https://user-images.githubusercontent.com/736191/69654882-df069980-10b8-11ea-8efe-069b68db3bc0.png) diff --git a/corne-light/doc/v2/buildguide_low_edition_en.md b/corne-light/doc/v2/buildguide_low_edition_en.md new file mode 100644 index 0000000..8e0bb76 --- /dev/null +++ b/corne-light/doc/v2/buildguide_low_edition_en.md @@ -0,0 +1,205 @@ +# Build Guide + +This is the build guide for Corne Light v2 Low edition. + +![corne-light-low-edition-001](assets/corner-light-low-edition-001.jpg) +![corne-light-low-edition-002](assets/corner-light-low-edition-002.jpg) +![corne-light-low-edition-003](assets/corner-light-low-edition-003.jpg) + +## Parts + +### Required + +| Name | Number | Remarks | +|:-|:-|:-| +| PCB | 1 set | | +| Top plate (acrylic) 2mm | 2 sheets | | +| Bottom foam | 2 sheets | Special foam is cut out with a special mold | +| OLED protective plate | 2 sheets | | +| ProMicro | 2 sheets | | +| TRRS jack | 2 | | +| Tact switch | 2 | | +| Diodes | 42 | Recommended SMD Parts | +| Key switches | 42 | Kailh Choc v1 or v2 recommended | +| Keycaps | 42 pcs | 1u 40 pcs, 1.5u 2 pcs | +| Spacer M2 9mm | 4 pieces | | +| Screw M2 4mm | 8 screws | | +| TRRS (4 poles) cable | 1 | TRS (3 poles) cable is also acceptable | +| Micro USB cable | 1 | | + +### Options + +| Name | Number | Remarks | +|:-|:-|:-| +| OLED module | 2 sheets | | +| Pin header for OLED module 4 series 1.5mm | 2 | | +| 4 pin sockets for OLED module 2.5mm | 2 | | + +## Advance preparation + +If you build the firmware yourself, +it takes time to prepare the environment, +so it is recommended to start first. \ +See +for more information. + +## Verification + +The PCB for Corne Light v2 is as follows. +Make sure it is the same as your PCB. + +![confirm_front](assets/confirm_front.jpg) + +![confirm_back](assets/confirm_back.jpg) + +The PCB comes with a frame for manufacturing reasons. +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, +to make it easier to remove. +In addition, the joint can be cleaned with a file. + +\* *Joint part: There are a total of 8 parts, +which are marked in red in the image below.* + +![confirm_remove_frame](assets/confirm_remove_frame.jpg) + +## Assembly + +### diode + +Solder diodes for SMD components. +Since SMD parts are very small, +it is convenient to have tweezers and counter-acting tweezers. + +**The diode has a fixed mounting direction**, +so solder it so that the "|" mark on the part faces the "|" on the diode mark "|◁". +In addition, Corne's PCB has all the same diode mounting orientations. + +![build_diode](assets/build_diode.jpg) + +
+TIPS: Tips for installing SMD parts + +The trick is to attach the SMD parts, but first, as a spare solder, +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) + +Next, solder one leg of the diode so that the spare solder melts. +At this time, it is recommended to use reverse-action tweezers, +because you can hold the chip parts firmly without exerting force +and you can concentrate on alignment and soldering. +Also, if the soldering iron is too hot or the solder is touched too much, +the flux contained in the solder may evaporate and form a clean pile of solder, +but it can be repaired later, +so at this point you should only care about attaching parts. +It's okay. + +![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 +when one foot is attached. +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) + +Then solder the other one. +Be careful not to apply too much, as a small amount of solder is sufficient. +If you apply too much, you can remove it with a blotting wire +or by scooping it with a soldering iron. + +If the amount of solder on the preliminary solder side is small, +additional soldering is performed, and if it is a mountain, +apply flux from above and heat it to clean it. + +![tips_building_smd_04](https://user-images.githubusercontent.com/736191/54487438-79cb9900-48d9-11e9-9280-dc72a2087307.jpg) + +
+ +The diode is completed by soldering 42 pieces in total on the left and right. + +![build_diode_overview](assets/build_diode_overview.jpg) + +### TRRS jack, reset switch, pin socket for OLED + +Solder the TRRS jack, reset switch (tact switch), +and OLED pin socket as shown in the picture below. + +![build_trrs_reset_oled](assets/build_trrs_reset_oled.jpg) + +Since it is a part that easily slips off, +you can solder it while holding the part by hand, +or fix it with masking tape and then solder it. + +### ProMicro + +Solder ProMicro in the following orientation + +![build_promicro](assets/build_promicro.jpg) + +If you use Conthru, you do not need to solder the back side. +Please refer to [Helix Build Guide]( +https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro) +for details on how to use Consul. + +![build_promicro_conthrough](assets/build_promicro_conthrough.jpg) + +### OLED module + +Insert the pin header into the pin socket for OLED first, +and then solder the pin header and OLED module. +At this time, the OLED module is easy to float, +so be careful not to float it while pressing it with your finger. + +![build_oled](assets/build_oled.jpg) + +### Firmware + +Write the firmware to ProMicro by referring to the following. \ + + +### Operation check + +We recommend that you check the operation when the ProMicro and OLED module are attached. +If you do it at the very end, it will be difficult to isolate the problem. + +To check the operation, connect the left hand side to the PC with MicroUSB, +and connect the left hand side and the right hand side with the TRRS cable. +Since there may be defects such as jacks, +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. + +### Top plate, switch + +After attaching the key switch to the top plate, solder the key switch. +If you attach all the key switches to the top plate first, +it will be more difficult to attach the switches to the board, +so it is easier to attach only the end key switches first. +![build_top_plate_switches](assets/build_top_plate_switches.jpg) + +### OLED protective plate + +Attach his OLED protective plate with M2 9mm spacers and M2 screws. + +![build_oled_plate_front](assets/build_oled_plate_front.jpg) +![build_oled_plate_back](assets/build_oled_plate_back.jpg) + +Especially for the screws on the back side, +tighten them firmly to attach the bottom foam after this. + +### Bottom form + +Finally, paste the bottom form. +This foam has an adhesive surface on one side +and a non-slip surface on the other side. +Stick the adhesive side firmly to the PCB. + +![build_bottom_foam](assets/build_bottom_foam.jpg) + +That's it. + +![build_finish](assets/build_finish.jpg)