homeassistant.components.wake_word Namespace Reference

Namespaces
	const
	models

Classes
class	WakeWordDetectionEntity

Functions
str|None	async_default_entity (HomeAssistant hass)
WakeWordDetectionEntity|None	async_get_wake_word_detection_entity (HomeAssistant hass, str entity_id)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)
None	websocket_entity_info (HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg)

Variables
list	__all__
	_LOGGER = logging.getLogger(__name__)
	CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)
int	TIMEOUT_FETCH_WAKE_WORDS = 10

Detailed Description

Provide functionality to wake word.

Function Documentation

async_default_entity()

str | None homeassistant.components.wake_word.async_default_entity

(

HomeAssistant

hass

)

Return the entity id of the default engine.

Definition at line 45 of file __init__.py.

async_get_wake_word_detection_entity()

WakeWordDetectionEntity | None homeassistant.components.wake_word.async_get_wake_word_detection_entity	(	HomeAssistant	hass,
		str	entity_id
	)

Return wake word entity.

Definition at line 51 of file __init__.py.

async_setup()

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

Set up wake word.

Definition at line 58 of file __init__.py.

async_setup_entry()

bool homeassistant.components.wake_word.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up a config entry.

Definition at line 70 of file __init__.py.

async_unload_entry()

bool homeassistant.components.wake_word.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 75 of file __init__.py.

websocket_entity_info()

None homeassistant.components.wake_word.websocket_entity_info	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict	msg
	)

Get info about wake word entity.

Definition at line 140 of file __init__.py.

Variable Documentation

__all__

list homeassistant.components.wake_word.__all__

private

Initial value:

=  [
    "async_default_entity",
    "async_get_wake_word_detection_entity",
    "DetectionResult",
    "DOMAIN",
    "WakeWord",
    "WakeWordDetectionEntity",
]

Definition at line 27 of file __init__.py.

_LOGGER

homeassistant.components.wake_word._LOGGER = logging.getLogger(__name__)

private

Definition at line 36 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.wake_word.CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)

Definition at line 38 of file __init__.py.

TIMEOUT_FETCH_WAKE_WORDS

int homeassistant.components.wake_word.TIMEOUT_FETCH_WAKE_WORDS = 10

Definition at line 41 of file __init__.py.