FIRMWARE SETUP GUIDE

キー配列セットアップ

ZEN のキー配置を編集して、GitHub Actions でファームウェアを作るまでの手順です。

00 — REQUIREMENTS

必要なもの

  • GitHub アカウント
  • ZEN 本体
  • 対応コントローラ(左右)
  • データ通信対応の USB Type-C ケーブル
  • Mac / PC
01 — FORK

リポジトリを fork する

fork は、このファームウェア設定を自分の GitHub アカウントにコピーする操作です。キー配置を自分用に編集するため、まず fork を作成します。

  1. E24-GH/zen-firmware を開きます。
  2. 画面右上の Fork を押し、Create a new fork を選びます。
  3. Owner に自分の GitHub アカウントを選びます。
  4. Repository name は通常そのまま zen-firmware で構いません。
  5. Copy the main branch only は ON のままにします。
  6. Create fork を押します。
GitHub リポジトリページの Fork メニュー
Fork メニューから Create a new fork を選びます。
GitHub の Create a new fork 画面
Create fork を押すと、自分のアカウントにコピーが作成されます。
ヒント
fork 後は URL が https://github.com/あなたのアカウント/zen-firmware のようになります。以降は自分の fork したリポジトリを使います。
02 — LOGIN

Keymap Editor にログインする

Keymap Editor を使うと、ブラウザ上でキー配置を編集できます。初回は GitHub ログインと認証が必要です。

  1. Keymap Editor を開きます。
  2. Login with GitHub を押します。
  3. 認証画面が出たら Authorize を押します。
Keymap Editor の GitHub ログイン画面
まず Keymap Editor に GitHub アカウントでログインします。
Keymap Editor を GitHub で認証
Authorize を押して、Keymap Editor の利用を許可します。
03 — ADD REPOSITORY

fork したリポジトリを追加する

  1. Keymap Editor で Add Repository が表示されたら押します。
  2. GitHub App のインストール画面で、Only select repositories を選びます。
  3. 自分が fork した zen-firmware だけを選び、Install を押します。
  4. Keymap Editor に戻ったら、Source を GitHub にして自分の zen-firmware を開きます。
  5. config/keymap.keymap が読み込まれ、ZEN のレイアウトが表示されれば OK です。
Keymap Editor の Add Repository 画面
Add Repository を押して、fork した zen-firmware を追加します。
Keymap Editor の GitHub App インストール画面
All repositories ではなく Only select repositories を選び、fork した zen-firmware だけを選択します。
注意
All repositories は選ばないでください。 選ぶと Keymap Editor 側で利用が停止される場合があります。ZEN 用の fork だけを選択してください。
レイアウトが表示されないとき
fork が最新でない可能性があります。GitHub の fork 画面で Sync fork を押してから、もう一度 Keymap Editor で開いてください。
04 — EDIT & SAVE

キー配置を編集して保存する

  1. Keymap Editor 上でキーを変更します。
  2. 変更が終わったら Save を押します。
  3. 保存すると、自分の fork した GitHub リポジトリに変更が反映されます。

保存後、GitHub Actions が自動でファームウェアを build します。ダウンロードは次の手順で GitHub Actions 画面から行います。

Keymap Editor の Save ボタン
キー配置を変更したら Save を押します。保存すると GitHub Actions で build が始まります。
05 — BUILD

GitHub Actions でファームウェアを作る

  1. 自分の zen-firmware リポジトリを開きます。
  2. Actions タブを開きます。
  3. 初回だけ、Actions を有効化するボタンが出る場合があります。その場合は有効化します。
  4. 最新の build を開きます。
  5. build が完了したら、図の赤枠のダウンロードボタンを押します。
GitHub Actions のファームウェアダウンロードボタン
画面下部の firmware 行にあるボタンを押すと、zip ファイルがダウンロードされます。

ダウンロードした zip ファイルの中には、以下の UF2 ファイルが入っています。

  • settings_reset-bmp_boost-zmk.uf2リセット用
  • zen_right_trackball_pmw3610_central.uf2右手用(トラックボール側)
  • zen_left_peripheral.uf2左手用

その他、カスタマイズ用のファームウェア

  • zen_right_trackball_paw3222_central.uf2トラックボールのセンサー PAW3222 用
  • zen_right_trackpad_central.uf2トラックパッド用
06 — FLASH

ファームウェアを書き込む

通常の書き込み

  1. 右手側の対応コントローラをブートローダーモードにします。
  2. zen_right_trackball_pmw3610_central.uf2 を書き込みます。
  3. 左手側の対応コントローラをブートローダーモードにします。
  4. zen_left_peripheral.uf2 を書き込みます。

接続がうまくいかない場合

  1. Mac / PC の接続設定から ZEN を削除します。
  2. settings_reset-bmp_boost-zmk.uf2 を書き込みます。
  3. USB を外します。
  4. ZEN の電源を入れます。
  5. もう一度、通常ファームウェアを書き込みます。
  6. Mac / PC の接続設定から ZEN を接続します。
07 — TROUBLESHOOTING

困ったとき

Keymap Editor で App Disabled と表示される

GitHub App が使えるリポジトリに、自分の fork した zen-firmware が含まれていない状態です。画面の Add Repository から fork したリポジトリを追加してください。

Keymap Editor でレイアウトが表示されない

fork が古い、または config/info.json が読み込まれていない可能性があります。fork を同期してから再度開いてください。

Actions が動かない

fork したリポジトリの Actions タブを開き、GitHub Actions を有効化してください。

接続が不安定

一度 settings_reset-bmp_boost-zmk.uf2 を書き込んでから、左右の通常ファームウェアを書き直してください。Mac / PC 側に残っている古い ZEN のペアリング情報も削除してください。

zen-firmware リポジトリ・Issues