homeassistant.components.alert Namespace Reference

Namespaces
	const
	entity
	reproduce_state

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)

Variables
	ALERT_SCHEMA
	CONFIG_SCHEMA

Detailed Description

Support for repeating alerts when conditions are met.

Function Documentation

async_setup()

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

Set up the Alert component.

Definition at line 65 of file __init__.py.

Variable Documentation

ALERT_SCHEMA

homeassistant.components.alert.ALERT_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_NAME): cv.string,
        vol.Required(CONF_ENTITY_ID): cv.entity_id,
        vol.Optional(CONF_STATE, default=STATE_ON): cv.string,
        vol.Required(CONF_REPEAT): vol.All(
            cv.ensure_list,
            [vol.Coerce(float)],
            # Minimum delay is 1 second = 0.016 minutes
            [vol.Range(min=0.016)],
        ),
        vol.Optional(CONF_CAN_ACK, default=DEFAULT_CAN_ACK): cv.boolean,
        vol.Optional(CONF_SKIP_FIRST, default=DEFAULT_SKIP_FIRST): cv.boolean,
        vol.Optional(CONF_ALERT_MESSAGE): cv.template,
        vol.Optional(CONF_DONE_MESSAGE): cv.template,
        vol.Optional(CONF_TITLE): cv.template,
        vol.Optional(CONF_DATA): dict,
        vol.Optional(CONF_NOTIFIERS, default=list): vol.All(
            cv.ensure_list, [cv.string]
        ),
    }
)

Definition at line 37 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.alert.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {DOMAIN: cv.schema_with_slug_keys(ALERT_SCHEMA)}, extra=vol.ALLOW_EXTRA
)

Definition at line 60 of file __init__.py.