MeKaBuファームウェア取り扱いガイド

                                :-:
                               =@@@%=
                               .#@@@@%-
                                 =@@@@@=         :%%#:
                    :*#*:         :@@@@@-        *@@@%
                    +@@@@#.        +@@@@#        %@@@%
                     =@@@@@-       -@@@@%       +@@@@*
                      .#@@@@=      -@@@@%     .#@@@@%.
                        #@@@@.     #@@@@=    =@@@@@%:
                        :@@@@=    *@@@@*   -%@@@@@*
                        :@@@@=   *@@@@#   +@@@@@*:   -#%#-
                        =@@@@.  =@@@@#   #@@@@#:    -@@@@%
                        *@@@#   %@@@@.  *@@@@=    .=@@@@@=
                        %@@@*   @@@@*  -@@@@-   :*%@@@@@=
                        #@@@#   #@@@=  #@@@=  .#@@@@@#+.
                        =@@@@-  -@@@+  %@@*  :@@@@#=.
         --.             +@@@@:  +@@%  #@@: :@@@#:                .--
       .%*=%*=======:     -%@@@=  *@@- *@@  %@@-      -==========*%+*%.
       :@*-%#++++++*@#.     -#@@#: #@# =@% +@%:     -%%++++++++++#@-+@:
        .==:        .*@+      :+@@= %@:-@*.@%.    .*@=            :==.
           .:         :#%=      .+@+-@*=@=#%.    +@*.            :.
         .%**%=-----:   -%#---:   +@*%%%@%@:  :=%#:   :--------=%**%:
         -@=-@#*****%#:   =***#%+*@@@@@@@@@%+#%*-   -%%********#@--@=
          :++-       +@#:      .+@@@@@@@@@@@*-    :#%=          -++-
                      .*@#*******%@@@@@@@@@@*****#@+
                        .:::::::::::::::::::::::::.

~~公式リポジトリ：https://github.com/Modulable-Keyboard-Developer/zmk-config-MKB~~→D**eprecated**

最新版はこちら→https://github.com/te9no/zmk-config-MKB2

ざっくり解説

./ │ build.yaml・・・ビルドするファームウェアの定義 │ ├─.github │ └─workflows │ build-nix.yml・・・nix版build.yml │ build.yml・・・通常のbuild.yml │ draw-keymap.yml・・・キーマップ画像ファイル生成用 │ ├─boards │ └─shields │ └─MKB │ Kconfig.defconfig・・・共通Kconfig定義 │ Kconfig.shield・・・Shield定義 │ MKB.dtsi・・・RCマクロ、physical layout定義、zmk-rgbled-widget設定、エンコーダ定義 │ MKB.zmk.yml

～以下左手～

│ MKB_L_Base.conf・・・左手共通config │ MKB_L_Base.overlay・・・kscan、input-listerner、input-processor、OLED用設定 │ MKB_L_ENC.conf・・・エンコーダモジュールconfig │ MKB_L_ENC.overlay・・・エンコーダモジュールdevice tree │ MKB_L_JOY.conf・・・アナログスティック＆エンコーダモジュールconfig │ MKB_L_JOY.overlay・・・アナログスティック＆エンコーダモジュールdevice tree

│ MKB_L_KEY.conf・・・キーモジュールconfig │ MKB_L_KEY.overlay・・・キーモジュールdevice tree │ MKB_L_RZT.conf・・・ろくじたんモジュールconfig │ MKB_L_RZT.overlay・・・ろくじたんモジュールdevice tree │ MKB_L_TB.conf・・・トラックボールモジュールconfig │ MKB_L_TB.overlay・・・トラックボールモジュールdevice tree │ MKB_L_TPD.conf・・・トラックパッドモジュールconfig │ MKB_L_TPD.overlay・・・トラックパッドモジュールdevice tree │ MKB_pinctrl_L.dtsi・・・OLED用ピン配置設定

│ MKB_L_JOY.conf・・・アナログスティック＆エンコーダモジュールconfig │ MKB_L_JOY.overlay・・・アナログスティック＆エンコーダモジュールdevice tree

～以下右手～ │ MKB_pinctrl_R.dtsi

│ MKB_R_Base.conf │ MKB_R_Base.overlay │ MKB_R_ENC.conf │ MKB_R_ENC.overlay │ MKB_R_JOY.conf │ MKB_R_JOY.overlay │ MKB_R_RZT.conf │ MKB_R_RZT.overlay │ MKB_R_TB.conf │ MKB_R_TB.overlay │ ├─config │ kle.json・・・kle用json │ MKB.json・・・keymap drawer用json │ MKB.keymap・・・キーマップ │ west.yml・・・module定義 │ ├─firmware・・・ファームウェア置き場 │ ├─main・・・ブランチ名 │ │ └─firmware │ │ MKB_L_MODULE_ENC.uf2 │ │ MKB_L_MODULE_JOY.uf2 │ │ MKB_L_MODULE_RZT.uf2 │ │ MKB_L_MODULE_TB.uf2 │ │ MKB_R_MODULE_ENC.uf2 │ │ MKB_R_MODULE_JOY.uf2 │ │ MKB_R_MODULE_RZT.uf2 │ │ MKB_R_MODULE_TB.uf2 │ │ settings_reset-seeeduino_xiao_ble-zmk.uf2 │ │・・・ │ ├─keymap-drawer・・・キーマップ画像置き場 │ config.yaml │ MKB.svg │ MKB.yaml │ └─zephyr・・・だいじなやつ module.yml

ファームウェアの書き込み方法

https://zmk.dev/docs/user-setup#flashing-uf2-files

キーマップの更新方法

リポジトリをフォークして編集するか、Keymap Editorを使用してください。

モジュールとファームウェアの交換方法

電源をOFFにする
ボトムケースを外す
モジュール側のFFPケーブルを外して取り外す
新しいモジュールにFFCケーブルを接続する
ボトムケースを取り付ける
PCと接続して、新しいモジュールに対応するファームウェアを書き込む

Nixビルドの無効化＆標準ビルドの有効化

/zmk-config-MKB/.github/workflows/build.ymlを編集

![image.png](firmware/image .png)

不要であれば/zmk-config-MKB/.github/workflows/build-nix.ymlを削除

FAQ

Q.AMLをOFFにする方法を教えていただけないでしょうか

MKB_L_Base.overlayの zip_temp_layerをOFF（コメントアウトか消去）にする