From 2aabdbfeb843763664783223fa1f7fd83d21a6f6 Mon Sep 17 00:00:00 2001 From: Marianne Arnold Date: Sat, 4 Jul 2009 23:51:06 +0000 Subject: Start of an Iaudio M3 manual: add the necessary platform files (name the remote keymap file 'iaudio' because the keymap is shared with M5 and X5 and could be reused there), add pictures of the remote with labels and place it below the player image, already fill out some installation instructions which are very similar to the other Iaudios. The manual still needs a way to mention main unit and remote control buttons in text descriptions, the second column in the button tables needs to be filled out (using IAUDIO_RC_PAD and adding this to the M5 and X5 platform files) - and screenshots are needed too... git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21645 a1c6a512-1295-4272-9138-f99709370657 --- manual/getting_started/iaudio_install.tex | 1 + manual/getting_started/installation.tex | 13 +- manual/platform/keymap-m3.tex | 93 ++ manual/platform/m3.tex | 26 + manual/platform/remote-keymap-iaudio.tex | 95 ++ manual/rockbox_interface/images/m3-remote.pdf | Bin 0 -> 64986 bytes manual/rockbox_interface/images/m3-remote.png | Bin 0 -> 31839 bytes manual/rockbox_interface/images/m3-remote.svg | 1281 +++++++++++++++++++++++++ manual/rockbox_interface/main.tex | 13 +- 9 files changed, 1515 insertions(+), 7 deletions(-) create mode 100644 manual/platform/keymap-m3.tex create mode 100644 manual/platform/m3.tex create mode 100644 manual/platform/remote-keymap-iaudio.tex create mode 100644 manual/rockbox_interface/images/m3-remote.pdf create mode 100644 manual/rockbox_interface/images/m3-remote.png create mode 100644 manual/rockbox_interface/images/m3-remote.svg diff --git a/manual/getting_started/iaudio_install.tex b/manual/getting_started/iaudio_install.tex index 41765eee24..1ef566173e 100644 --- a/manual/getting_started/iaudio_install.tex +++ b/manual/getting_started/iaudio_install.tex @@ -14,5 +14,6 @@ Rockbox bootloader can therefore be very minimalistic, as it does not require \opt{x5}{Use the \fname{x5v\_fw.bin} file if your \dap{} is a X5V. If it is a X5 or X5L, use the \fname{x5\_fw.bin} file.} \opt{m5}{Use the \fname{m5\_fw.bin} file.} + \opt{m3}{Use the \fname{cowon\_m3.bin} file.} \item Copy it to the \fname{FIRMWARE} directory on your \dap{}. \end{itemize} diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex index db356c12fc..582937f9ed 100644 --- a/manual/getting_started/installation.tex +++ b/manual/getting_started/installation.tex @@ -372,7 +372,7 @@ structure that Rockbox needs.\\} \subsubsection{Installing the bootloader} \opt{h100,h300}{\input{getting_started/iriver_install.tex}} \opt{ipod}{\input{getting_started/ipod_install.tex}} - \opt{m5,x5}{\input{getting_started/iaudio_install.tex}} + \opt{m3,m5,x5}{\input{getting_started/iaudio_install.tex}} \opt{h10,h10_5gb}{\input{getting_started/h10_install.tex}} \opt{gigabeatf}{\input{getting_started/gigabeat_install.tex}} \opt{sansa}{\input{getting_started/sansa_install.tex}} @@ -394,12 +394,15 @@ structure that Rockbox needs.\\} \end{itemize} } -\opt{m5,x5}{ +\opt{m3,m5,x5}{ After installing you \emph{need} to power-cycle the \dap{} by doing the following steps. \begin{itemize} \item Safely eject / unmount your \dap{} and unplug the USB cable. - \item Hold the \ButtonPower{} button to turn off the \dap{}. + \item Hold the + \opt{IAUDIO_X5_PAD}{\ButtonPower} + \opt{IAUDIO_M3_PAD}{\ButtonPlay} + button to turn off the \dap{}. \item Insert the charger. The Rockbox bootloader will automatically be flashed. \end{itemize} } @@ -479,6 +482,10 @@ you turn the unit on, Rockbox should load.} } } +\opt{m3}{ + \fixme{Add a note about the charging trick and place it here?} +} + \section{Updating Rockbox} Rockbox can be easily updated with Rockbox Utility. You can also update Rockbox manually - download a Rockbox build diff --git a/manual/platform/keymap-m3.tex b/manual/platform/keymap-m3.tex new file mode 100644 index 0000000000..098422b21d --- /dev/null +++ b/manual/platform/keymap-m3.tex @@ -0,0 +1,93 @@ +% $Id$ % +\newcommand{\ButtonLeft}{\btnfnt{Rewind}} +\newcommand{\ButtonRight}{\btnfnt{Forward}} +\newcommand{\ButtonUp}{\btnfnt{Volume Up}} +\newcommand{\ButtonDown}{\btnfnt{Volume Down}} +\newcommand{\ButtonRec}{\btnfnt{Rec}} +\newcommand{\ButtonPlay}{\btnfnt{Play}} +\newcommand{\ButtonMode}{\btnfnt{Mode}} +\newcommand{\ButtonHold}{\btnfnt{Hold}} + +%Button actions, standard context +\newcommand{\ActionStdPrev}{\ButtonUp} +\newcommand{\ActionStdPrevRepeat}{Long \ButtonUp} +\newcommand{\ActionStdNext}{\ButtonDown} +\newcommand{\ActionStdNextRepeat}{Long \ButtonDown} +\newcommand{\ActionStdCancel}{\ButtonLeft} +\newcommand{\ActionStdContext}{Long \ButtonMode} +\newcommand{\ActionStdQuickScreen}{Long \ButtonRec} +\newcommand{\ActionQuickScreenExit}{\ButtonRec} +\newcommand{\ActionStdMenu}{\ButtonRec} +\newcommand{\ActionStdOk}{\ButtonPlay{} or \ButtonRight} + +%Button actions, wps context +\newcommand{\ActionWpsPlay}{\ButtonPlay} +\newcommand{\ActionWpsStop}{Long \ButtonPlay} +\newcommand{\ActionWpsSkipNext}{\ButtonRight} +\newcommand{\ActionWpsSkipPrev}{\ButtonLeft} +\newcommand{\ActionWpsSeekBack}{Long \ButtonLeft} +\newcommand{\ActionWpsSeekFwd}{Long \ButtonRight} +\newcommand{\ActionWpsVolDown}{\ButtonDown} +\newcommand{\ActionWpsVolUp}{\ButtonUp} +\newcommand{\ActionWpsQuickScreen}{Long \ButtonRec} +\newcommand{\ActionWpsMenu}{\ButtonRec} +\newcommand{\ActionWpsContext}{Long \ButtonMode} +\newcommand{\ActionWpsBrowse}{\ButtonMode} + +%Button actions, tree context +\newcommand{\ActionTreeWps}{\ButtonPlay} +\newcommand{\ActionTreeStop}{Long \ButtonPlay} +\newcommand{\ActionTreeEnter}{\ButtonPlay{} or \ButtonRight} +\newcommand{\ActionTreeParentDirectory}{\ButtonLeft} + +%Button actions, YesNo context +\newcommand{\ActionYesNoAccept}{\ButtonPlay} + +%Button actions, Setting context +\newcommand{\ActionSettingInc}{\ButtonUp} +\newcommand{\ActionSettingDec}{\ButtonDown} + +%Button actions, Virtual Keyboard Context +\newcommand{\ActionKbdLeft}{\ButtonLeft} +\newcommand{\ActionKbdRight}{\ButtonRight} +\newcommand{\ActionKbdUp}{\ButtonUp} +\newcommand{\ActionKbdDown}{\ButtonDown} +\newcommand{\ActionKbdSelect}{\ButtonPlay} +\newcommand{\ActionKbdDone}{Long \ButtonPlay} +\newcommand{\ActionKbdAbort}{\ButtonRec} + +%Button actions, Pitch Screen context +\newcommand{\ActionPsToggleMode}{\ButtonMode} +\newcommand{\ActionPsIncSmall}{\ButtonUp} +\newcommand{\ActionPsIncBig}{Long \ButtonUp} +\newcommand{\ActionPsDecSmall}{\ButtonDown} +\newcommand{\ActionPsDecBig}{Long \ButtonDown} +\newcommand{\ActionPsNudgeLeft}{\ButtonLeft} +\newcommand{\ActionPsNudgeRight}{\ButtonRight} +\newcommand{\ActionPsReset}{\ButtonRec} +\newcommand{\ActionPsExit}{\ButtonPlay} + +%Button actions, Recording screen context +\newcommand{\ActionRecPause}{\ButtonPlay} +\newcommand{\ActionRecNewfile}{\ButtonRec} +\newcommand{\ActionRecSettingsInc}{\ButtonRight} +\newcommand{\ActionRecSettingsDec}{\ButtonLeft} +\newcommand{\ActionRecPrev}{\ButtonUp} +\newcommand{\ActionRecNext}{\ButtonDown} +\newcommand{\ActionRecMenu}{Long \ButtonRec} +\newcommand{\ActionRecExit}{Long \ButtonPlay} + +%Button actions, FM radio context +\newcommand{\ActionFMPreset}{\ButtonMode} +\newcommand{\ActionFMMenu}{Long \ButtonMode} +\newcommand{\ActionFMMode}{Long \ButtonRec} +\newcommand{\ActionFMStop}{Long \ButtonPlay} +\newcommand{\ActionFMExit}{\ButtonRec} +\newcommand{\ActionFMPlay}{\ButtonPlay} +\newcommand{\ActionFMSettingsInc}{\ActionSettingInc} +\newcommand{\ActionFMSettingsDec}{\ActionSettingDec} +\newcommand{\ActionFMPrev}{\ButtonLeft} +\newcommand{\ActionFMNext}{\ButtonRight} + +%Button actions, Bookmark screen context +\newcommand{\ActionBmDelete}{Long \ButtonRec} diff --git a/manual/platform/m3.tex b/manual/platform/m3.tex new file mode 100644 index 0000000000..bbdd255299 --- /dev/null +++ b/manual/platform/m3.tex @@ -0,0 +1,26 @@ +% $Id$ % +\def\UseOption{m3} +\edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH} +\edef\UseOption{\UseOption,IAUDIO_M3_PAD} +\edef\UseOption{\UseOption,IAUDIO_RC_PAD} +\edef\UseOption{\UseOption,HAVE_BACKLIGHT} +\edef\UseOption{\UseOption,HAVE_DISK_STORAGE} +\edef\UseOption{\UseOption,iaudio} +\edef\UseOption{\UseOption,HAVEREMOTEKEYMAP} + +\newcommand{\playerman}{Iaudio} +\newcommand{\playertype}{M3} +\newcommand{\playerlongtype}{\playertype} +\newcommand{\genericimg}{128x96x2} +\newcommand{\specimg}{m3} +%Used to name the player, e.g. ...to the \dap +\newcommand{\dap}{player} +%For use when referring to the player. E.g. the \daps\ capacity ... +\newcommand{\daps}{player's} +\newcommand{\firmwarefilename}{\fname{rockbox.iaudio}} +\newcommand{\screenshotsize}{4cm} +\newcommand{\disk}{hard disk} + +% link external keymap files +\input{platform/keymap-m3.tex} +\input{platform/remote-keymap-iaudio.tex} diff --git a/manual/platform/remote-keymap-iaudio.tex b/manual/platform/remote-keymap-iaudio.tex new file mode 100644 index 0000000000..3cf4d77c3f --- /dev/null +++ b/manual/platform/remote-keymap-iaudio.tex @@ -0,0 +1,95 @@ +% $Id$ % + +\newcommand{\ButtonRCLeft}{\btnfnt{Rewind}} +\newcommand{\ButtonRCRight}{\btnfnt{Forward}} +\newcommand{\ButtonRCUp}{\btnfnt{Volume Up}} +\newcommand{\ButtonRCDown}{\btnfnt{Volume Down}} +\newcommand{\ButtonRCRec}{\btnfnt{Rec}} +\newcommand{\ButtonRCPlay}{\btnfnt{Play}} +\newcommand{\ButtonRCMode}{\btnfnt{Mode}} +\newcommand{\ButtonRCMenu}{\btnfnt{Menu}} +\newcommand{\ButtonRCHold}{\btnfnt{Hold}} + +%Button actions, standard context +\newcommand{\ActionRCStdPrev}{\ButtonRCUp} +\newcommand{\ActionRCStdPrevRepeat}{Long \ButtonRCUp} +\newcommand{\ActionRCStdNext}{\ButtonRCDown} +\newcommand{\ActionRCStdNextRepeat}{Long \ButtonRCDown} +\newcommand{\ActionRCStdCancel}{\ButtonLeft} +\newcommand{\ActionRCStdContext}{Long \ButtonRCMode} +\newcommand{\ActionRCStdQuickScreen}{Long \ButtonRCRec} +\newcommand{\ActionRCQuickScreenExit}{\ButtonRCRec} +\newcommand{\ActionRCStdMenu}{\ButtonRCRec} +\newcommand{\ActionRCStdOk}{\ButtonRCPlay{} or \ButtonRCRight} + +%Button actions, wps context +\newcommand{\ActionRCWpsPlay}{\ButtonRCPlay} +\newcommand{\ActionRCWpsStop}{Long \ButtonRCPlay} +\newcommand{\ActionRCWpsSkipNext}{\ButtonRCRight} +\newcommand{\ActionRCWpsSkipPrev}{\ButtonRCLeft} +\newcommand{\ActionRCWpsSeekBack}{Long \ButtonRCLeft} +\newcommand{\ActionRCWpsSeekFwd}{Long \ButtonRCRight} +\newcommand{\ActionRCWpsVolDown}{\ButtonRCDown} +\newcommand{\ActionRCWpsVolUp}{\ButtonRCUp} +\newcommand{\ActionRCWpsQuickScreen}{Long \ButtonRCMenu{} (Main: Long \ButtonRec} +\newcommand{\ActionRCWpsMenu}{\ButtonRCMenu{} (Main: \ButtonRec)} +\newcommand{\ActionRCWpsContext}{Long \ButtonRCMode} +\newcommand{\ActionRCWpsBrowse}{\ButtonRCMode} + +%Button actions, tree context +\newcommand{\ActionRCTreeWps}{\ButtonRCPlay} +\newcommand{\ActionRCTreeStop}{Long \ButtonRCPlay} +\newcommand{\ActionRCTreeEnter}{\ButtonRCPlay{} or \ButtonRCRight} +\newcommand{\ActionRCTreeParentDirectory}{\ButtonRCLeft} + +%Button actions, YesNo context +\newcommand{\ActionRCYesNoAccept}{\ButtonRCPlay} + +%Button actions, Setting context +\newcommand{\ActionRCSettingInc}{\ButtonRCUp} +\newcommand{\ActionRCSettingDec}{\ButtonRCDown} + +%Button actions, Virtual Keyboard Context +\newcommand{\ActionRCKbdLeft}{\ButtonRCLeft} +\newcommand{\ActionRCKbdRight}{\ButtonRCRight} +\newcommand{\ActionRCKbdUp}{\ButtonRCUp} +\newcommand{\ActionRCKbdDown}{\ButtonRCDown} +\newcommand{\ActionRCKbdSelect}{\ButtonRCPlay} +\newcommand{\ActionRCKbdDone}{Long \ButtonRCPlay} +\newcommand{\ActionRCKbdAbort}{\ButtonRec} + +%Button actions, Pitch Screen context +\newcommand{\ActionRCPsToggleMode}{\ButtonRCMode} +\newcommand{\ActionRCPsIncSmall}{\ButtonRCUp} +\newcommand{\ActionRCPsIncBig}{Long \ButtonRCUp} +\newcommand{\ActionRCPsDecSmall}{\ButtonRCDown} +\newcommand{\ActionRCPsDecBig}{Long \ButtonRCDown} +\newcommand{\ActionRCPsNudgeLeft}{\ButtonRCLeft} +\newcommand{\ActionRCPsNudgeRight}{\ButtonRCRight} +\newcommand{\ActionRCPsReset}{\ButtonRCRec} +\newcommand{\ActionRCPsExit}{\ButtonRCPlay} + +%Button actions, Recording screen context +\newcommand{\ActionRCRecPause}{\ButtonRCPlay} +\newcommand{\ActionRCRecNewfile}{\ButtonRCRec} +\newcommand{\ActionRCRecSettingsInc}{\ButtonRCRight} +\newcommand{\ActionRCRecSettingsDec}{\ButtonRCLeft} +\newcommand{\ActionRCRecPrev}{\ButtonRCUp} +\newcommand{\ActionRCRecNext}{\ButtonRCDown} +\newcommand{\ActionRCRecMenu}{\ButtonRCMenu{} (Main: Long \ButtonRec)} +\newcommand{\ActionRCRecExit}{Long \ButtonRCPlay} + +%Button actions, FM radio context +\newcommand{\ActionRCFMPreset}{\ButtonRCMode} +\newcommand{\ActionRCFMMenu}{Long \ButtonRCMode} +\newcommand{\ActionRCFMMode}{Long \ButtonRCRec} +\newcommand{\ActionRCFMStop}{Long \ButtonPlay} +\newcommand{\ActionRCFMExit}{\ButtonRCMenu{} (Main: \ButtonRec)} +\newcommand{\ActionRCFMPlay}{\ButtonPlay} +\newcommand{\ActionRCFMSettingsInc}{\ActionRCSettingInc} +\newcommand{\ActionRCFMSettingsDec}{\ActionRCSettingDec} +\newcommand{\ActionRCFMPrev}{\ButtonRCLeft} +\newcommand{\ActionRCFMNext}{\ButtonRCRight} + +%Button actions, Bookmark screen context +\newcommand{\ActionRCBmDelete}{Long \ButtonRec} diff --git a/manual/rockbox_interface/images/m3-remote.pdf b/manual/rockbox_interface/images/m3-remote.pdf new file mode 100644 index 0000000000..31b747dff2 Binary files /dev/null and b/manual/rockbox_interface/images/m3-remote.pdf differ diff --git a/manual/rockbox_interface/images/m3-remote.png b/manual/rockbox_interface/images/m3-remote.png new file mode 100644 index 0000000000..986ff9a3b3 Binary files /dev/null and b/manual/rockbox_interface/images/m3-remote.png differ diff --git a/manual/rockbox_interface/images/m3-remote.svg b/manual/rockbox_interface/images/m3-remote.svg new file mode 100644 index 0000000000..90aa4713f2 --- /dev/null +++ b/manual/rockbox_interface/images/m3-remote.svg @@ -0,0 +1,1281 @@ + + +image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Rewind +Play +Forward +Mode +Rec +VolumeDown +VolumeUp +Menu + +Hold + + + + + + + + \ No newline at end of file diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex index d28f3ceb2d..af2cfb54f9 100644 --- a/manual/rockbox_interface/main.tex +++ b/manual/rockbox_interface/main.tex @@ -9,7 +9,12 @@ % The extension is selected in the preamble, so no further \ifpdfoutput % is necessary. \includegraphics[height=8cm,width=10cm,keepaspectratio=true]{rockbox_interface/images/\specimg-front} - +\opt{m3}{% replace with HAVEREMOTEKEYMAP when the h100 file exists or change specimg + \end{center} + % spacing between the two pictures, could possibly be improved + \begin{center} + \includegraphics[height=5.6cm,width=10cm,keepaspectratio=true]{rockbox_interface/images/\specimg-remote} +} \end{center} Throughout this manual, the buttons on the \dap{} are labelled according to the @@ -22,8 +27,8 @@ described in detail in the following paragraph. \wikilink{BlindFAQ}. % - \opt{h100}{ - Hold or lay the \dap{} so that the side with the joystick and LCD is facing + \opt{h100}{ + Hold or lay the \dap{} so that the side with the joystick and LCD is facing towards you, and the curved side is at the top. The joystick functions as the \ButtonUp{}, \ButtonRight{}, \ButtonLeft{}, and \ButtonDown{} buttons when pressed in the appropriate direction. Pressing the joystick down functions as @@ -467,7 +472,7 @@ To turn on and off your Rockbox enabled \dap{} use the following keys: performed by inserting a paperclip gently into the Reset hole. }% -\nopt{gigabeatf,m5,x5,archos} +\nopt{gigabeatf,m3,m5,x5,archos} { \subsection{Starting the original firmware} \label{ref:Dualboot} -- cgit v1.2.3