homeassistant.components.esphome.button.EsphomeButton Class Reference

Inheritance diagram for homeassistant.components.esphome.button.EsphomeButton:

Collaboration diagram for homeassistant.components.esphome.button.EsphomeButton:

Public Member Functions
None	async_press (self)
Public Member Functions inherited from homeassistant.components.esphome.entity.EsphomeEntity
None	__init__ (self, RuntimeEntryData entry_data, str domain, EntityInfo entity_info, type[_StateT] state_type)
None	async_added_to_hass (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
dict[str, Any]|None	capability_attributes (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
Public Member Functions inherited from homeassistant.components.button.ButtonEntity
None	async_internal_added_to_hass (self)
ButtonDeviceClass|None	device_class (self)
None	press (self)
str|None	state (self)
Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None	async_get_last_extra_data (self)
State|None	async_get_last_state (self)
None	async_internal_will_remove_from_hass (self)
ExtraStoredData|None	extra_restore_state_data (self)

Private Member Functions
None	_on_device_update (self)
None	_on_static_info_update (self, EntityInfo static_info)

Private Attributes
	_attr_device_class

Additional Inherited Members
Public Attributes inherited from homeassistant.components.esphome.entity.EsphomeEntity
	entity_id
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.button.ButtonEntity
	None

Detailed Description

A button implementation for ESPHome.

Definition at line 20 of file button.py.

Member Function Documentation

_on_device_update()

None homeassistant.components.esphome.button.EsphomeButton._on_device_update (   self )

private

Call when device updates or entry data changes.

The default behavior is only to write entity state when the
device is unavailable when the device state changes.
This method overrides the default behavior since buttons do
not have a state, so we will never get a state update for a
button. As such, we need to write the state on every device
update to ensure the button goes available and unavailable
as the device becomes available or unavailable.

Reimplemented from homeassistant.components.esphome.entity.EsphomeEntity.

Definition at line 32 of file button.py.

_on_static_info_update()

None homeassistant.components.esphome.button.EsphomeButton._on_static_info_update (   self, EntityInfo  static_info  )

private

Set attrs from static info.

Reimplemented from homeassistant.components.esphome.entity.EsphomeEntity.

Definition at line 24 of file button.py.

async_press()

None homeassistant.components.esphome.button.EsphomeButton.async_press

(

self

)

Press the button.

Reimplemented from homeassistant.components.button.ButtonEntity.

Definition at line 47 of file button.py.

Member Data Documentation

_attr_device_class

homeassistant.components.esphome.button.EsphomeButton._attr_device_class

private

Definition at line 27 of file button.py.

---

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

• core/homeassistant/components/esphome/button.py