Commit the first part of FS#10263: Starting playback from within pictureflow, by...
[kugel-rb.git] / manual / plugins / batterybenchmark.tex
blobfb7c64dfa0c788d266683b865449548180e188f7
1 \subsection{Battery Benchmark}
2 The \setting{Battery Benchmark} plugin enables you to test your battery's
3 performance whilst using your \dap\ normally. Results can be submitted
4 to the \wikilink{BatteryRuntime} wiki page.
6 \subsubsection{How it works}
7 Once loaded, \setting{Battery Benchmark} runs in the
8 background recording various information about your battery to memory.
9 A new point is written to memory every minute.
10 Every time the disk is accessed for any reason
11 (such as refilling the audio buffer, opening a directory or entering
12 USB mode etc.) then the information in memory is written to disk.
13 Once the memory becomes full (after many hours), then the data
14 are written to disk anyway. This is done so that the data are not biased by
15 excessive additional disk accesses. The file is written to the root
16 directory of your \dap\ and is called \fname{battery\_bench.txt}.
17 The plugin will continue to log info until:
19 \begin{itemize}
20 \item Another plugin is loaded.
21 \item The \dap\ is shut down.
22 \item The battery is empty.
23 \end{itemize}
25 Benchmarks can be resumed if
26 you accidentally load a plugin, or turn off your \dap, so long as the log
27 file \fname{battery\_bench.txt} is not deleted.
29 \subsubsection{Information explained}
30 At the top of the \fname{battery\_bench.txt} file is various
31 information on how to use the plugin, followed by the data themselves.
33 \begin{description}
34 \item[Time] This column reports the total time of operation of the \dap. It is
35 not the time that you started the plug-in. If you have your \dap\ on for 5
36 minutes and then start the plugin, it will start measuring from 5 minutes.
37 \item[Seconds] The same as \config{Time}, except measured in seconds.
38 \item[Level] The percent level of the battery estimated by Rockbox, and not the
39 actual battery level. The actual battery level can be seen from the
40 \config{Voltage} column
41 \item[Time Left] This shows the time remaining until the battery is empty,
42 again as estimated by Rockbox.
43 \item[Voltage] The battery voltage in mV at the moment the measurement
44 was taken.
45 \item[C] This stands for Charger. An "A" in that column shows if the power
46 adapter was attached to the unit at the time of the measurement.
47 \item[U] USB powered. Only for targets that support this. A "U" will indicate
48 if the unit was using the USB port for power at the time of the measurement.
49 \end{description}
51 \subsubsection{Usage}
52 The log file can be used to tell you how long the battery lasted (with some
53 limitations, see below), but it is most useful for graphing discharge curves
54 in order to improve Rockbox's estimation of battery level and time remaining.
55 The battery log (\fname{battery\_bench.txt}) is in CSV format
56 (comma separated variables) and thus can be easily imported into a spreadsheet
57 or similar program.
59 \subsubsection{Limitations}
60 As \setting{Battery Benchmark} needs to write the data held in memory to
61 disk in order to save them, it is possible that should Rockbox shut down
62 due to low battery then there will not be enough power remaining to write the
63 data to disk. Therefore all measurements since the previous save will be lost.