使用 ESPHome 工作
本页是通过 ESPHome 驱动任意兼容 Seeed ePaper 产品并将其集成到 Home Assistant 中的参考手册。它涵盖了所有硬件之间相同的部分:
- 为什么你会选择用 ESPHome 来驱动 ePaper 显示屏。
- 两种烧录路径:ESPHome Web Installer(零配置、基于浏览器)和 ESPHome CLI / HA 插件(完整 YAML 控制)。
- 通用 YAML 骨架——
wifi、api、ota、display——每个产品都用自己的引脚映射来专门化它。 - 每个产品的 cookbook 在哪里(外设、硬件相关 lambda、仪表盘配方)。
如果你想要一个端到端的“烧录 → 连接 → 第一个仪表盘”演练,可以直接跳到下面你所用硬件的 cookbook;这些页面复用本参考中的样板内容,并添加产品特定示例。
兼容硬件
在主汇总页面上,所有 ESPHome 列被勾选的 Seeed ePaper 产品都可以按本流程运行:
| 产品 | MCU | Cookbook |
|---|---|---|
| reTerminal E1001 / E1002 / E1003 / E1004 | XIAO ESP32-S3 | 显示 · I/O 与电源 · RTC、SD 与麦克风 |
| EE04 驱动板 | XIAO ESP32-S3 Plus | EE04 ESPHome cookbook |
| XIAO 7.5" ePaper 面板 | XIAO ESP32-C3 | XIAO 面板 ESPHome cookbook |
| TRMNL 7.5" (OG) DIY 套件 | XIAO ESP32-S3 Plus | TRMNL DIY 套件 ESPHome cookbook |
在找 TRMNL 云端仪表盘(无需 YAML、基于插件)吗?请参见 使用 TRMNL 工作。在找 Seeed 的零代码可视化 HMI 吗?请参见 使用 SenseCraft HMI 工作。
为什么在 ePaper 上使用 ESPHome?
- 能效高——ePaper 只有在屏幕更新时才耗电,因此组合(ESP32 + ESPHome 深度睡眠 + ePaper)可以在电池供电下运行数周/数月。
- 日光可读——与 LCD 不同,显示屏在阳光下也清晰可见;非常适合作为壁挂式 Home Assistant 面板。
- 原生 HA 公民——一旦设备出现在 Home Assistant 中,每个实体(空调、日历、传感器、人员、天气)都只差一个 Jinja 模板就能上墙显示。
- 本地优先——无云端、无厂商锁定。一切都在你的局域网中运行。
步骤 1:选择烧录路径
ESPHome 固件可以通过两种方式加载到设备上。正确的选择取决于你是想从零编写 YAML,还是只想快速获得一个可用的仪表盘。
- 路径 A:ESPHome Web Installer(推荐首次使用者)
- 路径 B:YAML + ESPHome 仪表盘(完全控制)
Seeed 托管了一个预构建固件 ZIP,并通过浏览器中的 WebSerial 将其烧录到你的设备。
- 使用 USB-C 线将设备连接到电脑。
- 在 Chrome 或 Edge 中打开每个产品的烧录页面(从你所用产品的 cookbook 中链接)。
- 点击 Connect,选择串口,然后点击 Install。
- 烧录完成后,设备会启动到一个 Wi-Fi 强制门户(
ESPHome-XXXX)。连接后设置 Wi-Fi,设备将通过 ESPHome 集成出现在 Home Assistant 中。
此路径无需编辑 YAML。如果你之后想开始自定义,可以在 ESPHome 仪表盘中“接管”该设备。
若要对固件进行完全控制(自定义显示布局、自定义传感器、多页面仪表盘、深度睡眠调优、OTA 更新),请运行 ESPHome 仪表盘,可以是:
- Home Assistant 的一个 插件(Add-on)(如果你已经运行 HA OS / HA Supervised,推荐使用),或
- 独立的 Python CLI(
pip install esphome然后esphome dashboard config/)。
工作流程:
- 在 ESPHome 仪表盘中,点击 + New device → 输入名称 → 选择正确的 ESP 变体(ESP32-S3 / ESP32-C3 / 等——你的产品 cookbook 会告诉你用哪一个)。
- 仪表盘会生成一个初始的
<device-name>.yaml。将其主体替换为 cookbook 中与你产品对应的 YAML(形状见下方步骤 2)。 - 点击 Install → 首次烧录选择 Plug into the computer running ESPHome;之后的烧录通过 OTA 无线完成。
- 设备会自动加入 Home Assistant 中的 ESPHome 集成。
步骤 2:通用 YAML 骨架
每个 Seeed ePaper 的 ESPHome 配置都遵循相同的大纲。你所用产品的 cookbook 会填入产品特定部分(替换项、引脚映射、屏幕型号)——但整体结构始终是:
substitutions:
device_name: my-epaper
esphome:
name: ${device_name}
friendly_name: ${device_name}
# Pick the right platform for your hardware.
# - reTerminal E Series & EE04 & TRMNL Kit: esp32 with framework: arduino (S3 variant)
# - XIAO 7.5" Panel: esp32 with framework: arduino (C3 variant)
esp32:
board: seeed_xiao_esp32s3 # see your cookbook
framework:
type: arduino
logger:
api:
encryption:
key: !secret api_key
ota:
- platform: esphome
password: !secret ota_password
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
ap:
ssid: "${device_name} Fallback"
# SPI bus that drives the ePaper - exact pins come from the cookbook
spi:
clk_pin: GPIO13
mosi_pin: GPIO11
# The display block - the model + pin map are the part that's
# different per product. The cookbook gives you the right values.
display:
- platform: waveshare_epaper
id: epaper
cs_pin: GPIO9
dc_pin: GPIO15
busy_pin: GPIO12
reset_pin: GPIO14
model: 7.50inv2
update_interval: never # we'll trigger refreshes from automations
lambda: |-
it.print(0, 0, id(roboto_24), "Hello, ePaper!");
font:
- file: "fonts/Roboto-Regular.ttf"
id: roboto_24
size: 24
哪些是产品特定内容(并位于各自的 cookbook 中):
esp32.board—— E1001/E1002/EE04/TRMNL 套件为seeed_xiao_esp32s3;XIAO 7.5" 面板为esp32-c3-devkitm-1;等等。spi和display的引脚映射。model的取值(7.50in-bwr、13.3in-spectra6等)。- 任意板载外设(按键 / 蜂鸣器 / 电池 / SHT4x)——在相关 cookbook 的 高级(Advanced) 章节中介绍。
步骤 3:连接到 Home Assistant
一旦固件启动并加入你的 Wi-Fi,Home Assistant 会自动发现该设备:
- Settings → Devices & services
- ESPHome 集成会显示一个你的设备的“Discovered”卡片。
- 点击 Configure,粘贴 API 加密密钥(来自
secrets.yaml),然后提交。 - 设备及其所有实体(sensors、binary_sensors、display)现在都可以在 HA 中使用。
现在你可以将这些实体拖入 Lovelace 仪表盘,或者——在 ePaper 上更有趣的方式——使用 display.lambda 块,通过 homeassistant 组件将任意 HA 实体直接渲染到屏幕上。
接下来去哪——Cookbooks
本页有意只停留在样板层面。产品特定的 YAML、外设示例以及端到端配方都位于各产品的 cookbook 中:
- reTerminal E 系列 — ESPHome 显示 —— 第一个仪表盘、Wi-Fi 设置、预构建固件 ZIP,以及适用于 E1001/E1002/E1003/E1004 的 ePaper 绘制示例。
- reTerminal E 系列 — ESPHome I/O、电池与电源 —— 按键、蜂鸣器、板载 LED、电池监测、SHT4x 传感器、深度睡眠和多页面仪表盘。
- reTerminal E1001 / E1002 — ESPHome RTC、SD 与麦克风 —— PCF8563 RTC 时间同步、microSD 卡电源/检测引脚,以及板载 PDM 麦克风配置。
- EE04 驱动板 — ESPHome —— 在 XIAO ESP32-S3 + EE04 + 你选择的 ePaper 屏幕上实现完整 Home Assistant 集成。
- XIAO 7.5" ePaper 面板 — ESPHome —— 精简的 ESP32-C3 仪表盘。
- TRMNL 7.5" DIY 套件 — ESPHome —— 使用套件硬件配合 ESPHome,而不是 TRMNL 云平台。
当有新的 ePaper 产品发售时,相应的 cookbook 会被添加到各产品的文件夹下;本主页面也会更新链接到它。
常见问题
烧录后显示屏保持空白
- 确认
display.platform和model字符串与你的屏幕匹配——错误的型号会在刷新时静默保持空白。 - 检查
busy_pin和reset_pin是否正确连接;悬空的 busy 线会阻塞所有刷新。 - 对于彩色 ePaper(
spectra6、7-color、bwr),首次刷新可能需要 25–45 秒;在进一步调试前请耐心等待。
设备没有出现在 Home Assistant 中
- 确认设备已加入 Wi-Fi(在 ESPHome 仪表盘日志中检查)。
- 确保 YAML 中存在
api:,并且 HA 中的加密密钥与secrets.yaml中的一致。 - 手动添加集成:Settings → Devices & services → Add Integration → ESPHome,然后输入设备的 IP。
电池耗电比预期更快
只有当 SoC 的其余部分也处于睡眠状态时,ePaper 才能真正省电。添加一个 deep_sleep 块(参见你所用产品的 I/O、电池和低功耗 cookbook),并降低 update_interval。
如需对特定产品进行更深入的故障排查,请查看该硬件对应的 cookbook。
技术支持与产品讨论
感谢您选择我们的产品!我们将为您提供多种支持,确保您在使用我们产品的过程中尽可能顺畅。我们提供多种沟通渠道,以满足不同的偏好和需求。