homeassistant.components.clicksend_tts.notify Namespace Reference

Classes
class	ClicksendNotificationService

Functions
def	_authenticate (config)
ClicksendNotificationService|None	get_service (HomeAssistant hass, ConfigType config, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	BASE_API_URL = "https://rest.clicksend.com/v3"
string	CONF_LANGUAGE = "language"
string	CONF_VOICE = "voice"
string	DEFAULT_LANGUAGE = "en-us"
string	DEFAULT_NAME = "clicksend_tts"
string	DEFAULT_VOICE = FEMALE_VOICE
string	FEMALE_VOICE = "female"
dictionary	HEADERS = {"Content-Type": CONTENT_TYPE_JSON}
string	MALE_VOICE = "male"
	PLATFORM_SCHEMA
int	TIMEOUT = 5

Detailed Description

clicksend_tts platform for notify component.

Function Documentation

_authenticate()

def homeassistant.components.clicksend_tts.notify._authenticate (   config )

private

Authenticate with ClickSend.

Definition at line 116 of file notify.py.

get_service()

ClicksendNotificationService | None homeassistant.components.clicksend_tts.notify.get_service	(	HomeAssistant	hass,
		ConfigType	config,
		DiscoveryInfoType | None	discovery_info = None
	)

Get the ClickSend notification service.

Definition at line 60 of file notify.py.

Variable Documentation

_LOGGER

homeassistant.components.clicksend_tts.notify._LOGGER = logging.getLogger(__name__)

private

Definition at line 27 of file notify.py.

BASE_API_URL

string homeassistant.components.clicksend_tts.notify.BASE_API_URL = "https://rest.clicksend.com/v3"

Definition at line 29 of file notify.py.

CONF_LANGUAGE

string homeassistant.components.clicksend_tts.notify.CONF_LANGUAGE = "language"

Definition at line 33 of file notify.py.

CONF_VOICE

string homeassistant.components.clicksend_tts.notify.CONF_VOICE = "voice"

Definition at line 34 of file notify.py.

DEFAULT_LANGUAGE

string homeassistant.components.clicksend_tts.notify.DEFAULT_LANGUAGE = "en-us"

Definition at line 40 of file notify.py.

DEFAULT_NAME

string homeassistant.components.clicksend_tts.notify.DEFAULT_NAME = "clicksend_tts"

Definition at line 39 of file notify.py.

DEFAULT_VOICE

string homeassistant.components.clicksend_tts.notify.DEFAULT_VOICE = FEMALE_VOICE

Definition at line 41 of file notify.py.

FEMALE_VOICE

string homeassistant.components.clicksend_tts.notify.FEMALE_VOICE = "female"

Definition at line 37 of file notify.py.

HEADERS

dictionary homeassistant.components.clicksend_tts.notify.HEADERS = {"Content-Type": CONTENT_TYPE_JSON}

Definition at line 31 of file notify.py.

MALE_VOICE

string homeassistant.components.clicksend_tts.notify.MALE_VOICE = "male"

Definition at line 36 of file notify.py.

PLATFORM_SCHEMA

homeassistant.components.clicksend_tts.notify.PLATFORM_SCHEMA

Initial value:

=  NOTIFY_PLATFORM_SCHEMA.extend(
    {
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Required(CONF_USERNAME): cv.string,
        vol.Required(CONF_API_KEY): cv.string,
        vol.Required(CONF_RECIPIENT): vol.All(
            cv.string, vol.Match(r"^\+?[1-9]\d{1,14}$")
        ),
        vol.Optional(CONF_LANGUAGE, default=DEFAULT_LANGUAGE): cv.string,
        vol.Optional(CONF_VOICE, default=DEFAULT_VOICE): vol.In(
            [MALE_VOICE, FEMALE_VOICE]
        ),
    }
)

Definition at line 44 of file notify.py.

TIMEOUT

int homeassistant.components.clicksend_tts.notify.TIMEOUT = 5

Definition at line 42 of file notify.py.