homeassistant.components.blueprint.schemas Namespace Reference

Functions
bool	is_blueprint_config (Any config)
bool	is_blueprint_instance_config (Any config)
Any	unique_input_validator (Any inputs)
str	validate_yaml_suffix (str value)
str	version_validator (Any value)

Variables
	BLUEPRINT_INPUT_SCHEMA
	BLUEPRINT_INPUT_SECTION_SCHEMA
	BLUEPRINT_INSTANCE_FIELDS
	BLUEPRINT_SCHEMA

Detailed Description

Schemas for the blueprint integration.

Function Documentation

is_blueprint_config()

bool homeassistant.components.blueprint.schemas.is_blueprint_config

(

Any

config

)

Return if it is a blueprint config.

Definition at line 69 of file schemas.py.

is_blueprint_instance_config()

bool homeassistant.components.blueprint.schemas.is_blueprint_instance_config

(

Any

config

)

Return if it is a blueprint instance config.

Definition at line 75 of file schemas.py.

unique_input_validator()

Any homeassistant.components.blueprint.schemas.unique_input_validator

(

Any

inputs

)

Validate the inputs don't have duplicate keys under different sections.

Definition at line 51 of file schemas.py.

validate_yaml_suffix()

str homeassistant.components.blueprint.schemas.validate_yaml_suffix

(

str

value

)

Validate value has a YAML suffix.

Definition at line 133 of file schemas.py.

version_validator()

str homeassistant.components.blueprint.schemas.version_validator

(

Any

value

)

Validate a Home Assistant version.

Definition at line 31 of file schemas.py.

Variable Documentation

BLUEPRINT_INPUT_SCHEMA

homeassistant.components.blueprint.schemas.BLUEPRINT_INPUT_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_NAME): str,
        vol.Optional(CONF_DESCRIPTION): str,
        vol.Optional(CONF_DEFAULT): cv.match_all,
        vol.Optional(CONF_SELECTOR): selector.validate_selector,
    }
)

Definition at line 80 of file schemas.py.

BLUEPRINT_INPUT_SECTION_SCHEMA

homeassistant.components.blueprint.schemas.BLUEPRINT_INPUT_SECTION_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_NAME): str,
        vol.Optional(CONF_ICON): str,
        vol.Optional(CONF_DESCRIPTION): str,
        vol.Optional(CONF_COLLAPSED): bool,
        vol.Required(CONF_INPUT, default=dict): {
            str: vol.Any(
                None,
                BLUEPRINT_INPUT_SCHEMA,
            )
        },
    }
)

Definition at line 89 of file schemas.py.

BLUEPRINT_INSTANCE_FIELDS

homeassistant.components.blueprint.schemas.BLUEPRINT_INSTANCE_FIELDS

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_USE_BLUEPRINT): vol.Schema(
            {
                vol.Required(CONF_PATH): vol.All(cv.path, validate_yaml_suffix),
                vol.Required(CONF_INPUT, default=dict): {str: cv.match_all},
            }
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 140 of file schemas.py.

BLUEPRINT_SCHEMA

homeassistant.components.blueprint.schemas.BLUEPRINT_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_BLUEPRINT): vol.Schema(
            {
                vol.Required(CONF_NAME): str,
                vol.Optional(CONF_DESCRIPTION): str,
                vol.Required(CONF_DOMAIN): str,
                vol.Optional(CONF_SOURCE_URL): cv.url,
                vol.Optional(CONF_AUTHOR): str,
                vol.Optional(CONF_HOMEASSISTANT): {
                    vol.Optional(CONF_MIN_VERSION): version_validator
                },
                vol.Optional(CONF_INPUT, default=dict): vol.All(
                    {
                        str: vol.Any(
                            None,
                            BLUEPRINT_INPUT_SCHEMA,
                            BLUEPRINT_INPUT_SECTION_SCHEMA,
                        )
                    },
                    unique_input_validator,
                ),
            }
        ),
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 104 of file schemas.py.