Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.lifx.button.LIFXRestartButton Class Reference
Inheritance diagram for homeassistant.components.lifx.button.LIFXRestartButton:
[legend]
Collaboration diagram for homeassistant.components.lifx.button.LIFXRestartButton:
[legend]

Public Member Functions

None async_press (self)
 
- Public Member Functions inherited from homeassistant.components.lifx.button.LIFXButton
None __init__ (self, LIFXUpdateCoordinator coordinator)
 
- 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.lifx.coordinator.LIFXUpdateCoordinator
None __init__ (self, HomeAssistant hass, LIFXConnection connection, str title)
 
None async_apply_theme (self, str theme_name)
 
Callable[[], None] async_enable_rssi_updates (self)
 
int async_get_active_effect (self)
 
None async_get_color (self)
 
None async_get_color_zones (self)
 
str|None async_get_entity_id (self, Platform platform, str key)
 
None async_get_extended_color_zones (self)
 
bool|None async_get_hev_cycle_state (self)
 
None async_identify_bulb (self)
 
None async_set_color (self, list[float|int|None] hsbk, int|None duration)
 
None async_set_color_zones (self, int start_index, int end_index, list[float|int|None] hsbk, int|None duration, int apply)
 
None async_set_extended_color_zones (self, list[tuple[int|float, int|float, int|float, int|float]] colors, int|None colors_count=None, int duration=0, int apply=1)
 
None async_set_hev_cycle_state (self, bool enable, int duration=0)
 
None async_set_infrared_brightness (self, str option)
 
None async_set_matrix_effect (self, str effect, list[tuple[int, int, int, int]]|None palette=None, float|None speed=None, bool power_on=True, str|None sky_type=None, int|None cloud_saturation_min=None, int|None cloud_saturation_max=None)
 
None async_set_multizone_effect (self, str effect, float speed=3.0, str direction="RIGHT", str|None theme_name=None, bool power_on=True)
 
None async_set_power (self, bool state, int|None duration)
 
None async_set_waveform_optional (self, dict[str, Any] value, bool rapid=False)
 
None async_setup (self)
 
str|None current_infrared_brightness (self)
 
dict[str, Any] diagnostics (self)
 
int get_number_of_zones (self)
 
bool is_extended_multizone (self)
 
bool is_legacy_multizone (self)
 
bool is_matrix (self)
 
str label (self)
 
str mac_address (self)
 
int rssi (self)
 
str rssi_uom (self)
 
str serial_number (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- Public Member Functions inherited from homeassistant.components.button.ButtonEntity
None async_internal_added_to_hass (self)
 
ButtonDeviceClass|None device_class (self)
 
None press (self)
 
str|None state (self)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (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_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
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)
 
dict[str, Any]|None capability_attributes (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)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (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)
 

Static Public Attributes

 entity_description = RESTART_BUTTON_DESCRIPTION
 
- Static Public Attributes inherited from homeassistant.components.button.ButtonEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.lifx.entity.LIFXEntity
 bulb
 
- Public Attributes inherited from homeassistant.components.lifx.coordinator.LIFXUpdateCoordinator
 active_effect
 
 connection
 
 last_used_theme
 
 lock
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

LIFX restart button.

Definition at line 58 of file button.py.

Member Function Documentation

◆ async_press()

None homeassistant.components.lifx.button.LIFXRestartButton.async_press (   self)
Restart the bulb on button press.

Reimplemented from homeassistant.components.button.ButtonEntity.

Definition at line 63 of file button.py.

Member Data Documentation

◆ entity_description

homeassistant.components.lifx.button.LIFXRestartButton.entity_description = RESTART_BUTTON_DESCRIPTION
static

Definition at line 61 of file button.py.


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