Skip to content

Commit 5e9f077

Browse files
committed
Update firmware docs
1 parent 2f32498 commit 5e9f077

File tree

2 files changed

+62
-184
lines changed

2 files changed

+62
-184
lines changed

docs/firmware/firmware_en.md

+29-93
Original file line numberDiff line numberDiff line change
@@ -1,126 +1,62 @@
11
# Firmware
22

3-
## Flash the firmware
3+
## Flash the firmware for rev4
4+
Download the firmware of VIA from below
5+
- [crkbd_rev4_standard_via.uf2](https://github.com/foostan/kbd_firmware/blob/main/keyboards/crkbd/qmk/qmk_firmware/.build/crkbd_rev4_standard_via.uf2)
6+
- [crkbd_rev4_mini_via.uf2](https://github.com/foostan/kbd_firmware/blob/main/keyboards/crkbd/qmk/qmk_firmware/.build/crkbd_rev4_mini_via.uf2)
47

5-
There are several ways to flash the firmware,
6-
but using [QMK Toolbox](https://github.com/qmk/qmk_toolbox) is the easiest way.
8+
Connect to the PC while holding down the BOOT button, or while connected to the PC, hold down the BOOT button and press the RESET button.
9+
After that, an RPI-PR2 device will be mounted.
710

8-
### Download QMK Toolbox
11+
![btn](https://github.com/foostan/kbd_firmware/assets/736191/05fd9c4b-12c7-4a32-9606-8fea27bfe7b4)
912

10-
Download QMK Toolbox from the following link.\
11-
<https://github.com/qmk/qmk_toolbox/releases/>
13+
Drop the downloaded uf2 file into the RPI-PR2 device to complete flash.
1214

13-
![qmk_toolbox_download](assets/qmk_toolbox_download.jpg)
15+
![flash](https://github.com/foostan/crkbd/assets/736191/5e5e6eab-3ad3-47f1-9871-1e2bfe554490)
1416

15-
Install QMK Toolbox from the downloaded file. \
16-
Follow the instructions for each operating system for installation.
17+
Once the firmware has been written to one side, follow the same procedure for the other side.
1718

18-
Open QMK Toolbox, you will see a window like the one below.
19+
## Flash the firmware for rev1
1920

20-
![qmk_toolbox_begin](assets/qmk_toolbox_begin.jpg)
21+
### Use [Remap](https://remap-keys.app/catalog/EfziB9K7ZcxLnIHXl5AQ/firmware)
22+
The easiest and most recommended way is to go to Remap and select FLASH for crkbd:via.
2123

22-
### Flash the firmware
24+
![flash_by_remap](https://github.com/foostan/kbd_firmware/assets/736191/78b74abe-9853-4a5f-9577-421d39a4a380)
2325

24-
Download the firmware of VIA from the following link.\
25-
[crkbd_rev1_common_via.hex](https://raw.githubusercontent.com/foostan/qmk_firmware-hex/main/.build/crkbd_rev1_via.hex)
26+
Once the firmware has been written to one side, follow the same procedure for the other side.
2627

27-
Specify the file downloaded from "**Open**" in QMK Toolbox.
28-
And enable the check box for "**Auto-Flash**".
28+
### Use [QMK Toolbox](https://github.com/qmk/qmk_toolbox)
2929

30-
![qmk_toolbox_flash](assets/qmk_toolbox_flash.jpg)
30+
Download the firmware of VIA from [crkbd_rev1_via.hex](https://github.com/foostan/kbd_firmware/blob/main/keyboards/crkbd/qmk/qmk_firmware/.build/crkbd_rev1_via.hex)
3131

3232
With the keyboard connected via USB,
3333
press the reset button **twice** or short **GND & RST** pins on ProMicro to start flashing the firmware. \
3434
If you see the message, it's done.
3535

3636
![qmk_toolbox_flashed](assets/qmk_toolbox_flashed.jpg)
3737

38-
Once the firmware has been written to one side of the Pro Micro,
39-
follow the same procedure for the other side.
38+
Once the firmware has been written to one side, follow the same procedure for the other side.
4039

41-
### (Optional) If you build the firmware yourself
40+
## (Optional) If you build the firmware yourself
4241

4342
Refer to [the QMK _getting started_ guide](https://docs.qmk.fm/#/newbs_getting_started),
4443
and install the necessary software according to your OS
4544
(it takes quite some time to install).
4645

4746
Once the environment is ready,
48-
build the firmware for Crkbd with the following command.
49-
50-
```
51-
make crkbd:via
52-
```
53-
54-
When the build is completed,
55-
execute the following command to flash.
56-
57-
```
58-
make crkbd:via:avrdude
59-
```
60-
61-
When you execute it,
62-
you will see the following output (`.`'s progressively appearing).
63-
Press the reset switch **twice** or short **GND & RST** pins on ProMicro during this time to complete the firmware writing.
64-
Depending on the ProMicro, it may be only require pressing reset switch once.
65-
66-
```
67-
Checking file size of crkbd_rev1_default.hex [OK]
68-
* File size is fine-27328/28672
69-
Copying crkbd_rev1_default.hex to qmk_firmware folder [OK]
70-
Detecting USB port, reset your controller now ........
71-
```
72-
73-
Once the firmware has been written to one side of the Pro Micro,
74-
follow the same procedure for the other side.
47+
build the firmware for Crkbd with the following files.
48+
https://github.com/foostan/kbd_firmware/tree/main/keyboards/crkbd/qmk/qmk_firmware
7549

7650
## Change your keymap
7751

78-
The Corne Keyboard is supported by [VIA](https://caniusevia.com/). \
79-
It can be used by flashing the firmware for VIA as described above.
80-
81-
### Download VIA
82-
83-
Download VIA from the following link.\
84-
<https://github.com/the-via/releases/releases/>
85-
86-
![via_download](assets/via_download.jpg)
87-
88-
Install VIA from the downloaded file. \
89-
Follow the instructions for each operating system for installation.
90-
91-
When VIA is opened with the keyboard plugged in, the following window will appear.
92-
93-
![via_begin](assets/via_begin.jpg)
94-
95-
### Configure
96-
97-
In this screen, you can change the keymap.
98-
99-
There are several types of keys that can be changed
100-
and you can find them in the "1" area.
101-
If you want to change the key,
102-
click on "2" to change the key and "3" to select the key you want to change.
103-
VIA instantly changes the keymap.
104-
105-
![via_keymap_configure](assets/via_keymap_configure.jpg)
106-
107-
### Tester
108-
109-
In this screen, you can test the operation of the keymap.
110-
111-
You can confirm that the key is set correctly
112-
by checking that the color of the key you press changes.
113-
114-
![via_keymap_tester](assets/via_keymap_tester.jpg)
115-
116-
Test Matrix allows you to check the operation of each switch on the keyboard.
117-
It is easier to check the operation of each switch after build.
118-
119-
![via_keymap_tester_matrix](assets/via_keymap_tester_matrix.jpg)
120-
121-
### Lighting
52+
The Corne Keyboard is supported by [VIA](https://usevia.app/). \
53+
It can be used by flashing the firmware for VIA.
12254

123-
In this screen, you can change the pattern and color of the LEDs.
55+
### for v4
12456

125-
![via_lighitng](assets/via_lighting.jpg)
57+
If you use Corne v4, please download json file from bellow and load at VIA
58+
- [Corne v4](https://github.com/foostan/kbd_firmware/blob/main/keyboards/crkbd/the-via/crkbd_rev4.json)
59+
- [Corne v4 mini](https://github.com/foostan/kbd_firmware/blob/main/keyboards/crkbd/the-via/crkbd_rev4_mini.json)
12660

61+
![load_json](https://github.com/foostan/kbd_firmware/assets/736191/67398174-0ef7-4698-9e39-6595b8320428)
62+
![loaded_json](https://github.com/foostan/kbd_firmware/assets/736191/e3e850a8-a5c1-4116-a43d-b2b71c2f606e)

docs/firmware/firmware_jp.md

+33-91
Original file line numberDiff line numberDiff line change
@@ -1,115 +1,57 @@
11
# ファームウェア
22

3-
## ファームウェアの書き込み
3+
## ファームウェアの書き込み for rev4
4+
VIA用のファームウェアを下記からダウンロードします
5+
- [crkbd_rev4_standard_via.uf2](https://github.com/foostan/kbd_firmware/blob/main/keyboards/crkbd/qmk/qmk_firmware/.build/crkbd_rev4_standard_via.uf2)
6+
- [crkbd_rev4_mini_via.uf2](https://github.com/foostan/kbd_firmware/blob/main/keyboards/crkbd/qmk/qmk_firmware/.build/crkbd_rev4_mini_via.uf2)
47

5-
ファームウェアの書き込み方法はいくつか用意されていますが、[QMK Toolbox](https://github.com/qmk/qmk_toolbox) を利用する方法が手軽です。
8+
BOOTボタンを押しながらPCに接続するか、PCに接続した状態でBOOTボタンを押しながらリセットボタンを押します。
9+
すると、RPI-PR2デバイスがマウントされます。
10+
![btn](https://github.com/foostan/kbd_firmware/assets/736191/05fd9c4b-12c7-4a32-9606-8fea27bfe7b4)
611

7-
### QMK Toolbox のダウンロード
12+
ダウンロードしたuf2ファイルをRPI-PR2デバイスにドロップすると書き込みが完了します。
13+
![flash](https://github.com/foostan/crkbd/assets/736191/5e5e6eab-3ad3-47f1-9871-1e2bfe554490)
814

9-
下記のURLから最新版の QMK Toolbox をダウンロードします。\
10-
<https://github.com/qmk/qmk_toolbox/releases/>
15+
片側にファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
1116

12-
![qmk_toolbox_download](assets/qmk_toolbox_download.jpg)
17+
## ファームウェアの書き込み for rev1
1318

14-
ダウンロードしたファイルから QMK Toolbox をインストールします。\
15-
インストール方法は各OSの指示に従ってください。
19+
### [Remap](https://remap-keys.app/catalog/EfziB9K7ZcxLnIHXl5AQ/firmware) を使う
20+
最も簡単で推奨する方法はRemapを使って crkbd:via を書き込む方法です。
21+
Remapにアクセスし指示に従って書き込みを行ってください。
22+
![flash_by_remap](https://github.com/foostan/kbd_firmware/assets/736191/78b74abe-9853-4a5f-9577-421d39a4a380)
1623

17-
QMK Toolbox を開くと下記のようなウィンドウが表示されます
24+
片側にファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います
1825

19-
![qmk_toolbox_begin](assets/qmk_toolbox_begin.jpg)
26+
### Flash the firmware by [QMK Toolbox](https://github.com/qmk/qmk_toolbox) を使う
2027

21-
### ファームウェアの書き込み
28+
VIA用のファームウェアを [crkbd_rev1_via.hex](https://github.com/foostan/kbd_firmware/blob/main/keyboards/crkbd/qmk/qmk_firmware/.build/crkbd_rev1_via.hex) からダウンロードします。
2229

23-
VIA用のファームウェアを下記よりダウンロードします。\
24-
[crkbd_rev1_common_via.hex](https://raw.githubusercontent.com/foostan/qmk_firmware-hex/main/.build/crkbd_rev1_via.hex)
25-
26-
QMK Toolbox の 「**Open**」 からダウンロードしたファイルを指定します。\
27-
また「**Auto-Flash**」のチェックボックスをチェックします。
28-
29-
![qmk_toolbox_flash](assets/qmk_toolbox_flash.jpg)
30-
31-
この状態でキーボードをUSBで接続し、リセットボタンを押すとファームウェアの書き込みが始まります。\
30+
QMK Toolbox の 「Open」 からダウンロードしたファイルを指定します。
31+
そしてキーボードをUSBで接続し、リセットボタンを押すとファームウェアの書き込みが始まります。
3232
下記のように書き込みのメッセージが表示されれば完了です。
3333

3434
![qmk_toolbox_flashed](assets/qmk_toolbox_flashed.jpg)
3535

36-
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
37-
38-
### (オプション) 自分でファームウェアをビルドする場合
39-
40-
<https://docs.qmk.fm/#/newbs_getting_started> こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
41-
42-
環境ができましたら、下記コマンドで Crkbd 用にファームウェアをビルドします。
43-
44-
```
45-
make crkbd/rev1/common:via
46-
```
36+
片側にファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
4737

48-
ビルドが完了したら下記コマンドを実行します。
38+
## (オプション) 自分でファームウェアをビルドする場合
4939

50-
```
51-
make crkbd/rev1/common:via:avrdude
52-
```
40+
[the QMK _getting started_ guide](https://docs.qmk.fm/#/newbs_getting_started) こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
5341

54-
実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
55-
この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
56-
なおProMicroによって1回の場合もあります。
57-
58-
```
59-
<省略>
60-
61-
Checking file size of crkbd_rev1_common_via.hex [OK]
62-
* File size is fine - 27328/28672
63-
Copying crkbd_rev1_common_via.hex to qmk_firmware folder [OK]
64-
Detecting USB port, reset your controller now........
65-
```
66-
67-
片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
42+
環境ができましたら、下記のファイルを利用して自身でビルドを行ってください。
43+
https://github.com/foostan/kbd_firmware/tree/main/keyboards/crkbd/qmk/qmk_firmware
6844

6945
## キーマップの変更
7046

71-
Corne Keyboard は [VIA](https://caniusevia.com/) に対応しています。\
72-
上記の手順で VIA 用のファームウェアを書き込むことで利用することできます。
73-
74-
### VIA のダウンロード
75-
76-
下記のURLから最新版の VIA をダウンロードします。\
77-
<https://github.com/the-via/releases/releases/>
78-
79-
![via_download](assets/via_download.jpg)
80-
81-
ダウンロードしたファイルから VIA をインストールします。\
82-
インストール方法は各OSの指示に従ってください。
83-
84-
キーボードを接続した状態で VIA を開くと下記のようなウィンドウが表示されます。
85-
86-
![via_begin](assets/via_begin.jpg)
87-
88-
### KEYMAP / CONFIGURE
89-
90-
この画面ではキーマップが変更できます。
91-
92-
変更可能なキーはいくつかの種類に分類されていて、「1」のエリアから探すことができます。
93-
キーを変更する場合は「2」変更する場所をクリックし、「3」変更したいキーを選択します。
94-
なお VIA では瞬時にキーマップが書き換わります。
95-
96-
![via_keymap_configure](assets/via_keymap_configure.jpg)
97-
98-
### KEYMAP / TESTER
99-
100-
この画面ではキーマップの動作テストができます。
101-
102-
押したキーの色が変わることでキーが正しく設定されていることが確認できます。
103-
104-
![via_keymap_tester](assets/via_keymap_tester.jpg)
105-
106-
Test Matrix ではキーボードの各スイッチの動作確認ができます。
107-
実装後の動作確認はこちらで行ったほうがわかりやすいです。
108-
109-
![via_keymap_tester_matrix](assets/via_keymap_tester_matrix.jpg)
47+
Corne Keyboardは [VIA](https://usevia.app/) に対応しています。\
48+
VIA用のファームウェアを書き込むことで利用することできます。
11049

111-
### LIGHTING
50+
### for v4
11251

113-
この画面ではLEDのパターンや色の変更ができます。
52+
Corne v4を使う場合は、下記からjsonファイルをダウンロードし、VIAでロードしてください。
53+
- [Corne v4](https://github.com/foostan/kbd_firmware/blob/main/keyboards/crkbd/the-via/crkbd_rev4.json)
54+
- [Corne v4 mini](https://github.com/foostan/kbd_firmware/blob/main/keyboards/crkbd/the-via/crkbd_rev4_mini.json)
11455

115-
![via_lighitng](assets/via_lighting.jpg)
56+
![load_json](https://github.com/foostan/kbd_firmware/assets/736191/67398174-0ef7-4698-9e39-6595b8320428)
57+
![loaded_json](https://github.com/foostan/kbd_firmware/assets/736191/e3e850a8-a5c1-4116-a43d-b2b71c2f606e)

0 commit comments

Comments
 (0)