Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.alexa Namespace Reference

Namespaces

 auth
 
 capabilities
 
 config
 
 const
 
 diagnostics
 
 entities
 
 errors
 
 flash_briefings
 
 handlers
 
 intent
 
 logbook
 
 resources
 
 smart_home
 
 state_report
 

Variables

 ALEXA_ENTITY_SCHEMA
 
string CONF_FLASH_BRIEFINGS = "flash_briefings"
 
string CONF_SMART_HOME = "smart_home"
 
string DEFAULT_LOCALE = "en-US"
 
 SMART_HOME_SCHEMA
 
list VALID_ENDPOINTS
 

Detailed Description

Support for Alexa skill service end point.

Variable Documentation

◆ ALEXA_ENTITY_SCHEMA

homeassistant.components.alexa.ALEXA_ENTITY_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_DESCRIPTION): cv.string,
4  vol.Optional(CONF_DISPLAY_CATEGORIES): cv.string,
5  vol.Optional(CONF_NAME): cv.string,
6  }
7 )

Definition at line 49 of file __init__.py.

◆ CONF_FLASH_BRIEFINGS

string homeassistant.components.alexa.CONF_FLASH_BRIEFINGS = "flash_briefings"

Definition at line 36 of file __init__.py.

◆ CONF_SMART_HOME

string homeassistant.components.alexa.CONF_SMART_HOME = "smart_home"

Definition at line 37 of file __init__.py.

◆ DEFAULT_LOCALE

string homeassistant.components.alexa.DEFAULT_LOCALE = "en-US"

Definition at line 38 of file __init__.py.

◆ SMART_HOME_SCHEMA

homeassistant.components.alexa.SMART_HOME_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_ENDPOINT): vol.All(vol.Lower, vol.In(VALID_ENDPOINTS)),
4  vol.Optional(CONF_CLIENT_ID): cv.string,
5  vol.Optional(CONF_CLIENT_SECRET): cv.string,
6  vol.Optional(CONF_LOCALE, default=DEFAULT_LOCALE): vol.In(
7  CONF_SUPPORTED_LOCALES
8  ),
9  vol.Optional(CONF_FILTER, default={}): entityfilter.FILTER_SCHEMA,
10  vol.Optional(CONF_ENTITY_CONFIG): {cv.entity_id: ALEXA_ENTITY_SCHEMA},
11  }
12 )

Definition at line 57 of file __init__.py.

◆ VALID_ENDPOINTS

list homeassistant.components.alexa.VALID_ENDPOINTS
Initial value:
1 = [
2  "https://api.amazonalexa.com/v3/events",
3  "https://api.eu.amazonalexa.com/v3/events",
4  "https://api.fe.amazonalexa.com/v3/events",
5 ]

Definition at line 42 of file __init__.py.