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