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

Additional Inherited Members

- Public Member Functions inherited from homeassistant.components.homekit_controller.entity.CharacteristicEntity
None __init__ (self, HKDevice accessory, ConfigType devinfo, Characteristic char)
 
str old_unique_id (self)
 
- Public Member Functions inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
None __init__ (self, HKDevice accessory, ConfigType devinfo)
 
None async_added_to_hass (self)
 
None async_put_characteristics (self, dict[str, Any] characteristics)
 
None async_setup (self)
 
None async_update (self)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
str|None default_name (self)
 
DeviceInfo device_info (self)
 
list[strget_characteristic_types (self)
 
str|None name (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_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_write_ha_state (self)
 
str|None attribution (self)
 
dict[str, Any]|None capability_attributes (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)
 
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 Member Functions inherited from homeassistant.components.button.ButtonEntity
None async_internal_added_to_hass (self)
 
None async_press (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 Attributes inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
 accessory
 
 accessory_info
 
 all_characteristics
 
 all_iids
 
 pollable_characteristics
 
 service
 
 watchable_characteristics
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.button.ButtonEntity
 None
 

Detailed Description

Base class for all HomeKit buttons.

Definition at line 104 of file button.py.


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