安装 ESPHome
ESPHome 包含两部分:运行在设备上的固件,以及运行在您电脑上用于构建和安装该固件的部分。本页介绍的是第二部分。
大多数人使用 ESPHome 设备构建器,这是一个用于创建配置、编译固件并将其安装到设备上的仪表盘。您可以将其作为 Home Assistant 应用运行,也可以作为 macOS、Windows 和 Linux 上的原生桌面应用运行。两者都自带 Python 环境,因此无需手动安装任何东西。
如果您更愿意自行管理 Python,pip 选项卡介绍了如何将设备构建器和 ESPHome 命令行工具作为普通 Python 包安装。
请在下方选择您的平台。我们会尝试自动检测。
与 Home Assistant 实例一起运行 ESPHome Device Builder。
安装官方的 ESPHome Device Builder 应用:
点击上方的按钮可在您的 Home Assistant 实例中打开 ESPHome Device Builder 应用 —— 点击 安装,然后 启动,再 打开 Web UI。
手动安装
如果按钮无法使用,您可以手动安装应用:
- 在 Home Assistant 中,进入 设置 → 应用→ 安装应用。
- 在列表中找到 ESPHome Device Builder 并点击它。
- 点击 安装,然后 启动,再 打开 Web UI。
如果列表中未显示该应用,说明 ESPHome 仓库尚未注册。点击 ⋮ 菜单(右上角) → 仓库,粘贴 https://github.com/esphome/home-assistant-addon,点击 添加,然后关闭对话框重新查看。
将 ESPHome Device Builder 面板作为 Docker 容器与您的 Home Assistant Container 安装一起运行:
docker run --rm --net=host -v "${PWD}":/config -it ghcr.io/esphome/esphome运行后,在浏览器中打开 http://localhost:6052。 --net=host 使面板可以使用 mDNS,它需要 mDNS 来发现设备并解析其 .local 名称。在 Docker Desktop 中(由于主机网络不可用),替换为 -p 6052:6052;面板仍可运行,但没有 mDNS 时只能访问您指定了固定地址的设备。
有关镜像标签、Compose 文件及其他选项,请参阅 在 Docker 中运行 ESPHome。
适用于 Windows 10 和 Windows 11。
下载安装程序 (.exe)- 打开下载的
.exe文件。 - 如果 Windows 提示 "您是否允许此应用进行更改?",请选择 是。
- 按照安装程序的提示操作。
- 从开始菜单启动 ESPHome Device Builder。
如果看到 "Windows 保护了你的电脑",点击 更多信息 → 仍要运行。
macOS 10.15 Catalina 或更高版本。
对 Intel Mac 的支持即将移除。Python 生态系统正在放弃 Intel macOS,cryptography 包自 49 版本起不再发布 Intel 版本。
- 打开下载的
.dmg文件。 - 将 ESPHome Device Builder 拖入 应用程序 文件夹。
- 打开应用程序文件夹,双击 ESPHome Device Builder。
- 首次运行时,macOS 可能会要求您确认 —— 点击 打开。
不确定您的 Mac 是哪款?点击 Apple 菜单 → 关于本机。如果看到 Apple M1/M2/M3/M4,选择 Apple Silicon。如果看到 Intel,选择 Intel。
选择与您发行版匹配的包格式。
在文件管理器中双击该文件,或运行:
sudo apt install ./ESPHome.Device.Builder_*.deb在文件管理器中双击该文件,或运行:
sudo dnf install ./ESPHome.Device.Builder-*.rpm使用您喜欢的 AUR 辅助工具安装 esphome-desktop-bin 包:
yay -S esphome-desktop-bin# orparu -S esphome-desktop-bin使其可执行并运行:
chmod +x ESPHome.Device.Builder_*.AppImage./ESPHome.Device.Builder_*.AppImage如果串口设备未显示,将您的用户添加到 dialout 组并注销重新登录:sudo usermod -a -G dialout $USER。
任何安装了 Python 3.12 或更高版本的操作系统。
使用 pip 安装可获得相同的工具,但不包含桌面应用的封装。Web UI 和 命令行工具是分开的包,请根据需要选择。
Device Builder(Web UI)
Device Builder 需要 ESPHome 命令行工具来编译固件,因此请使用esphome 附加组件一次性安装两者:
pip install "esphome-device-builder[esphome]"esphome-device-builder config这里的 config 不是子命令:它是存储配置的目录,因此请替换为您想要使用的路径。面板随后可在http://localhost:6052 访问。
仅命令行
如果您只需要命令行工具而不需要 Web UI,请单独安装 esphome:
pip install esphomeesphome run livingroom.yaml有关完整指南,请参阅 入门指南。
如果可以,请安装到 虚拟环境 中。许多 Linux 发行版现在拒绝将 pip install 到系统 Python 中,并会显示 externally-managed-environment 错误。
安装桌面应用后
Section titled “安装桌面应用后”首次在 macOS、Windows 或 Linux 上启动 ESPHome 设备构建器时,它会在后台设置其自带的 Python 环境,并在默认浏览器中打开仪表盘。ESPHome 图标会出现在 macOS 菜单栏、Windows 通知区域或 Linux 桌面系统托盘中,方便快速访问——您可以从那里打开仪表盘、检查更新或退出。
NOTE
某些 Linux 桌面环境(尤其是没有托盘扩展的 GNOME)完全不显示托盘图标。应用仍会运行;请使用浏览器中的仪表盘。
Home Assistant 用户可以从 Home Assistant 中应用页面上的 打开 Web UI 按钮打开仪表盘。
安装好 ESPHome 后,请前往ESPHome 入门指南创建您的第一个配置并将其安装到设备上。
- ESPHome 入门指南 - 创建您的第一个设备
- 在 Docker 中运行 ESPHome - 镜像标签、Compose 和 USB 透传
- 命令行界面 - 所有
esphome子命令 - GitHub 上的 esphome-desktop - 源代码和问题追踪
- 所有版本 - 历史版本和发布说明