manual/plugins/clock.tex

   1 \subsection{Clock}
   2 \screenshot{plugins/images/ss-clock}{Clock}{img:clock}
   3
   4 This is a fully featured analogue and digital clock plugin.
   5
   6 \subsubsection{Key configuration}
   7
   8 \begin{table}
   9 \begin{btnmap}{}{}
  10     \opt{RECORDER_PAD,IAUDIO_X5_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IPOD_3G_PAD%
  11         ,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_C200_PAD%
  12         ,SANSA_E200_PAD,IRIVER_H10_PAD,SANSA_FUZE_PAD}
  13         {\ButtonLeft{} / \ButtonRight}
  14     \opt{COWON_D2_PAD}{\TouchMidRight{} / \TouchMidLeft}
  15        \opt{HAVEREMOTEKEYMAP}{& }
  16     & Cycle through modes \\
  17     \opt{RECORDER_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
  18         ,MROBE100_PAD}{\ButtonUp{} / \ButtonDown}
  19     \opt{IPOD_3G_PAD,IPOD_4G_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD}
  20       {\ButtonScrollFwd{} / \ButtonScrollBack}
  21     \opt{SANSA_C200_PAD}{\ButtonVolUp{} / \ButtonVolDown}
  22     \opt{IRIVER_H10_PAD}{\ButtonScrollUp{} / \ButtonScrollDown}
  23     \opt{COWON_D2_PAD}{\ButtonMinus{} / \ButtonPlus}
  24        \opt{HAVEREMOTEKEYMAP}{& }
  25     & Cycle through skins \\
  26     \opt{RECORDER_PAD}{\ButtonFOne}
  27     \opt{IAUDIO_X5_PAD}{\ButtonRec}
  28     \opt{IRIVER_H300_PAD}{\ButtonMode}
  29     \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}
  30       {\ButtonMenu}
  31     \opt{SANSA_C200_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonDown}
  32     \opt{IRIVER_H10_PAD}{\ButtonFF}
  33     \opt{COWON_D2_PAD}{\ButtonMenu{} or \TouchTopLeft}
  34        \opt{HAVEREMOTEKEYMAP}{& }
  35     & Main Menu \\
  36     \opt{RECORDER_PAD}{\ButtonPlay}
  37     \opt{IRIVER_H10_PAD}{\ButtonRew}
  38     \opt{IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,SANSA_C200_PAD%
  39       ,SANSA_E200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD%
  40       ,SANSA_FUZE_PAD}
  41       {\ButtonSelect}
  42     \opt{COWON_D2_PAD}{\ButtonPlus{} or \TouchBottomMiddle}
  43        \opt{HAVEREMOTEKEYMAP}{& }
  44     & Start / Stop Counter \\
  45     \opt{RECORDER_PAD_PAD}{Long \ButtonPlay}%
  46     \opt{IRIVER_H10_PAD}{Long \ButtonRew}%
  47     \opt{IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,SANSA_C200_PAD%
  48       ,SANSA_E200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_FUZE_PAD}
  49       {Long \ButtonSelect}
  50     \opt{COWON_D2_PAD}{\ButtonPlus{} or long \TouchBottomMiddle}
  51        \opt{HAVEREMOTEKEYMAP}{& }
  52     & Reset Counter \\
  53     \opt{RECORDER_PAD,IRIVER_H300_PAD}{\ButtonOff}
  54     \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu + \ButtonSelect}
  55     \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
  56         ,MROBE100_PAD}{\ButtonPower}
  57     \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
  58     \opt{GIGABEAT_S_PAD}{\ButtonBack}
  59     \opt{COWON_D2_PAD}{\ButtonPower{} or \TouchBottomRight}
  60        \opt{HAVEREMOTEKEYMAP}{& }
  61     & Save Settings (if enabled) and Exit \\
  62 \end{btnmap}
  63 \end{table}
  64
  65 \textbf{Clock Menu}
  66 \begin{description}
  67 \item[View Clock] Exits the menu and returns to the current clock mode display.
  68 \item[Mode Selector] Opens a menu from which you can select a clock mode to view.
  69 \item[Counter Settings] Opens a menu from which you can adjust settings
  70     pertaining to the counter.
  71 \item[Mode Settings] Opens a menu from which you can adjust settings pertaining to
  72     the current clock mode (analog, digital, binary).
  73 \item[General Settings]
  74     \begin{description}
  75     \item[Reset Settings]
  76     Reset all settings to their default values.
  77     \item[Save Settings]
  78     Save all settings to disk.
  79     \item[Show Counter]
  80     Toggle Counter display.
  81     \item[Save]
  82     Choose whether to disable automatic saving, saving to disk on exit, or
  83     saving to disk every settings change.
  84     \item[Backlight]
  85     Choose whether to disable the backlight, use the user's timeout setting,
  86     or keep the backlight on.
  87     \item[Idle Poweroff]
  88     Toggle Idle Poweroff.
  89     \note{This setting is not saved to disk.}
  90     \end{description}
  91 \item[Help] Opens a brief help screen with key mappings and functionality.
  92 \item[Credits] Displays a credits roll.
  93 \end{description}
  94
  95 \subsubsection{Analog mode}
  96 Small, round, analog clock is displayed in the middle of the LCD.
  97 Time readout, if enabled, is displayed at the upper left.
  98 If Time readout is in 12-hour (``12h'') mode, AM or PM will be displayed at the
  99 upper right.  The Date readout, if enabled, is displayed at the lower left.
 100 The Counter, if enabled, is displayed at the lower right.
 101 The second hand, if enabled, is displayed along with the hour and minute hands.
 102 Digit display, if enabled, places ``12'', ``3'', ``6'', and ``9'' around the
 103 face of the clock in their respective positions.
 104
 105 \subsubsection{Digital mode}
 106 An imitation of an LCD, this mode shows a Clock comprised of digital ``segments''.
 107 The Date readout, if enabled, is displayed at the bottom, center.
 108 The Second readout, if in ``Text'' mode, is displayed at the top, center; if in
 109 ``Bar'' mode, is displayed as a progress bar at the top of the LCD; if in
 110 ``Invert'' mode, will invert the LCD left-to-right as the seconds pass (a
 111 fully-inverted LCD means the entire minute has passed).
 112 The Counter, if displayed, is shown at the upper left.
 113 The Blinking Colon, if enabled, blinks the colon once every second.
 114 12-hour mode, if enabled, will display the time in a 12-hour format.
 115
 116 \subsubsection{LCD mode}
 117 Based on the Digital Mode, the LCD mode is another imitation of an LCD.
 118 The settings available in this mode are exactly the same as Digital Mode, but
 119 they are independent of Digital Mode. For example, you can have the Date
 120 Readout enabled in Digital Mode and disabled in LCD Mode.
 121
 122 \subsubsection{Fullscreen}
 123 A Fullscreen clock is displayed. Show Border, if enabled, will draw a small
 124 box at every hour position (1 to 12 inclusive).
 125 Invert Seconds, if enabled, will invert the LCD as the seconds pass.
 126 Second Hand, if enabled, will draw a second hand among the hour and minute hands.
 127
 128 \subsubsection{Binary mode}
 129 This mode shows a Binary clock.
 130 The hour is displayed on the top line, the minute is displayed on the middle
 131 line, and the seconds are on the last line.
 132 Circle mode, if enabled, draws empty and full circles, instead of zeros and ones.
 133 For help on reading binary, please visit:
 134 \url{http://en.wikipedia.org/wiki/Binary_numeral_system}
 135
 136 \subsubsection{Plain mode}
 137 This mode shows a ``plain'' clock in large text that takes up nearly the whole LCD.