Inheritance diagram for homeassistant.components.alexa.entities.AlexaEntity:

[legend]

Public Member Functions
None	__init__ (self, HomeAssistant hass, AbstractConfig config, State entity)

str	alexa_id (self)

list[str]\|None	default_display_categories (self)

str	description (self)

list[str]\|None	display_categories (self)

str	entity_id (self)

str	friendly_name (self)

Iterable[AlexaCapability]	interfaces (self)

dict[str, Any]	serialize_discovery (self)

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

Public Attributes
	config

	entity

	entity_conf

	hass

Detailed Description

An adaptation of an entity, expressed in Alexa's terms.

The API handlers should manipulate entities only through this interface.

Definition at line 267 of file entities.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.alexa.entities.AlexaEntity.__init__	(		self,
		HomeAssistant	hass,
		AbstractConfig	config,
		State	entity
	)

Initialize Alexa Entity.

Definition at line 273 of file entities.py.

Member Function Documentation

◆ alexa_id()

str homeassistant.components.alexa.entities.AlexaEntity.alexa_id ( self )

Return the Alexa API entity id.

Definition at line 299 of file entities.py.

◆ default_display_categories()

list[str] | None homeassistant.components.alexa.entities.AlexaEntity.default_display_categories ( self )

Return a list of default display categories.

This can be overridden by the user in the Home Assistant configuration.

See also DisplayCategory.

Definition at line 310 of file entities.py.

◆ description()

str homeassistant.components.alexa.entities.AlexaEntity.description ( self )

Return the Alexa API description.

Reimplemented in homeassistant.components.alexa.entities.SceneCapabilities.

Definition at line 294 of file entities.py.

◆ display_categories()

list[str] | None homeassistant.components.alexa.entities.AlexaEntity.display_categories ( self )

Return a list of display categories.

Definition at line 303 of file entities.py.

◆ entity_id()

str homeassistant.components.alexa.entities.AlexaEntity.entity_id ( self )

Return the Entity ID.

Definition at line 283 of file entities.py.

◆ friendly_name()

str homeassistant.components.alexa.entities.AlexaEntity.friendly_name ( self )

Return the Alexa API friendly name.

Definition at line 287 of file entities.py.

◆ interfaces()

Iterable[AlexaCapability] homeassistant.components.alexa.entities.AlexaEntity.interfaces ( self )

Return a list of supported interfaces.

Used for discovery. The list should contain AlexaInterface instances.
If the list is empty, this entity will not be discovered.

Definition at line 319 of file entities.py.

◆ serialize_discovery()

dict[str, Any] homeassistant.components.alexa.entities.AlexaEntity.serialize_discovery ( self )

Serialize the entity for discovery.

Definition at line 335 of file entities.py.

◆ serialize_properties()

Generator[dict[str, Any]] homeassistant.components.alexa.entities.AlexaEntity.serialize_properties ( self )

Yield each supported property in API format.

Definition at line 327 of file entities.py.

Member Data Documentation

◆ config

homeassistant.components.alexa.entities.AlexaEntity.config

Definition at line 278 of file entities.py.

◆ entity

homeassistant.components.alexa.entities.AlexaEntity.entity

Definition at line 279 of file entities.py.

◆ entity_conf

homeassistant.components.alexa.entities.AlexaEntity.entity_conf

Definition at line 280 of file entities.py.

◆ hass

homeassistant.components.alexa.entities.AlexaEntity.hass

Definition at line 277 of file entities.py.

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

core/homeassistant/components/alexa/entities.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes