diff options
author | Alex Parker <rockbox@aeparker.com> | 2009-03-18 22:37:24 +0000 |
---|---|---|
committer | Alex Parker <rockbox@aeparker.com> | 2009-03-18 22:37:24 +0000 |
commit | 12791d37142e95c07c3e7178ad6eee969c4848eb (patch) | |
tree | e36b7f383a93be8c257fc38663f258af9eb6d1b8 /manual/plugins/batterybenchmark.tex | |
parent | 41959d097042d663531dc0985d3166e96062d81b (diff) | |
download | rockbox-12791d37142e95c07c3e7178ad6eee969c4848eb.tar.gz rockbox-12791d37142e95c07c3e7178ad6eee969c4848eb.zip |
Update Battery Benchmark plugin in the manual to correct some out-of-date
information, and rewrite some sections to improve the English.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@20352 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/plugins/batterybenchmark.tex')
-rw-r--r-- | manual/plugins/batterybenchmark.tex | 97 |
1 files changed, 45 insertions, 52 deletions
diff --git a/manual/plugins/batterybenchmark.tex b/manual/plugins/batterybenchmark.tex index ab7774c2c4..fb7c64dfa0 100644 --- a/manual/plugins/batterybenchmark.tex +++ b/manual/plugins/batterybenchmark.tex | |||
@@ -1,20 +1,19 @@ | |||
1 | \subsection{Battery Benchmark} | 1 | \subsection{Battery Benchmark} |
2 | The Battery Benchmark Plugin enables you to test your battery's performance, | 2 | The \setting{Battery Benchmark} plugin enables you to test your battery's |
3 | while making normal use of your \dap. Once loaded it will run in the | 3 | performance whilst using your \dap\ normally. Results can be submitted |
4 | background (TSR plugin), reading various info about your battery while you use | 4 | to the \wikilink{BatteryRuntime} wiki page. |
5 | it. Once you finish your session you can find the benchmark output data in a | ||
6 | file on your \dap\ \fname{/battery\_bench.txt}. | ||
7 | Please submit your results to the Rockbox wiki. | ||
8 | \wikilink{BatteryRuntime} | ||
9 | 5 | ||
10 | \subsubsection{How it works} | 6 | \subsubsection{How it works} |
11 | After you load the plug-in the operation of your \dap\ continues as normal. | 7 | Once loaded, \setting{Battery Benchmark} runs in the |
12 | You can do whatever you could do before loading the plugin except loading | 8 | background recording various information about your battery to memory. |
13 | another plugin. If you happen to load a plugin while benchmarking, a splash | 9 | A new point is written to memory every minute. |
14 | screen will inform you about the termination of the benchmark. | 10 | Every time the disk is accessed for any reason |
15 | While you operate it will log various battery related information every time | 11 | (such as refilling the audio buffer, opening a directory or entering |
16 | the disk is activated by external causes, (buffer refill, open directory, | 12 | USB mode etc.) then the information in memory is written to disk. |
17 | USB mode) or an hour passes without updating the log file.\\ | 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}. | ||
18 | The plugin will continue to log info until: | 17 | The plugin will continue to log info until: |
19 | 18 | ||
20 | \begin{itemize} | 19 | \begin{itemize} |
@@ -22,49 +21,43 @@ The plugin will continue to log info until: | |||
22 | \item The \dap\ is shut down. | 21 | \item The \dap\ is shut down. |
23 | \item The battery is empty. | 22 | \item The battery is empty. |
24 | \end{itemize} | 23 | \end{itemize} |
25 | Between disk activity (or an hour), it will log info in memory (every | 24 | |
26 | measurement is captured when the voltage changes). If there are too many | 25 | Benchmarks can be resumed if |
27 | measurements older entries will be deleted and the log file will inform the | 26 | you accidentally load a plugin, or turn off your \dap, so long as the log |
28 | user about the interval where entries were lost. Benchmarks can be resumed if | 27 | file \fname{battery\_bench.txt} is not deleted. |
29 | you accidentally load a plugin, or turn off your \dap, as long as the log | ||
30 | file \fname{/battery\_bench.txt} is not deleted. | ||
31 | 28 | ||
32 | \subsubsection{Information explained} | 29 | \subsubsection{Information explained} |
33 | On the top of the file you will see various info on how to use the plugin. | 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. | ||
32 | |||
34 | \begin{description} | 33 | \begin{description} |
35 | \item[Time] This column reports the total time of operation of the \dap. It is | 34 | \item[Time] This column reports the total time of operation of the \dap. It is |
36 | not the time that you started the plug-in. If you have your player on for 5 | 35 | not the time that you started the plug-in. If you have your \dap\ on for 5 |
37 | minutes and then start the plugin, it will start measuring from 5 minutes. | 36 | minutes and then start the plugin, it will start measuring from 5 minutes. |
38 | \item[Seconds] As time, it shows time passed in seconds. Nothing special, it is | 37 | \item[Seconds] The same as \config{Time}, except measured in seconds. |
39 | there because it is free and maybe someone might want to make graphs with | 38 | \item[Level] The percent level of the battery estimated by Rockbox, and not the |
40 | seconds. | 39 | actual battery level. The actual battery level can be seen from the |
41 | \item[Level] The percent level of the battery estimated by Rockbox. This is an | 40 | \config{Voltage} column |
42 | estimation and not an accurate result. Using the real percentage (current | 41 | \item[Time Left] This shows the time remaining until the battery is empty, |
43 | battery voltage / top battery voltage) * 100) we can calculate the difference | 42 | again as estimated by Rockbox. |
44 | between the estimation. Goal of this column is to make the estimation algorithm | 43 | \item[Voltage] The battery voltage in mV at the moment the measurement |
45 | of Rockbox more accurate. | 44 | was taken. |
46 | \item[Time Left] It shows the estimated (by Rockbox) remaining time until | 45 | \item[C] This stands for Charger. An "A" in that column shows if the power |
47 | shutdown. Again, as with Level(above), this column can be used to see | 46 | adapter was attached to the unit at the time of the measurement. |
48 | differences between real time left and estimated time left. This could help | ||
49 | make time left more accurate. | ||
50 | \item[Voltage] The battery voltage, the moment the measurement was captured. | ||
51 | Measurements are captured when this number changes while benchmarking. | ||
52 | This column can be used to give quite interesting graphs in a spreadsheet | ||
53 | program. (Excel, Calc, e.t.c) | ||
54 | \item[M/DA] (Measurements per Disk Activity) The number of measurements stored | ||
55 | temporarily in memory, before written on the log file. This can give you an | ||
56 | idea of how many voltage changes there are between disk activity (or one hour). | ||
57 | \item[C] Stands for Charger. An "A" in that column shows if there was the power | ||
58 | adapter attached to the unit, at the time of the measurement. | ||
59 | \item[S] The "S" column shows the state of the device (Charging, or not). The | ||
60 | "C" indicated that the unit was charging when the measurement was captured. | ||
61 | \item[U] USB powered. Only for targets that support this. A "U" will indicate | 47 | \item[U] USB powered. Only for targets that support this. A "U" will indicate |
62 | if the unit was using the USB port for powering. | 48 | if the unit was using the USB port for power at the time of the measurement. |
63 | \end{description} | 49 | \end{description} |
64 | 50 | ||
65 | \subsubsection{Making graphs} | 51 | \subsubsection{Usage} |
66 | While you can tell how long your battery lasted, with a single look at the last | 52 | The log file can be used to tell you how long the battery lasted (with some |
67 | line of the battery log (\fname{/battery\_bench.txt}), the most useful purpose of | 53 | limitations, see below), but it is most useful for graphing discharge curves |
68 | Battery Benchmark is to make graphs using a spreadsheet program like Excel or | 54 | in order to improve Rockbox's estimation of battery level and time remaining. |
69 | Calc. The battery log (\fname{/battery\_bench.txt}) is in CSV format (comma separated) | 55 | The battery log (\fname{battery\_bench.txt}) is in CSV format |
70 | so you can quite easily import it to a spreadsheet program. | 56 | (comma separated variables) and thus can be easily imported into a spreadsheet |
57 | or similar program. | ||
58 | |||
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. | ||