Inheritance diagram for homeassistant.components.alexa.capabilities.AlexaCapability:

[legend]

Public Member Functions
None	__init__ (self, State entity, str\|None instance=None, bool\|None non_controllable_properties=None)

list[dict[str, Any]]\|None	camera_stream_configurations (self)

bool\|None	capability_proactively_reported (self)

dict[str, list[dict[str, Any]]]	capability_resources (self)

dict[str, Any]\|None	configuration (self)

dict[str, Any]\|None	configurations (self)

dict[str, Any]	get_property (self, str name)

list[dict[str, str]]\|None	inputs (self)

str	name (self)

bool\|None	properties_non_controllable (self)

bool	properties_proactively_reported (self)

bool	properties_retrievable (self)

list[dict]	properties_supported (self)

dict[str, Any]\|None	semantics (self)

dict[str, Any]	serialize_discovery (self)

Generator[dict[str, Any]]	serialize_properties (self)

list[str]	supported_operations (self)

bool\|None	supports_deactivation (self)

Public Attributes
	entity

	instance

Private Attributes
	_non_controllable_properties

Detailed Description

Base class for Alexa capability interfaces.

The Smart Home Skills API defines a number of "capability interfaces",
roughly analogous to domains in Home Assistant. The supported interfaces
describe what actions can be performed on a particular device.

https://developer.amazon.com/docs/device-apis/message-guide.html

Definition at line 104 of file capabilities.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.alexa.capabilities.AlexaCapability.__init__	(		self,
		State	entity,
		str \| None	instance = `None`,
		bool \| None	non_controllable_properties = `None`
	)

Initialize an Alexa capability.

Definition at line 118 of file capabilities.py.

Member Function Documentation

◆ camera_stream_configurations()

list[dict[str, Any]] | None homeassistant.components.alexa.capabilities.AlexaCapability.camera_stream_configurations ( self )

Applicable only to CameraStreamController.

Reimplemented in homeassistant.components.alexa.capabilities.AlexaCameraStreamController.

Definition at line 203 of file capabilities.py.

◆ capability_proactively_reported()

bool | None homeassistant.components.alexa.capabilities.AlexaCapability.capability_proactively_reported ( self )

Return True if the capability is proactively reported.

Set properties_proactively_reported() for proactively reported properties.
Applicable to DoorbellEventSource.

Reimplemented in homeassistant.components.alexa.capabilities.AlexaDoorbellEventSource.

Definition at line 162 of file capabilities.py.

◆ capability_resources()

dict[str, list[dict[str, Any]]] homeassistant.components.alexa.capabilities.AlexaCapability.capability_resources ( self )

Return the capability object.

Applicable to ToggleController, RangeController, and ModeController interfaces.

Reimplemented in homeassistant.components.alexa.capabilities.AlexaToggleController, homeassistant.components.alexa.capabilities.AlexaRangeController, and homeassistant.components.alexa.capabilities.AlexaModeController.

Definition at line 169 of file capabilities.py.

◆ configuration()

dict[str, Any] | None homeassistant.components.alexa.capabilities.AlexaCapability.configuration ( self )

Return the configuration object.

Applicable to the ThermostatController, SecurityControlPanel, ModeController,
RangeController, and EventDetectionSensor.

Reimplemented in homeassistant.components.alexa.capabilities.AlexaTimeHoldController, homeassistant.components.alexa.capabilities.AlexaEventDetectionSensor, homeassistant.components.alexa.capabilities.AlexaRangeController, homeassistant.components.alexa.capabilities.AlexaModeController, homeassistant.components.alexa.capabilities.AlexaSecurityPanelController, and homeassistant.components.alexa.capabilities.AlexaThermostatController.

Definition at line 176 of file capabilities.py.

◆ configurations()

dict[str, Any] | None homeassistant.components.alexa.capabilities.AlexaCapability.configurations ( self )

Return the configurations object.

The plural configurations object is different that the singular configuration
object. Applicable to EqualizerController interface.

Reimplemented in homeassistant.components.alexa.capabilities.AlexaEqualizerController.

Definition at line 183 of file capabilities.py.

◆ get_property()

dict[str, Any] homeassistant.components.alexa.capabilities.AlexaCapability.get_property	(		self,
		str	name
	)

Read and return a property.

Return value should be a dict, or raise UnsupportedProperty.

Properties can also have a timeOfSample and uncertaintyInMilliseconds,
but returning those metadata is not yet implemented.

Definition at line 149 of file capabilities.py.

◆ inputs()

list[dict[str, str]] | None homeassistant.components.alexa.capabilities.AlexaCapability.inputs ( self )

Applicable only to media players.

Reimplemented in homeassistant.components.alexa.capabilities.AlexaInputController.

Definition at line 190 of file capabilities.py.

◆ name()

str homeassistant.components.alexa.capabilities.AlexaCapability.name ( self )

Return the Alexa API name of this interface.

Definition at line 129 of file capabilities.py.

◆ properties_non_controllable()

bool | None homeassistant.components.alexa.capabilities.AlexaCapability.properties_non_controllable ( self )

Return True if non controllable.

Definition at line 145 of file capabilities.py.

◆ properties_proactively_reported()

bool homeassistant.components.alexa.capabilities.AlexaCapability.properties_proactively_reported ( self )

Return True if properties asynchronously reported.

Definition at line 137 of file capabilities.py.

◆ properties_retrievable()

bool homeassistant.components.alexa.capabilities.AlexaCapability.properties_retrievable ( self )

Return True if properties can be retrieved.

Definition at line 141 of file capabilities.py.

◆ properties_supported()

list[dict] homeassistant.components.alexa.capabilities.AlexaCapability.properties_supported ( self )

Return what properties this entity supports.

Definition at line 133 of file capabilities.py.

◆ semantics()

dict[str, Any] | None homeassistant.components.alexa.capabilities.AlexaCapability.semantics ( self )

Return the semantics object.

Applicable to ToggleController, RangeController, and ModeController interfaces.

Reimplemented in homeassistant.components.alexa.capabilities.AlexaRangeController, and homeassistant.components.alexa.capabilities.AlexaModeController.

Definition at line 193 of file capabilities.py.

◆ serialize_discovery()

dict[str, Any] homeassistant.components.alexa.capabilities.AlexaCapability.serialize_discovery ( self )

Serialize according to the Discovery API.

Definition at line 206 of file capabilities.py.

◆ serialize_properties()

Generator[dict[str, Any]] homeassistant.components.alexa.capabilities.AlexaCapability.serialize_properties ( self )

Return properties serialized for an API response.

Definition at line 258 of file capabilities.py.

◆ supported_operations()

list[str] homeassistant.components.alexa.capabilities.AlexaCapability.supported_operations ( self )

Return the supportedOperations object.

Reimplemented in homeassistant.components.alexa.capabilities.AlexaPlaybackController.

Definition at line 199 of file capabilities.py.

◆ supports_deactivation()

bool | None homeassistant.components.alexa.capabilities.AlexaCapability.supports_deactivation ( self )

Applicable only to scenes.

Reimplemented in homeassistant.components.alexa.capabilities.AlexaSceneController.

Definition at line 159 of file capabilities.py.

Member Data Documentation

◆ _non_controllable_properties

homeassistant.components.alexa.capabilities.AlexaCapability._non_controllable_properties

private

Definition at line 127 of file capabilities.py.

◆ entity

homeassistant.components.alexa.capabilities.AlexaCapability.entity

Definition at line 125 of file capabilities.py.

◆ instance

homeassistant.components.alexa.capabilities.AlexaCapability.instance

Definition at line 126 of file capabilities.py.

The documentation for this class was generated from the following file:

core/homeassistant/components/alexa/capabilities.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Attributes