Add descriptive comments to ESPHome devices

2026-09-16 15:49:15 +02:00
parent 330cf7569f
commit 9a800b3732
15 changed files with 29 additions and 1 deletions
@@ -4,7 +4,7 @@ substitutions:
  external_components_source: github://syssi/esphome-atorch-dl24@main
  dl24_mac_address: !secret dl24_mac_address
  project_version: 2.1.0
-  device_description: "Monitor and control a Atorch meter via bluetooth BLE"
+  device_description: "ESP32-S3 BLE client to monitor and control an Atorch DL24 programmable DC load"

 esphome:
  name: ${name}
@@ -1,10 +1,12 @@
 substitutions:
  name: "aussensensor"
  friendly_name: "Außensensor"
+  device_description: "NodeMCU-32S outdoor temperature and humidity sensor using a DHT22"

 esphome:
  name: ${name}
  friendly_name: ${friendly_name}
+  comment: ${device_description}
  name_add_mac_suffix: false
  project:
    name: sensor.outdoor
@@ -3,6 +3,7 @@
 substitutions:
  name: "raspiaudio-muse-luxe"
  friendly_name: "RaspiAudio Muse Luxe"
+  device_description: "RaspiAudio Muse Luxe ESP32 voice assistant and media player with local wake-word detection, ES8388 audio codec and battery monitoring"
 #States  
  P_starting: "0"
  P_waiting: "1"
@@ -43,6 +44,7 @@ wifi:
 esphome:
  name: ${name}
  friendly_name: ${friendly_name}
+  comment: ${device_description}
  min_version: 2025.2.0
  name_add_mac_suffix: false
  platformio_options:
@@ -1,10 +1,12 @@
 substitutions:
  name: "sleepingroom"
  friendly_name: "Luftqualität Schlafzimmer"
+  device_description: "NodeMCU-32S bedroom air-quality monitor with SCD30 CO2, temperature and humidity, PM1006 particulate sensing, RGB status LED and IR receiver/transmitter"

 esphome:
  name: ${name}
  friendly_name: ${friendly_name}
+  comment: ${device_description}
  name_add_mac_suffix: false
  project:
    name: sensor.${name}
@@ -1,8 +1,10 @@
 substitutions:
+  device_description: "ESP32-C3 bathroom temperature and humidity monitor with DHT22 and SHT3x sensors"
  name: "bathroom"
  friendly_name: "Bad"

 esphome:
+  comment: ${device_description}
  name: ${name}
  friendly_name: ${friendly_name}
  name_add_mac_suffix: false
@@ -1,10 +1,12 @@
 substitutions:
+  device_description: "M5Stack Core energy dashboard for Home Assistant grid, solar and consumer usage, with analog/digital clock and WireGuard"
  name: "energymonitor"
  friendly_name: "Energy Monitor"
  grid_power_gauge_max_w: "5000.0"
  balcony_solar_gauge_max_w: "800.0"

 esphome:
+  comment: ${device_description}
  name: ${name}
  friendly_name: ${friendly_name}
  name_add_mac_suffix: false
@@ -1,11 +1,13 @@
 # Device identity shared by ESPHome and Home Assistant.
 substitutions:
+  device_description: "ESP32 e-paper Home Assistant dashboard for indoor climate, energy and calendar events, with button-controlled pages"
  name: epaperframe
  friendly_name: "Info-Dashboard"

 # Startup selects the default page only after Home Assistant has had time to
 # provide the sensor states needed by its display lambda.
 esphome:
+  comment: ${device_description}
  name: ${name}
  friendly_name: ${friendly_name}
  name_add_mac_suffix: false
@@ -1,8 +1,10 @@
 substitutions:
+  device_description: "ESP32 Geiger counter with radiation dose rate, accumulated dose and MAX7219 seven-segment display"
  name: "geigercounter"
  friendly_name: "Geigerzähler"
  
 esphome:
+  comment: ${device_description}
  name: ${name}
  friendly_name: ${friendly_name}
  name_add_mac_suffix: false
@@ -1,9 +1,11 @@
 substitutions:
+  device_description: "Home Assistant Voice PE voice assistant with microphone and speaker."
  name: home-assistant-voice-09c0e7
  friendly_name: Home Assistant Voice Küche
 packages:
  Nabu Casa.Home Assistant Voice PE: github://esphome/home-assistant-voice-pe/home-assistant-voice.yaml
 esphome:
+  comment: ${device_description}
  name: ${name}
  name_add_mac_suffix: false
  friendly_name: ${friendly_name}
@@ -1,9 +1,11 @@
 substitutions:
+  device_description: "Home Assistant Voice PE voice assistant with microphone and speaker."
  name: home-assistant-voice-0a7c6b
  friendly_name: Home Assistant Voice Wohnzimmer
 packages:
  Nabu Casa.Home Assistant Voice PE: github://esphome/home-assistant-voice-pe/home-assistant-voice.yaml
 esphome:
+  comment: ${device_description}
  name: ${name}
  name_add_mac_suffix: false
  friendly_name: ${friendly_name}
@@ -1,8 +1,10 @@
 substitutions:
  name: kamera-balkon
  friendly_name: Kamera Balkon
+  device_description: "Balcony ESP32-CAM with HTTP stream and snapshots, flash LED, and SHT3x temperature and humidity sensing."

 esphome:
+  comment: ${device_description}
  name: ${name}
  friendly_name: ${friendly_name}
  name_add_mac_suffix: false
@@ -1,8 +1,10 @@
 substitutions:
  name: kamera-wohnzimmer
  friendly_name: Kamera Wohnzimmer
+  device_description: "Living-room ESP32 camera with HTTP stream and snapshots and a controllable flash LED."

 esphome:
+  comment: ${device_description}
  name: ${name}
  friendly_name: ${friendly_name}
  name_add_mac_suffix: false
@@ -1,8 +1,10 @@
 substitutions:
+  device_description: "ESP32 living-room air quality monitor with SCD30 CO2, temperature and humidity, PM2.5 sensing and RGB status LED"
  name: "livingroom"
  friendly_name: "Luftqualität Wohnzimmer"

 esphome:
+  comment: ${device_description}
  name: ${name}
  friendly_name: ${friendly_name}
  name_add_mac_suffix: false
@@ -3,8 +3,10 @@
 substitutions:
  name: m5stack-atom-echo
  friendly_name: M5Stack Atom Echo
+  device_description: "M5Stack Atom Echo ESP32 voice assistant with on-device or Home Assistant wake-word detection and timer announcements."

 esphome:
+  comment: ${device_description}
  name: ${name}
  name_add_mac_suffix: false
  friendly_name: ${friendly_name}
@@ -1,8 +1,10 @@
 substitutions:
+  device_description: "ESP32-C3 server-room temperature and atmospheric pressure monitor with BMP280 sensor"
  name: "serverroom"
  friendly_name: "Serverraum Luft"

 esphome:
+  comment: ${device_description}
  name: ${name}
  friendly_name: ${friendly_name}
  name_add_mac_suffix: false