Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity Class Reference
Inheritance diagram for homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity:
[legend]
Collaboration diagram for homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, TriggerUpdateCoordinator coordinator, dict config)
 
None async_added_to_hass (self)
 
AutoOffExtraStoredData|None async_get_last_binary_sensor_data (self)
 
AutoOffExtraStoredData extra_restore_state_data (self)
 
- Public Member Functions inherited from homeassistant.components.binary_sensor.BinarySensorEntity
None async_internal_added_to_hass (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_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)
 
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)
 
StateType state (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.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 

Static Public Attributes

 domain = BINARY_SENSOR_DOMAIN
 
tuple extra_template_keys = (CONF_STATE,)
 
- Static Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

None _handle_coordinator_update (self)
 
None _set_auto_off (self, datetime auto_off_time)
 
def _set_state (self, state, _=None)
 

Private Attributes

 _attr_is_on
 
 _auto_off_cancel
 
 _auto_off_time
 
 _delay_cancel
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
 entity_category
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Sensor entity based on trigger data.

Definition at line 333 of file binary_sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity.__init__ (   self,
HomeAssistant  hass,
TriggerUpdateCoordinator  coordinator,
dict  config 
)
Initialize the entity.

Definition at line 339 of file binary_sensor.py.

Member Function Documentation

◆ _handle_coordinator_update()

None homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity._handle_coordinator_update (   self)
private
Handle update of the data.

Definition at line 385 of file binary_sensor.py.

◆ _set_auto_off()

None homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity._set_auto_off (   self,
datetime  auto_off_time 
)
private

Definition at line 456 of file binary_sensor.py.

◆ _set_state()

def homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity._set_state (   self,
  state,
  _ = None 
)
private
Set up auto off.

Definition at line 428 of file binary_sensor.py.

◆ async_added_to_hass()

None homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity.async_added_to_hass (   self)
Restore last state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 357 of file binary_sensor.py.

◆ async_get_last_binary_sensor_data()

AutoOffExtraStoredData | None homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity.async_get_last_binary_sensor_data (   self)
Restore auto_off_time.

Definition at line 473 of file binary_sensor.py.

◆ extra_restore_state_data()

AutoOffExtraStoredData homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity.extra_restore_state_data (   self)
Return specific state data to be restored.

Reimplemented from homeassistant.helpers.restore_state.RestoreEntity.

Definition at line 469 of file binary_sensor.py.

Member Data Documentation

◆ _attr_is_on

homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity._attr_is_on
private

Definition at line 369 of file binary_sensor.py.

◆ _auto_off_cancel

homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity._auto_off_cancel
private

Definition at line 395 of file binary_sensor.py.

◆ _auto_off_time

homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity._auto_off_time
private

Definition at line 396 of file binary_sensor.py.

◆ _delay_cancel

homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity._delay_cancel
private

Definition at line 391 of file binary_sensor.py.

◆ domain

homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity.domain = BINARY_SENSOR_DOMAIN
static

Definition at line 336 of file binary_sensor.py.

◆ extra_template_keys

tuple homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity.extra_template_keys = (CONF_STATE,)
static

Definition at line 337 of file binary_sensor.py.


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