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

Public Member Functions

def brightness (self)
 
ColorMode color_mode (self)
 
def color_temp (self)
 
def effect (self)
 
def effect_list (self)
 
def hs_color (self)
 
def is_on (self)
 
set[ColorModesupported_color_modes (self)
 
LightEntityFeature supported_features (self)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.homematic.entity.HMDevice
None __init__ (self, dict[str, str] config, EntityDescription|None entity_description=None)
 
def async_added_to_hass (self)
 
def available (self)
 
def extra_state_attributes (self)
 
def name (self)
 
def unique_id (self)
 
def update (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)
 
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]|None rgb_color (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)
 
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)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 

Private Member Functions

def _init_data_struct (self)
 

Private Attributes

 _state
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.homematic.entity.HMDevice
 entity_description
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- 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
 

Detailed Description

Representation of a Homematic light.

Definition at line 43 of file light.py.

Member Function Documentation

◆ _init_data_struct()

def homeassistant.components.homematic.light.HMLight._init_data_struct (   self)
private
Generate a data dict (self._data) from the Homematic metadata.

Reimplemented from homeassistant.components.homematic.entity.HMDevice.

Definition at line 159 of file light.py.

◆ brightness()

def homeassistant.components.homematic.light.HMLight.brightness (   self)
Return the brightness of this light between 0..255.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 47 of file light.py.

◆ color_mode()

ColorMode homeassistant.components.homematic.light.HMLight.color_mode (   self)
Return the color mode of the light.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 63 of file light.py.

◆ color_temp()

def homeassistant.components.homematic.light.HMLight.color_temp (   self)
Return the color temp in mireds [int].

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 102 of file light.py.

◆ effect()

def homeassistant.components.homematic.light.HMLight.effect (   self)
Return the current color change program of the light.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 117 of file light.py.

◆ effect_list()

def homeassistant.components.homematic.light.HMLight.effect_list (   self)
Return the list of supported effects.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 110 of file light.py.

◆ hs_color()

def homeassistant.components.homematic.light.HMLight.hs_color (   self)
Return the hue and saturation color value [float, float].

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 94 of file light.py.

◆ is_on()

def homeassistant.components.homematic.light.HMLight.is_on (   self)
Return true if light is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 55 of file light.py.

◆ supported_color_modes()

set[ColorMode] homeassistant.components.homematic.light.HMLight.supported_color_modes (   self)
Flag supported color modes.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 72 of file light.py.

◆ supported_features()

LightEntityFeature homeassistant.components.homematic.light.HMLight.supported_features (   self)
Flag supported features.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 86 of file light.py.

◆ turn_off()

None homeassistant.components.homematic.light.HMLight.turn_off (   self,
**Any  kwargs 
)
Turn the light off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 152 of file light.py.

◆ turn_on()

None homeassistant.components.homematic.light.HMLight.turn_on (   self,
**Any  kwargs 
)
Turn the light on and/or change color or color effect settings.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 123 of file light.py.

Member Data Documentation

◆ _state

homeassistant.components.homematic.light.HMLight._state
private

Definition at line 50 of file light.py.


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