homeassistant.components.automation.config Namespace Reference

Classes
class	AutomationConfig
class	ValidationStatus

Functions
AutomationConfig	_async_validate_config_item (HomeAssistant hass, ConfigType config, bool raise_on_errors, bool warn_on_errors)
Any	_backward_compat_schema (Any|None value)
AutomationConfig|None	_try_async_validate_config_item (HomeAssistant hass, dict[str, Any] config)
ConfigType	async_validate_config (HomeAssistant hass, ConfigType config)
AutomationConfig|None	async_validate_config_item (HomeAssistant hass, str config_key, dict[str, Any] config)

Variables
	_MINIMAL_PLATFORM_SCHEMA
	AUTOMATION_BLUEPRINT_SCHEMA
string	PACKAGE_MERGE_HINT = "list"
	PLATFORM_SCHEMA

Detailed Description

Config validation helper for the automation integration.

Function Documentation

_async_validate_config_item()

AutomationConfig homeassistant.components.automation.config._async_validate_config_item ( HomeAssistant  hass, ConfigType  config, bool  raise_on_errors, bool  warn_on_errors  )

private

Validate config item.

Definition at line 118 of file config.py.

_backward_compat_schema()

Any homeassistant.components.automation.config._backward_compat_schema ( Any | None  value )

private

Backward compatibility for automations.

Definition at line 58 of file config.py.

_try_async_validate_config_item()

AutomationConfig | None homeassistant.components.automation.config._try_async_validate_config_item ( HomeAssistant  hass, dict[str, Any]  config  )

private

Validate config item.

Definition at line 325 of file config.py.

async_validate_config()

ConfigType homeassistant.components.automation.config.async_validate_config	(	HomeAssistant	hass,
		ConfigType	config
	)

Validate config.

Definition at line 345 of file config.py.

async_validate_config_item()

AutomationConfig | None homeassistant.components.automation.config.async_validate_config_item	(	HomeAssistant	hass,
		str	config_key,
		dict[str, Any]	config
	)

Validate config item, called by EditAutomationConfigView.

Definition at line 336 of file config.py.

Variable Documentation

_MINIMAL_PLATFORM_SCHEMA

homeassistant.components.automation.config._MINIMAL_PLATFORM_SCHEMA

private

Initial value:

=  vol.Schema(
    {
        CONF_ID: str,
        CONF_ALIAS: cv.string,
        vol.Optional(CONF_DESCRIPTION): cv.string,
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 48 of file config.py.

AUTOMATION_BLUEPRINT_SCHEMA

homeassistant.components.automation.config.AUTOMATION_BLUEPRINT_SCHEMA

Initial value:

=  vol.All(
    _backward_compat_schema, blueprint.schemas.BLUEPRINT_SCHEMA
)

Definition at line 113 of file config.py.

PACKAGE_MERGE_HINT

string homeassistant.components.automation.config.PACKAGE_MERGE_HINT = "list"

Definition at line 46 of file config.py.

PLATFORM_SCHEMA

homeassistant.components.automation.config.PLATFORM_SCHEMA

Initial value:

=  vol.All(
    _backward_compat_schema,
    cv.deprecated(CONF_HIDE_ENTITY),
    script.make_script_schema(
        {
            # str on purpose
            CONF_ID: str,
            CONF_ALIAS: cv.string,
            vol.Optional(CONF_DESCRIPTION): cv.string,
            vol.Optional(CONF_TRACE, default={}): TRACE_CONFIG_SCHEMA,
            vol.Optional(CONF_INITIAL_STATE): cv.boolean,
            vol.Optional(CONF_HIDE_ENTITY): cv.boolean,
            vol.Required(CONF_TRIGGERS): cv.TRIGGER_SCHEMA,
            vol.Optional(CONF_CONDITIONS): cv.CONDITIONS_SCHEMA,
            vol.Optional(CONF_VARIABLES): cv.SCRIPT_VARIABLES_SCHEMA,
            vol.Optional(CONF_TRIGGER_VARIABLES): cv.SCRIPT_VARIABLES_SCHEMA,
            vol.Required(CONF_ACTIONS): cv.SCRIPT_SCHEMA,
        },
        script.SCRIPT_MODE_SINGLE,
    ),
)

Definition at line 91 of file config.py.