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

Public Member Functions

None __init__ (self, SwitchbotDataUpdateCoordinator coordinator)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.switchbot.entity.SwitchbotEntity
None async_added_to_hass (self)
 
None async_update (self)
 
Mapping[Any, Any] extra_state_attributes (self)
 
dict[str, Any] parsed_data (self)
 
- Public Member Functions inherited from homeassistant.components.switchbot.coordinator.SwitchbotDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, BLEDevice ble_device, switchbot.SwitchbotDevice device, str base_unique_id, str device_name, bool connectable, SwitchbotModel model)
 
bool async_wait_ready (self)
 
- Public Member Functions inherited from homeassistant.components.bluetooth.active_update_coordinator.ActiveBluetoothDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *str address, BluetoothScanningMode mode, Callable[[BluetoothServiceInfoBleak, float|None], bool] needs_poll_method, Callable[[BluetoothServiceInfoBleak], Coroutine[Any, Any, _T],]|None poll_method=None, Debouncer[Coroutine[Any, Any, None]]|None poll_debouncer=None, bool connectable=True)
 
bool needs_poll (self, BluetoothServiceInfoBleak service_info)
 
- Public Member Functions inherited from homeassistant.components.bluetooth.passive_update_coordinator.PassiveBluetoothDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, str address, BluetoothScanningMode mode, bool connectable=False)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
Generator[Any] async_contexts (self)
 
None async_update_listeners (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.bluetooth.update_coordinator.BasePassiveBluetoothCoordinator
CALLBACK_TYPE async_start (self)
 
float last_seen (self)
 
str name (self)
 
- 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)
 
- 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

None _async_update_attrs (self)
 

Private Attributes

 _attr_brightness
 
 _attr_color_mode
 
 _attr_color_temp
 
 _attr_is_on
 
 _attr_max_mireds
 
 _attr_min_mireds
 
 _attr_rgb_color
 
 _attr_supported_color_modes
 

Static Private Attributes

 _attr_name = None
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.switchbot.coordinator.SwitchbotDataUpdateCoordinator
 base_unique_id
 
 ble_device
 
 device
 
 device_name
 
 model
 
- Public Attributes inherited from homeassistant.components.bluetooth.active_update_coordinator.ActiveBluetoothDataUpdateCoordinator
 data
 
 last_poll_successful
 
- Public Attributes inherited from homeassistant.components.bluetooth.update_coordinator.BasePassiveBluetoothCoordinator
 address
 
 connectable
 
 hass
 
 logger
 
 mode
 
- 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 switchbot light bulb.

Definition at line 43 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.switchbot.light.SwitchbotLightEntity.__init__ (   self,
SwitchbotDataUpdateCoordinator  coordinator 
)
Initialize the Switchbot light.

Reimplemented from homeassistant.components.switchbot.entity.SwitchbotEntity.

Definition at line 49 of file light.py.

Member Function Documentation

◆ _async_update_attrs()

None homeassistant.components.switchbot.light.SwitchbotLightEntity._async_update_attrs (   self)
private
Handle updating _attr values.

Reimplemented from homeassistant.components.switchbot.entity.SwitchbotEntity.

Definition at line 61 of file light.py.

◆ async_turn_off()

None homeassistant.components.switchbot.light.SwitchbotLightEntity.async_turn_off (   self,
**Any  kwargs 
)
Instruct the light to turn off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 95 of file light.py.

◆ async_turn_on()

None homeassistant.components.switchbot.light.SwitchbotLightEntity.async_turn_on (   self,
**Any  kwargs 
)
Instruct the light to turn on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 73 of file light.py.

Member Data Documentation

◆ _attr_brightness

homeassistant.components.switchbot.light.SwitchbotLightEntity._attr_brightness
private

Definition at line 65 of file light.py.

◆ _attr_color_mode

homeassistant.components.switchbot.light.SwitchbotLightEntity._attr_color_mode
private

Definition at line 68 of file light.py.

◆ _attr_color_temp

homeassistant.components.switchbot.light.SwitchbotLightEntity._attr_color_temp
private

Definition at line 67 of file light.py.

◆ _attr_is_on

homeassistant.components.switchbot.light.SwitchbotLightEntity._attr_is_on
private

Definition at line 64 of file light.py.

◆ _attr_max_mireds

homeassistant.components.switchbot.light.SwitchbotLightEntity._attr_max_mireds
private

Definition at line 54 of file light.py.

◆ _attr_min_mireds

homeassistant.components.switchbot.light.SwitchbotLightEntity._attr_min_mireds
private

Definition at line 53 of file light.py.

◆ _attr_name

homeassistant.components.switchbot.light.SwitchbotLightEntity._attr_name = None
staticprivate

Definition at line 47 of file light.py.

◆ _attr_rgb_color

homeassistant.components.switchbot.light.SwitchbotLightEntity._attr_rgb_color
private

Definition at line 70 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.switchbot.light.SwitchbotLightEntity._attr_supported_color_modes
private

Definition at line 55 of file light.py.


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