Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.alexa.capabilities.AlexaThermostatController Class Reference
Inheritance diagram for homeassistant.components.alexa.capabilities.AlexaThermostatController:
[legend]
Collaboration diagram for homeassistant.components.alexa.capabilities.AlexaThermostatController:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, State entity)
 
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)
 
- 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, list[dict[str, Any]]] capability_resources (self)
 
dict[str, Any]|None configurations (self)
 
list[dict[str, str]]|None inputs (self)
 
bool|None properties_non_controllable (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

 hass
 
- Public Attributes inherited from homeassistant.components.alexa.capabilities.AlexaCapability
 entity
 
 instance
 

Static Public Attributes

dictionary supported_locales
 

Detailed Description

Implements Alexa.ThermostatController.

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

Definition at line 1085 of file capabilities.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.alexa.capabilities.AlexaThermostatController.__init__ (   self,
HomeAssistant  hass,
State  entity 
)
Initialize the entity.

Definition at line 1110 of file capabilities.py.

Member Function Documentation

◆ configuration()

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

Translates climate HVAC_MODES and PRESETS to supported Alexa
ThermostatMode Values.

ThermostatMode Value must be AUTO, COOL, HEAT, ECO, OFF, or CUSTOM.
Water heater devices do not return thermostat modes.

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

Definition at line 1194 of file capabilities.py.

◆ get_property()

Any homeassistant.components.alexa.capabilities.AlexaThermostatController.get_property (   self,
str  name 
)
Read and return a property.

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

Definition at line 1144 of file capabilities.py.

◆ name()

str homeassistant.components.alexa.capabilities.AlexaThermostatController.name (   self)
Return the Alexa API name of this interface.

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

Definition at line 1115 of file capabilities.py.

◆ properties_proactively_reported()

bool homeassistant.components.alexa.capabilities.AlexaThermostatController.properties_proactively_reported (   self)
Return True if properties asynchronously reported.

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

Definition at line 1136 of file capabilities.py.

◆ properties_retrievable()

bool homeassistant.components.alexa.capabilities.AlexaThermostatController.properties_retrievable (   self)
Return True if properties can be retrieved.

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

Definition at line 1140 of file capabilities.py.

◆ properties_supported()

list[dict[str, str]] homeassistant.components.alexa.capabilities.AlexaThermostatController.properties_supported (   self)
Return what properties this entity supports.

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

Definition at line 1119 of file capabilities.py.

Member Data Documentation

◆ hass

homeassistant.components.alexa.capabilities.AlexaThermostatController.hass

Definition at line 1113 of file capabilities.py.

◆ supported_locales

dictionary homeassistant.components.alexa.capabilities.AlexaThermostatController.supported_locales
static
Initial value:
= {
"ar-SA",
"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 1091 of file capabilities.py.


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