circuits.core.timers – Timers — circuits 2.1.0 documentation

# circuits 2.1.0 documentation

# `circuits.core.timers` – Timers

Timer component to facilitate timed events.

## Classes

none

## Components

class `circuits.core.timers.` `Timer`(interval, event, *channels, **kwargs)

  Bases: `circuits.core.components.BaseComponent`

  A timer is a component that fires an event once after a certain delay or periodically at a regular interval.

  Parameters: | interval (datetime or float number) – the delay or interval to wait for until the event is fired. If interval is specified as datetime, the interval is recalculated as the time span from now to the given datetime. event (`Event`) – the event to fire.

  If the optional keyword argument persist is set to `True`, the event will be fired repeatedly. Else the timer fires the event once and then unregisters itself.

  `reset`()

    Reset the timer, i.e. clear the amount of time already waited for.

## Events

none

## Functions

none