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

Public Member Functions

def __init__ (self, lightpad)
 
None async_added_to_hass (self)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
int brightness (self)
 
def configchange_event (self, event)
 
def hs_color (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)
 
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)
 
- 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)
 
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 Attributes

 _attr_device_info
 
 _attr_is_on
 
 _attr_name
 
 _attr_unique_id
 
 _blue
 
 _glow_intensity
 
 _green
 
 _lightpad
 
 _red
 

Static Private Attributes

 _attr_color_mode = ColorMode.HS
 
bool _attr_should_poll = False
 
dictionary _attr_supported_color_modes = {ColorMode.HS}
 
string _attr_translation_key = "glow_ring"
 

Additional Inherited Members

- 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

Representation of a Plum Lightpad dimmer glow ring.

Definition at line 129 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.plum_lightpad.light.GlowRing.__init__ (   self,
  lightpad 
)
Initialize the light.

Definition at line 137 of file light.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.plum_lightpad.light.GlowRing.async_added_to_hass (   self)
Subscribe to configchange events.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 157 of file light.py.

◆ async_turn_off()

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

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 195 of file light.py.

◆ async_turn_on()

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

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 183 of file light.py.

◆ brightness()

int homeassistant.components.plum_lightpad.light.GlowRing.brightness (   self)
Return the brightness of this switch between 0..255.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 179 of file light.py.

◆ configchange_event()

def homeassistant.components.plum_lightpad.light.GlowRing.configchange_event (   self,
  event 
)
Handle Configuration change event.

Definition at line 161 of file light.py.

◆ hs_color()

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

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 174 of file light.py.

Member Data Documentation

◆ _attr_color_mode

homeassistant.components.plum_lightpad.light.GlowRing._attr_color_mode = ColorMode.HS
staticprivate

Definition at line 132 of file light.py.

◆ _attr_device_info

homeassistant.components.plum_lightpad.light.GlowRing._attr_device_info
private

Definition at line 150 of file light.py.

◆ _attr_is_on

homeassistant.components.plum_lightpad.light.GlowRing._attr_is_on
private

Definition at line 142 of file light.py.

◆ _attr_name

homeassistant.components.plum_lightpad.light.GlowRing._attr_name
private

Definition at line 140 of file light.py.

◆ _attr_should_poll

bool homeassistant.components.plum_lightpad.light.GlowRing._attr_should_poll = False
staticprivate

Definition at line 133 of file light.py.

◆ _attr_supported_color_modes

dictionary homeassistant.components.plum_lightpad.light.GlowRing._attr_supported_color_modes = {ColorMode.HS}
staticprivate

Definition at line 135 of file light.py.

◆ _attr_translation_key

string homeassistant.components.plum_lightpad.light.GlowRing._attr_translation_key = "glow_ring"
staticprivate

Definition at line 134 of file light.py.

◆ _attr_unique_id

homeassistant.components.plum_lightpad.light.GlowRing._attr_unique_id
private

Definition at line 145 of file light.py.

◆ _blue

homeassistant.components.plum_lightpad.light.GlowRing._blue
private

Definition at line 149 of file light.py.

◆ _glow_intensity

homeassistant.components.plum_lightpad.light.GlowRing._glow_intensity
private

Definition at line 143 of file light.py.

◆ _green

homeassistant.components.plum_lightpad.light.GlowRing._green
private

Definition at line 148 of file light.py.

◆ _lightpad

homeassistant.components.plum_lightpad.light.GlowRing._lightpad
private

Definition at line 139 of file light.py.

◆ _red

homeassistant.components.plum_lightpad.light.GlowRing._red
private

Definition at line 147 of file light.py.


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