#include <template_button.h>

Inheritance diagram for esphome::template_::TemplateButton:

Public Member Functions
void	press_action () override

Public Member Functions inherited from esphome::button::Button
void	press ()
	Press this button.

void	add_on_press_callback (std::function< void()> &&callback)
	Set callback for state changes.

Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const

void	set_name (const char *name)

bool	has_own_name () const

ESPDEPRECATED("object_id mangles names and all object_id methods are planned for removal " "(see https://github.com/esphome/backlog/issues/76). " "Now is the time to stop using object_id. If still needed, use get_object_id_to() " "which will remain available longer. get_object_id() will be removed in 2026.7.0", "2025.12.0") std void	set_object_id (const char *object_id)

void	set_name_and_object_id (const char name, const char object_id)

uint32_t	get_object_id_hash ()

StringRef	get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
	Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.

size_t	write_object_id_to (char *buf, size_t buf_size) const
	Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.

bool	is_internal () const

void	set_internal (bool internal)

bool	is_disabled_by_default () const

void	set_disabled_by_default (bool disabled_by_default)

EntityCategory	get_entity_category () const

void	set_entity_category (EntityCategory entity_category)

ESPDEPRECATED("Use get_icon_ref() instead for better performance (avoids string copy). Will be removed in ESPHome 2026.5.0", "2025.11.0") std void	set_icon (const char *icon)

StringRef	get_icon_ref () const

uint32_t	get_device_id () const

void	set_device (Device *device)

bool	has_state () const

void	set_has_state (bool state)

uint32_t	get_preference_hash ()
	Get a unique hash for storing preferences/settings for this entity.

Public Member Functions inherited from esphome::EntityBase_DeviceClass
ESPDEPRECATED("Use get_device_class_ref() instead for better performance (avoids string copy). Will be removed in " "ESPHome 2026.5.0", "2025.11.0") std void	set_device_class (const char *device_class)
	Get the device class, using the manual override if set.

StringRef	get_device_class_ref () const
	Get the device class as StringRef.

Additional Inherited Members
Protected Member Functions inherited from esphome::button::Button
Protected Member Functions inherited from esphome::EntityBase
void	calc_object_id_ ()

bool	is_object_id_dynamic_ () const
	Check if the object_id is dynamic (changes with MAC suffix)

Protected Attributes inherited from esphome::button::Button
LazyCallbackManager< void()>	press_callback_ {}

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

const char *	object_id_c_str_ {nullptr}

const char *	icon_c_str_ {nullptr}

uint32_t	object_id_hash_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override.

Detailed Description

Definition at line 7 of file template_button.h.

Member Function Documentation

◆ press_action()

void esphome::template_::TemplateButton::press_action ( )

inlineoverridevirtual

Implements esphome::button::Button.

Definition at line 10 of file template_button.h.

The documentation for this class was generated from the following file:

esphome/components/template/button/template_button.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ press_action()