Kurikintonsの設定#
Kurikintons は、OSECHI検出器のマイクロコントローラ(ESP32-WROOM-32D)に書き込むArduinoスケッチです。
このドキュメントでは、Kurikintonsスケッチをダウンロードしてビルド・書き込みする方法を説明します。
概要#
必要な道具#
まず、必要なハードウェアとソフトウェアを確認しましょう。
ハードウェア:
パソコン(スケッチをビルド・書き込むため)
OSECHI検出器本体
USB-Aケーブル(通常のUSBケーブル:パソコンとOSECHIを接続)
Micro-USBケーブル(OSECHIに接続)
ソフトウェア:
Arduino IDE(スケッチのビルド・書き込みに必須)
Kurikintonsスケッチ(
.inoファイル)
注釈
パソコンについて
自分が普段使っているパソコン(WindowsまたはmacOS)を使うことをお勧めします。
Raspberry Piも使用できますが、ビルドと書き込みに時間がかかる場合があります。
動作確認済み環境#
このドキュメントは以下の環境で動作確認しています:
ソフトウェア |
バージョン |
備考 |
|---|---|---|
Arduino IDE |
2.3.6 |
macOS環境で確認 |
ESP32 Board Support |
3.3.2 |
Espressif Systems |
Adafruit Unified Sensor |
1.1.15 |
センサーライブラリ依存 |
Adafruit BME280 Library |
2.3.0 |
温度・湿度・気圧センサー |
Adafruit BusIO |
1.17.4 |
I2C/SPI通信ライブラリ |
注釈
バージョンについて
上記のバージョンは動作確認済みですが、最新版でも動作する可能性が高いです。とくに理由がない限り、最新版のインストールをオススメします。
ステップ1: Arduino IDEをインストールする#
Kurikintonsスケッチをビルド・書き込むために、Arduino IDEをインストールします。
インストール方法#
macOSの場合(Homebrewを使用):
$ brew install --cask arduino-ide
Windows / macOS / Linux(公式ウェブサイト):
Arduino公式ウェブサイトにアクセス
Arduino IDE 2.0(最新版)をダウンロード
インストーラーを実行してインストール
注釈
arduino-cli について
arduino-cliはコマンドライン版のArduino IDEです。VS Codeなどのエディターを使う場合に便利ですが、初心者向けにはGUIのArduino IDE 2.0の使用をお勧めします。
ステップ2: Arduino IDEを設定する#
Arduino IDEをインストールしたら、ESP32とセンサーライブラリをセットアップします。
2.1 ESP32ボードサポートをインストール#
Arduino IDEでESP32を使うには、ボードの定義をインストールします。
Arduino IDEを起動
メニューから
Arduino IDE→Settings(macOS)またはFile→Preferences(Windows)を選択Additional Boards Manager URLs に以下のURLを追加:
https://espressif.github.io/arduino-esp32/package_esp32_index.json
OK をクリック
メニューから
Tools→Board→Boards Managerを選択検索欄で「esp32」と入力
esp32 by Espressif Systems を探して Install をクリック
2.2 ボード設定#
スケッチを書き込む前に、使用するボードを指定します。
メニューから
Tools→Board→ESP32を選択ESP32-WROOM-32D を選択
リストに見つからない場合は、ESP32 Dev Module を選択してください
2.3 シリアルポート設定#
USBケーブルでOSECHIをパソコンに接続した後、ポートを選択します。
メニューから
Tools→Portを選択接続したシリアルポートを選択
macOS:
/dev/cu.usbserial-*または/dev/cu.SLAB_USBtoUARTのような名前Windows:
COM3、COM4など
Tip
どのポートを選べばいいか分からない場合
Tools → Port を見て、新しく表示されたポートがOSECHIです。不確定な場合は、ユーザーマニュアルの「シリアルポート確認」を参照してください。
2.4 センサーライブラリをインストール#
Kurikintonsスケッチは、温度・湿度・気圧センサー(BME280)を使用しています。ライブラリをインストールします。
メニューから
Tools→Manage Librariesを選択検索欄で以下のライブラリを検索して、順にインストール:
Adafruit Unified Sensor by Adafruit
Adafruit BME280 Library by Adafruit
Adafruit BusIO by Adafruit
注釈
ライブラリインストールの順序
依存関係があるため、上記の順序で3つのライブラリをインストールしてください。
ステップ3: Kurikintonsスケッチをダウンロード#
Kurikintonsスケッチを取得します。
スケッチの入手#
スケッチは以下の場所から取得できます:
公式リポジトリ: haniwersのスケッチディレクトリ
最新バージョン:
kurikintons_v1/kurikintons_v1.ino
注釈
複数のスケッチバージョン
kurikintons_v1/kurikintons_v1.ino: 現在の推奨版
kurikintons_x/kurikintons_x.ino: テスト・開発版
archives/: 過去のバージョン
特別な理由がない限り、最新版(v1)を使用してください。
ダウンロード手順#
haniwersリポジトリにアクセス
arduinoフォルダを開くkurikintons_v1フォルダを開くkurikintons_v1.inoファイルを右クリック → Download を選択パソコンの分かりやすい場所(例:
~/Downloads)に保存
ステップ4: Kurikintonsスケッチをビルド・書き込み#
4.1 スケッチをArduino IDEで開く#
Arduino IDEを起動
メニューから
File→Openを選択ダウンロードした
kurikintons_v1.inoを選択して開く
4.2 ビルド(コンパイル)#
スケッチが正しいか確認します。
メニューから
Sketch→Verify/Compileを選択(または ⌘+R on macOS / Ctrl+R on Windows)画面の下部に進捗が表示されます
Compilation complete と表示されればOK
警告
コンパイルエラーが出た場合
以下を確認してください:
全てのライブラリがインストールされているか
ボード設定が ESP32-WROOM-32D になっているか
Arduino IDEの最新バージョンを使用しているか
4.3 USBで接続#
Micro-USBケーブルでOSECHIをパソコンに接続
LEDが点灯することを確認
4.4 スケッチを書き込み#
Tools→Portでシリアルポートが選択されているか確認メニューから
Sketch→Uploadを選択(または ⌘+U on macOS / Ctrl+U on Windows)画面の下部に進捗バーが表示されます
Leaving… Hard resetting via RTS pin… と表示されれば完了
Tip
書き込み中の画面
書き込み中は以下のようなメッセージが表示されます:
Connecting........_____
Uploading... 100%
Leaving... Hard resetting via RTS pin...
時間がかかる場合(30秒~1分)がありますが、辛抱強く待ってください。
ステップ5: VS Codeでの編集(オプション)#
警告
非推奨の拡張機能について(2024年10月更新)
Microsoft製のArduino拡張機能は2024年10月1日に廃止されました。既存ユーザー向けに情報を残していますが、新規ユーザーにはArduino IDE 2.0の使用をオススメします。
VS Codeでの開発を希望する場合は、以下の代替案があります:
PlatformIO: ESP32開発で広く使われているコミュニティ標準の拡張機能
pioarduino: PlatformIOのフォーク、ESP32 Arduino Core v3をサポート
これらの拡張機能は別途セットアップが必要で、Arduino IDEとは異なる開発環境になります。
インストール(非推奨・既存ユーザー向け)#
VS Code Marketplaceで Arduino拡張機能 を検索・インストール
拡張機能は
arduino-cliをバンドルしており、別途インストール不要
コマンドパレット(非推奨・既存ユーザー向け)#
VS Codeのコマンドパレット(Shift+Command+P on macOS / Ctrl+Shift+P on Windows)で以下が使用できます:
Arduino: Select Serial Port: シリアルポートを選択Arduino: Open Serial Monitor: センサー出力を監視Arduino: Library Manager: ライブラリを管理
トラブルシューティング#
よくある問題と解決方法#
Q: コンパイルエラーが出る
A: 以下を確認してください:
全てのライブラリが正しくインストールされているか(セクション2.4参照)
ボード設定が ESP32-WROOM-32D になっているか(セクション2.2参照)
Arduino IDEを最新版に更新してみてください
Q: ファイルが書き込めない / “Permission denied” エラーが出る
A:
macOS / Linux: ユーザーが
/dev/ttyUSB*へのアクセス権を持っていない可能性がありますWindows: USB ドライバーが正しくインストールされているか確認してください
Q: ポートが表示されない / 認識されない
A:
USB ケーブルが正しく接続されているか確認
ケーブルがデータ通信対応か確認(充電用のケーブルではない)
パソコンを再起動してみてください
別のUSBポートに接続してみてください
Q: 書き込み時に “timeout” や “Connection refused” エラーが出る
A:
ボード設定が正しいか確認(セクション2.2参照)
USB ケーブルをしっかり接続し直す
Arduino IDE を再起動する
パソコンを再起動する
Arduino関係のリファレンス#
スケッチで使っているヘッダーファイルや関数/メソッドなどのリファレンスです。