简体中文
English
简体中文
日本語

ESPHome CLI 固件编译

ESPHome CLI 提供命令行方式管理设备配置、检查 YAML、编译固件、烧录设备和查看运行日志。部分 M5Stack 外部组件可能尚未适配最新版本的 ESPHome,使用最新版编译时可能出现配置或编译错误。遇到版本兼容问题时,建议通过 pip 安装产品组件要求的 ESPHome 版本,再进行编译。

使用流程

  1. 参考官方安装文档安装 Python,并通过 pip 安装 ESPHome CLI。
  2. 根据产品组件文档确定 ESPHome 版本,并安装对应的固定版本。
  3. 准备设备对应的 YAML 配置文件,先配置 Wi-Fi 名称和密码。
  4. 检查配置并编译固件。
  5. 通过 USB 或 OTA 烧录固件。
  6. 查看设备日志,并将设备添加到 Home Assistant。

建议先进入 ESPHome 官方安装文档完成 Python 和 CLI 环境配置;需要指定版本时,在终端中使用带版本号的 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