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

Public Member Functions

None __init__ (self, dict entry_data, DataUpdateCoordinator[dict[int, dict[str, Any]]] coordinator, str name, int idx, str|None device_name, str|None device_manufacturer, str|None device_model, int device_id, bool is_dimmer)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
def brightness (self)
 
def is_on (self)
 
LightEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.components.control4.entity.Control4Entity
None __init__ (self, dict entry_data, DataUpdateCoordinator[Any] coordinator, str|None name, int idx, str|None device_name, str|None device_manufacturer, str|None device_model, int device_id)
 
DeviceInfo device_info (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.light.LightEntity
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_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.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_added_to_hass (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)
 
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 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)
 

Private Member Functions

def _create_api_object (self)
 

Private Attributes

 _attr_color_mode
 
 _attr_supported_color_modes
 
 _is_dimmer
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.control4.entity.Control4Entity
 entry_data
 
- 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.light.LightEntity
 int
 
 LightEntityFeature
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Control4 light entity.

Definition at line 150 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.control4.light.Control4Light.__init__ (   self,
dict  entry_data,
DataUpdateCoordinator[dict[int, dict[str, Any]]]  coordinator,
str  name,
int  idx,
str | None  device_name,
str | None  device_manufacturer,
str | None  device_model,
int  device_id,
bool  is_dimmer 
)
Initialize Control4 light entity.

Definition at line 155 of file light.py.

Member Function Documentation

◆ _create_api_object()

def homeassistant.components.control4.light.Control4Light._create_api_object (   self)
private
Create a pyControl4 device object.

This exists so the director token used is always the latest one, without needing to re-init the entire entity.

Definition at line 186 of file light.py.

◆ async_turn_off()

None homeassistant.components.control4.light.Control4Light.async_turn_off (   self,
**Any  kwargs 
)
Turn the entity off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 242 of file light.py.

◆ async_turn_on()

None homeassistant.components.control4.light.Control4Light.async_turn_on (   self,
**Any  kwargs 
)
Turn the entity on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 219 of file light.py.

◆ brightness()

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

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 204 of file light.py.

◆ is_on()

def homeassistant.components.control4.light.Control4Light.is_on (   self)
Return whether this light is on or off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 194 of file light.py.

◆ supported_features()

LightEntityFeature homeassistant.components.control4.light.Control4Light.supported_features (   self)
Flag supported features.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 213 of file light.py.

Member Data Documentation

◆ _attr_color_mode

homeassistant.components.control4.light.Control4Light._attr_color_mode
private

Definition at line 180 of file light.py.

◆ _attr_has_entity_name

bool homeassistant.components.control4.light.Control4Light._attr_has_entity_name = True
staticprivate

Definition at line 153 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.control4.light.Control4Light._attr_supported_color_modes
private

Definition at line 181 of file light.py.

◆ _is_dimmer

homeassistant.components.control4.light.Control4Light._is_dimmer
private

Definition at line 178 of file light.py.


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