Home Assistant Unofficial Reference 2024.12.1
homeassistant.util.timeout._ZoneTimeoutManager Class Reference

Public Member Functions

None __init__ (self, TimeoutManager manager, str zone)
 
str __repr__ (self)
 
bool active (self)
 
None enter_freeze (self, _ZoneFreezeContext freeze)
 
None enter_task (self, _ZoneTaskContext task)
 
None exit_freeze (self, _ZoneFreezeContext freeze)
 
None exit_task (self, _ZoneTaskContext task)
 
bool freezes_done (self)
 
str name (self)
 
None pause (self)
 
None reset (self)
 

Detailed Description

Manage the timeouts for a zone.

Definition at line 368 of file timeout.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.util.timeout._ZoneTimeoutManager.__init__ (   self,
TimeoutManager  manager,
str  zone 
)
Initialize internal timeout context manager.

Definition at line 371 of file timeout.py.

Member Function Documentation

◆ __repr__()

str homeassistant.util.timeout._ZoneTimeoutManager.__repr__ (   self)
Representation of a zone.

Definition at line 378 of file timeout.py.

◆ active()

bool homeassistant.util.timeout._ZoneTimeoutManager.active (   self)
Return True if zone is active.

Definition at line 388 of file timeout.py.

◆ enter_freeze()

None homeassistant.util.timeout._ZoneTimeoutManager.enter_freeze (   self,
_ZoneFreezeContext  freeze 
)
Start into new freeze.

Definition at line 409 of file timeout.py.

◆ enter_task()

None homeassistant.util.timeout._ZoneTimeoutManager.enter_task (   self,
_ZoneTaskContext  task 
)
Start into new Task.

Definition at line 397 of file timeout.py.

◆ exit_freeze()

None homeassistant.util.timeout._ZoneTimeoutManager.exit_freeze (   self,
_ZoneFreezeContext  freeze 
)
Exit a running Freeze.

Definition at line 413 of file timeout.py.

◆ exit_task()

None homeassistant.util.timeout._ZoneTimeoutManager.exit_task (   self,
_ZoneTaskContext  task 
)
Exit a running Task.

Definition at line 401 of file timeout.py.

◆ freezes_done()

bool homeassistant.util.timeout._ZoneTimeoutManager.freezes_done (   self)
Return True if all freeze are done.

Definition at line 393 of file timeout.py.

◆ name()

str homeassistant.util.timeout._ZoneTimeoutManager.name (   self)
Return Zone name.

Definition at line 383 of file timeout.py.

◆ pause()

None homeassistant.util.timeout._ZoneTimeoutManager.pause (   self)
Stop timers while it freeze.

Definition at line 421 of file timeout.py.

◆ reset()

None homeassistant.util.timeout._ZoneTimeoutManager.reset (   self)
Reset timer after freeze.

Definition at line 430 of file timeout.py.


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