Skip to content

Commit 95d4a6e

Browse files
authored
Add a helpful nudge to set a friendly_name (#4826)
1 parent d749ef3 commit 95d4a6e

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

components/esphome.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,13 @@ Configuration variables:
3030
characters, digits and hyphens, and can be at most 24 characters long by default, or 31
3131
characters long if ``name_add_mac_suffix`` is ``false``.
3232
See :ref:`esphome-changing_node_name`.
33-
- **friendly_name** (*Optional*, string): This is the name sent to the frontend. It is used
34-
by Home Assistant as the integration name, device name, and is automatically prefixed to entities
35-
where necessary.
33+
- **friendly_name** (*Optional*, string):
34+
This name is sent to the frontend and used by Home Assistant as
35+
the integration and device name. It also gets prefixed to entity
36+
names when needed. While optional, leaving it out can result in
37+
less intuitive names and a less polished experience in Home
38+
Assistant. Setting a `friendly_name` helps keep things clear,
39+
consistent, and easier to manage.
3640
- **area** (*Optional*, string): This is the area sent to the frontend. It is used
3741
by Home Assistant as the area / zone which the node belongs to.
3842

0 commit comments

Comments
 (0)