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

initial

Browse Source
This commit is contained in:
jack 2022-03-15 23:05:16 -06:00
parent 381b68f7eb
commit fb4dc70b4d
No known key found for this signature in database
GPG Key ID: 38FE2D9C474B1286
3 changed files with 1673 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -13,10 +13,10 @@ https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.m
| PCB | 1 set | |
| Top plate | 2 sheets | |
| Bottom plate | 2 sheets | |
| OLED protective plate | 2 sheets | |
| ProMicro | 2 sheets | |
| OLED cover | 2 sheets | |
| ProMicro | 2 | |
| TRRS jack | 2 | |
| Tact switch | 2 | |
| Reset switch | 2 | |
| Diodes | 42 | Only SMD parts are supported |
| PCB sockets | 42 | Compatible with Kailh and Gateron |
| Key switches | 42 | Only compatible with CherryMX |
@ -24,7 +24,7 @@ https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.m
| Spacer M2 7.5mm | 10 pieces | |
| Spacer M2 9mm | 4 pieces | |
| 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 |
| Micro USB cable | 1 | |
@ -32,17 +32,17 @@ https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.m
| Name | Count | Remarks |
|:-|:-|:-|
| OLED module | 2 sheets | |
| OLED module | 2 | |
| 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
## Firmware preparation
If you build the firmware yourself,
it will take some time to set up the environment,
so it's best to start at the beginning. \
If you build the firmware yourself, it will take some time to set up the environment,
so it's best to start at the beginning.
It is recommended to flash ProMicro's prior to soldering.
For more information,
please see <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>.
@ -191,7 +191,7 @@ or fix it with masking tape and then solder it.
### ProMicro
Solder ProMicro in the following orientation
Solder headers to PCB. Then solder ProMicro to headers, with components facing PCB
![build_promicro](assets/build_promicro.jpg)
@ -212,11 +212,6 @@ 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. \
<https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
### Operation check
We recommend that you check the operation when the ProMicro and OLED module are attached.

1651
doc/assets/crkbd_rev1_via.hex Normal file
View File

File diff suppressed because it is too large Load Diff

27
doc/firmware_en.md
View File

@ -22,7 +22,7 @@ Open QMK Toolbox, you will see a window like the one below.
### Flash the firmware
Download the firmware of VIA from the following link.\
[crkbd_rev1_common_via.hex](https://raw.githubusercontent.com/foostan/qmk_firmware-hex/main/.build/crkbd_rev1_via.hex)
[crkbd_rev1_common_via.hex]()
Specify the file downloaded from "**Open**" in QMK Toolbox.
And enable the check box for "**Auto-Flash**".
@ -30,7 +30,7 @@ And enable the check box for "**Auto-Flash**".
![qmk_toolbox_flash](assets/qmk_toolbox_flash.jpg)
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.
![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.
```
make crkbd/rev1/common:via
make crkbd:via
```
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,
you will see the following log,
and you can progress by `.`s appearing.
Press the reset switch **twice** during this time to complete the firmware writing.
Depending on the ProMicro, it may be one time.
you will see the following output (`.`'s progressively appearing).
Press the reset switch **twice** or short **GND & RST** pins on ProMicro during this time to complete the firmware writing.
Depending on the ProMicro, it may be only require pressing reset switch once.
```
<Omitted>
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]
@ -95,9 +92,9 @@ When VIA is opened with the keyboard plugged in, the following window will appea
![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
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)
### KEYMAP / TESTER
### Tester
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)
### LIGHTING
### Lighting
In this screen, you can change the pattern and color of the LEDs.