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

Public Member Functions

None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
None send_device_command (self, Any command)
 
- Public Member Functions inherited from homeassistant.components.matter.entity.MatterEntity
None __init__ (self, MatterClient matter_client, MatterEndpoint endpoint, MatterEntityInfo entity_info)
 
None async_added_to_hass (self)
 
str get_matter_attribute_path (self, type[ClusterAttributeDescriptor] attribute)
 
Any get_matter_attribute_value (self, type[ClusterAttributeDescriptor] attribute, bool null_as_none=True)
 
str|UndefinedType|None name (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)
 
bool available (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)
 
Mapping[str, Any]|None extra_state_attributes (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 unique_id (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
int|None brightness (self)
 
dict[str, Any] capability_attributes (self)
 
ColorMode|str|None color_mode (self)
 
int|None color_temp (self)
 
int|None color_temp_kelvin (self)
 
str|None effect (self)
 
list[str]|None effect_list (self)
 
tuple[float, float]|None hs_color (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)
 
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)
 
bool|None is_on (self)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 

Private Member Functions

None _check_transition_blocklist (self)
 
int _get_brightness (self)
 
ColorMode _get_color_mode (self)
 
int _get_color_temperature (self)
 
tuple[float, float] _get_hs_color (self)
 
tuple[float, float] _get_xy_color (self)
 
None _set_brightness (self, int brightness, float transition=0.0)
 
None _set_color_temp (self, int color_temp, float transition=0.0)
 
None _set_hs_color (self, tuple[float, float] hs_color, float transition=0.0)
 
None _set_xy_color (self, tuple[float, float] xy_color, float transition=0.0)
 
None _update_from_device (self)
 

Private Attributes

 _attr_brightness
 
 _attr_color_mode
 
 _attr_color_temp
 
 _attr_hs_color
 
 _attr_is_on
 
 _attr_max_mireds
 
 _attr_min_mireds
 
 _attr_supported_color_modes
 
 _attr_xy_color
 
 _supports_brightness
 
 _supports_color
 
 _supports_color_temperature
 
 _transitions_disabled
 

Static Private Attributes

string _platform_translation_key = "light"
 
bool _supports_brightness = False
 
bool _supports_color = False
 
bool _supports_color_temperature = False
 
bool _transitions_disabled = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.matter.entity.MatterEntity
 entity_description
 
 matter_client
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.matter.entity.MatterEntity
 None
 
- 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 Matter light.

Definition at line 84 of file light.py.

Member Function Documentation

◆ _check_transition_blocklist()

None homeassistant.components.matter.light.MatterLight._check_transition_blocklist (   self)
private
Check if this device is reported to have non working transitions.

Definition at line 424 of file light.py.

◆ _get_brightness()

int homeassistant.components.matter.light.MatterLight._get_brightness (   self)
private
Get brightness from matter.

Definition at line 235 of file light.py.

◆ _get_color_mode()

ColorMode homeassistant.components.matter.light.MatterLight._get_color_mode (   self)
private
Get color mode from matter.

Definition at line 257 of file light.py.

◆ _get_color_temperature()

int homeassistant.components.matter.light.MatterLight._get_color_temperature (   self)
private
Get color temperature from matter.

Definition at line 218 of file light.py.

◆ _get_hs_color()

tuple[float, float] homeassistant.components.matter.light.MatterLight._get_hs_color (   self)
private
Get hs color from matter.

Definition at line 194 of file light.py.

◆ _get_xy_color()

tuple[float, float] homeassistant.components.matter.light.MatterLight._get_xy_color (   self)
private
Get xy color from matter.

Definition at line 172 of file light.py.

◆ _set_brightness()

None homeassistant.components.matter.light.MatterLight._set_brightness (   self,
int  brightness,
float   transition = 0.0 
)
private
Set brightness.

Definition at line 149 of file light.py.

◆ _set_color_temp()

None homeassistant.components.matter.light.MatterLight._set_color_temp (   self,
int  color_temp,
float   transition = 0.0 
)
private
Set color temperature.

Definition at line 134 of file light.py.

◆ _set_hs_color()

None homeassistant.components.matter.light.MatterLight._set_hs_color (   self,
tuple[float, float]  hs_color,
float   transition = 0.0 
)
private
Set hs color.

Definition at line 114 of file light.py.

◆ _set_xy_color()

None homeassistant.components.matter.light.MatterLight._set_xy_color (   self,
tuple[float, float]  xy_color,
float   transition = 0.0 
)
private
Set xy color.

Definition at line 94 of file light.py.

◆ _update_from_device()

None homeassistant.components.matter.light.MatterLight._update_from_device (   self)
private
Update from device.

Reimplemented from homeassistant.components.matter.entity.MatterEntity.

Definition at line 321 of file light.py.

◆ async_turn_off()

None homeassistant.components.matter.light.MatterLight.async_turn_off (   self,
**Any  kwargs 
)
Turn light off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 314 of file light.py.

◆ async_turn_on()

None homeassistant.components.matter.light.MatterLight.async_turn_on (   self,
**Any  kwargs 
)
Turn light on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 284 of file light.py.

◆ send_device_command()

None homeassistant.components.matter.light.MatterLight.send_device_command (   self,
Any  command 
)
Send device command.

Definition at line 276 of file light.py.

Member Data Documentation

◆ _attr_brightness

homeassistant.components.matter.light.MatterLight._attr_brightness
private

Definition at line 400 of file light.py.

◆ _attr_color_mode

homeassistant.components.matter.light.MatterLight._attr_color_mode
private

Definition at line 406 of file light.py.

◆ _attr_color_temp

homeassistant.components.matter.light.MatterLight._attr_color_temp
private

Definition at line 403 of file light.py.

◆ _attr_hs_color

homeassistant.components.matter.light.MatterLight._attr_hs_color
private

Definition at line 411 of file light.py.

◆ _attr_is_on

homeassistant.components.matter.light.MatterLight._attr_is_on
private

Definition at line 395 of file light.py.

◆ _attr_max_mireds

homeassistant.components.matter.light.MatterLight._attr_max_mireds
private

Definition at line 376 of file light.py.

◆ _attr_min_mireds

homeassistant.components.matter.light.MatterLight._attr_min_mireds
private

Definition at line 371 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.matter.light.MatterLight._attr_supported_color_modes
private

Definition at line 379 of file light.py.

◆ _attr_xy_color

homeassistant.components.matter.light.MatterLight._attr_xy_color
private

Definition at line 416 of file light.py.

◆ _platform_translation_key

string homeassistant.components.matter.light.MatterLight._platform_translation_key = "light"
staticprivate

Definition at line 92 of file light.py.

◆ _supports_brightness [1/2]

bool homeassistant.components.matter.light.MatterLight._supports_brightness = False
staticprivate

Definition at line 88 of file light.py.

◆ _supports_brightness [2/2]

homeassistant.components.matter.light.MatterLight._supports_brightness
private

Definition at line 334 of file light.py.

◆ _supports_color [1/2]

bool homeassistant.components.matter.light.MatterLight._supports_color = False
staticprivate

Definition at line 89 of file light.py.

◆ _supports_color [2/2]

homeassistant.components.matter.light.MatterLight._supports_color
private

Definition at line 352 of file light.py.

◆ _supports_color_temperature [1/2]

bool homeassistant.components.matter.light.MatterLight._supports_color_temperature = False
staticprivate

Definition at line 90 of file light.py.

◆ _supports_color_temperature [2/2]

homeassistant.components.matter.light.MatterLight._supports_color_temperature
private

Definition at line 366 of file light.py.

◆ _transitions_disabled [1/2]

bool homeassistant.components.matter.light.MatterLight._transitions_disabled = False
staticprivate

Definition at line 91 of file light.py.

◆ _transitions_disabled [2/2]

homeassistant.components.matter.light.MatterLight._transitions_disabled
private

Definition at line 435 of file light.py.


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