homeassistant.components.device_automation Namespace Reference

Namespaces
	action
	condition
	const
	entity
	exceptions
	helpers
	toggle_entity
	trigger

Classes
class	DeviceAutomationDetails
class	DeviceAutomationType

Functions
dict[str, Any]	_async_get_device_automation_capabilities (HomeAssistant hass, DeviceAutomationType automation_type, Mapping[str, Any] automation)
list[list[dict[str, Any]]|Exception]	_async_get_device_automations_from_domain (HomeAssistant hass, str domain, DeviceAutomationType automation_type, Iterable[str] device_ids, bool return_exceptions)
None	_async_set_entity_device_automation_metadata (HomeAssistant hass, dict[str, Any] automation)
DeviceAutomationPlatformType	async_get_device_automation_platform (HomeAssistant hass, str domain, DeviceAutomationType automation_type)
DeviceAutomationActionProtocol	async_get_device_automation_platform (HomeAssistant hass, str domain, Literal[DeviceAutomationType.ACTION] automation_type)
DeviceAutomationConditionProtocol	async_get_device_automation_platform (HomeAssistant hass, str domain, Literal[DeviceAutomationType.CONDITION] automation_type)
DeviceAutomationTriggerProtocol	async_get_device_automation_platform (HomeAssistant hass, str domain, Literal[DeviceAutomationType.TRIGGER] automation_type)
Mapping[str, list[dict[str, Any]]]	async_get_device_automations (HomeAssistant hass, DeviceAutomationType automation_type, Iterable[str]|None device_ids=None)
er.RegistryEntry	async_get_entity_registry_entry_or_raise (HomeAssistant hass, str entity_registry_id)
bool	async_setup (HomeAssistant hass, ConfigType config)
ConfigType	async_validate_entity_schema (HomeAssistant hass, ConfigType config, VolSchemaType schema)
Callable[[HomeAssistant, ActiveConnection, dict[str, Any]], Coroutine[Any, Any, None]]	handle_device_errors (Callable[[HomeAssistant, ActiveConnection, dict[str, Any]], Awaitable[None]] func)
None	websocket_device_automation_get_action_capabilities (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_device_automation_get_condition_capabilities (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_device_automation_get_trigger_capabilities (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_device_automation_list_actions (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_device_automation_list_conditions (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_device_automation_list_triggers (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)

Variables
	CONFIG_SCHEMA
	DOMAIN
	Schema
	TYPES

Detailed Description

Helpers for device automations.

Function Documentation

_async_get_device_automation_capabilities()

dict[str, Any] homeassistant.components.device_automation._async_get_device_automation_capabilities ( HomeAssistant  hass, DeviceAutomationType  automation_type, Mapping[str, Any]  automation  )

private

List device automations.

Definition at line 293 of file __init__.py.

_async_get_device_automations_from_domain()

list[list[dict[str, Any]] | Exception] homeassistant.components.device_automation._async_get_device_automations_from_domain ( HomeAssistant  hass, str  domain, DeviceAutomationType  automation_type, Iterable[str]  device_ids, bool  return_exceptions  )

private

List device automations.

Definition at line 208 of file __init__.py.

_async_set_entity_device_automation_metadata()

None homeassistant.components.device_automation._async_set_entity_device_automation_metadata ( HomeAssistant  hass, dict[str, Any]   automation  )

private

Set device automation metadata based on entity registry entry data.

Definition at line 191 of file __init__.py.

async_get_device_automation_platform() [1/4]

DeviceAutomationPlatformType homeassistant.components.device_automation.async_get_device_automation_platform	(	HomeAssistant	hass,
		str	domain,
		DeviceAutomationType	automation_type
	)

Load device automation platform for integration.

Throws InvalidDeviceAutomationConfig if the integration is not found or does not support device automation.

Definition at line 157 of file __init__.py.

async_get_device_automation_platform() [2/4]

DeviceAutomationActionProtocol homeassistant.components.device_automation.async_get_device_automation_platform	(	HomeAssistant	hass,
		str	domain,
		Literal[DeviceAutomationType.ACTION]	automation_type
	)

Definition at line 149 of file __init__.py.

async_get_device_automation_platform() [3/4]

DeviceAutomationConditionProtocol homeassistant.components.device_automation.async_get_device_automation_platform	(	HomeAssistant	hass,
		str	domain,
		Literal[DeviceAutomationType.CONDITION]	automation_type
	)

Definition at line 141 of file __init__.py.

async_get_device_automation_platform() [4/4]

DeviceAutomationTriggerProtocol homeassistant.components.device_automation.async_get_device_automation_platform	(	HomeAssistant	hass,
		str	domain,
		Literal[DeviceAutomationType.TRIGGER]	automation_type
	)

Definition at line 133 of file __init__.py.

async_get_device_automations()

Mapping[str, list[dict[str, Any]]] homeassistant.components.device_automation.async_get_device_automations	(	HomeAssistant	hass,
		DeviceAutomationType	automation_type,
		Iterable[str] | None	device_ids = None
	)

List device automations.

Definition at line 234 of file __init__.py.

async_get_entity_registry_entry_or_raise()

er.RegistryEntry homeassistant.components.device_automation.async_get_entity_registry_entry_or_raise	(	HomeAssistant	hass,
		str	entity_registry_id
	)

Get an entity registry entry from entry ID or raise.

Definition at line 330 of file __init__.py.

async_setup()

bool homeassistant.components.device_automation.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up device automation.

Definition at line 111 of file __init__.py.

async_validate_entity_schema()

ConfigType homeassistant.components.device_automation.async_validate_entity_schema	(	HomeAssistant	hass,
		ConfigType	config,
		VolSchemaType	schema
	)

Validate schema and resolve entity registry entry id to entity_id.

Definition at line 342 of file __init__.py.

handle_device_errors()

Callable[ [HomeAssistant, ActiveConnection, dict[str, Any]], Coroutine[Any, Any, None] ] homeassistant.components.device_automation.handle_device_errors

(

Callable[[HomeAssistant, ActiveConnection, dict[str, Any]], Awaitable[None]]

func

)

Handle device automation errors.

Definition at line 357 of file __init__.py.

websocket_device_automation_get_action_capabilities()

None homeassistant.components.device_automation.websocket_device_automation_get_action_capabilities	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle request for device action capabilities.

Definition at line 449 of file __init__.py.

websocket_device_automation_get_condition_capabilities()

None homeassistant.components.device_automation.websocket_device_automation_get_condition_capabilities	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle request for device condition capabilities.

Definition at line 470 of file __init__.py.

websocket_device_automation_get_trigger_capabilities()

None homeassistant.components.device_automation.websocket_device_automation_get_trigger_capabilities	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle request for device trigger capabilities.

Definition at line 494 of file __init__.py.

websocket_device_automation_list_actions()

None homeassistant.components.device_automation.websocket_device_automation_list_actions	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle request for device actions.

Definition at line 386 of file __init__.py.

websocket_device_automation_list_conditions()

None homeassistant.components.device_automation.websocket_device_automation_list_conditions	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle request for device conditions.

Definition at line 407 of file __init__.py.

websocket_device_automation_list_triggers()

None homeassistant.components.device_automation.websocket_device_automation_list_triggers	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle request for device triggers.

Definition at line 428 of file __init__.py.

Variable Documentation

CONFIG_SCHEMA

homeassistant.components.device_automation.CONFIG_SCHEMA

Definition at line 62 of file __init__.py.

DOMAIN

homeassistant.components.device_automation.DOMAIN

Definition at line 60 of file __init__.py.

Schema

homeassistant.components.device_automation.Schema

Definition at line 64 of file __init__.py.

TYPES

homeassistant.components.device_automation.TYPES

Definition at line 104 of file __init__.py.