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

Public Member Functions

None __init__ (self, ShellyRpcCoordinator|ShellyBlockCoordinator coordinator, ShellyButtonDescription[ShellyRpcCoordinator|ShellyBlockCoordinator] description)
 
None async_press (self)
 
- 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.ShellyRpcCoordinator
None __init__ (self, HomeAssistant hass, ShellyConfigEntry entry, RpcDevice device)
 
None async_device_online (self, str source)
 
None async_setup (self, list[Platform]|None pending_platforms=None)
 
CALLBACK_TYPE async_subscribe_events (self, Callable[[dict[str, Any]], None] event_callback)
 
CALLBACK_TYPE async_subscribe_input_events (self, Callable[[dict[str, Any]], None] input_event_callback)
 
CALLBACK_TYPE async_subscribe_ota_events (self, Callable[[dict[str, Any]], None] ota_event_callback)
 
None shutdown (self)
 
bool update_sleep_period (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.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)
 

Public Attributes

 entity_description
 
- Public Attributes inherited from homeassistant.components.shelly.coordinator.ShellyRpcCoordinator
 connected
 
 entry
 
 last_update_success
 
 update_interval
 
- 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 Attributes

 _attr_device_info
 
 _attr_name
 
 _attr_unique_id
 

Additional Inherited Members

- 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
 

Detailed Description

Defines a Shelly base button.

Definition at line 133 of file button.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.shelly.button.ShellyButton.__init__ (   self,
ShellyRpcCoordinator | ShellyBlockCoordinator  coordinator,
ShellyButtonDescription[ ShellyRpcCoordinator | ShellyBlockCoordinator description 
)
Initialize Shelly button.

Definition at line 142 of file button.py.

Member Function Documentation

◆ async_press()

None homeassistant.components.shelly.button.ShellyButton.async_press (   self)
Triggers the Shelly button press service.

Reimplemented from homeassistant.components.button.ButtonEntity.

Definition at line 159 of file button.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.shelly.button.ShellyButton._attr_device_info
private

Definition at line 155 of file button.py.

◆ _attr_name

homeassistant.components.shelly.button.ShellyButton._attr_name
private

Definition at line 153 of file button.py.

◆ _attr_unique_id

homeassistant.components.shelly.button.ShellyButton._attr_unique_id
private

Definition at line 154 of file button.py.

◆ entity_description

homeassistant.components.shelly.button.ShellyButton.entity_description

Definition at line 151 of file button.py.


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