Public Member Functions
None	__init__ (self, HomeAssistant hass)

None	add_time (self, str timer_id, int seconds)

None	cancel_timer (self, str timer_id)

bool	is_timer_device (self, str device_id)

None	pause_timer (self, str timer_id)

Callable[[], None]	register_handler (self, str device_id, TimerHandler handler)

None	remove_time (self, str timer_id, int seconds)

str	start_timer (self, str\|None device_id, int\|None hours, int\|None minutes, int\|None seconds, str language, str\|None name=None, str\|None conversation_command=None, str\|None conversation_agent_id=None)

None	unpause_timer (self, str timer_id)

Public Attributes
	hass

Private Member Functions
None	_timer_finished (self, str timer_id)

None	_wait_for_timer (self, str timer_id, int seconds, int updated_at)

Detailed Description

Manager for intent timers.

Definition at line 206 of file timers.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.intent.timers.TimerManager.__init__	(		self,
		HomeAssistant	hass
	)

Initialize timer manager.

Definition at line 209 of file timers.py.

Member Function Documentation

◆ _timer_finished()

None homeassistant.components.intent.timers.TimerManager._timer_finished	(		self,
		str	timer_id
	)

private

Call event handlers when a timer finishes.

Definition at line 440 of file timers.py.

◆ _wait_for_timer()

None homeassistant.components.intent.timers.TimerManager._wait_for_timer	(		self,
		str	timer_id,
		int	seconds,
		int	updated_at
	)

private

Sleep until timer is up. Timer is only finished if it hasn't been updated.

Definition at line 312 of file timers.py.

◆ add_time()

None homeassistant.components.intent.timers.TimerManager.add_time	(		self,
		str	timer_id,
		int	seconds
	)

Add time to a timer.

Definition at line 347 of file timers.py.

◆ cancel_timer()

None homeassistant.components.intent.timers.TimerManager.cancel_timer	(		self,
		str	timer_id
	)

Cancel a timer.

Definition at line 325 of file timers.py.

◆ is_timer_device()

bool homeassistant.components.intent.timers.TimerManager.is_timer_device	(		self,
		str	device_id
	)

Return True if device has been registered to handle timer events.

Definition at line 472 of file timers.py.

◆ pause_timer()

None homeassistant.components.intent.timers.TimerManager.pause_timer	(		self,
		str	timer_id
	)

Pauses a timer.

Definition at line 390 of file timers.py.

◆ register_handler()

Callable[[], None] homeassistant.components.intent.timers.TimerManager.register_handler	(		self,
		str	device_id,
		TimerHandler	handler
	)

Register a timer handler.

Returns a callable to unregister.

Definition at line 220 of file timers.py.

◆ remove_time()

None homeassistant.components.intent.timers.TimerManager.remove_time	(		self,
		str	timer_id,
		int	seconds
	)

Remove time from a timer.

Definition at line 386 of file timers.py.

◆ start_timer()

str homeassistant.components.intent.timers.TimerManager.start_timer	(		self,
		str \| None	device_id,
		int \| None	hours,
		int \| None	minutes,
		int \| None	seconds,
		str	language,
		str \| None	name = `None`,
		str \| None	conversation_command = `None`,
		str \| None	conversation_agent_id = `None`
	)

Start a timer.

Definition at line 234 of file timers.py.

◆ unpause_timer()

None homeassistant.components.intent.timers.TimerManager.unpause_timer	(		self,
		str	timer_id
	)

Unpause a timer.

Definition at line 414 of file timers.py.

Member Data Documentation

◆ hass

homeassistant.components.intent.timers.TimerManager.hass

Definition at line 211 of file timers.py.

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

core/homeassistant/components/intent/timers.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Member Functions