Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.light.Profiles Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass)
 
None apply_default (self, str entity_id, bool|None state_on, dict[str, Any] params)
 
None apply_profile (self, str name, dict[str, Any] params)
 
None async_initialize (self)
 

Public Attributes

 data
 
 hass
 

Private Member Functions

dict[str, Profile_load_profile_data (self)
 

Detailed Description

Representation of available color profiles.

The light profiles feature is in a frozen development state
until otherwise decided in an architecture discussion.

Definition at line 746 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.light.Profiles.__init__ (   self,
HomeAssistant  hass 
)
Initialize profiles.

Definition at line 753 of file __init__.py.

Member Function Documentation

◆ _load_profile_data()

dict[str, Profile] homeassistant.components.light.Profiles._load_profile_data (   self)
private
Load built-in profiles and custom profiles.

Definition at line 758 of file __init__.py.

◆ apply_default()

None homeassistant.components.light.Profiles.apply_default (   self,
str  entity_id,
bool | None  state_on,
dict[str, Any]   params 
)
Return the default profile for the given light.

Definition at line 795 of file __init__.py.

◆ apply_profile()

None homeassistant.components.light.Profiles.apply_profile (   self,
str  name,
dict[str, Any]  params 
)
Apply a profile.

Definition at line 808 of file __init__.py.

◆ async_initialize()

None homeassistant.components.light.Profiles.async_initialize (   self)
Load and cache profiles.

Definition at line 790 of file __init__.py.

Member Data Documentation

◆ data

homeassistant.components.light.Profiles.data

Definition at line 792 of file __init__.py.

◆ hass

homeassistant.components.light.Profiles.hass

Definition at line 755 of file __init__.py.


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