Method timer_start

PySimpleGUI/PySimpleGUI.py:12517–12544

Starts a timer that gnerates Timer Events. Time can be specified as an integer number of milliseconds or a string format "H:M:S" The default is to repeat the timer events until timer is stopped. You can provide your own key or a default key will be used. The default

(self, frequency_ms, key=EVENT_TIMER, repeating=True)

    def timer_start(self, frequency_ms, key=EVENT_TIMER, repeating=True):
        """
        Starts a timer that gnerates Timer Events.
        Time can be specified as an integer number of milliseconds or a string format "H:M:S"
        The default is to repeat the timer events until timer is stopped.
        You can provide your own key or a default key will be used.  The default key is defined
        with the constants EVENT_TIMER or TIMER_KEY.  They both equal the same value.
        The values dictionary will contain the timer ID that is returned from this function.

        :param frequency_ms:    How often to generate timer events in milliseconds or a string "HH:MM:SS". HH, MM, SS each can be any length of chars
        :type frequency_ms:     None | int | str
        :param key:             Key to be returned as the timer event
        :type key:              str | int | tuple | object
        :param repeating:       If True then repeat timer events until timer is explicitly stopped
        :type repeating:        bool
        :return:                Timer ID for the timer or None if error
        :rtype:                 int | None
        """
        if isinstance(frequency_ms, str):
            try:
                hour, min, sec = self._parse_h_m_s(frequency_ms)
                frequency_ms = (hour * 3600 + min * 60 + sec) * 1000
            except Exception as e:
                popup_error_with_traceback('Error in H:M:S string', f'Error in H:M:S string = {frequency_ms}', e)
                return None

        timer = _TimerPeriodic(self, frequency_ms=frequency_ms, key=key, repeating=repeating)
        return timer.id

    def timer_stop(self, timer_id):
        """