ESPHome CLI によるファームウェアのコンパイル

ESPHome CLI は、デバイス設定の管理、YAML の検証、ファームウェアのコンパイル、デバイスへの書き込み、実行ログの確認をコマンドラインから行うためのツールです。一部の M5Stack 外部コンポーネントは最新バージョンの ESPHome に対応していない場合があり、設定またはコンパイルエラーが発生することがあります。互換性の問題が発生した場合は、製品コンポーネントが要求する ESPHome バージョンを pip でインストールしてから、再度コンパイルしてください。

手順

  1. 公式インストールガイドに従って Python をインストールし、pip で ESPHome CLI をインストールします。
  2. 製品コンポーネントのドキュメントで必要な ESPHome バージョンを確認し、指定されたバージョンをインストールします。
  3. デバイス用の YAML 設定ファイルを用意し、Wi-Fi のネットワーク名とパスワードを設定します。
  4. 設定を検証してファームウェアをコンパイルします。
  5. USBまたはOTA 経由でファームウェアを書き込みます。
  6. デバイスのログを確認し、Home Assistantにデバイスを追加します。

Python と CLI の環境設定は、ESPHome 公式インストールガイドに従って行うことを推奨します。特定のバージョンが必要な場合は、ターミナルでバージョンを指定した pip コマンドを使用してインストールしてください。インストール要件、コマンドオプション、操作方法については、以下を参照してください。

よく使用するコマンド

日常的な設定とファームウェア管理には、次のコマンドを使用できます。利用可能なすべてのオプションについては公式ドキュメントを参照してください。

esphome version
esphome config device.yaml
esphome compile device.yaml
esphome upload device.yaml
esphome logs device.yaml

特定のバージョンを指定する場合は、インストール時にバージョン番号を指定します。

python -m pip install esphome==2026.4.5
コンパイル前の確認
デバイス用 YAML をコンパイルする前に、Wi-Fi の SSID とパスワードを入力してください。機密情報は secrets.yaml に保存し、YAML から !secret で参照することを推奨します。Wi-Fi 情報が正しくない場合、書き込み後にデバイスがネットワークへ接続できず、Home Assistant から検出できません。

関連リンク

Page Tools
PDF
On This Page