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

Public Member Functions

None __init__ (self, list[str] labels, float min_value, float max_value, float precision, str|None unit=None)
 
None add_preset (self, float value, list[str] labels)
 
dict[str, Any] serialize_configuration (self)
 
- Public Member Functions inherited from homeassistant.components.alexa.resources.AlexaCapabilityResource
None __init__ (self, list[str] labels)
 
dict[str, list[dict[str, Any]]] serialize_capability_resources (self)
 
dict[str, list[dict[str, Any]]] serialize_labels (self, list[str] resources)
 

Private Attributes

 _maximum_value
 
 _minimum_value
 
 _precision
 
 _unit_of_measure
 

Detailed Description

Implements Alexa PresetResources.

Use presetResources with RangeController to provide a set of
friendlyNames for each RangeController preset.

https://developer.amazon.com/docs/device-apis/resources-and-assets.html#presetresources

Definition at line 282 of file resources.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.alexa.resources.AlexaPresetResource.__init__ (   self,
list[str]  labels,
float  min_value,
float  max_value,
float  precision,
str | None   unit = None 
)
Initialize an Alexa presetResource.

Definition at line 291 of file resources.py.

Member Function Documentation

◆ add_preset()

None homeassistant.components.alexa.resources.AlexaPresetResource.add_preset (   self,
float  value,
list[str]  labels 
)
Add preset to configuration presets array.

Definition at line 309 of file resources.py.

◆ serialize_configuration()

dict[str, Any] homeassistant.components.alexa.resources.AlexaPresetResource.serialize_configuration (   self)
Return serialized configuration for an API response.

Returns configuration for PresetResources friendlyNames serialized.

Reimplemented from homeassistant.components.alexa.resources.AlexaCapabilityResource.

Definition at line 313 of file resources.py.

Member Data Documentation

◆ _maximum_value

homeassistant.components.alexa.resources.AlexaPresetResource._maximum_value
private

Definition at line 303 of file resources.py.

◆ _minimum_value

homeassistant.components.alexa.resources.AlexaPresetResource._minimum_value
private

Definition at line 302 of file resources.py.

◆ _precision

homeassistant.components.alexa.resources.AlexaPresetResource._precision
private

Definition at line 304 of file resources.py.

◆ _unit_of_measure

homeassistant.components.alexa.resources.AlexaPresetResource._unit_of_measure
private

Definition at line 305 of file resources.py.


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