homeassistant.components.alexa.state_report Namespace Reference

Classes
class	AlexaDirective
class	AlexaResponse

Functions
CALLBACK_TYPE|None	async_enable_proactive_mode (HomeAssistant hass, AbstractConfig smart_home_config)
aiohttp.ClientResponse	async_send_add_or_update_message (HomeAssistant hass, AbstractConfig config, list[str] entity_ids)
None	async_send_changereport_message (HomeAssistant hass, AbstractConfig config, AlexaEntity alexa_entity, list[dict[str, Any]] alexa_properties, *bool invalidate_access_token=True)
aiohttp.ClientResponse	async_send_delete_message (HomeAssistant hass, AbstractConfig config, list[str] entity_ids)
None	async_send_doorbell_event_message (HomeAssistant hass, AbstractConfig config, AlexaEntity alexa_entity)

Variables
	_LOGGER = logging.getLogger(__name__)
int	DEFAULT_TIMEOUT = 10
dictionary	TO_REDACT = {"correlationToken", "token"}

Detailed Description

Alexa state report code.

Function Documentation

async_enable_proactive_mode()

CALLBACK_TYPE | None homeassistant.components.alexa.state_report.async_enable_proactive_mode	(	HomeAssistant	hass,
		AbstractConfig	smart_home_config
	)

Enable the proactive mode.

Proactive mode makes this component report state changes to Alexa.

Definition at line 249 of file state_report.py.

async_send_add_or_update_message()

aiohttp.ClientResponse homeassistant.components.alexa.state_report.async_send_add_or_update_message	(	HomeAssistant	hass,
		AbstractConfig	config,
		list[str]	entity_ids
	)

Send an AddOrUpdateReport message for entities.

https://developer.amazon.com/docs/device-apis/alexa-discovery.html#add-or-update-report

Definition at line 436 of file state_report.py.

async_send_changereport_message()

None homeassistant.components.alexa.state_report.async_send_changereport_message	(	HomeAssistant	hass,
		AbstractConfig	config,
		AlexaEntity	alexa_entity,
		list[dict[str, Any]]	alexa_properties,
		*bool	invalidate_access_token = True
	)

Send a ChangeReport message for an Alexa entity.

https://developer.amazon.com/docs/smarthome/state-reporting-for-a-smart-home-skill.html#report-state-with-changereport-events

Definition at line 348 of file state_report.py.

async_send_delete_message()

aiohttp.ClientResponse homeassistant.components.alexa.state_report.async_send_delete_message	(	HomeAssistant	hass,
		AbstractConfig	config,
		list[str]	entity_ids
	)

Send an DeleteReport message for entities.

https://developer.amazon.com/docs/device-apis/alexa-discovery.html#deletereport-event

Definition at line 477 of file state_report.py.

async_send_doorbell_event_message()

None homeassistant.components.alexa.state_report.async_send_doorbell_event_message	(	HomeAssistant	hass,
		AbstractConfig	config,
		AlexaEntity	alexa_entity
	)

Send a DoorbellPress event message for an Alexa entity.

https://developer.amazon.com/en-US/docs/alexa/device-apis/alexa-doorbelleventsource.html

Definition at line 516 of file state_report.py.

Variable Documentation

_LOGGER

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

private

Definition at line 50 of file state_report.py.

DEFAULT_TIMEOUT

int homeassistant.components.alexa.state_report.DEFAULT_TIMEOUT = 10

Definition at line 51 of file state_report.py.

TO_REDACT

dictionary homeassistant.components.alexa.state_report.TO_REDACT = {"correlationToken", "token"}

Definition at line 53 of file state_report.py.