esphome-docs/components/button/template.rst
Keith Burzinski 5c78504d97
Break apart automations doc (#3957)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
2024-06-27 11:55:41 +12:00

33 lines
932 B
ReStructuredText

Template Button
===============
.. seo::
:description: Instructions for setting up template buttons that can execute arbitrary actions when pressed.
:image: description.svg
The ``template`` button platform allows you to create simple buttons out of just actions. Once defined,
it will automatically appear in Home Assistant as a button and can be controlled through the frontend.
.. code-block:: yaml
# Example configuration entry
button:
- platform: template
name: "Template Button"
on_press:
- logger.log: Button Pressed
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>`.
See Also
--------
- :doc:`/automations/index`
- :doc:`/components/button/index`
- :ghedit:`Edit`