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

Public Member Functions

None __init__ (self, ShellyBlockCoordinator coordinator, Block block)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
int brightness (self)
 
ColorMode color_mode (self)
 
int color_temp_kelvin (self)
 
str|None effect (self)
 
list[str]|None effect_list (self)
 
bool is_on (self)
 
str mode (self)
 
tuple[int, int, intrgb_color (self)
 
tuple[int, int, int, intrgbw_color (self)
 
- Public Member Functions inherited from homeassistant.components.shelly.entity.ShellyBlockEntity
None async_added_to_hass (self)
 
Any set_state (self, **Any kwargs)
 
- 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.shelly.coordinator.ShellyBlockCoordinator
None __init__ (self, HomeAssistant hass, ShellyConfigEntry entry, BlockDevice device)
 
None async_setup (self, list[Platform]|None pending_platforms=None)
 
CALLBACK_TYPE async_subscribe_input_events (self, Callable[[dict[str, Any]], None] input_event_callback)
 
- Public Member Functions inherited from homeassistant.components.light.LightEntity
dict[str, Any] capability_attributes (self)
 
int|None color_temp (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, 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)
 
- 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)
 

Public Attributes

 control_result
 
 mode
 
- Public Attributes inherited from homeassistant.components.shelly.entity.ShellyBlockEntity
 block
 
- Public Attributes inherited from homeassistant.components.shelly.coordinator.ShellyBlockCoordinator
 entry
 
 model
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _update_callback (self)
 

Private Attributes

 _attr_max_color_temp_kelvin
 
 _attr_min_color_temp_kelvin
 
 _attr_supported_color_modes
 

Additional Inherited Members

- 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

Entity that controls a light on block based Shelly devices.

Definition at line 142 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.shelly.light.BlockShellyLight.__init__ (   self,
ShellyBlockCoordinator  coordinator,
Block  block 
)
Initialize light.

Reimplemented from homeassistant.components.shelly.entity.ShellyBlockEntity.

Definition at line 147 of file light.py.

Member Function Documentation

◆ _update_callback()

None homeassistant.components.shelly.light.BlockShellyLight._update_callback (   self)
private
When device updates, clear control & mode result that overrides state.

Reimplemented from homeassistant.components.shelly.entity.ShellyBlockEntity.

Definition at line 381 of file light.py.

◆ async_turn_off()

None homeassistant.components.shelly.light.BlockShellyLight.async_turn_off (   self,
**Any  kwargs 
)
Turn off light.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 367 of file light.py.

◆ async_turn_on()

None homeassistant.components.shelly.light.BlockShellyLight.async_turn_on (   self,
**Any  kwargs 
)
Turn on light.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 288 of file light.py.

◆ brightness()

int homeassistant.components.shelly.light.BlockShellyLight.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.

◆ color_mode()

ColorMode homeassistant.components.shelly.light.BlockShellyLight.color_mode (   self)
Return the color mode of the light.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 217 of file light.py.

◆ color_temp_kelvin()

int homeassistant.components.shelly.light.BlockShellyLight.color_temp_kelvin (   self)
Return the CT color value in kelvin.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 256 of file light.py.

◆ effect()

str | None homeassistant.components.shelly.light.BlockShellyLight.effect (   self)
Return the current effect.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 276 of file light.py.

◆ effect_list()

list[str] | None homeassistant.components.shelly.light.BlockShellyLight.effect_list (   self)
Return the list of supported effects.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 268 of file light.py.

◆ is_on()

bool homeassistant.components.shelly.light.BlockShellyLight.is_on (   self)
If light is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 178 of file light.py.

◆ mode()

str homeassistant.components.shelly.light.BlockShellyLight.mode (   self)
Return the color mode of the light.

Definition at line 186 of file light.py.

◆ rgb_color()

tuple[int, int, int] homeassistant.components.shelly.light.BlockShellyLight.rgb_color (   self)
Return the rgb color value [int, int, int].

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 233 of file light.py.

◆ rgbw_color()

tuple[int, int, int, int] homeassistant.components.shelly.light.BlockShellyLight.rgbw_color (   self)
Return the rgbw color value [int, int, int, int].

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 246 of file light.py.

Member Data Documentation

◆ _attr_max_color_temp_kelvin

homeassistant.components.shelly.light.BlockShellyLight._attr_max_color_temp_kelvin
private

Definition at line 153 of file light.py.

◆ _attr_min_color_temp_kelvin

homeassistant.components.shelly.light.BlockShellyLight._attr_min_color_temp_kelvin
private

Definition at line 152 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.shelly.light.BlockShellyLight._attr_supported_color_modes
private

Definition at line 151 of file light.py.

◆ control_result

homeassistant.components.shelly.light.BlockShellyLight.control_result

Definition at line 291 of file light.py.

◆ mode

homeassistant.components.shelly.light.BlockShellyLight.mode

Definition at line 206 of file light.py.


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