Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass)
 
None initialize (self)
 
None remove (self, str unique_id)
 
None reset (self)
 
str signal (self)
 
None update (self, str unique_id, datetime heartbeat_expire_time)
 

Public Attributes

 hass
 

Static Public Attributes

 CHECK_HEARTBEAT_INTERVAL = timedelta(seconds=1)
 

Private Member Functions

None _check_for_stale (self, *datetime _)
 

Private Attributes

 _cancel_heartbeat_check
 

Detailed Description

UniFi entity heartbeat monitor.

Definition at line 61 of file entity_helper.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat.__init__ (   self,
HomeAssistant  hass 
)
Initialize the heartbeat monitor.

Definition at line 66 of file entity_helper.py.

Member Function Documentation

◆ _check_for_stale()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat._check_for_stale (   self,
*datetime  _ 
)
private
Check for any devices scheduled to be marked disconnected.

Definition at line 103 of file entity_helper.py.

◆ initialize()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat.initialize (   self)
Initialize heartbeat monitor.

Definition at line 81 of file entity_helper.py.

◆ remove()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat.remove (   self,
str  unique_id 
)
Remove device from heartbeat monitor.

Definition at line 98 of file entity_helper.py.

◆ reset()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat.reset (   self)
Cancel timers.

Definition at line 74 of file entity_helper.py.

◆ signal()

str homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat.signal (   self)
Event to signal new heartbeat missed.

Definition at line 88 of file entity_helper.py.

◆ update()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat.update (   self,
str  unique_id,
datetime  heartbeat_expire_time 
)
Update device time in heartbeat monitor.

Definition at line 93 of file entity_helper.py.

Member Data Documentation

◆ _cancel_heartbeat_check

homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat._cancel_heartbeat_check
private

Definition at line 78 of file entity_helper.py.

◆ CHECK_HEARTBEAT_INTERVAL

homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat.CHECK_HEARTBEAT_INTERVAL = timedelta(seconds=1)
static

Definition at line 64 of file entity_helper.py.

◆ hass

homeassistant.components.unifi.hub.entity_helper.UnifiEntityHeartbeat.hass

Definition at line 68 of file entity_helper.py.


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