homeassistant.components.automation.BaseAutomationEntity Class Reference

Inheritance diagram for homeassistant.components.automation.BaseAutomationEntity:

Collaboration diagram for homeassistant.components.automation.BaseAutomationEntity:

Public Member Functions
ScriptRunResult|None	async_trigger (self, dict[str, Any] run_variables, Context|None context=None, bool skip_condition=False)
dict[str, Any]|None	capability_attributes (self)
set[str]	referenced_areas (self)
str|None	referenced_blueprint (self)
set[str]	referenced_devices (self)
set[str]	referenced_entities (self)
set[str]	referenced_floors (self)
set[str]	referenced_labels (self)
Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None	async_toggle (self, **Any kwargs)
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
bool|None	is_on (self)
Literal["on", "off"]|None	state (self)
None	toggle (self, **Any kwargs)
None	turn_off (self, **Any kwargs)
None	turn_on (self, **Any kwargs)
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)
bool	available (self)
str|None	device_class (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)

Static Private Attributes
	_entity_component_unrecorded_attributes

Additional Inherited Members
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.ToggleEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Base class for automation entities.

Definition at line 352 of file __init__.py.

Member Function Documentation

async_trigger()

ScriptRunResult | None homeassistant.components.automation.BaseAutomationEntity.async_trigger	(		self,
		dict[str, Any]	run_variables,
		Context | None	context = None,
		bool	skip_condition = False
	)

Trigger automation.

Reimplemented in homeassistant.components.automation.AutomationEntity, and homeassistant.components.automation.UnavailableAutomationEntity.

Definition at line 398 of file __init__.py.

capability_attributes()

dict[str, Any] | None homeassistant.components.automation.BaseAutomationEntity.capability_attributes

(

self

)

Return capability attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 361 of file __init__.py.

referenced_areas()

set[str] homeassistant.components.automation.BaseAutomationEntity.referenced_areas

(

self

)

Return a set of referenced areas.

Reimplemented in homeassistant.components.automation.AutomationEntity, and homeassistant.components.automation.UnavailableAutomationEntity.

Definition at line 379 of file __init__.py.

referenced_blueprint()

str | None homeassistant.components.automation.BaseAutomationEntity.referenced_blueprint

(

self

)

Return referenced blueprint or None.

Reimplemented in homeassistant.components.automation.AutomationEntity, and homeassistant.components.automation.UnavailableAutomationEntity.

Definition at line 384 of file __init__.py.

referenced_devices()

set[str] homeassistant.components.automation.BaseAutomationEntity.referenced_devices

(

self

)

Return a set of referenced devices.

Reimplemented in homeassistant.components.automation.AutomationEntity, and homeassistant.components.automation.UnavailableAutomationEntity.

Definition at line 389 of file __init__.py.

referenced_entities()

set[str] homeassistant.components.automation.BaseAutomationEntity.referenced_entities

(

self

)

Return a set of referenced entities.

Reimplemented in homeassistant.components.automation.AutomationEntity, and homeassistant.components.automation.UnavailableAutomationEntity.

Definition at line 394 of file __init__.py.

referenced_floors()

set[str] homeassistant.components.automation.BaseAutomationEntity.referenced_floors

(

self

)

Return a set of referenced floors.

Reimplemented in homeassistant.components.automation.AutomationEntity, and homeassistant.components.automation.UnavailableAutomationEntity.

Definition at line 374 of file __init__.py.

referenced_labels()

set[str] homeassistant.components.automation.BaseAutomationEntity.referenced_labels

(

self

)

Return a set of referenced labels.

Reimplemented in homeassistant.components.automation.AutomationEntity, and homeassistant.components.automation.UnavailableAutomationEntity.

Definition at line 369 of file __init__.py.

Member Data Documentation

_entity_component_unrecorded_attributes

homeassistant.components.automation.BaseAutomationEntity._entity_component_unrecorded_attributes

staticprivate

Initial value:

=  frozenset(
        (ATTR_LAST_TRIGGERED, ATTR_MODE, ATTR_CUR, ATTR_MAX, CONF_ID)
    )

Base class for automation entities.

Definition at line 355 of file __init__.py.

---

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

• core/homeassistant/components/automation/__init__.py