Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.yeelight.light.YeelightAmbientLight Class Reference
Inheritance diagram for homeassistant.components.yeelight.light.YeelightAmbientLight:
[legend]
Collaboration diagram for homeassistant.components.yeelight.light.YeelightAmbientLight:
[legend]

Public Member Functions

def __init__ (self, *args, **kwargs)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.components.yeelight.light.YeelightColorLightSupport
ColorMode color_mode (self)
 
- Public Member Functions inherited from homeassistant.components.yeelight.light.YeelightBaseLight
None __init__ (self, YeelightDevice device, ConfigEntry entry, dict[str, dict[str, Any]]|None custom_effects=None)
 
None async_added_to_hass (self)
 
None async_set_brightness (self, brightness, duration)
 
None async_set_colortemp (self, colortemp, duration)
 
None async_set_default (self)
 
None async_set_effect (self, effect)
 
None async_set_flash (self, flash)
 
None async_set_hs (self, hs_color, duration)
 
def async_set_mode (self, str mode)
 
None async_set_music_mode (self, music_mode)
 
None async_set_rgb (self, rgb, duration)
 
def async_set_scene (self, scene_class, *args)
 
def async_start_flow (self, transitions, count=0, action=ACTION_RECOVER)
 
None async_state_changed (self)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
None async_update (self)
 
int brightness (self)
 
dict[str, dict[str, Any]] custom_effects (self)
 
list[strcustom_effects_names (self)
 
YeelightDevice device (self)
 
str|None effect (self)
 
list[streffect_list (self)
 
dict[str, Any] extra_state_attributes (self)
 
tuple[float, float]|None hs_color (self)
 
bool is_on (self)
 
LightType light_type (self)
 
tuple[int, int, int]|None rgb_color (self)
 
- Public Member Functions inherited from homeassistant.components.yeelight.entity.YeelightEntity
None __init__ (self, YeelightDevice device, ConfigEntry entry)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.light.LightEntity
dict[str, Any] capability_attributes (self)
 
int|None color_temp_kelvin (self)
 
int max_color_temp_kelvin (self)
 
int max_mireds (self)
 
int min_color_temp_kelvin (self)
 
int min_mireds (self)
 
tuple[int, int, int, int]|None rgbw_color (self)
 
tuple[int, int, int, int, int]|None rgbww_color (self)
 
dict[str, Any]|None state_attributes (self)
 
set[ColorMode]|set[str]|None supported_color_modes (self)
 
LightEntityFeature supported_features (self)
 
LightEntityFeature supported_features_compat (self)
 
tuple[float, float]|None xy_color (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.yeelight.light.YeelightWithoutNightlightSwitchMixIn
int|None color_temp (self)
 

Static Public Attributes

dictionary PROPERTIES_MAPPING = {"color_mode": "bg_lmode"}
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.light.LightEntity
 int
 
 LightEntityFeature
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 

Private Member Functions

str _brightness_property (self)
 
def _get_property (self, str prop, default=None)
 

Private Attributes

 _attr_max_mireds
 
 _attr_min_mireds
 
 _light_type
 

Static Private Attributes

string _attr_translation_key = "ambilight"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.yeelight.light.YeelightBaseLight
 color_mode
 
 color_temp
 
 config
 
 hs_color
 
 rgb_color
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Representation of a Yeelight ambient light.

Definition at line 1074 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.yeelight.light.YeelightAmbientLight.__init__ (   self,
args,
**  kwargs 
)
Initialize the Yeelight Ambient light.

Definition at line 1081 of file light.py.

Member Function Documentation

◆ _brightness_property()

str homeassistant.components.yeelight.light.YeelightAmbientLight._brightness_property (   self)
private

◆ _get_property()

def homeassistant.components.yeelight.light.YeelightAmbientLight._get_property (   self,
str  prop,
  default = None 
)
private

Reimplemented from homeassistant.components.yeelight.light.YeelightBaseLight.

Definition at line 1099 of file light.py.

◆ unique_id()

str homeassistant.components.yeelight.light.YeelightAmbientLight.unique_id (   self)
Return a unique ID.

Reimplemented from homeassistant.components.yeelight.entity.YeelightEntity.

Definition at line 1090 of file light.py.

Member Data Documentation

◆ _attr_max_mireds

homeassistant.components.yeelight.light.YeelightAmbientLight._attr_max_mireds
private

Definition at line 1085 of file light.py.

◆ _attr_min_mireds

homeassistant.components.yeelight.light.YeelightAmbientLight._attr_min_mireds
private

Definition at line 1084 of file light.py.

◆ _attr_translation_key

string homeassistant.components.yeelight.light.YeelightAmbientLight._attr_translation_key = "ambilight"
staticprivate

Definition at line 1077 of file light.py.

◆ _light_type

homeassistant.components.yeelight.light.YeelightAmbientLight._light_type
private

Definition at line 1087 of file light.py.

◆ PROPERTIES_MAPPING

dictionary homeassistant.components.yeelight.light.YeelightAmbientLight.PROPERTIES_MAPPING = {"color_mode": "bg_lmode"}
static

Definition at line 1079 of file light.py.


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