2021-06-13 03:11:56 +08:00
|
|
|
# ファームウェアを書き込む
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
<!---
|
2019-11-15 10:22:55 +08:00
|
|
|
grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
|
2021-06-13 03:11:56 +08:00
|
|
|
original document: 0.12.45:docs/newbs_flashing.md
|
|
|
|
|
git diff 0.12.45 HEAD -- docs/newbs_flashing.md | cat
|
2019-11-12 06:27:48 +08:00
|
|
|
-->
|
|
|
|
|
|
2021-06-13 03:11:56 +08:00
|
|
|
カスタムファームウェアは出来たので、いよいよキーボードへの書き込み(フラッシュ)です。
|
2019-11-12 06:27:48 +08:00
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
## キーボードを DFU (Bootloader) モードにする
|
|
|
|
|
|
|
|
|
|
カスタムファームウェアを書き込むには、最初にキーボードを普段とは違う特別な状態、フラッシュモードにする必要があります。
|
|
|
|
|
このモードでは、キーボードはキーボードとしての機能を果たしません。
|
|
|
|
|
ファームウェアの書き込み中にキーボードのケーブルを抜いたり、書き込みプロセスを中断したりしないことが非常に重要です。
|
|
|
|
|
|
|
|
|
|
キーボードによって、この特別なモードに入る方法は異なります。
|
|
|
|
|
PCB が現在 QMK、TMK、PS2AVRGB (Bootmapper Client) を実行しており、キーボードメーカーから具体的な指示が与えられていない場合は、次を順番に試してください。
|
|
|
|
|
|
|
|
|
|
* 両方のシフトキーを押しながら、`Pause` キーを押す
|
|
|
|
|
* 両方のシフトキーを押しながら、`B` キーを押す
|
|
|
|
|
* キーボードのケーブルを抜いて、スペースバーと `B` を同時に押しながら、キーボードを再び接続し、1秒待ってからキーを放す
|
|
|
|
|
* キーボードのケーブルを抜いて、左上か左下のキー(通常は Escape か左 Control)を押しながらキーボードを接続する
|
|
|
|
|
* 通常、PCB の裏側に付けられている物理的な `RESET` ボタンを押す
|
|
|
|
|
* PCB 上の `RESET` か `GND` のラベルの付いたヘッダピンを探し、PCB 接続中にそれらを互いにショートする
|
|
|
|
|
|
|
|
|
|
上記を全て試してもうまくいかず、基板のメインチップに `STM32` と表示されている場合、これは少し複雑になる可能性があります。通常、最善の方法は [Discord](https://discord.gg/Uq7gcHh) で助けを求めることです。おそらく基板の写真をいくつか求められるでしょう。あらかじめそれらを準備することができれば物事を進めるのに役立ちます！
|
|
|
|
|
|
|
|
|
|
それ以外の場合は、QMK Toolbox で次のような黄色のメッセージが表示されます:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
*** DFU device connected: Atmel Corp. ATmega32U4 (03EB:2FF4:0000)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
そして、このブートローダデバイスはデバイスマネージャーやシステム情報.app、`lsusb` にも表示されます。
|
|
|
|
|
|
2019-11-12 06:27:48 +08:00
|
|
|
## QMK Toolbox を使ってキーボードに書き込む
|
|
|
|
|
|
|
|
|
|
キーボードに書き込む最も簡単な方法は [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) を使うことです。
|
|
|
|
|
|
|
|
|
|
ただし、QMK Toolbox は、現在は Windows と macOS でしか使えません。
|
2020-08-01 10:08:43 +08:00
|
|
|
Linux を使用している場合(および、コマンドラインでファームウェアを書き込みたい場合)は、[コマンドラインからキーボードを書き込む](#flash-your-keyboard-from-the-command-line)節まで進んでください。
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
### QMK Toolbox にファイルをロードする
|
|
|
|
|
|
|
|
|
|
まず QMK Toolbox アプリケーションを起動します。
|
|
|
|
|
Finder またはエクスプローラーでファームウェアのファイルを探します。
|
2020-08-01 10:08:43 +08:00
|
|
|
キーボードのファームウェアは `.hex` または `.bin` のどちらかの形式です。
|
2019-11-12 06:27:48 +08:00
|
|
|
ビルド時に QMK は、キーボードに適した形式のものを `qmk_firmware` のトップフォルダにコピーしているはずです。
|
|
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
Windows か macOS を使用している場合、現在のフォルダをエクスプローラーか Finder で簡単に開くためのコマンドがあります。
|
2019-11-12 06:27:48 +08:00
|
|
|
|
2021-06-13 03:11:56 +08:00
|
|
|
<!-- tabs:start -->
|
|
|
|
|
|
|
|
|
|
#### ** Windows **
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
start .
|
|
|
|
|
```
|
|
|
|
|
|
2021-06-13 03:11:56 +08:00
|
|
|
#### ** macOS **
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
open .
|
|
|
|
|
```
|
|
|
|
|
|
2021-06-13 03:11:56 +08:00
|
|
|
<!-- tabs:end -->
|
|
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
ファームウェアファイルは常に以下の命名形式に従っています:
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
<keyboard_name>_<keymap_name>.{bin,hex}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
例えば、`plank/rev5` の `default` キーマップのファイル名は以下のようになります:
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
planck_rev5_default.hex
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
ファームウェアファイルを見つけたら、QMK Toolbox の "Local file" ボックスにドラッグするか、"Open" をクリックしてファームウェアファイルが格納されている場所を指定します。
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
### キーボードへの書き込み
|
|
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
QMK Toolbox の `Flash` ボタンをクリックします。次のような出力が表示されます。
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
```
|
2020-08-01 10:08:43 +08:00
|
|
|
*** DFU device connected: Atmel Corp. ATmega32U4 (03EB:2FF4:0000)
|
2019-11-12 06:27:48 +08:00
|
|
|
*** Attempting to flash, please don't remove device
|
2020-08-01 10:08:43 +08:00
|
|
|
>>> dfu-programmer.exe atmega32u4 erase --force
|
2019-11-12 06:27:48 +08:00
|
|
|
Erasing flash... Success
|
|
|
|
|
Checking memory from 0x0 to 0x6FFF... Empty.
|
2020-08-01 10:08:43 +08:00
|
|
|
>>> dfu-programmer.exe atmega32u4 flash "D:\Git\qmk_firmware\gh60_satan_default.hex"
|
|
|
|
|
Checking memory from 0x0 to 0x3F7F... Empty.
|
|
|
|
|
0% 100% Programming 0x3F80 bytes...
|
2019-11-12 06:27:48 +08:00
|
|
|
[>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
|
|
|
|
|
0% 100% Reading 0x7000 bytes...
|
|
|
|
|
[>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
|
|
|
|
|
Validating... Success
|
2020-08-01 10:08:43 +08:00
|
|
|
0x3F80 bytes written into 0x7000 bytes memory (56.70%).
|
|
|
|
|
>>> dfu-programmer.exe atmega32u4 reset
|
2019-11-12 06:27:48 +08:00
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
*** DFU device disconnected: Atmel Corp: ATmega32U4 (03EB:2FF4:0000)
|
2019-11-12 06:27:48 +08:00
|
|
|
```
|
|
|
|
|
|
2019-11-21 18:36:38 +08:00
|
|
|
## コマンドラインでファームウェアを書き込む :id=flash-your-keyboard-from-the-command-line
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
これは、以前のものと比較して非常に単純になりました。
|
2020-08-01 10:08:43 +08:00
|
|
|
ファームウェアをコンパイルして書き込む準備ができたら、ターミナルウィンドウを開いて書き込みコマンドを実行します:
|
2019-11-12 06:27:48 +08:00
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
qmk flash
|
2019-11-12 06:27:48 +08:00
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
もし CLI でキーボードやキーマップ名を設定していない場合や、複数のキーボードを持っている場合、キーボードとキーマップを指定することができます:
|
2019-11-12 06:27:48 +08:00
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
qmk flash -kb <my_keyboard> -km <my_keymap>
|
2019-11-12 06:27:48 +08:00
|
|
|
|
2020-08-01 10:08:43 +08:00
|
|
|
これはキーボードの設定を確認し、指定されたブートローダに基づいて書き込もうとします。これはどのブートローダをキーボードが使っているか知る必要がないことを意味します。単にコマンドを実行し、コマンドに重い仕事をさせましょう。
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
ただし、これはキーボードごとに設定されているブートローダに依存します。
|
2020-08-01 10:08:43 +08:00
|
|
|
もし、この情報が設定されていない場合、または、使用しているキーボードが、ファームウェア書き込みでサポートされているターゲットを持っていない場合、次のエラーが表示されます:
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
WARNING: This board's bootloader is not specified or is not supported by the ":flash" target at this time.
|
|
|
|
|
|
2021-06-13 03:11:56 +08:00
|
|
|
この場合、あなたは明示的にブートローダを指定する方法を使わなければなりません。詳細は、[ファームウェアのフラッシュ](ja/flashing.md)ガイドを参照してください。
|
2019-11-12 06:27:48 +08:00
|
|
|
|
|
|
|
|
## テストしましょう！
|
|
|
|
|
|
2021-06-13 03:11:56 +08:00
|
|
|
おめでとうございます！カスタムファームウェアがキーボードにプログラムされ、テストする準備ができました！
|
|
|
|
|
|
|
|
|
|
少し運が良ければ全てが完璧に機能しますが、そうでない場合は何が問題なのかを理解するのに役立つ手順があります。
|
|
|
|
|
通常、キーボードのテストは非常に簡単です。全てのキーをひとつずつ押して、期待するキーが送信されることを確認します。例え QMK で動作していない場合でも、[QMK Configurator](https://config.qmk.fm/#/test/) のテストモードを使用すると、キーボードをチェックできます。
|
2019-11-12 06:27:48 +08:00
|
|
|
|
2021-06-13 03:11:56 +08:00
|
|
|
まだ動作しませんか？詳細については FAQ トピックを参照するか、[Discord でチャット](https://discord.gg/Uq7gcHh)してください。
|
