homeassistant.components.homeassistant.scene.HomeAssistantScene Class Reference

Inheritance diagram for homeassistant.components.homeassistant.scene.HomeAssistantScene:

Collaboration diagram for homeassistant.components.homeassistant.scene.HomeAssistantScene:

Public Member Functions
None	__init__ (self, HomeAssistant hass, SceneConfig scene_config, bool from_service=False)
None	async_activate (self, **Any kwargs)
Mapping[str, Any]	extra_state_attributes (self)
str|None	icon (self)
str	name (self)
str|None	unique_id (self)

Public Attributes
	from_service
	hass
	scene_config

Detailed Description

A scene is a group of entities and the states we want them to be.

Definition at line 330 of file scene.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.homeassistant.scene.HomeAssistantScene.__init__	(		self,
		HomeAssistant	hass,
		SceneConfig	scene_config,
		bool	from_service = False
	)

Initialize the scene.

Definition at line 333 of file scene.py.

Member Function Documentation

async_activate()

None homeassistant.components.homeassistant.scene.HomeAssistantScene.async_activate	(		self,
		**Any	kwargs
	)

Activate scene. Try to get entities into requested state.

Definition at line 364 of file scene.py.

extra_state_attributes()

Mapping[str, Any] homeassistant.components.homeassistant.scene.HomeAssistantScene.extra_state_attributes

(

self

)

Return the scene state attributes.

Definition at line 357 of file scene.py.

icon()

str | None homeassistant.components.homeassistant.scene.HomeAssistantScene.icon

(

self

)

Return the icon of the scene.

Definition at line 347 of file scene.py.

name()

str homeassistant.components.homeassistant.scene.HomeAssistantScene.name

(

self

)

Return the name of the scene.

Definition at line 342 of file scene.py.

unique_id()

str | None homeassistant.components.homeassistant.scene.HomeAssistantScene.unique_id

(

self

)

Return unique ID.

Definition at line 352 of file scene.py.

Member Data Documentation

from_service

homeassistant.components.homeassistant.scene.HomeAssistantScene.from_service

Definition at line 339 of file scene.py.

hass

homeassistant.components.homeassistant.scene.HomeAssistantScene.hass

Definition at line 337 of file scene.py.

scene_config

homeassistant.components.homeassistant.scene.HomeAssistantScene.scene_config

Definition at line 338 of file scene.py.

---

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

• core/homeassistant/components/homeassistant/scene.py