homeassistant.components.alexa.smart_home Namespace Reference

Classes
class	AlexaConfig
class	SmartHomeView

Functions
dict[str, Any]	async_handle_message (HomeAssistant hass, AbstractConfig config, dict[str, Any] request, Context|None context=None, bool enabled=True)
None	async_setup (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
string	SMART_HOME_HTTP_ENDPOINT = "/api/alexa/smart_home"

Detailed Description

Support for alexa Smart Home Skill API.

Function Documentation

async_handle_message()

dict[str, Any] homeassistant.components.alexa.smart_home.async_handle_message	(	HomeAssistant	hass,
		AbstractConfig	config,
		dict[str, Any]	request,
		Context | None	context = None,
		bool	enabled = True
	)

Handle incoming API messages.

If enabled is False, the response to all messages will be a
BRIDGE_UNREACHABLE error. This can be used if the API has been disabled in
configuration.

Definition at line 175 of file smart_home.py.

async_setup()

None homeassistant.components.alexa.smart_home.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Activate Smart Home functionality of Alexa component.

This is optional, triggered by having a `smart_home:` sub-section in the
alexa configuration.

Even if that's disabled, the functionality in this module may still be used
by the cloud component which will call async_handle_message directly.

Definition at line 119 of file smart_home.py.

Variable Documentation

_LOGGER

homeassistant.components.alexa.smart_home._LOGGER = logging.getLogger(__name__)

private

Definition at line 37 of file smart_home.py.

SMART_HOME_HTTP_ENDPOINT

string homeassistant.components.alexa.smart_home.SMART_HOME_HTTP_ENDPOINT = "/api/alexa/smart_home"

Definition at line 38 of file smart_home.py.