ファームウェア取り扱いガイド
このガイドの対象
USBドライブに .uf2 ファイルをコピーして書き込むキーボード向けの共通手順です。機種固有の配布案内がある場合は、その案内を優先してください。UF2以外の形式を使う基板には、この手順をそのまま適用しないでください。
最初にファイルを選び、次に書き込み、最後に動作を確認します。通常の更新で、設定消去用の settings_reset を先に書き込む必要はありません。
1. 対応するファイルを用意する
製品別の案内
| 製品 | 配布元・設定リポジトリ | 選ぶときの注意 |
|---|---|---|
| SparAkasha | MeKaBuと共通。製品ガイドと購入時の配布案内を確認 | 商品名とファイル名が一致するとは限りません。左右・モジュール・マイコンの対応を確認 |
| MaRiMo | zmk-config-MRM | 3スロットのモジュール構成に対応するビルドを選択 |
| GeaconPolaris | zmk-config-GeaconPolaris | 左右で別ファイル。右手側は本ガイドで対応を案内しているトラックボール構成を選択 |
| Berkut51 | zmk-config-berkut51 | 中央のマイコン1台に書き込み。左右別のUF2は不要 |
| SparAkashaAnanta | zmk-config-SparAkashaAnanta | SAA_L／SAA_Rとモジュール構成を確認 |
| CornixLPトラックパッドモジュール | zmk-keyboard-cornix | TPS43親機と左右子機の3台ともUF2。ファイルは別々なので、製品ガイドの対応表・初回接続・復旧手順を確認 |
| Solkatstice | 購入時の配布案内を確認 | 本サイトでは配布URL・対象ファイル名が未確認。別機種のファイルを代用しない |
| Geacon | zmk-config-te9no | 日本語／英語配列に対応する構成を確認 |
| GeaconSolstice | 購入時の配布案内を確認 | 本サイトでは配布URL・対象ファイル名が未確認。左右・配列に対応するファイルを販売者に確認 |
リポジトリは設定やソースコードの置き場です。開いただけで完成済みUF2が見つかるとは限りません。
GitHubから入手する場合
- 製品の配布案内に従って、指定されたリリースまたは成功したGitHub Actionsの実行結果を開きます。
- Releasesでは配布用Assets、ActionsではArtifactsを確認します。ソースコードのZIPをUF2として使わないでください。
- ダウンロードしたZIPを展開し、対象のファイルを取り出します。Actionsの成果物のダウンロードにはGitHubへのログインが必要な場合があります。
- 下のチェック表で書き込み先と照合します。成果物がない・期限切れの場合は配布案内を確認し、別機種のファイルで代用しないでください。
自分でビルドする場合の流れは、ZMK公式のインストールガイドを参照してください。機種固有のリポジトリ設定は維持してください。
書き込み前のチェック表
| 確認するもの | 照合する内容 |
|---|---|
| 機種・基板の版 | 手元の製品に対応する配布元か。似た製品名だけで選ばない |
| マイコン | 基板や配布案内で指定されたマイコン向けか |
| 左右・役割 | 左用／右用、Central（親機）／Peripheral（子機）のどれか。親機が左とは限らない |
| モジュール・配列 | 搭載部品、スロット位置、JIS／US配列に対応するか |
| 用途 | 通常動作用か、設定消去用か。初回書き込みでは通常動作用を選ぶ |
| 配布版 | 製品で動作確認された版か。新しい日付だけを理由に別構成へ変更しない |
ファイル名の例は Polaris_L_MODULE_ENC.uf2（左・エンコーダ）と Polaris_R_MODULE_TB.uf2（右・トラックボール）です。製品によって命名規則は異なります。
| 略称の例 | 意味 |
|---|---|
L / R | 左 / 右 |
ENC | エンコーダ |
TB | トラックボール |
JOY | アナログスティック＆エンコーダ |
TPD | トラックパッド |
KEY | キーモジュール |
ファイルが存在していても、ケースへの取り付けまで対応しているとは限りません。製品ガイドの対応範囲も確認してください。
2. UF2を書き込む
- 組立後の短絡・極性・配線の確認を済ませます。データ通信対応のUSBケーブルを用意します。
- 書き込む基板を1台ずつPCにUSB接続します。分割機では、今つないだ側とファイルの対応を再確認します。
- 対象基板のリセットボタンを素早く2回押します。このサイトで案内するXIAO搭載機では、この操作で書き込み用ドライブを表示します。製品固有の指示があればそちらに従ってください。
- PCに新しく現れた書き込み用ドライブへ、対応する
.uf2を1ファイルコピーします。ZIPやリポジトリ全体はコピーしません。 - コピーと再起動を待ちます。書き込み中にUSBケーブルを抜かないでください。
- 複数のマイコンがある製品では、残りの基板にもそれぞれ対応するファイルを書き込みます。
ドライブ名はマイコンやブートローダーによって異なります。再起動に伴ってドライブが消えることはありますが、ドライブの消失やLEDの色だけでは成功と判断できません。コピーエラーが出た場合も、次の動作確認を行ってください。
キーマップに &bootloader が設定されている場合は、キー操作で書き込みモードへ移れます。&sys_reset は通常の再起動で、役割が異なります。初回書き込みや入力不能時は物理ボタンを使います。詳しくはZMK公式のリセット動作を参照してください。
3. 書き込み後の動作確認
- 親機または一体型キーボードをPCに接続し、テキストエディターでキー入力を確認します。分割機の子機は、単独のUSB接続だけでPCにキー入力を送る構成とは限りません。
- 分割機では各基板の電源を入れ、左右すべてのキーを確認します。
- 使用するモジュールのポインター移動、クリック、回転、押し込みなどを確認します。OLED搭載時は表示も確認します。
- 無線で使う場合は、親機とPCをペアリングして入力を確認します。USB接続中の出力先にも注意してください。
最初から取り付けたモジュールに合うファームウェアを使ってください。配布元が案内していない「標準構成」を推測して先に書く必要はありません。
4. 動かないときの切り分け
| 症状 | まず確認すること |
|---|---|
| 書き込み用ドライブが出ない | 通信対応ケーブルか、PC本体のUSBポートへ直接接続できるか、対象基板のリセットを素早く2回押したか |
| コピーエラーが出た／再起動後に入力できない | 機種・マイコン・左右・ファイル形式を再確認。正しいUF2で書き込みをやり直す |
| 分割機の片側だけ動かない | 各基板の電源と対応ファイルを確認。親機をPCへ接続して左右の入力を試す |
| キー入力はできるがモジュールが動かない | ファームウェアのモジュール構成・スロット位置を照合。配線の確認時はUSBと電池を外す |
| USBでは使えるが無線で使えない | 接続プロファイル、出力先、PC側の登録情報を確認。配布元のペアリング手順に従う |
LEDの点灯仕様はファームウェアごとに異なるため、点灯しないことだけを故障の根拠にしないでください。異常な発熱・異臭がある場合は使用を中止し、書き込みを繰り返さないでください。
5. 設定リセットが必要な場合
接続先や通常のペアリング操作を確認しても分割機同士が接続できない場合などに、配布元の案内に従って設定をリセットします。
settings_reset はBluetoothの接続情報を含む保存設定を消去します。 通常の更新とは区別し、先に必要な設定を控え、各基板の通常ファームウェアを手元に用意してください。
一般的なZMKの分割機では、各マイコンに適合する設定リセット用ファイルを全基板へ書き込み、その後、それぞれに通常ファームウェアを書き戻します。PC側の古い登録も削除して再ペアリングします。設定リセット用ファイルのままでは通常のキーボードとして使えません。ZMK公式の接続トラブル対処に詳細があります。
Cornixのように親機・子機で基板や復旧方法が異なる製品へ、XIAO用のリセットUF2を一律に書き込まないでください。CornixTPの詳細手順には、3台の通常版・復旧版の対応と、消去後の書き戻し方法をまとめています。
問い合わせ時に伝える情報
- 製品名、基板の版、マイコンの種類
- 配布元URLとリリース名またはActionsの実行番号
- 各基板に書いたファイル名と左右・役割の対応
- モジュールの種類と取り付け位置
- PCのOS、USB／Bluetoothのどちらで試したか
- ドライブが表示されるか、コピーエラーの内容
- どのキー・モジュールまで動いたか、すでに試した対処
ファイル名と構成を一緒に伝えると、書き込みと組立のどちらを確認すべきか判断しやすくなります。