rockbox/manual/plugins/countdown_timer.tex
seroteunine a1040cda5d plugins: add timer/countdown plugin
-New countdown timer plugin with pause, overtime support
-Add full name to credits and manual entry
-Make status strings translatable

Change-Id: I1437b2e5ac5ede292bdab8d36e58b81326ea2ba3
2026-04-16 21:35:52 -04:00

51 lines
1.8 KiB
TeX

% $Id$ %
\subsection{Countdown_timer}
A countdown timer. Set the desired duration, start the countdown, and the
\dap{} will alert you with a beep sequence when time is up. The timer
defaults to 10 minutes on launch.
\subsubsection{Setting the timer}
When the plugin starts, the display shows the time to count down from with
the active field highlighted in brackets (e.g.\ \texttt{[10]:00}).
\begin{btnmap}
\opt{scrollwheel}{\PluginScrollFwd{} / \PluginScrollBack{} or }
\PluginUp{} / \PluginDown
\opt{HAVEREMOTEKEYMAP}{& \PluginRCUp{} / \PluginRCDown}
& Increase / decrease the selected field \\
\PluginLeft{} / \PluginRight
\opt{HAVEREMOTEKEYMAP}{& \PluginRCLeft{} / \PluginRCRight}
& Switch between the minutes and seconds fields \\
\PluginSelect
\opt{HAVEREMOTEKEYMAP}{& \PluginRCSelect}
& Start the countdown \\
\end{btnmap}
Minutes can be set from 0 to 99 and seconds from 0 to 59. The timer cannot
be started if both fields are zero. Values wrap around when incremented or
decremented past their limits.
\subsubsection{Running the timer}
Once started, the remaining time counts down in \texttt{MM:SS} format.
\begin{btnmap}
\PluginSelect
\opt{HAVEREMOTEKEYMAP}{& \PluginRCSelect}
& Pause / resume the timer \\
\nopt{IPOD_4G_PAD,IPOD_3G_PAD}{\PluginCancel}
\opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu}
\opt{HAVEREMOTEKEYMAP}{& \PluginRCCancel}
& Quit (only available while paused) \\
\end{btnmap}
When the countdown reaches zero the \dap{} pauses playback, turns on the
backlight, and plays three beeps. After the alert the timer continues
running into overtime, displaying the elapsed overtime as
\texttt{-MM:SS}. Playback resumes automatically after the beep sequence.
The timer can be quit by pausing it and pressing the quit button.