From e3c9d6a3590fadf73250535bac94817501eac30a Mon Sep 17 00:00:00 2001 From: Rafaël Carré Date: Fri, 22 May 2009 10:44:15 +0000 Subject: Initial work on the Fuze manual Still missing: - svg/pdf/nice png front image - plugin keymaps - manual install instructions for sansav2 (and mkamsboot binaries) git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21031 a1c6a512-1295-4272-9138-f99709370657 --- manual/advanced_topics/main.tex | 1 + manual/appendix/file_formats.tex | 3 +- manual/configure_rockbox/sound_settings.tex | 8 +- manual/getting_started/sansaAMS_install.tex | 35 ++++++++ manual/getting_started/sansav2_install.tex | 35 -------- manual/main_menu/main.tex | 2 +- manual/platform/fuze.tex | 24 ++++++ manual/platform/keymap-fuze.tex | 109 +++++++++++++++++++++++++ manual/rockbox_interface/images/fuze-front.png | Bin 0 -> 117248 bytes manual/rockbox_interface/main.tex | 13 ++- 10 files changed, 186 insertions(+), 44 deletions(-) create mode 100644 manual/getting_started/sansaAMS_install.tex delete mode 100644 manual/getting_started/sansav2_install.tex create mode 100644 manual/platform/fuze.tex create mode 100644 manual/platform/keymap-fuze.tex create mode 100644 manual/rockbox_interface/images/fuze-front.png (limited to 'manual') diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex index 5414ec13f6..c25a2faad2 100644 --- a/manual/advanced_topics/main.tex +++ b/manual/advanced_topics/main.tex @@ -483,6 +483,7 @@ You just ``play'' a file with the extension % \opt{ipod}{\fname{.ipod}.} % \opt{iaudio}{\fname{.iaudio}.} % \opt{sansa,h10,h10_5gb}{\fname{.mi4}.} % +\opt{sansaAMS}{\fname{.sansa}.} % This can be used to test new firmware versions without deleting your current version. diff --git a/manual/appendix/file_formats.tex b/manual/appendix/file_formats.tex index 4e9dd7c440..07226eaed8 100644 --- a/manual/appendix/file_formats.tex +++ b/manual/appendix/file_formats.tex @@ -28,7 +28,8 @@ & Rockbox firmware & \opt{player}{\fname{.mod}}\opt{recorder,recorderv2fm,ondiofm,ondiosp}{\fname{.ajz}}% \opt{h100,h300}{\fname{.iriver}}\opt{ipod}{\fname{.ipod}}\opt{iaudio}{\fname{.iaudio}}% - \opt{h10,h10_5gb,sansa}{\fname{.mi4}}\opt{gigabeat}{\fname{.gigabeat}} + \opt{h10,h10_5gb,sansa}{\fname{.mi4}}\opt{gigabeat}{\fname{.gigabeat}}% + \opt{sansaAMS}{\fname{.sansa}} & Load the new firmware with ROLO \\ \includegraphics[width=0.37cm]{appendix/images/icon-wps.png} & While Playing Screen & \fname{.wps} & Load the new WPS display configuration \\ diff --git a/manual/configure_rockbox/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex index 585e74187c..b699eeb821 100644 --- a/manual/configure_rockbox/sound_settings.tex +++ b/manual/configure_rockbox/sound_settings.tex @@ -11,7 +11,7 @@ change to customise your listening experience. can produce without possible distortion (clipping). All values lower than this reference will be negative and yield a progressively softer volume. \opt{player,recorder,recorderv2fm,ondio,x5,m5,ipodnano,ipodvideo, - ipodcolor,ipod1g2g,h10,h10_5gb, sansa}{ + ipodcolor,ipod1g2g,h10,h10_5gb,sansa,sansaAMS}{ Values higher than 0 dB are available and can be used to raise the volume more than would otherwise be possible. These volume levels will ordinarily lead to distorted sound, but might work nicely for music that has @@ -23,7 +23,7 @@ change to customise your listening experience. \opt{x5,m5,ipod3g,ipod4g,gigabeatf,mrobe100}{minimum of -73 dB to a maximum of +6 dB.}% \opt{ipodnano}{minimum of -72 dB to a maximum of +6 dB.}% \opt{ipodvideo}{minimum of -57 dB to a maximum of +6 dB.}% - \opt{ipodcolor,ipod1g2g,h10,h10_5gb,sansa}{minimum of -74 dB to a maximum + \opt{ipodcolor,ipod1g2g,h10,h10_5gb,sansa,sansaAMS}{minimum of -74 dB to a maximum of +6 db.}% \section{Bass} @@ -36,7 +36,7 @@ change to customise your listening experience. \opt{h100,h300}{The minimum setting is 0 dB and the maximum is 24 dB.}% \opt{ipodnano,ipodcolor}{The minimum setting is -6 dB and the maximum is 9 dB.}% \opt{ipodvideo}{The minimum setting is -12 dB and the maximum is 12 dB.}% - \opt{x5,sansa,h10,h10_5gb}{The minimum setting is -24 dB and the maximum is 24 dB.} + \opt{x5,sansa,sansaAMS,h10,h10_5gb}{The minimum setting is -24 dB and the maximum is 24 dB.} \opt{ipodvideo}{ \section{Bass Cutoff} @@ -56,7 +56,7 @@ change to customise your listening experience. \opt{h100,h300}{The minimum setting is 0 dB and the maximum is 6 dB.}% \opt{ipodnano,ipodcolor}{The minimum setting is -6 dB and the maximum is 9 dB.}% \opt{ipodvideo}{The minimum setting is -12 dB and the maximum is 12 dB.}% - \opt{x5,sansa,h10,h10_5gb}{The minimum setting is -24 dB and the maximum is 24 dB.} + \opt{x5,sansa,sansaAMS,h10,h10_5gb}{The minimum setting is -24 dB and the maximum is 24 dB.} \opt{ipodvideo}{ \section{Treble Cutoff} diff --git a/manual/getting_started/sansaAMS_install.tex b/manual/getting_started/sansaAMS_install.tex new file mode 100644 index 0000000000..9f2e25c64b --- /dev/null +++ b/manual/getting_started/sansaAMS_install.tex @@ -0,0 +1,35 @@ +% $Id: % + +In order to make your \playertype{} load and execute the Rockbox +firmware you have just installed, you will need to install the +Rockbox bootloader. Unless bugs are found in the bootloader code, or +significant new features are added, you will only have to perform this +step once. + +These steps use the mkamsboot tool. Source code is available in the +Rockbox SVN repository +(\url{http://svn.rockbox.org/viewvc.cgi/trunk/rbutil/mkamsboot/}). + +\subsection{Bootloader installation from Windows} + +\begin{enumerate} + +% Will add when I have required install instructions % + +\end{enumerate} + +\subsection{Bootloader installation from Mac OS X} + +\begin{enumerate} + +% Same as above % + +\end{enumerate} + +\subsection{Bootloader installation from Linux} + +\begin{enumerate} + +% Lather rinse repeat % + +\end{enumerate} \ No newline at end of file diff --git a/manual/getting_started/sansav2_install.tex b/manual/getting_started/sansav2_install.tex deleted file mode 100644 index 9f2e25c64b..0000000000 --- a/manual/getting_started/sansav2_install.tex +++ /dev/null @@ -1,35 +0,0 @@ -% $Id: % - -In order to make your \playertype{} load and execute the Rockbox -firmware you have just installed, you will need to install the -Rockbox bootloader. Unless bugs are found in the bootloader code, or -significant new features are added, you will only have to perform this -step once. - -These steps use the mkamsboot tool. Source code is available in the -Rockbox SVN repository -(\url{http://svn.rockbox.org/viewvc.cgi/trunk/rbutil/mkamsboot/}). - -\subsection{Bootloader installation from Windows} - -\begin{enumerate} - -% Will add when I have required install instructions % - -\end{enumerate} - -\subsection{Bootloader installation from Mac OS X} - -\begin{enumerate} - -% Same as above % - -\end{enumerate} - -\subsection{Bootloader installation from Linux} - -\begin{enumerate} - -% Lather rinse repeat % - -\end{enumerate} \ No newline at end of file diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex index f41a42248a..72b0b98acc 100644 --- a/manual/main_menu/main.tex +++ b/manual/main_menu/main.tex @@ -216,7 +216,7 @@ pages of information.} given seperately for internal memory (\emph{Int}) and for a plugged in memory card \opt{ondio}{(\emph{MMC})} - \opt{sansa}{(\emph{MSD})}. + \opt{sansa,e200v2,fuze}{(\emph{MSD})}. }% \nopt{multivolume}{Hard disk size and the amount of free space on the disk.} diff --git a/manual/platform/fuze.tex b/manual/platform/fuze.tex new file mode 100644 index 0000000000..887d62ea89 --- /dev/null +++ b/manual/platform/fuze.tex @@ -0,0 +1,24 @@ +% $Id$ % +\def\UseOption{fuze} +\edef\UseOption{\UseOption,SANSA_FUZE_PAD} +\edef\UseOption{\UseOption,HAVE_BACKLIGHT} +\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE} +\edef\UseOption{\UseOption,HAVE_BUTTON_LIGHTS} +\edef\UseOption{\UseOption,sansaAMS} + +\newcommand{\playerman}{Sansa} +\newcommand{\playertype}{Fuze} +\newcommand{\playerlongtype}{\playertype} +\newcommand{\genericimg}{220x176x16} +\newcommand{\specimg}{fuze} +%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.sansa}} +\newcommand{\firmwareextension}{\fname{sansa}} +\newcommand{\screenshotsize}{4cm} +\newcommand{\disk}{flash storage} + +% link external keymap file +\input{platform/keymap-fuze.tex} diff --git a/manual/platform/keymap-fuze.tex b/manual/platform/keymap-fuze.tex new file mode 100644 index 0000000000..f642411682 --- /dev/null +++ b/manual/platform/keymap-fuze.tex @@ -0,0 +1,109 @@ +% $Id$ + +\newcommand{\ButtonLeft}{\btnfnt{Left}} +\newcommand{\ButtonRight}{\btnfnt{Right}} +\newcommand{\ButtonHome}{\btnfnt{Home}} +\newcommand{\ButtonUp}{\btnfnt{Play}} +\newcommand{\ButtonDown}{\btnfnt{Submenu}} +\newcommand{\ButtonSelect}{\btnfnt{Select}} +\newcommand{\ButtonPower}{\btnfnt{Power}} +\newcommand{\ButtonScrollBack}{\btnfnt{Scroll Backward}} +\newcommand{\ButtonScrollFwd}{\btnfnt{Scroll Forward}} +\newcommand{\ButtonHold}{\btnfnt{Hold}} + +%Button actions, standard context +\newcommand{\ActionStdPrev}{\ButtonScrollBack} +\newcommand{\ActionStdPrevRepeat}{Long \ButtonScrollBack} +\newcommand{\ActionStdNext}{\ButtonScrollFwd} +\newcommand{\ActionStdNextRepeat}{Long \ButtonScrollFwd} +\newcommand{\ActionStdCancel}{\ButtonLeft} +\newcommand{\ActionStdContext}{Long \ButtonSelect} +\newcommand{\ActionStdQuickScreen}{Long \ButtonDown} +\newcommand{\ActionQuickScreenExit}{\ButtonPower} +\newcommand{\ActionStdMenu}{\ButtonDown} +\newcommand{\ActionStdOk}{\ButtonSelect{} or \ButtonRight} +\newcommand{\ActionStdUsbCharge}{\ButtonSelect} + +%Button actions, wps context +\newcommand{\ActionWpsPlay}{\ButtonUp} +\newcommand{\ActionWpsSkipNext}{\ButtonRight} +\newcommand{\ActionWpsSkipPrev}{\ButtonLeft} +\newcommand{\ActionWpsSeekBack}{Long \ButtonLeft} +\newcommand{\ActionWpsSeekFwd}{Long \ButtonRight} + +\newcommand{\ActionWpsStop}{Long \ButtonHome} +\newcommand{\ActionWpsVolDown}{\ButtonScrollBack} +\newcommand{\ActionWpsVolUp}{\ButtonScrollFwd} + +\newcommand{\ActionWpsQuickScreen}{Long \ButtonDown} +\newcommand{\ActionWpsMenu}{\ButtonDown} +\newcommand{\ActionWpsContext}{Long \ButtonSelect} +\newcommand{\ActionWpsBrowse}{\ButtonSelect} +\newcommand{\ActionWpsPitchScreen}{\ButtonSelect{} + \ButtonUp} +\newcommand{\ActionWpsIdThreeScreen}{\ButtonSelect{} + \ButtonDown} + +\newcommand{\ActionWpsAbSetBNextDir}{\ButtonHome{} + \ButtonRight} +\newcommand{\ActionWpsAbSetAPrevDir}{\ButtonHome{} + \ButtonLeft} +\newcommand{\ActionWpsAbReset}{\ButtonHome{} + \ButtonUp} + +%Button actions, tree context +\newcommand{\ActionTreeWps}{\ButtonUp} +\newcommand{\ActionTreeStop}{\ButtonHome} +\newcommand{\ActionTreeEnter}{\ButtonSelect{} or \ButtonRight} +\newcommand{\ActionTreeParentDirectory}{\ButtonLeft} + +%Button actions, YesNo context +\newcommand{\ActionYesNoAccept}{\ButtonSelect} + +%Button actions, Setting context +\newcommand{\ActionSettingInc}{\ButtonScrollFwd} +\newcommand{\ActionSettingDec}{\ButtonScrollBack} + +%Button actions, Virtual Keyboard Context +\newcommand{\ActionKbdLeft}{\ButtonLeft} +\newcommand{\ActionKbdRight}{\ButtonRight} +\newcommand{\ActionKbdSelect}{\ButtonSelect} +\newcommand{\ActionKbdDone}{\ButtonUp} +\newcommand{\ActionKbdAbort}{Long \ButtonHome} +\newcommand{\ActionKbdUp}{\ButtonScrollBack} +\newcommand{\ActionKbdDown}{\ButtonScrollFwd} +\newcommand{\ActionKbdCursorLeft}{\ButtonHome{} + \ButtonLeft} +\newcommand{\ActionKbdCursorRight}{\ButtonHome{} + \ButtonRight} +\newcommand{\ActionKbdBackSpace}{\ButtonDown} +\newcommand{\ActionKbdPageFlip}{\ButtonHome{} + \ButtonSelect} + +%Button actions, Pitch Screen context +\newcommand{\ActionPsToggleMode}{\ButtonHome} +\newcommand{\ActionPsIncSmall}{\ButtonScrollFwd} +\newcommand{\ActionPsIncBig}{Long \ButtonScrollFwd} +\newcommand{\ActionPsDecSmall}{\ButtonScrollBack} +\newcommand{\ActionPsDecBig}{Long \ButtonScrollBack} +\newcommand{\ActionPsNudgeLeft}{\ButtonLeft} +\newcommand{\ActionPsNudgeRight}{\ButtonRight} +\newcommand{\ActionPsReset}{\ButtonSelect} +\newcommand{\ActionPsExit}{Long \ButtonHome{} or \ButtonUp} + +%Button actions, Recording screen context +%\newcommand{\ActionRecPause}{\ButtonUp} +%\newcommand{\ActionRecExit}{\ButtonDown} +%\newcommand{\ActionRecNewfile}{\ButtonHome} +%\newcommand{\ActionRecMenu}{Long \ButtonSelect} +%\newcommand{\ActionRecSettingsInc}{\ButtonRight} +%\newcommand{\ActionRecSettingsDec}{\ButtonLeft} +%\newcommand{\ActionRecPrev}{\ButtonScrollBack} +%\newcommand{\ActionRecNext}{\ButtonScrollFwd} + +%Button actions, FM radio context +\newcommand{\ActionFMPreset}{\ButtonSelect} +\newcommand{\ActionFMMenu}{Long \ButtonSelect} +\newcommand{\ActionFMMode}{Long \ButtonUp} +\newcommand{\ActionFMStop}{Long \ButtonHome} +\newcommand{\ActionFMExit}{\ButtonDown} +\newcommand{\ActionFMPlay}{\ButtonUp} +\newcommand{\ActionFMSettingsInc}{\ButtonUp} %? +\newcommand{\ActionFMSettingsDec}{\ButtonDown} %? +\newcommand{\ActionFMPrev}{\ButtonLeft} +\newcommand{\ActionFMNext}{\ButtonRight} + +%Button actions, Bookmark screen context +\newcommand{\ActionBmDelete}{\ButtonHome} diff --git a/manual/rockbox_interface/images/fuze-front.png b/manual/rockbox_interface/images/fuze-front.png new file mode 100644 index 0000000000..37a86f9a53 Binary files /dev/null and b/manual/rockbox_interface/images/fuze-front.png differ diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex index 48b471cd98..43851489a1 100644 --- a/manual/rockbox_interface/main.tex +++ b/manual/rockbox_interface/main.tex @@ -428,7 +428,7 @@ To turn on and off your Rockbox enabled \dap{} use the following keys: \opt{IPOD_3G_PAD}{\ButtonMenu{} / \ButtonPlay}% \opt{ONDIO_PAD}{\ButtonOff}\opt{RECORDER_PAD,PLAYER_PAD}% {Long \ButtonOn}% - \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD} + \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD,sansaAMS} {\ButtonPower}% & Start Rockbox\\ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{Long \ButtonOff}% @@ -436,7 +436,7 @@ To turn on and off your Rockbox enabled \dap{} use the following keys: \opt{ONDIO_PAD,recorderv2fm}{Long \ButtonOff}% \opt{recorder}{Double tap \ButtonOff\ when playback is stopped}% \opt{PLAYER_PAD}{From the Main Menu, select \textbf{Shutdown}}% - \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD}% + \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,MROBE100_PAD,GIGABEAT_S_PAD,sansaAMS}% {Long \ButtonPower}% & Shutdown Rockbox\\ \end{btnmap} @@ -519,12 +519,19 @@ To turn on and off your Rockbox enabled \dap{} use the following keys: pin in the reset hole}\opt{h10_5gb}{removing and reinserting the battery}.} } - \opt{sansa} + \opt{sansa,sansaAMS} { Rockbox has a dual-boot feature. To boot into the original firmware, press and hold the \ButtonLeft{} button while turning on the player. } + \opt{sansaAMS} + { + The player will boot into the original firmware if it is powered + by a USB connection. That feature might go away in the future if + Rockbox can handle USB transfers. + } + \opt{mrobe100} { Rockbox has a dual-boot feature. It loads the original firmware from -- cgit v1.2.3