homeassistant.components.tts.legacy Namespace Reference

Classes
class	Provider

Functions
str	_deprecated_platform (str value)
list[Coroutine[Any, Any, None]]	async_setup_legacy (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_SERVICE_NAME = "service_name"
	PLATFORM_SCHEMA
	PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE.extend(PLATFORM_SCHEMA.schema)
	SCHEMA_SERVICE_SAY
string	SERVICE_SAY = "say"

Detailed Description

Provide the legacy TTS service provider interface.

Function Documentation

_deprecated_platform()

str homeassistant.components.tts.legacy._deprecated_platform ( str  value )

private

Validate if platform is deprecated.

Definition at line 65 of file legacy.py.

async_setup_legacy()

list[Coroutine[Any, Any, None]] homeassistant.components.tts.legacy.async_setup_legacy	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up legacy text-to-speech providers.

Definition at line 101 of file legacy.py.

Variable Documentation

_LOGGER

homeassistant.components.tts.legacy._LOGGER = logging.getLogger(__name__)

private

Definition at line 60 of file legacy.py.

CONF_SERVICE_NAME

string homeassistant.components.tts.legacy.CONF_SERVICE_NAME = "service_name"

Definition at line 62 of file legacy.py.

PLATFORM_SCHEMA

homeassistant.components.tts.legacy.PLATFORM_SCHEMA

Initial value:

=  cv.PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_PLATFORM): vol.All(cv.string, _deprecated_platform),
        vol.Optional(CONF_CACHE, default=DEFAULT_CACHE): cv.boolean,
        vol.Optional(CONF_CACHE_DIR, default=DEFAULT_CACHE_DIR): cv.string,
        vol.Optional(CONF_TIME_MEMORY, default=DEFAULT_TIME_MEMORY): vol.All(
            vol.Coerce(int), vol.Range(min=60, max=57600)
        ),
        vol.Optional(CONF_SERVICE_NAME): cv.string,
    }
)

Definition at line 75 of file legacy.py.

PLATFORM_SCHEMA_BASE

homeassistant.components.tts.legacy.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE.extend(PLATFORM_SCHEMA.schema)

Definition at line 86 of file legacy.py.

SCHEMA_SERVICE_SAY

homeassistant.components.tts.legacy.SCHEMA_SERVICE_SAY

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_MESSAGE): cv.string,
        vol.Optional(ATTR_CACHE): cv.boolean,
        vol.Required(ATTR_ENTITY_ID): cv.comp_entity_ids,
        vol.Optional(ATTR_LANGUAGE): cv.string,
        vol.Optional(ATTR_OPTIONS): dict,
    }
)

Definition at line 90 of file legacy.py.

SERVICE_SAY

string homeassistant.components.tts.legacy.SERVICE_SAY = "say"

Definition at line 88 of file legacy.py.