homeassistant.components.script Namespace Reference

Namespaces
	config
	const
	helpers
	logbook
	trace

Classes
class	BaseScriptEntity
class	ScriptEntity
class	ScriptEntityConfig
class	UnavailableScriptEntity

Functions
None	_async_process_config (HomeAssistant hass, ConfigType config, EntityComponent[BaseScriptEntity] component)
list[BaseScriptEntity]	_create_script_entities (HomeAssistant hass, list[ScriptEntityConfig] script_configs)
list[ScriptEntityConfig]	_prepare_script_config (HomeAssistant hass, ConfigType config)
list[str]	_scripts_with_x (HomeAssistant hass, str referenced_id, str property_name)
list[str]	_x_in_script (HomeAssistant hass, str entity_id, str property_name)
list[str]	areas_in_script (HomeAssistant hass, str entity_id)
bool	async_setup (HomeAssistant hass, ConfigType config)
str|None	blueprint_in_script (HomeAssistant hass, str entity_id)
list[str]	devices_in_script (HomeAssistant hass, str entity_id)
list[str]	entities_in_script (HomeAssistant hass, str entity_id)
list[str]	floors_in_script (HomeAssistant hass, str entity_id)
bool	is_on (HomeAssistant hass, str entity_id)
list[str]	labels_in_script (HomeAssistant hass, str entity_id)
list[str]	scripts_with_area (HomeAssistant hass, str area_id)
list[str]	scripts_with_blueprint (HomeAssistant hass, str blueprint_path)
list[str]	scripts_with_device (HomeAssistant hass, str device_id)
list[str]	scripts_with_entity (HomeAssistant hass, str entity_id)
list[str]	scripts_with_floor (HomeAssistant hass, str floor_id)
list[str]	scripts_with_label (HomeAssistant hass, str label_id)
None	websocket_config (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
	RELOAD_SERVICE_SCHEMA = vol.Schema({})
	SCRIPT_SERVICE_SCHEMA = vol.Schema(dict)
	SCRIPT_TURN_ONOFF_SCHEMA

Detailed Description

Support for scripts.

Function Documentation

_async_process_config()

None homeassistant.components.script._async_process_config ( HomeAssistant  hass, ConfigType  config, EntityComponent[BaseScriptEntity]  component  )

private

Process script configuration.

Definition at line 359 of file __init__.py.

_create_script_entities()

list[BaseScriptEntity] homeassistant.components.script._create_script_entities ( HomeAssistant  hass, list[ScriptEntityConfig]   script_configs  )

private

Create script entities from prepared configuration.

Definition at line 329 of file __init__.py.

_prepare_script_config()

list[ScriptEntityConfig] homeassistant.components.script._prepare_script_config ( HomeAssistant  hass, ConfigType  config  )

private

Parse configuration and prepare script entity configuration.

Definition at line 300 of file __init__.py.

_scripts_with_x()

list[str] homeassistant.components.script._scripts_with_x ( HomeAssistant  hass, str  referenced_id, str   property_name  )

private

Return all scripts that reference the x.

Definition at line 96 of file __init__.py.

_x_in_script()

list[str] homeassistant.components.script._x_in_script ( HomeAssistant  hass, str  entity_id, str  property_name  )

private

Return all x in a script.

Definition at line 112 of file __init__.py.

areas_in_script()

list[str] homeassistant.components.script.areas_in_script	(	HomeAssistant	hass,
		str	entity_id
	)

Return all areas in a script.

Definition at line 156 of file __init__.py.

async_setup()

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

Load the scripts from the configuration.

Definition at line 214 of file __init__.py.

blueprint_in_script()

str | None homeassistant.components.script.blueprint_in_script	(	HomeAssistant	hass,
		str	entity_id
	)

Return the blueprint the script is based on or None.

Definition at line 201 of file __init__.py.

devices_in_script()

list[str] homeassistant.components.script.devices_in_script	(	HomeAssistant	hass,
		str	entity_id
	)

Return all devices in script.

Definition at line 144 of file __init__.py.

entities_in_script()

list[str] homeassistant.components.script.entities_in_script	(	HomeAssistant	hass,
		str	entity_id
	)

Return all entities in script.

Definition at line 132 of file __init__.py.

floors_in_script()

list[str] homeassistant.components.script.floors_in_script	(	HomeAssistant	hass,
		str	entity_id
	)

Return all floors in a script.

Definition at line 168 of file __init__.py.

is_on()

bool homeassistant.components.script.is_on	(	HomeAssistant	hass,
		str	entity_id
	)

Return if the script is on based on the statemachine.

Definition at line 91 of file __init__.py.

labels_in_script()

list[str] homeassistant.components.script.labels_in_script	(	HomeAssistant	hass,
		str	entity_id
	)

Return all labels in a script.

Definition at line 180 of file __init__.py.

scripts_with_area()

list[str] homeassistant.components.script.scripts_with_area	(	HomeAssistant	hass,
		str	area_id
	)

Return all scripts that reference the area.

Definition at line 150 of file __init__.py.

scripts_with_blueprint()

list[str] homeassistant.components.script.scripts_with_blueprint	(	HomeAssistant	hass,
		str	blueprint_path
	)

Return all scripts that reference the blueprint.

Definition at line 186 of file __init__.py.

scripts_with_device()

list[str] homeassistant.components.script.scripts_with_device	(	HomeAssistant	hass,
		str	device_id
	)

Return all scripts that reference the device.

Definition at line 138 of file __init__.py.

scripts_with_entity()

list[str] homeassistant.components.script.scripts_with_entity	(	HomeAssistant	hass,
		str	entity_id
	)

Return all scripts that reference the entity.

Definition at line 126 of file __init__.py.

scripts_with_floor()

list[str] homeassistant.components.script.scripts_with_floor	(	HomeAssistant	hass,
		str	floor_id
	)

Return all scripts that reference the floor.

Definition at line 162 of file __init__.py.

scripts_with_label()

list[str] homeassistant.components.script.scripts_with_label	(	HomeAssistant	hass,
		str	label_id
	)

Return all scripts that reference the label.

Definition at line 174 of file __init__.py.

websocket_config()

None homeassistant.components.script.websocket_config	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Get script config.

Definition at line 763 of file __init__.py.

Variable Documentation

RELOAD_SERVICE_SCHEMA

homeassistant.components.script.RELOAD_SERVICE_SCHEMA = vol.Schema({})

Definition at line 87 of file __init__.py.

SCRIPT_SERVICE_SCHEMA

homeassistant.components.script.SCRIPT_SERVICE_SCHEMA = vol.Schema(dict)

Definition at line 83 of file __init__.py.

SCRIPT_TURN_ONOFF_SCHEMA

homeassistant.components.script.SCRIPT_TURN_ONOFF_SCHEMA

Initial value:

=  make_entity_service_schema(
    {vol.Optional(ATTR_VARIABLES): {str: cv.match_all}}
)

Definition at line 84 of file __init__.py.