1. はじめに

このページでは、パタマナキーボードへファームウェアを書き込むための環境構築とファームウェアの書き込み方法、導通確認を説明します。

現状、パタマナキーボードのファームウェアはArduino言語を用いて作られており、Arduino IDEを用いて書き込みます。

Arduino の数多くの便利なライブラリを使用しております。ライブラリの作成者たちに深謝の意を表します。

(Web書き込みツールを作成したいと思っていますが、私の技術力不足により、まだまだ時間がかかりそうです)

2. Arduino IDE のダウンロード

Arduino IDE をダウンロードしていない方は、Arduino IDE のダウンロードが必要です。

下記の公式サイトから Arduino IDE をダウンロードしてください。

3. esp32 ボードパッケージの追加

Arduino IDE にESP32ボードパッケージを追加します。

以下、Arduino IDE 2.3.2 の Mac での表示画面で説明します。

[Arduino IDE]>[Preferences]の[Additional boards maanager URLs]に下記のURLを追加します。

https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json

[Tools]>[Board]>[Board Manager...]を選択し、検索ボックスに esp32 を入力して、esp32 by Espressif Systems をインストールしてください。

[Tools]>[Board]>[esp32]>[XIAO_ESP32S3] を選択してください。

4. ライブラリのインストール

このページで使う導通確認用ファームウェアには LovyanGFX のライブラリが必要です。

にアクセスして、Download ZIP よりZIPファイルをダウンロードしてください。

(解凍する必要はありません)

[Sketch]>[Include Library]>[Add .ZIP Library...]を選択して、ダウンロードしたZIPファイルを読み込んでください。

5. 導通確認用ファームウェアの書き込み

patamana/keyboard_firmwareのcontinuity_checkを使用します。[File]>[Add]からダウンロードしたcontinuity_check.inoを選択するか、continuity_check.inoのコードをスケッチにコピペしてください。

USB Type-C 端子をキーボードに挿入し、パソコンと繋げてください。

[Tools]>[Port]に移動して、繋げたPortを選択してください。

[Tools]の下側の各種設定が下図のようになっていることを確認してください。

必須ではありませんが、下図のように、[Arduino IDE]>[Preferences]の[Show verbose output duiring]の[compile]と[upload]にチェックを入れ、[Compiler warnings]を[All]にすることでコンパイル中やアップロード中の詳細ログが表示されます。

左上の矢印ボダンをクリックすると書き込みが始まります。

下図のようなログが表示されれば書き込み成功です。

書き込みに失敗する場合

コンパイルができているのに書き込みに失敗する場合は以下の原因が考えられます。

• ・ポートを正しく選択していない。
• ・ポートを他のソフトで使用している。
• ・XIAO ESP32S3 がUSB-OTGで起動している。

XIAOに繋がったポートを他のソフトで使用しているとAruduino IDEがそのポートを使用することができません。他のソフトを閉じてください。

XIAO ESP32S3 にすでにUSBがUSB-OTGとして動くプログラムが書き込まれている場合は、USB Serialによる書き込みができません。[Tools]の[UploadMode]を[USB-OTG]に変更するか、以下のようにXIAOのBootボタンをつまようじ等で押しながらUSBを差し込み(ESP32S3を起動し)、ESP32S3をBootモードで立ち上げて書き込んでください。

6 導通確認、はんだ付けの修正

キーボードのUSBを一度抜いてからもう一度挿すことで、導通確認用のプログラムが起動します。

スイッチを押すと、下図のようにOLEDに押したスイッチのキー番号が表示されます。

キー番号が表示されないスイッチは導通していません。はんだ付けがとれてしまっているか、ポリウレタン導線の皮膜が剥がれていないのが原因です。そのスイッチのGNDやInputの配線を確認し、再度はんだ付けしてください。

7. ゴム足、重りの貼り付け、ねじ止め

スイッチの導通確認ができたら、キーボードの土台側にゴム足と重りを貼り付けて、スイッチプレートと土台をねじ止めします。

7.1 ゴム足の貼り付け

土台の四隅にキットに付属のゴム足を取り付けてください。

7.2 重りの貼り付け

キットに付属の重りを、はさみで切り分けてください。

土台に重りを貼り付けてください。手前側を多くすると奥に押した時に浮きづらくなります。

7.3 リポバッテリーの接続(無線接続用)

無線接続をする方はPHコネクタつきのリポバッテリーをパタマナボードのPHコネクタに接続してください。

基板表面にPHコネクタがある場合は接続しづらいです。細い棒状のもので押し込んでください。

きちんと接続できると、スライドスイッチを基板中央側にスライドすることで、USB接続なしで、先ほど書き込んだ導通確認用ファームウェアが起動します。

7.4 ねじ止め

キット付属のM3ネジとナットを用いてスイッチプレートと土台をねじ止めしてください。

今回はドライバーを使ってしっかりとねじ止めしてください。

8. キーキャップの取り付け

キットに付属のキーキャップをスイッチに取り付けます。

キーキャップが奥までハマらずに緩くなってしまう場合は、やすりで根本を少し削るとしっかりはまります。

ここまでのことを左右で行うと下図のようになります。

9. ファームウェアの書き込み

下記のページに従って、ファームウェアを書き込んでください。