🐡

Windows でqmk firmwareを promicreに書き込む環境を整える手順書 @ 2021/05/30

3 min read

前書き

  • Windowsで 「qmk firmwareを編集して ProMicroに書き込める環境」を作成する。
  • Gitなどの仕様がある程度わかっている人向けの手順書になっているので、folkとかがわからない人には参考にならないかも。
  • 解説はあんまりなく、コマンドベースでの手順だけ記載している。

環境構築手順

WSL2環境を整える

下記Qiitaを参照

https://qiita.com/whim0321/items/ed76b490daaec152dc69

Githubにてqmk_firmwareのrepositoryを自分のアカウントにfolk

wsl2(ubuntu) にログイン

後のsudoのパスワードを入力を省略

sudo echo "hello"

git python-3pipをインストール

sudo apt update
sudo apt install -y git python3-pip
#

変数定義

  • 後の工程で使う変数を定義する
  • これ以降のScriptはすべて開きっぱなしの同じターミナルで打つこと
INSTALL_DIR="/home/kuzu"                            # git cloneで持ってきたファイルを配置するディレクトリ

HEX_DIR="/mnt/c/Users/scbp6/Documents/qmk_hexs"     # HEXファイルを置くディレクトリ(Windowsサイド・コピー先)のディレクトリを


GITHUB_ACCOUNT_NAME="kuzumotch"                     # 自分のgitlabのアカウントネーム

REQUIRE_KEYBOARDS=$(cat << __EOL__                  # ここに自分が使うキーボード(複数)を記載 qmk_firmwareのGit Repositoryの /keyboards/ ディレクトリを参照して書く
                                      
/keyboards/claw44
/keyboards/naked64
/keyboards/keyboardio
/keyboards/reviung41

__EOL__
)



# check
cat << __EOL__
#-------------------------------------------------------------------------------
[INSTALLER]           
$INSTALL_DIR

[GITHUB_ACCOUNT_NAME] 
$GITHUB_ACCOUNT_NAME

[REQUIRE_KEYBOARDS]
$REQUIRE_KEYBOARDS
__EOL__
#

qmk_firmwareをgit clone

cd ${INSTALL_DIR}

git clone --filter=blob:none --no-checkout https://github.com/${GITHUB_ACCOUNT_NAME}/qmk_firmware.git

cd qmk_firmware
git sparse-checkout init

cat << __EOL__ > .git/info/sparse-checkout
/*
!/keyboards/
${REQUIRE_KEYBOARDS}
__EOL__

git read-tree -m -u HEAD
git submodule init
git submodule update
#

qmk setup

cd ${INSTALL_DIR}/qmk_firmware

python3 -m pip install --user qmk
echo 'PATH="$HOME/.local/bin:$PATH"' >> $HOME/.bashrc && source $HOME/.bashrc
qmk setup -H ${INSTALL_DIR}/qmk_firmware
#

hexをwindows側にmvするスクリプト作成

cd ${INSTALL_DIR}

cat << __EOL__ > ./move_hex_to_windows.sh
find ${INSTALL_DIR}/qmk_firmware/ -maxdepth 1 -name "*.hex" -exec mv -f {} ${HEX_DIR} \;
__EOL__

chmod 755 ./move_hex_to_windows.sh
#

環境構築確認 & firmware書き込み手順

cd ${INSTALL_DIR}/qmk_firmware
make naked64:default               # ここは、自分がもってきたキーボード

 ../move_hex_to_windows.sh

windows側に持ってきたHexファイルを、下記Pro Micro Web Updateを使ってPro Microに書き込む。

https://sekigon-gonnoc.github.io/promicro-web-updater/index.html

新しいKeyboardを買ったときの手順

  • git clone してくる keyboard firmware を追加したい場合
# 変数定義
REPO_DIR="/home/kuzu/qmk_firmware"      # qmk_firmware local repositoryのパス

KEYBOARD_FIRMWARE="/keyboards/helix"    # 追加したいfirmware名

# ---------------------------------------------------------------------------
cd ${REPO_DIR}
echo ${KEYBOARD_FIRMWARE} >> .git/info/sparse-checkout

git read-tree -m -u HEAD
#

Reference

https://beta.docs.qmk.fm/tutorial/newbs_getting_started
https://kakakakakku.hatenablog.com/entry/2020/06/04/104940
https://leico.github.io/TechnicalNote/Git/sparse-checkout

Discussion

ログインするとコメントできます