Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.tts.notify Namespace Reference

Classes

class  TTSNotificationService
 

Functions

TTSNotificationService async_get_service (HomeAssistant hass, ConfigType config, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_MEDIA_PLAYER = "media_player"
 
string CONF_TTS_SERVICE = "tts_service"
 
string ENTITY_LEGACY_PROVIDER_GROUP = "entity_or_legacy_provider"
 
 PLATFORM_SCHEMA
 

Detailed Description

Support notifications through TTS service.

Function Documentation

◆ async_get_service()

TTSNotificationService homeassistant.components.tts.notify.async_get_service ( HomeAssistant  hass,
ConfigType  config,
DiscoveryInfoType | None   discovery_info = None 
)
Return the notify service.

Definition at line 43 of file notify.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.tts.notify._LOGGER = logging.getLogger(__name__)
private

Definition at line 25 of file notify.py.

◆ CONF_MEDIA_PLAYER

string homeassistant.components.tts.notify.CONF_MEDIA_PLAYER = "media_player"

Definition at line 21 of file notify.py.

◆ CONF_TTS_SERVICE

string homeassistant.components.tts.notify.CONF_TTS_SERVICE = "tts_service"

Definition at line 22 of file notify.py.

◆ ENTITY_LEGACY_PROVIDER_GROUP

string homeassistant.components.tts.notify.ENTITY_LEGACY_PROVIDER_GROUP = "entity_or_legacy_provider"

Definition at line 23 of file notify.py.

◆ PLATFORM_SCHEMA

homeassistant.components.tts.notify.PLATFORM_SCHEMA
Initial value:
1 = vol.All(
2  cv.has_at_least_one_key(CONF_TTS_SERVICE, CONF_ENTITY_ID),
3  NOTIFY_PLATFORM_SCHEMA.extend(
4  {
5  vol.Required(CONF_NAME): cv.string,
6  vol.Exclusive(CONF_TTS_SERVICE, ENTITY_LEGACY_PROVIDER_GROUP): cv.entity_id,
7  vol.Exclusive(
8  CONF_ENTITY_ID, ENTITY_LEGACY_PROVIDER_GROUP
9  ): cv.entities_domain(DOMAIN),
10  vol.Required(CONF_MEDIA_PLAYER): cv.entity_id,
11  vol.Optional(ATTR_LANGUAGE): cv.string,
12  }
13  ),
14 )

Definition at line 27 of file notify.py.