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

Merge remote-tracking branch 'origin/master' into update-light

Browse Source
This commit is contained in:
foostan 2020-11-11 23:49:38 +09:00
commit 53d224f89f
31 changed files with 45133 additions and 295 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -8,7 +8,7 @@ Crkbd stands for Corne Keyboard.
- 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/buildguide_tilting_tenting_plate_jp.md)):
- corne-cherry([JP](corne-cherry/doc/buildguide_jp.md)) ([tilting, JP](corne-cherry/doc/v2/buildguide_tilting_tenting_plate_jp.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)):
Hotswappable Corne for Chocolate switches using Kailh PCB hot-swap sockets.

35
corne-cherry/doc/v2/buildguide_jp.md
View File

@ -36,8 +36,8 @@
![01](https://user-images.githubusercontent.com/736191/54487431-789a6c00-48d9-11e9-9390-a8510b19ba34.jpg)
## 事前準備
実装の途中でProMicroにファームを入れる作業がありますが、ファームをビルドする環境を整備するのは時間がかかるのではじめに取り掛かっておくことをおすすめします。
https://docs.qmk.fm/#/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます(インストールに時間がかかるため動かしつつ実装を進めると効率的です)。
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
## 実装
@ -150,35 +150,8 @@ ProMicroとOLEDモジュールを付けた段階で動作確認をすること
![20](https://user-images.githubusercontent.com/736191/54487451-7afcc600-48d9-11e9-8c90-2f2919bf9483.jpg)
## ファームウェア
https://docs.qmk.fm/#/newbs_getting_started こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
環境ができましたら、下記コマンドで Crkbd 用にファームウェアをビルドします。
```
make crkbd:default
```
ビルドが完了したら下記コマンドを実行します。
```
make crkbd:default:avrdude
```
実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
```
<省略>
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........
```
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
以上で完成です。
下記を参照しファームウェアをProMicroに書き込みます。\
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
## LED（オプション）
SK6812MINIを取り付けていきます。

57
corne-cherry/doc/v3/buildguide_jp.md
View File

@ -36,10 +36,8 @@
| WS2812B | 12個 | Undergrow 用 LEDs |
## 事前準備
組み立ての途中で ProMicro にファームウェアを入れる作業がありますが、ファームウェアをビルドする環境を整備するのには時間がかかるためはじめに取り掛かっておくことをおすすめします。
https://docs.qmk.fm/#/ja/newbs_getting_started を参考にし、OSに合わせて必要なものをインストールしておきます。
インストールに時間がかかるため動かしつつ組み立てを進めると効率的です。
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
## 確認
@ -165,54 +163,9 @@ OLED用のピンソケットにピンヘッダを先に差し込み、その後
![build_oled](assets/build_oled.jpg)
### ファームウェア
https://docs.qmk.fm/#/ja/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます。
上記の事前準備にも挙げたとおり、インストールに時間がかかるため事前に用意しておくことをおすすめします。
Corne 用のファームウェアは `keyboards/crkbd` です。
なお、LEDはデフォルトでは無効になっているため、`keyboards/crkbd/rules.mk` にて `RGBLIGHT_ENABLE = yes` と変更する必要があります。
```diff
diff --git a/keyboards/crkbd/rules.mk b/keyboards/crkbd/rules.mk
index 30de5b388..174dd5c7e 100644
--- a/keyboards/crkbd/rules.mk
+++ b/keyboards/crkbd/rules.mk
@@ -26,7 +26,7 @@ MIDI_ENABLE = no # MIDI controls
AUDIO_ENABLE = no # Audio output on port C6
UNICODE_ENABLE = no # Unicode
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
-RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight.
+RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight.
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
```
環境ができたら、下記コマンドでファームウェアをビルドします。
```bash
make crkbd:default
```
ビルドが完了したら下記コマンドを実行します。
```bash
make crkbd:default:avrdude
```
実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
```bash
<省略>
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........
```
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
## ファームウェア
下記を参照しファームウェアをProMicroに書き込みます。\
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
### 動作確認
ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします。

4
corne-cherry/pcb/corne-cherry.kicad_pcb
View File

@ -94,11 +94,11 @@
(plotinvisibletext false)
(padsonsilk false)
(subtractmaskfromsilk false)
(outputformat 1)
(outputformat 5)
(mirror false)
(drillshape 0)
(scaleselection 1)
(outputdirectory "./garber"))
(outputdirectory "./svg"))
)
(net 0 "")

2
corne-cherry/pcb/kbd

@ -1 +1 @@
Subproject commit e6b740e597b23f9370d4f8f19beb0164f4eac087
Subproject commit f90510c11b6df53bcdb55740b0d59183957e4036

11959
corne-cherry/pcb/svg/corne-cherry-B_Cu.svg Normal file
View File

File diff suppressed because it is too large Load Diff
Side by Side

After

Width:  |  Height:  |  Size: 278 KiB

7346
corne-cherry/pcb/svg/corne-cherry-B_Mask.svg Normal file
View File

File diff suppressed because it is too large Load Diff
Side by Side

After

Width:  |  Height:  |  Size: 235 KiB

9056
corne-cherry/pcb/svg/corne-cherry-B_SilkS.svg Normal file
View File

File diff suppressed because it is too large Load Diff
Side by Side

After

Width:  |  Height:  |  Size: 174 KiB

3091
corne-cherry/pcb/svg/corne-cherry-Edge_Cuts.svg Normal file
View File

File diff suppressed because it is too large Load Diff
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

4634
corne-cherry/pcb/svg/corne-cherry-F_Cu.svg Normal file
View File

File diff suppressed because it is too large Load Diff
Side by Side

After

Width:  |  Height:  |  Size: 120 KiB

3326
corne-cherry/pcb/svg/corne-cherry-F_Mask.svg Normal file
View File

File diff suppressed because it is too large Load Diff
Side by Side

After

Width:  |  Height:  |  Size: 114 KiB

5444
corne-cherry/pcb/svg/corne-cherry-F_SilkS.svg Normal file
View File

File diff suppressed because it is too large Load Diff
Side by Side

After

Width:  |  Height:  |  Size: 80 KiB

43
corne-chocolate/doc/buildguide_en.md
View File

@ -37,10 +37,8 @@ This is the build guide for Corne Chocolate.
| SK6812MINI | 54 | 42 for backlight, 12 for under-glow |
## Preparation
It is recommended to [flash the firmware](#firmware) onto the Pro Micro before doing anything else,
as it is time-consuming to prepare the environment for building it,
and doing it in the middle of the soldering process is a hassle.
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. \
For more information, please see https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md.
## Building
@ -254,41 +252,8 @@ because it looks better.
![](https://user-images.githubusercontent.com/736191/52534914-00e19a80-2d8b-11e9-8005-7e0b157e09e4.png)
## Firmware
Refer to [the QMK _getting started_ guide](https://docs.qmk.fm/#/newbs_getting_started),
and install the necessary software according to your OS
(it takes quite some time to install).
Once the environment is ready,
build the firmware for Crkbd with the following command.
```
make crkbd: default
```
When the build is completed,
execute the following command.
```
make crkbd: default: 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.
```
<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]
Detecting USB port, reset your controller now ........
```
Once the firmware has been written to one side of the Pro Micro,
follow the same procedure for the other side.
See below to flash the firmware to the ProMicro. \
https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md
This is the end.

33
corne-chocolate/doc/buildguide_jp.md
View File

@ -34,8 +34,8 @@
| SK6812MINI | 54個 | 上向き実装 42個、下向き実装 12個 |
## 事前準備
実装の途中でProMicroにファームを入れる作業がありますが、ファームをビルドする環境を整備するのは時間がかかるのではじめに取り掛かっておくことをおすすめします。
https://docs.qmk.fm/#/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます(インストールに時間がかかるため動かしつつ実装を進めると効率的です)。
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
## 実装
@ -191,33 +191,8 @@ LEDは４つずつはんだづけを行いますが、一度に４つ行わず
![33](https://user-images.githubusercontent.com/736191/52534914-00e19a80-2d8b-11e9-8005-7e0b157e09e4.png)
## ファームウェア
https://docs.qmk.fm/#/newbs_getting_started こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
環境ができましたら、下記コマンドで Crkbd 用にファームウェアをビルドします。
```
make crkbd:default
```
ビルドが完了したら下記コマンドを実行します。
```
make crkbd:default:avrdude
```
実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
```
<省略>
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........
```
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
下記を参照しファームウェアをProMicroに書き込みます。\
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
以上で完成です。

34
corne-classic/doc/buildguide_en.md
View File

@ -29,6 +29,10 @@
![image](https://user-images.githubusercontent.com/736191/40734610-e1ca0136-6473-11e8-8ac7-7bfa4b843f93.png)
## 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. \
For more information, please see https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md.
## Soldering
PCB is reversible; use one for the left hand side and the other for the right.
@ -193,34 +197,8 @@ Lastly install keycaps.
## 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.
See below to flash the firmware to the ProMicro. \
https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md
### Turning LEDS on
To turn the LEDs on, you have to edit the `rules.mk` file. If you use the default layout, it can be found here `keyboards/crkbd/keymaps/default/rules.mk`. Add the following line to the top of the file:

33
corne-classic/doc/buildguide_jp.md
View File

@ -30,8 +30,8 @@
![image](https://user-images.githubusercontent.com/736191/40734610-e1ca0136-6473-11e8-8ac7-7bfa4b843f93.png)
## 事前準備
実装の途中でProMicroにファームを入れる作業がありますが、ファームをビルドする環境を整備するのは時間がかかるのではじめに取り掛かっておくことをおすすめします。
https://docs.qmk.fm/#/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます(インストールに時間がかかるため動かしつつ実装を進めると効率的です)。
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
## 実装
@ -179,32 +179,7 @@ LEDを実装した場合はすべて点灯することを確認します。
![lrg_dsc03895](https://user-images.githubusercontent.com/736191/40888756-c371e264-6796-11e8-8fc5-e842e8baf2b8.png)
## ファームウェア
https://docs.qmk.fm/#/newbs_getting_started こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
環境ができましたら、下記コマンドで Crkbd 用にファームウェアをビルドします。
```
make crkbd:default
```
ビルドが完了したら下記コマンドを実行します。
```
make crkbd:default:avrdude
```
実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
この間にリセットスイッチを __2回__ 押すとファームウェアの書き込みが完了します。
```
<省略>
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........
```
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
下記を参照しファームウェアをProMicroに書き込みます。\
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
以上で完成です。

35
corne-light/doc/v1/buildguide_jp.md
View File

@ -110,8 +110,8 @@
</table>
## 事前準備
実装の途中でProMicroにファームを入れる作業がありますが、ファームをビルドする環境を整備するのは時間がかかるのではじめに取り掛かっておくことをおすすめします。
https://docs.qmk.fm/#/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます(インストールに時間がかかるため動かしつつ実装を進めると効率的です)。
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
## 実装
### PCBの切り離し
@ -171,35 +171,8 @@ https://docs.qmk.fm/#/newbs_getting_started こちら等を参考にし、OSに
<img alt="assembly-promicro-oled" src="https://user-images.githubusercontent.com/736191/69554644-6e427d00-0fe5-11ea-8c6b-9aaa3d2c3f6c.JPG" width="100%">
### ファームウェアの書き込み
ProMicroとOLEDモジュールを付けた段階でファームウェアを書き込み、動作確認をすることをおすすめします(キースイッチを付けたあとに不具合が見つかると厄介です)。
https://docs.qmk.fm/#/newbs_getting_started こちらを参照し、ファームウェアを書き込む環境を用意します。
環境ができたら下記コマンドで Crkbd 用にファームウェアをビルドします。
```
make crkbd:default
```
ビルドが完了したら下記コマンドを実行します。
```
make crkbd:default:avrdude
```
実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
```
<省略>
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........
```
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
下記を参照しファームウェアをProMicroに書き込みます。\
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
### 動作確認

55
corne-light/doc/v2/buildguide_low_edition_jp.md
View File

@ -33,10 +33,8 @@
| OLEDモジュール用ピンソケット 4連 2.5mm | 2つ | |
## 事前準備
組み立ての途中で ProMicro にファームウェアを入れる作業がありますが、ファームウェアをビルドする環境を整備するのには時間がかかるためはじめに取り掛かっておくことをおすすめします。
https://docs.qmk.fm/#/ja/newbs_getting_started を参考にし、OSに合わせて必要なものをインストールしておきます。
インストールに時間がかかるため動かしつつ組み立てを進めると効率的です。
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
## 確認
@ -120,53 +118,8 @@ OLED用のピンソケットにピンヘッダを先に差し込み、その後
![build_oled](assets/build_oled.jpg)
### ファームウェア
https://docs.qmk.fm/#/ja/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます。
上記の事前準備にも挙げたとおり、インストールに時間がかかるため事前に用意しておくことをおすすめします。
Corne 用のファームウェアは `keyboards/crkbd` です。
なお、LEDはデフォルトでは無効になっているため、`keyboards/crkbd/rules.mk` にて `RGBLIGHT_ENABLE = yes` と変更する必要があります。
```diff
diff --git a/keyboards/crkbd/rules.mk b/keyboards/crkbd/rules.mk
index 30de5b388..174dd5c7e 100644
--- a/keyboards/crkbd/rules.mk
+++ b/keyboards/crkbd/rules.mk
@@ -26,7 +26,7 @@ MIDI_ENABLE = no # MIDI controls
AUDIO_ENABLE = no # Audio output on port C6
UNICODE_ENABLE = no # Unicode
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
-RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight.
+RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight.
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
```
環境ができたら、下記コマンドでファームウェアをビルドします。
```bash
make crkbd:default
```
ビルドが完了したら下記コマンドを実行します。
```bash
make crkbd:default:avrdude
```
実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
```bash
<省略>
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........
```
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
下記を参照しファームウェアをProMicroに書き込みます。\
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
### 動作確認
ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします。

2
corne-light/pcb/kbd

@ -1 +1 @@
Subproject commit f829a12d88a0cb7cf553ddcb0b7139f8a2abec80
Subproject commit f90510c11b6df53bcdb55740b0d59183957e4036

BIN
doc/assets/qmk_toolbox_begin.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 64 KiB

BIN
doc/assets/qmk_toolbox_download.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 187 KiB

BIN
doc/assets/qmk_toolbox_flash.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 62 KiB

BIN
doc/assets/qmk_toolbox_flashed.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 161 KiB

BIN
doc/assets/via_begin.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 152 KiB

BIN
doc/assets/via_download.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 169 KiB

BIN
doc/assets/via_keymap_configure.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 164 KiB

BIN
doc/assets/via_keymap_tester.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 91 KiB

BIN
doc/assets/via_keymap_tester_matrix.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 55 KiB

BIN
doc/assets/via_lighting.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 85 KiB

124
doc/firmware_en.md Normal file
View File

@ -0,0 +1,124 @@
# Firmware
## Flash the firmware
There are several ways to flash the firmware, but using [QMK Toolbox](https://github.com/qmk/qmk_toolbox) is the easiest way.
### Download QMK Toolbox
Download QMK Toolbox from the following link.\
https://github.com/qmk/qmk_toolbox/releases/
![qmk_toolbox_download](assets/qmk_toolbox_download.jpg)
Install QMK Toolbox from the downloaded file. \
Follow the instructions for each operating system for installation.
Open QMK Toolbox, you will see a window like the one below.
![qmk_toolbox_begin](assets/qmk_toolbox_begin.jpg)
### Flash the firmware
Download the firmware of VIA from the following link.\
[crkbd_rev1_common_via.hex](https://github.com/foostan/qmk_firmware-hex/releases/download/release-20201103/crkbd_rev1_common_via.hex)
Specify the file downloaded from "**Open**" in QMK Toolbox.
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. \
If you see the message, it's done.
![qmk_toolbox_flashed](assets/qmk_toolbox_flashed.jpg)
Once the firmware has been written to one side of the Pro Micro,
follow the same procedure for the other side.
### (Optional) If you build the firmware yourself
Refer to [the QMK _getting started_ guide](https://docs.qmk.fm/#/newbs_getting_started),
and install the necessary software according to your OS
(it takes quite some time to install).
Once the environment is ready,
build the firmware for Crkbd with the following command.
```
make crkbd/rev1/common:via
```
When the build is completed,
execute the following command.
```
make crkbd/rev1/common: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.
```
<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]
Detecting USB port, reset your controller now ........
```
Once the firmware has been written to one side of the Pro Micro,
follow the same procedure for the other side.
## Change your keymap
The Corne Keyboard is supported by [VIA](https://caniusevia.com/). \
It can be used by flashing the firmware for VIA as described above.
### Download VIA
Download VIA from the following link.\
https://github.com/the-via/releases/releases/
![via_download](assets/via_download.jpg)
Install VIA from the downloaded file. \
Follow the instructions for each operating system for installation.
When VIA is opened with the keyboard plugged in, the following window will appear.
![via_begin](assets/via_begin.jpg)
### KEYMAP / CONFIGURE
In this screen, you can change the key map.
There are several types of keys that can be changed and you can find them in the "1" area.
If you want to change the key, click on "2" to change the key and "3" to select the key you want to change.
VIA instantly changes the keymap.
![via_keymap_configure](assets/via_keymap_configure.jpg)
### KEYMAP / TESTER
In this screen, you can test the operation of the keymap.
You can confirm that the key is set correctly by checking that the color of the key you press changes.
![via_keymap_tester](assets/via_keymap_tester.jpg)
Test Matrix allows you to check the operation of each switch on the keyboard.
It is easier to check the operation of each switch after build.
![via_keymap_tester_matrix](assets/via_keymap_tester_matrix.jpg)
### LIGHTING
In this screen, you can change the pattern and color of the LEDs.
![via_lighitng](assets/via_lighting.jpg)

113
doc/firmware_jp.md Normal file
View File

@ -0,0 +1,113 @@
# ファームウェア
## ファームウェアの書き込み
ファームウェアの書き込み方法はいくつか用意されていますが、[QMK Toolbox](https://github.com/qmk/qmk_toolbox) を利用する方法が手軽です。
### QMK Toolbox のダウンロード
下記のURLから最新版の QMK Toolbox をダウンロードします。\
https://github.com/qmk/qmk_toolbox/releases/
![qmk_toolbox_download](assets/qmk_toolbox_download.jpg)
ダウンロードしたファイルから QMK Toolbox をインストールします。\
インストール方法は各OSの指示に従ってください。
QMK Toolbox を開くと下記のようなウィンドウが表示されます。
![qmk_toolbox_begin](assets/qmk_toolbox_begin.jpg)
### ファームウェアの書き込み
VIA用のファームウェアを下記よりダウンロードします。\
[crkbd_rev1_common_via.hex](https://github.com/foostan/qmk_firmware-hex/releases/download/release-20201103/crkbd_rev1_common_via.hex)
QMK Toolbox の 「**Open**」 からダウンロードしたファイルを指定します。\
また「**Auto-Flash**」のチェックボックスをチェックします。
![qmk_toolbox_flash](assets/qmk_toolbox_flash.jpg)
この状態でキーボードをUSBで接続し、リセットボタンを押すとファームウェアの書き込みが始まります。\
下記のように書き込みのメッセージが表示されれば完了です。
![qmk_toolbox_flashed](assets/qmk_toolbox_flashed.jpg)
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
### (オプション) 自分でファームウェアをビルドする場合
https://docs.qmk.fm/#/newbs_getting_started こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
環境ができましたら、下記コマンドで Crkbd 用にファームウェアをビルドします。
```
make crkbd/rev1/common:via
```
ビルドが完了したら下記コマンドを実行します。
```
make crkbd/rev1/common:via:avrdude
```
実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
なおProMicroによって1回の場合もあります。
```
<省略>
Checking file size of crkbd_rev1_common_via.hex [OK]
* File size is fine - 27328/28672
Copying crkbd_rev1_common_via.hex to qmk_firmware folder [OK]
Detecting USB port, reset your controller now........
```
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
## キーマップの変更
Corne Keyboard は [VIA](https://caniusevia.com/) に対応しています。\
上記の手順で VIA 用のファームウェアを書き込むことで利用することできます。
### VIA のダウンロード
下記のURLから最新版の VIA をダウンロードします。\
https://github.com/the-via/releases/releases/
![via_download](assets/via_download.jpg)
ダウンロードしたファイルから VIA をインストールします。\
インストール方法は各OSの指示に従ってください。
キーボードを接続した状態で VIA を開くと下記のようなウィンドウが表示されます。
![via_begin](assets/via_begin.jpg)
### KEYMAP / CONFIGURE
この画面ではキーマップが変更できます。
変更可能なキーはいくつかの種類に分類されていて、「１」のエリアから探すことができます。
キーを変更する場合は「2」変更する場所をクリックし、「3」変更したいキーを選択します。
なお VIA では瞬時にキーマップが書き換わります。
![via_keymap_configure](assets/via_keymap_configure.jpg)
### KEYMAP / TESTER
この画面ではキーマップの動作テストができます。
押したキーの色が変わることでキーが正しく設定されていることが確認できます。
![via_keymap_tester](assets/via_keymap_tester.jpg)
Test Matrix ではキーボードの各スイッチの動作確認ができます。
実装後の動作確認はこちらで行ったほうがわかりやすいです。
![via_keymap_tester_matrix](assets/via_keymap_tester_matrix.jpg)
### LIGHTING
この画面ではLEDのパターンや色の変更ができます。
![via_lighitng](assets/via_lighting.jpg)