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

Public Member Functions

None __init__ (self, TeslaFleetVehicleData data, TeslaFleetButtonEntityDescription description)
 
None async_press (self)
 
- Public Member Functions inherited from homeassistant.components.tesla_fleet.entity.TeslaFleetVehicleEntity
None __init__ (self, TeslaFleetVehicleData data, str key)
 
None wake_up_if_asleep (self)
 
- Public Member Functions inherited from homeassistant.components.tesla_fleet.entity.TeslaFleetEntity
None __init__ (self, TeslaFleetVehicleDataCoordinator|TeslaFleetEnergySiteLiveCoordinator|TeslaFleetEnergySiteInfoCoordinator coordinator, VehicleSpecific|EnergySpecific api, str key)
 
bool available (self)
 
Any|None get (self, str key, Any|None default=None)
 
float get_number (self, str key, float default)
 
bool has (self)
 
bool is_none (self)
 
None raise_for_read_only (self, Scope scope)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.tesla_fleet.coordinator.TeslaFleetVehicleDataCoordinator
None __init__ (self, HomeAssistant hass, VehicleSpecific api, dict product)
 
- 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.tesla_fleet.coordinator.TeslaFleetEnergySiteLiveCoordinator
None __init__ (self, HomeAssistant hass, EnergySpecific api)
 
- Public Member Functions inherited from homeassistant.components.tesla_fleet.coordinator.TeslaFleetEnergySiteInfoCoordinator
None __init__ (self, HomeAssistant hass, EnergySpecific api, dict product)
 
- 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.tesla_fleet.entity.TeslaFleetVehicleEntity
 vehicle
 
- Public Attributes inherited from homeassistant.components.tesla_fleet.entity.TeslaFleetEntity
 api
 
 key
 
- Public Attributes inherited from homeassistant.components.tesla_fleet.coordinator.TeslaFleetVehicleDataCoordinator
 api
 
 data
 
 last_active
 
 rate
 
 update_interval
 
 updated_once
 
- 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.components.tesla_fleet.coordinator.TeslaFleetEnergySiteLiveCoordinator
 api
 
 data
 
 update_interval
 
 updated_once
 
- Public Attributes inherited from homeassistant.components.tesla_fleet.coordinator.TeslaFleetEnergySiteInfoCoordinator
 api
 
 data
 
 update_interval
 
 updated_once
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _async_update_attrs (self)
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.tesla_fleet.entity.TeslaFleetVehicleEntity
 int
 
- 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

Base class for TeslaFleet buttons.

Definition at line 76 of file button.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tesla_fleet.button.TeslaFleetButtonEntity.__init__ (   self,
TeslaFleetVehicleData  data,
TeslaFleetButtonEntityDescription  description 
)
Initialize the button.

Definition at line 81 of file button.py.

Member Function Documentation

◆ _async_update_attrs()

None homeassistant.components.tesla_fleet.button.TeslaFleetButtonEntity._async_update_attrs (   self)
private
Update the attributes of the entity.

Reimplemented from homeassistant.components.tesla_fleet.entity.TeslaFleetEntity.

Definition at line 90 of file button.py.

◆ async_press()

None homeassistant.components.tesla_fleet.button.TeslaFleetButtonEntity.async_press (   self)
Press the button.

Reimplemented from homeassistant.components.button.ButtonEntity.

Definition at line 93 of file button.py.

Member Data Documentation

◆ entity_description

homeassistant.components.tesla_fleet.button.TeslaFleetButtonEntity.entity_description

Definition at line 87 of file button.py.


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