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

[button] Tidy up name/id (#4139)

Browse Source
This commit is contained in:
Jesse Hills 2024-08-14 14:52:16 +12:00 committed by GitHub
parent 52542f3608
commit 4b09703009
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 7 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
components/button/factory_reset.rst
View File

@ -35,9 +35,7 @@ After reboot all states, parameters and variables will be reinitialized with the
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the button.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Button <config-button>`.
- All options from :ref:`Button <config-button>`.
See Also
--------

3
components/button/index.rst
View File

@ -40,7 +40,8 @@ All buttons in ESPHome have a name and an optional icon.
Configuration variables:
- **name** (**Required**, string): The name for the button.
- **id** (*Optional*, string): Manually specify the ID for code generation. At least one of **id** and **name** must be specified.
- **name** (*Optional*, string): The name for the button. At least one of **id** and **name** must be specified.
.. note::

2
components/button/output.rst
View File

@ -29,8 +29,6 @@ momentarily set a GPIO pin using a button.
Configuration variables:
------------------------
- **name** (**Required**, string): The name for the button.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **output** (**Required**, :ref:`config-id`): The ID of the output component to use.
- **duration** (**Required**, :ref:`config-time`): How long the output should be set when the button is pressed.
- All other options from :ref:`Button <config-button>`.

4
components/button/restart.rst
View File

@ -18,9 +18,7 @@ through Home Assistant.
Configuration variables:
------------------------
- **name** (**Required**, string): The name for the button.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Button <config-button>`.
- All options from :ref:`Button <config-button>`.
See Also
--------

4
components/button/safe_mode.rst
View File

@ -24,9 +24,7 @@ This component requires :doc:`/components/safe_mode` to be configured.
Configuration variables:
------------------------
- **name** (**Required**, string): The name for the button.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Button <config-button>`.
- All options from :ref:`Button <config-button>`.
See Also
--------

4
components/button/shutdown.rst
View File

@ -24,9 +24,7 @@ pressing the reset button or restarting the power supply.
Configuration variables:
------------------------
- **name** (**Required**, string): The name for the button.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Button <config-button>`.
- All options from :ref:`Button <config-button>`.
See Also
--------

4
components/button/template.rst
View File

@ -20,9 +20,7 @@ it will automatically appear in Home Assistant as a button and can be controlled
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the switch.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Button <config-button>`.
- All options from :ref:`Button <config-button>`.
See Also
--------

2
components/button/uart.rst
View File

@ -22,8 +22,6 @@ The ``uart`` button platform allows you to send a pre-defined sequence of bytes
Configuration variables:
------------------------
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (*Optional*, string): The name for the button.
- **data** (**Required**, string or list of bytes): The data to send via UART. Either an ASCII string
or a list of bytes.
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub.

2
components/button/wake_on_lan.rst
View File

@ -19,9 +19,7 @@ by specifying its MAC address.
Configuration variables:
------------------------
- **name** (**Required**, string): The name for the button.
- **target_mac_address** (**Required**, MAC Address): The MAC Address of the target computer.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Button <config-button>`.
See Also