homeassistant.components.alexa.capabilities.AlexaModeController Class Reference

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

Collaboration diagram for homeassistant.components.alexa.capabilities.AlexaModeController:

Public Member Functions
None	__init__ (self, State entity, str instance, bool non_controllable=False)
dict[str, list[dict[str, Any]]]	capability_resources (self)
dict[str, Any]|None	configuration (self)
Any	get_property (self, str name)
str	name (self)
bool	properties_proactively_reported (self)
bool	properties_retrievable (self)
list[dict[str, str]]	properties_supported (self)
dict[str, Any]|None	semantics (self)
Public Member Functions inherited from homeassistant.components.alexa.capabilities.AlexaCapability
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, Any]|None	configurations (self)
list[dict[str, str]]|None	inputs (self)
bool|None	properties_non_controllable (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
	instance
Public Attributes inherited from homeassistant.components.alexa.capabilities.AlexaCapability
	entity
	instance

Static Public Attributes
dictionary	supported_locales

Private Attributes
	_resource
	_semantics

Detailed Description

Implements Alexa.ModeController.

The instance property must be unique across ModeController, RangeController,
ToggleController within the same device.

The instance property should be a concatenated string of device domain period
and single word. e.g. fan.speed & fan.direction.

The instance property must not contain words from other instance property
strings within the same device. e.g. Instance property cover.position &
cover.tilt_position will cause the Alexa.Discovery directive to fail.

An instance property string value may be reused for different devices.

https://developer.amazon.com/docs/device-apis/alexa-modecontroller.html

Definition at line 1355 of file capabilities.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.alexa.capabilities.AlexaModeController.__init__	(		self,
		State	entity,
		str	instance,
		bool	non_controllable = False
	)

Initialize the entity.

Definition at line 1391 of file capabilities.py.

Member Function Documentation

capability_resources()

dict[str, list[dict[str, Any]]] homeassistant.components.alexa.capabilities.AlexaModeController.capability_resources

(

self

)

Return capabilityResources object.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 1493 of file capabilities.py.

configuration()

dict[str, Any] | None homeassistant.components.alexa.capabilities.AlexaModeController.configuration

(

self

)

Return configuration with modeResources.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 1486 of file capabilities.py.

get_property()

Any homeassistant.components.alexa.capabilities.AlexaModeController.get_property	(		self,
		str	name
	)

Read and return a property.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 1415 of file capabilities.py.

name()

str homeassistant.components.alexa.capabilities.AlexaModeController.name

(

self

)

Return the Alexa API name of this interface.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 1399 of file capabilities.py.

properties_proactively_reported()

bool homeassistant.components.alexa.capabilities.AlexaModeController.properties_proactively_reported

(

self

)

Return True if properties asynchronously reported.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 1407 of file capabilities.py.

properties_retrievable()

bool homeassistant.components.alexa.capabilities.AlexaModeController.properties_retrievable

(

self

)

Return True if properties can be retrieved.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 1411 of file capabilities.py.

properties_supported()

list[dict[str, str]] homeassistant.components.alexa.capabilities.AlexaModeController.properties_supported

(

self

)

Return what properties this entity supports.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 1403 of file capabilities.py.

semantics()

dict[str, Any] | None homeassistant.components.alexa.capabilities.AlexaModeController.semantics

(

self

)

Build and return semantics object.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 1626 of file capabilities.py.

Member Data Documentation

_resource

homeassistant.components.alexa.capabilities.AlexaModeController._resource

private

Definition at line 1396 of file capabilities.py.

_semantics

homeassistant.components.alexa.capabilities.AlexaModeController._semantics

private

Definition at line 1397 of file capabilities.py.

instance

homeassistant.components.alexa.capabilities.AlexaModeController.instance

Definition at line 1421 of file capabilities.py.

supported_locales

dictionary homeassistant.components.alexa.capabilities.AlexaModeController.supported_locales

static

Initial value:

=  {
        "de-DE",
        "en-AU",
        "en-CA",
        "en-GB",
        "en-IN",
        "en-US",
        "es-ES",
        "es-MX",
        "es-US",
        "fr-CA",
        "fr-FR",
        "hi-IN",
        "it-IT",
        "ja-JP",
        "pt-BR",
    }

Definition at line 1373 of file capabilities.py.

---

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

• core/homeassistant/components/alexa/capabilities.py