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

Public Member Functions

None __init__ (self, IHCController ihc_controller, str controller_id, str name, int ihc_id, int ihc_off_id, int ihc_on_id, dimmable=False, product=None)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
int brightness (self)
 
bool is_on (self)
 
def on_ihc_change (self, ihc_id, value)
 
- Public Member Functions inherited from homeassistant.components.ihc.entity.IHCEntity
None __init__ (self, IHCController ihc_controller, str controller_id, str name, int ihc_id, product=None)
 
def async_added_to_hass (self)
 
def extra_state_attributes (self)
 
def name (self)
 
def unique_id (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)
 
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)
 
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)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 

Private Attributes

 _attr_color_mode
 
 _attr_supported_color_modes
 
 _brightness
 
 _dimmable
 
 _ihc_off_id
 
 _ihc_on_id
 
 _state
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.ihc.entity.IHCEntity
 controller_id
 
 device_id
 
 device_model
 
 device_name
 
 ihc_controller
 
 ihc_id
 
 ihc_name
 
 ihc_note
 
 ihc_position
 
 suggested_area
 
- 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 IHC light.

For dimmable lights, the associated IHC resource should be a light
level (integer). For non dimmable light the IHC resource should be
an on/off (boolean) resource

Definition at line 53 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ihc.light.IhcLight.__init__ (   self,
IHCController  ihc_controller,
str  controller_id,
str  name,
int  ihc_id,
int  ihc_off_id,
int  ihc_on_id,
  dimmable = False,
  product = None 
)
Initialize the light.

Definition at line 61 of file light.py.

Member Function Documentation

◆ async_turn_off()

None homeassistant.components.ihc.light.IhcLight.async_turn_off (   self,
**Any  kwargs 
)
Turn the light off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 112 of file light.py.

◆ async_turn_on()

None homeassistant.components.ihc.light.IhcLight.async_turn_on (   self,
**Any  kwargs 
)
Turn the light on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 96 of file light.py.

◆ brightness()

int homeassistant.components.ihc.light.IhcLight.brightness (   self)
Return the brightness of this light between 0..255.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 87 of file light.py.

◆ is_on()

bool homeassistant.components.ihc.light.IhcLight.is_on (   self)
Return true if light is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 92 of file light.py.

◆ on_ihc_change()

def homeassistant.components.ihc.light.IhcLight.on_ihc_change (   self,
  ihc_id,
  value 
)
Handle IHC notifications.

Reimplemented from homeassistant.components.ihc.entity.IHCEntity.

Definition at line 121 of file light.py.

Member Data Documentation

◆ _attr_color_mode

homeassistant.components.ihc.light.IhcLight._attr_color_mode
private

Definition at line 81 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.ihc.light.IhcLight._attr_supported_color_modes
private

Definition at line 84 of file light.py.

◆ _brightness

homeassistant.components.ihc.light.IhcLight._brightness
private

Definition at line 76 of file light.py.

◆ _dimmable

homeassistant.components.ihc.light.IhcLight._dimmable
private

Definition at line 77 of file light.py.

◆ _ihc_off_id

homeassistant.components.ihc.light.IhcLight._ihc_off_id
private

Definition at line 74 of file light.py.

◆ _ihc_on_id

homeassistant.components.ihc.light.IhcLight._ihc_on_id
private

Definition at line 75 of file light.py.

◆ _state

homeassistant.components.ihc.light.IhcLight._state
private

Definition at line 78 of file light.py.


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