homeassistant.components.script.config Namespace Reference

Classes
class	ScriptConfig
class	ValidationStatus

Functions
ScriptConfig	_async_validate_config_item (HomeAssistant hass, str object_id, ConfigType config, bool raise_on_errors, bool warn_on_errors)
ScriptConfig|None	_try_async_validate_config_item (HomeAssistant hass, str object_id, ConfigType config)
ConfigType	async_validate_config (HomeAssistant hass, ConfigType config)
ScriptConfig|None	async_validate_config_item (HomeAssistant hass, str object_id, dict[str, Any] config)

Variables
dictionary	_INVALID_OBJECT_IDS
	_MINIMAL_SCRIPT_ENTITY_SCHEMA
	_SCRIPT_OBJECT_ID_SCHEMA
string	PACKAGE_MERGE_HINT = "dict"
	SCRIPT_ENTITY_SCHEMA

Detailed Description

Config validation helper for the script integration.

Function Documentation

_async_validate_config_item()

ScriptConfig homeassistant.components.script.config._async_validate_config_item ( HomeAssistant  hass, str  object_id, ConfigType  config, bool  raise_on_errors, bool  warn_on_errors  )

private

Validate config item.

Definition at line 108 of file config.py.

_try_async_validate_config_item()

ScriptConfig | None homeassistant.components.script.config._try_async_validate_config_item ( HomeAssistant  hass, str  object_id, ConfigType  config  )

private

Validate config item.

Definition at line 275 of file config.py.

async_validate_config()

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

Validate config.

Definition at line 296 of file config.py.

async_validate_config_item()

ScriptConfig | None homeassistant.components.script.config.async_validate_config_item	(	HomeAssistant	hass,
		str	object_id,
		dict[str, Any]	config
	)

Validate config item, called by EditScriptConfigView.

Definition at line 287 of file config.py.

Variable Documentation

_INVALID_OBJECT_IDS

dictionary homeassistant.components.script.config._INVALID_OBJECT_IDS

private

Initial value:

=  {
    SERVICE_RELOAD,
    SERVICE_TURN_OFF,
    SERVICE_TURN_ON,
    SERVICE_TOGGLE,
}

Definition at line 66 of file config.py.

_MINIMAL_SCRIPT_ENTITY_SCHEMA

homeassistant.components.script.config._MINIMAL_SCRIPT_ENTITY_SCHEMA

private

Initial value:

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

Definition at line 58 of file config.py.

_SCRIPT_OBJECT_ID_SCHEMA

homeassistant.components.script.config._SCRIPT_OBJECT_ID_SCHEMA

private

Initial value:

=  vol.All(
    cv.slug,
    vol.NotIn(
        _INVALID_OBJECT_IDS,
        (
            "A script's object_id must not be one of "
            f"{', '.join(sorted(_INVALID_OBJECT_IDS))}"
        ),
    ),
)

Definition at line 73 of file config.py.

PACKAGE_MERGE_HINT

string homeassistant.components.script.config.PACKAGE_MERGE_HINT = "dict"

Definition at line 56 of file config.py.

SCRIPT_ENTITY_SCHEMA

homeassistant.components.script.config.SCRIPT_ENTITY_SCHEMA

Initial value:

=  make_script_schema(
    {
        vol.Optional(CONF_ALIAS): cv.string,
        vol.Optional(CONF_TRACE, default={}): TRACE_CONFIG_SCHEMA,
        vol.Optional(CONF_ICON): cv.icon,
        vol.Required(CONF_SEQUENCE): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_DESCRIPTION, default=""): cv.string,
        vol.Optional(CONF_VARIABLES): cv.SCRIPT_VARIABLES_SCHEMA,
        vol.Optional(CONF_FIELDS, default={}): {
            cv.string: {
                vol.Optional(CONF_ADVANCED, default=False): cv.boolean,
                vol.Optional(CONF_DEFAULT): cv.match_all,
                vol.Optional(CONF_DESCRIPTION): cv.string,
                vol.Optional(CONF_EXAMPLE): cv.string,
                vol.Optional(CONF_NAME): cv.string,
                vol.Optional(CONF_REQUIRED, default=False): cv.boolean,
                vol.Optional(CONF_SELECTOR): validate_selector,
            }
        },
    },
    SCRIPT_MODE_SINGLE,
)

Definition at line 84 of file config.py.