Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-25 17:17:54 +01:00
Code Issues Projects Releases Wiki Activity

[update] Tidy up name/id (#4153)

Browse Source
This commit is contained in:
Jesse Hills 2024-08-14 14:03:19 +12:00 committed by GitHub
parent dc2c7aa02f
commit 9839ac3a50
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
components/update/index.rst
View File

@ -21,8 +21,14 @@ install it on its own.
Configuration variables: Configuration variables:
------------------------ ------------------------
- **name** (*Optional*, string): The name to use for the update component. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. At least one of **id** and **name** must be specified.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **name** (*Optional*, string): The name of the update entity. At least one of **id** and **name** must be specified.
.. note::
If you have a :ref:`friendly_name <esphome-configuration_variables>` set for your device and
you want the light to use that name, you can set ``name: None``.
- **device_class** (*Optional*, string): The device class for the update entity. See - **device_class** (*Optional*, string): The device class for the update entity. See
https://www.home-assistant.io/integrations/binary_sensor/#device-class for a list of available options. https://www.home-assistant.io/integrations/binary_sensor/#device-class for a list of available options.
- **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend