Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin Class Reference
Inheritance diagram for homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin:
[legend]
Collaboration diagram for homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin:
[legend]

Public Member Functions

None async_will_remove_from_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_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
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)
 
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)
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

None _cancel_timeout (self)
 
None _setup_timeout (self)
 

Private Attributes

 _timeout
 

Additional Inherited Members

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

Detailed Description

Mixin to support timeouts on data.

Many 433 devices only send data when active. They will
repeatedly (every x seconds) send a command to indicate
being active and stop sending this command when inactive.
This mixin allow us to keep track of the timeout once
they go inactive.

Definition at line 92 of file siren.py.

Member Function Documentation

◆ _cancel_timeout()

None homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin._cancel_timeout (   self)
private

Definition at line 114 of file siren.py.

◆ _setup_timeout()

None homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin._setup_timeout (   self)
private

Definition at line 105 of file siren.py.

◆ async_will_remove_from_hass()

None homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin.async_will_remove_from_hass (   self)
Run when entity will be removed from hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 119 of file siren.py.

Member Data Documentation

◆ _timeout

homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin._timeout
private

Definition at line 108 of file siren.py.

◆ None

homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin.None
static

Definition at line 102 of file siren.py.


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