Add descriptive comments to ESPHome devices

This commit is contained in:
2026-09-16 15:49:15 +02:00
parent 330cf7569f
commit 9a800b3732
15 changed files with 29 additions and 1 deletions
+1 -1
View File
@@ -4,7 +4,7 @@ substitutions:
external_components_source: github://syssi/esphome-atorch-dl24@main external_components_source: github://syssi/esphome-atorch-dl24@main
dl24_mac_address: !secret dl24_mac_address dl24_mac_address: !secret dl24_mac_address
project_version: 2.1.0 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: esphome:
name: ${name} name: ${name}
+2
View File
@@ -1,10 +1,12 @@
substitutions: substitutions:
name: "aussensensor" name: "aussensensor"
friendly_name: "Außensensor" friendly_name: "Außensensor"
device_description: "NodeMCU-32S outdoor temperature and humidity sensor using a DHT22"
esphome: esphome:
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
comment: ${device_description}
name_add_mac_suffix: false name_add_mac_suffix: false
project: project:
name: sensor.outdoor name: sensor.outdoor
@@ -3,6 +3,7 @@
substitutions: substitutions:
name: "raspiaudio-muse-luxe" name: "raspiaudio-muse-luxe"
friendly_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 #States
P_starting: "0" P_starting: "0"
P_waiting: "1" P_waiting: "1"
@@ -43,6 +44,7 @@ wifi:
esphome: esphome:
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
comment: ${device_description}
min_version: 2025.2.0 min_version: 2025.2.0
name_add_mac_suffix: false name_add_mac_suffix: false
platformio_options: platformio_options:
+2
View File
@@ -1,10 +1,12 @@
substitutions: substitutions:
name: "sleepingroom" name: "sleepingroom"
friendly_name: "Luftqualität Schlafzimmer" 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: esphome:
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
comment: ${device_description}
name_add_mac_suffix: false name_add_mac_suffix: false
project: project:
name: sensor.${name} name: sensor.${name}
+2
View File
@@ -1,8 +1,10 @@
substitutions: substitutions:
device_description: "ESP32-C3 bathroom temperature and humidity monitor with DHT22 and SHT3x sensors"
name: "bathroom" name: "bathroom"
friendly_name: "Bad" friendly_name: "Bad"
esphome: esphome:
comment: ${device_description}
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
name_add_mac_suffix: false name_add_mac_suffix: false
+2
View File
@@ -1,10 +1,12 @@
substitutions: substitutions:
device_description: "M5Stack Core energy dashboard for Home Assistant grid, solar and consumer usage, with analog/digital clock and WireGuard"
name: "energymonitor" name: "energymonitor"
friendly_name: "Energy Monitor" friendly_name: "Energy Monitor"
grid_power_gauge_max_w: "5000.0" grid_power_gauge_max_w: "5000.0"
balcony_solar_gauge_max_w: "800.0" balcony_solar_gauge_max_w: "800.0"
esphome: esphome:
comment: ${device_description}
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
name_add_mac_suffix: false name_add_mac_suffix: false
+2
View File
@@ -1,11 +1,13 @@
# Device identity shared by ESPHome and Home Assistant. # Device identity shared by ESPHome and Home Assistant.
substitutions: substitutions:
device_description: "ESP32 e-paper Home Assistant dashboard for indoor climate, energy and calendar events, with button-controlled pages"
name: epaperframe name: epaperframe
friendly_name: "Info-Dashboard" friendly_name: "Info-Dashboard"
# Startup selects the default page only after Home Assistant has had time to # Startup selects the default page only after Home Assistant has had time to
# provide the sensor states needed by its display lambda. # provide the sensor states needed by its display lambda.
esphome: esphome:
comment: ${device_description}
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
name_add_mac_suffix: false name_add_mac_suffix: false
+2
View File
@@ -1,8 +1,10 @@
substitutions: substitutions:
device_description: "ESP32 Geiger counter with radiation dose rate, accumulated dose and MAX7219 seven-segment display"
name: "geigercounter" name: "geigercounter"
friendly_name: "Geigerzähler" friendly_name: "Geigerzähler"
esphome: esphome:
comment: ${device_description}
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
name_add_mac_suffix: false name_add_mac_suffix: false
+2
View File
@@ -1,9 +1,11 @@
substitutions: substitutions:
device_description: "Home Assistant Voice PE voice assistant with microphone and speaker."
name: home-assistant-voice-09c0e7 name: home-assistant-voice-09c0e7
friendly_name: Home Assistant Voice Küche friendly_name: Home Assistant Voice Küche
packages: packages:
Nabu Casa.Home Assistant Voice PE: github://esphome/home-assistant-voice-pe/home-assistant-voice.yaml Nabu Casa.Home Assistant Voice PE: github://esphome/home-assistant-voice-pe/home-assistant-voice.yaml
esphome: esphome:
comment: ${device_description}
name: ${name} name: ${name}
name_add_mac_suffix: false name_add_mac_suffix: false
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
+2
View File
@@ -1,9 +1,11 @@
substitutions: substitutions:
device_description: "Home Assistant Voice PE voice assistant with microphone and speaker."
name: home-assistant-voice-0a7c6b name: home-assistant-voice-0a7c6b
friendly_name: Home Assistant Voice Wohnzimmer friendly_name: Home Assistant Voice Wohnzimmer
packages: packages:
Nabu Casa.Home Assistant Voice PE: github://esphome/home-assistant-voice-pe/home-assistant-voice.yaml Nabu Casa.Home Assistant Voice PE: github://esphome/home-assistant-voice-pe/home-assistant-voice.yaml
esphome: esphome:
comment: ${device_description}
name: ${name} name: ${name}
name_add_mac_suffix: false name_add_mac_suffix: false
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
+2
View File
@@ -1,8 +1,10 @@
substitutions: substitutions:
name: kamera-balkon name: kamera-balkon
friendly_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: esphome:
comment: ${device_description}
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
name_add_mac_suffix: false name_add_mac_suffix: false
+2
View File
@@ -1,8 +1,10 @@
substitutions: substitutions:
name: kamera-wohnzimmer name: kamera-wohnzimmer
friendly_name: Kamera Wohnzimmer friendly_name: Kamera Wohnzimmer
device_description: "Living-room ESP32 camera with HTTP stream and snapshots and a controllable flash LED."
esphome: esphome:
comment: ${device_description}
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
name_add_mac_suffix: false name_add_mac_suffix: false
+2
View File
@@ -1,8 +1,10 @@
substitutions: substitutions:
device_description: "ESP32 living-room air quality monitor with SCD30 CO2, temperature and humidity, PM2.5 sensing and RGB status LED"
name: "livingroom" name: "livingroom"
friendly_name: "Luftqualität Wohnzimmer" friendly_name: "Luftqualität Wohnzimmer"
esphome: esphome:
comment: ${device_description}
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
name_add_mac_suffix: false name_add_mac_suffix: false
+2
View File
@@ -3,8 +3,10 @@
substitutions: substitutions:
name: m5stack-atom-echo name: m5stack-atom-echo
friendly_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: esphome:
comment: ${device_description}
name: ${name} name: ${name}
name_add_mac_suffix: false name_add_mac_suffix: false
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
+2
View File
@@ -1,8 +1,10 @@
substitutions: substitutions:
device_description: "ESP32-C3 server-room temperature and atmospheric pressure monitor with BMP280 sensor"
name: "serverroom" name: "serverroom"
friendly_name: "Serverraum Luft" friendly_name: "Serverraum Luft"
esphome: esphome:
comment: ${device_description}
name: ${name} name: ${name}
friendly_name: ${friendly_name} friendly_name: ${friendly_name}
name_add_mac_suffix: false name_add_mac_suffix: false