跳转到内容

分享 ESPHome 设备

我们添加了配置选项到 ESPHome,使其更容易创建、配置、安装和分发运行 ESPHome 的设备。

“模板”配置的任何部分都不应有任何对机密的引用,或预先应用的密码。ESPHome 使最终用户在将设备采用到自己的 ESPHome 仪表板后可以轻松添加这些内容。

# 这些替换允许最终用户覆盖某些值
substitutions:
name: "project-template"
friendly_name: "Project Template"
esphome:
name: "${name}"
# 友好名称在 Home Assistant 中适当的地方使用
friendly_name: "${friendly_name}"
# 自动将 mac 地址添加到名称中
# 这样您可以为所有设备使用单个固件
name_add_mac_suffix: true
# 这将允许(未来的)项目识别、
# 配置和更新。
project:
name: esphome.project-template
version: "1.0"
# 为了能够通过串行和 api 从设备获取日志。
logger:
# API 是仪表板导入的要求。
api:
# OTA 是空中更新所必需的
ota:
platform: esphome
# 这应该指向此 yaml 文件的公开位置。
dashboard_import:
package_import_url: github://esphome/esphome-project-template/project-template-esp32.yaml@v6
import_full_config: false # 或 true
wifi:
# 设置 wifi 接入点
ap:
password: "12345678"
# 与 `ap` 结合,这允许用户
# 为设备配置 wifi 凭据。
captive_portal:
# 设置蓝牙 LE(仅限 ESP32)以允许用户
# 为设备配置 wifi 凭据。
esp32_improv:
authorizer: none
# 为 Wi-Fi 配置设置 improv 通过串行客户端
improv_serial:
next_url: https://example.com/project-template/manual?ip={{ip_address}}&name={{device_name}}&version={{esphome_version}}
  • name_add_mac_suffix - 将 MAC 地址作为后缀添加到设备名称

  • project - 项目信息

  • esp32_improv - ESP32 Improv

  • captive_portal - Captive Portal

  • wifi -> ap 允许您刷写不包含任何凭据的设备,用户必须通过 ap + captive_portalesp32_improv / improv_serial 组件设置凭据。

  • dashboard_import

    NOTE

    上面的项目信息是仪表板中采用功能所需的。

    • package_import_url - 这应该指向包含设备配置的公开存储库,以便用户的 ESPHome 仪表板可以自动检测此设备并使用远程/Git 包创建最小 YAML。

    • import_full_config - 这表示 ESPHome 是否应该下载整个 YAML 文件作为用户的配置 YAML 而不是引用包。如果您正在创建教程让用户轻松调整整个配置或能够取消注释后续教程步骤,请将此设置为 true

  • improv_serial - Improv Serial