Inheritance diagram for homeassistant.helpers.trigger_template_entity.TriggerBaseEntity:

Collaboration diagram for homeassistant.helpers.trigger_template_entity.TriggerBaseEntity:

Public Member Functions
None	__init__ (self, HomeAssistant hass, ConfigType config)

bool	available (self)

str\|None	entity_picture (self)

dict[str, Any]\|None	extra_state_attributes (self)

str\|None	icon (self)

str\|None	name (self)

None	restore_attributes (self, State last_state)

str\|None	unique_id (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_added_to_hass (self)

None	async_device_update (self, bool warning=True)

None	async_internal_added_to_hass (self)

None	async_internal_will_remove_from_hass (self)

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)

dict[str, Any]\|None	capability_attributes (self)

str\|None	device_class (self)

DeviceInfo\|None	device_info (self)

bool	enabled (self)

EntityCategory\|None	entity_category (self)

bool	entity_registry_enabled_default (self)

bool	entity_registry_visible_default (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)

None	schedule_update_ha_state (self, bool force_refresh=False)

bool	should_poll (self)

StateType	state (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	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 Attributes
	hass

Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Static Public Attributes
	None

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Private Member Functions
None	_render_templates (self, dict[str, Any] variables)

None	_set_unique_id (self, str\|None unique_id)

Private Attributes
	_attr_device_class

	_config

	_parse_result

	_rendered

	_static_rendered

	_unique_id

Detailed Description

Template Base entity based on trigger data.

Definition at line 77 of file trigger_template_entity.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.__init__	(		self,
		HomeAssistant	hass,
		ConfigType	config
	)

Initialize the entity.

Reimplemented in homeassistant.helpers.trigger_template_entity.ManualTriggerSensorEntity, and homeassistant.helpers.trigger_template_entity.ManualTriggerEntity.

Definition at line 85 of file trigger_template_entity.py.

Member Function Documentation

◆ _render_templates()

None homeassistant.helpers.trigger_template_entity.TriggerBaseEntity._render_templates	(		self,
		dict[str, Any]	variables
	)

private

Render templates.

Definition at line 179 of file trigger_template_entity.py.

◆ _set_unique_id()

None homeassistant.helpers.trigger_template_entity.TriggerBaseEntity._set_unique_id	(		self,
		str \| None	unique_id
	)

private

Set unique id.

Definition at line 160 of file trigger_template_entity.py.

◆ available()

bool homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.available ( self )

Return availability of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.scrape.sensor.ScrapeSensor, homeassistant.components.rest.sensor.RestSensor, and homeassistant.components.rest.binary_sensor.RestBinarySensor.

Definition at line 146 of file trigger_template_entity.py.

◆ entity_picture()

str | None homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.entity_picture ( self )

Return entity picture.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 141 of file trigger_template_entity.py.

◆ extra_state_attributes()

dict[str, Any] | None homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.extra_state_attributes ( self )

Return extra attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.sql.sensor.SQLSensor, homeassistant.components.rest.sensor.RestSensor, and homeassistant.components.command_line.sensor.CommandSensor.

Definition at line 156 of file trigger_template_entity.py.

◆ icon()

str | None homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.icon ( self )

Return icon.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 136 of file trigger_template_entity.py.

◆ name()

str | None homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.name ( self )

Name of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 126 of file trigger_template_entity.py.

◆ restore_attributes()

None homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.restore_attributes	(		self,
		State	last_state
	)

Restore attributes.

Definition at line 164 of file trigger_template_entity.py.

◆ unique_id()

str | None homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.unique_id ( self )

Return unique ID of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 131 of file trigger_template_entity.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.helpers.trigger_template_entity.TriggerBaseEntity._attr_device_class

private

Definition at line 123 of file trigger_template_entity.py.

◆ _config

homeassistant.helpers.trigger_template_entity.TriggerBaseEntity._config

private

Definition at line 95 of file trigger_template_entity.py.

◆ _parse_result

homeassistant.helpers.trigger_template_entity.TriggerBaseEntity._parse_result

private

Definition at line 122 of file trigger_template_entity.py.

◆ _rendered

homeassistant.helpers.trigger_template_entity.TriggerBaseEntity._rendered

private

Definition at line 121 of file trigger_template_entity.py.

◆ _static_rendered

homeassistant.helpers.trigger_template_entity.TriggerBaseEntity._static_rendered

private

Definition at line 97 of file trigger_template_entity.py.

◆ _unique_id

homeassistant.helpers.trigger_template_entity.TriggerBaseEntity._unique_id

private

Definition at line 162 of file trigger_template_entity.py.

◆ hass

homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.hass

Definition at line 91 of file trigger_template_entity.py.

◆ None

homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.None

static

Definition at line 81 of file trigger_template_entity.py.

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

core/homeassistant/helpers/trigger_template_entity.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _render_templates()

◆ _set_unique_id()

◆ available()

◆ entity_picture()

◆ extra_state_attributes()

◆ icon()

◆ name()

◆ restore_attributes()

◆ unique_id()

Member Data Documentation

◆ _attr_device_class

◆ _config

◆ _parse_result

◆ _rendered

◆ _static_rendered

◆ _unique_id

◆ hass

◆ None

◆ init()