Mesure battery duration for KSM

[embryo]

The goal was, as I wrote at an older Koreader's forum post:

I asked tshering in his KSM thread for a way to count the time I read and he was kind enough to give me a command to add to my power-off script to measure the uptime of the reader.

It would be nice if someone with bash knowledge could improve it to give us somehow the total time, since now I have to make the counting manually, and to format it in a more readable way e.g.:

• uptime: 0:00:14:32 (total 0:02:42:56)
• idle: 0:00:13:32 (total 0:02:24:31)
• battery: 68%

I was using a combination of this handy mod for Koreader and tshering's scripts to get a more accurate picture of my battery's duration.
And since nobody improved the original script, I had to learn a bit about bash and try to improve it myself.
So I did, and this is the outcome.

DISCLAIMER - USE AT YOUR OWN RISK
I'm using this with Kobo Glo (non-HD), KSM7 and Koreader v2015.11-11-g16509e2.
It should work with other configurations too, but I can't be sure about the KSM8 before someone else try it.
UPDATE: For KSM8 files and instructions, please read the 2nd post from tshering.

INSTALL FOR KSM7
There is a KoboRoot.tgz in the KSM07_uptimeX_0x.zip
The steps are:

• Extract KoboRoot.tgz from the KSM07_uptimeX_0x.zip
• Copy KoboRoot.tgz into the .kobo folder
• In KSM7 menu select "handle update" > "install update"
• Wait until the device has restarted

The KoboRoot.tgz archive contains a modified poweroff.sh script that will be copied to the "\.adds\kbmenu\onstart\" directory and
the show_uptime.sh and delete_uptime.sh scripts that will be copied to the "\.adds\kbmenu\scripts_intern\returntests\" directory.

That's it!

After that, every time you shut down the device (really shut down, not suspend) it will add a line to a uptime.txt file that it will be created in the "\.adds\kbmenu\logs\" directory.
This line will be in the form of:

2016:03:08_19:59, 0:00:11:58 total: 52992 bat: 78

which is the date and time that the device was shut down, the time it spend open, the total ms that the device was open after the creation of the uptime .txt, and the current battery level.

Whenever you want to check the status you have to goto KSM and navigate to scripts>tests>returntests.msh and execute the "show uptime.sh" script.
You will get a reading of:

Uptime: 0:00:01:56
Total time: 0:14:06:23
Battery charge: 65
Battery spend: 22

If you want to restart the measurements (after a partial or complete charge) you have to execute the "delete uptime.sh" (found in the same place) which deletes the uptime.txt.
You have to restart the device after that to start fresh.

The "Battery charge" and the "Battery spend" sum is the battery level of the device when the uptime.txt was re-created.

If anybody that is more knowledgeable than me with bash (almost everybody ;o) can improve the scripts, please do so and post the updates here.

After two complete battery cycles, I'm in a happy position to announce that my Glo's battery is enough for more than 2 days of continuous reading:
2 days with 76 shutdowns and
2 days and 4 hours with 56 shutdowns.

I'll keep on measuring a bit more before coming to a conclusive number, but its much better than I thought.

...and have a nice read too...

Edit1: Uploaded a zip file, since .7z files are not supported ...
Edit2: Instruction for Koreader support.

[tshering]

embryo, thank you for the nice contribution!

Here is the version for KSM 08.

How to install:

• extract KoboRoot.tgz from the uploaded archive
• copy KoboRoot.tgz into .kobo
• select (KSM home) "handle update" > "install update"
• wait until the device has restarted

The navigation path to the two scripts is:
(KSM home) "user scripts" > "tests" > "returntests user.msh"

I renamed show_uptime.sh and delete_uptime.sh to uptime_show.sh and uptime_delete.sh so that they are displayed next to each other in the list. These two files should work on KSM 07 too (at least when started via the menu; when starting them from telnet one has to set and export the variable "ksmroot"). The KSM 08 version of the script poweroff.sh must not be used under KSM 07 however!

Note: Looking at the screen shot again I notice that "battery spend" sounds strange.

[embryo]

Originally Posted by tshering

embryo, thank you for the nice contribution!

Here is the version for KSM 08.

Thank you and don't forget that you started it...
I'll link your post from the first post

How to install:

• extract KoboRoot.tgz from the uploaded archive
• copy KoboRoot.tgz into .kobo
• select (KSM home) "handle update" > "install update"
• wait until the device has restarted

The navigation path to the two scripts is:
(KSM home) "user scripts" > "tests" > "returntests user.msh"

I renamed show_uptime.sh and delete_uptime.sh to uptime_show.sh and uptime_delete.sh so that they are displayed next to each other in the list.

Well, THAT was what I was trying to avoid by using these names.. ;o)
I think its dangerous to have the delete script next to the script that you use all the time.
Its a mistake waiting to happen...

These two files should work on KSM 07 too (at least when started via the menu; when starting them from telnet one has to set and export the variable "ksmroot"). The KSM 08 version of the script poweroff.sh must not be used under KSM 07 however!

Note: Looking at the screen shot again I notice that "battery spend" sounds strange.

It looks like your battery meter didn't change since the first entry in the uptime.txt.
Remember this is measuring the consumption of the "Total time" not how much is missing from the 100%
It should change.
If it doesn't, then there is something different in the environment variables of the touch (which I highly doubt)

BTW Do you thing I should provide a KoboRoot.tgz for installation?

[tshering]

Originally Posted by embryo

Well, THAT was what I was trying to avoid by using these names.. ;o)
I think its dangerous to have the delete script next to the script that you use all the time.
Its a mistake waiting to happen...

I see, our preferences differ. I prefer to have those things that I consider as belonging together also grouped together in the list. Anyway, since the two scripts are on the user partition (and no other scripts are depending on them) everybody can rename them according to taste.

Originally Posted by embryo

It looks like your battery meter didn't change since the first entry in the uptime.txt.
Remember this is measuring the consumption of the "Total time" not how much is missing from the 100%
It should change.
If it doesn't, then there is something different in the environment variables of the touch (which I highly doubt)

I have no problem with the "0." I meant to say that the expression "battery spend" sounds strange to me. I would rather expect "battery discharge," "battery discharged" or something like that. But since I am not a native English speaker, I cannot really propose anything.

Originally Posted by embryo

BTW Do you thing I should provide a KoboRoot.tgz for installation?

I think for some people this might be helpful. It just came to my mind that I could modify poweroff.sh a little so that it works for KSM 07 and 08. But since the location of this file is different in 07 and 08, we still need two different installation packages. (By the way there was a screen rotation problem with the 07 poweroff.sh. You cannot see it on the Glo).

Update: I modified poweroff.sh. I expect it to work on 07 (update 4) and 08. I did not test it, since I do not have a Kobo with me. I will test it under 08 this evening.
We could use the same installation package for 07 and 08, if we do not care that poweroff.sh will be copied to two different locations. -We could get rid of the unnecessary file afterwards with the help of udev/rules.d, but I do not care for the moment.

[Alan_S]

Originally Posted by embryo

After that, every time you shut down the device (really shut down, not suspend) it will add a line to a uptime.txt file that it will be created in the "\.adds\kbmenu\logs\" directory.

Would be possible to measure suspended time also?

Shutting device off in a way is "safe" to maximize battery life, you can't have more than that. But, suspending device could have problems, device maybe wouldn't go completely to sleep, or whatever is reason that battery drains much faster than normal.

[embryo]

Originally Posted by tshering

I see, our preferences differ. I prefer to have those things that I consider as belonging together also grouped together in the list. Anyway, since the two scripts are on the user partition (and no other scripts are depending on them) everybody can rename them according to taste.

I prefer the grouping too.
Its more logical.
I changed it after an "accident" happened.

I have no problem with the "0." I meant to say that the expression "battery spend" sounds strange to me. I would rather expect "battery discharge," "battery discharged" or something like that. But since I am not a native English speaker, I cannot really propose anything.

I'm also foreign to the English language.
I like the "discharge" version.
Maybe some native English speaker can enlighten us?

I think for some people this might be helpful. It just came to my mind that I could modify poweroff.sh a little so that it works for KSM 07 and 08. But since the location of this file is different in 07 and 08, we still need two different installation packages. (By the way there was a screen rotation problem with the 07 poweroff.sh. You cannot see it on the Glo).

Update: I modified poweroff.sh. I expect it to work on 07 (update 4) and 08. I did not test it, since I do not have a Kobo with me. I will test it under 08 this evening.
We could use the same installation package for 07 and 08, if we do not care that poweroff.sh will be copied to two different locations. -We could get rid of the unnecessary file afterwards with the help of udev/rules.d, but I do not care for the moment.

This is excellent!
I tried the poweroff.sh and it works with my KSM7 Glo.

I agree to use one package for everything.
It makes things easier for everybody.
I can rename the scripts the more "logical" way.
The existence of an extra file that nobody uses is no problem I think.

But maybe there is a difference in the other script's location too.
From your KoboRoot.tgz structure I can see that they must be copied to the kbmenu_user folder and not to the kbmenu that the KSM7 uses.
Is this going to impose any more problems?

[embryo]

Originally Posted by Alan_S

Would be possible to measure suspended time also?

I couldn't find any way to do that.
I know of a variable for the idle part of the wake time but I didn't find any for the suspend time.
Maybe someone with more knowledge of linux vars?

[tshering]

Originally Posted by embryo

But maybe there is a difference in the other script's location too.
From your KoboRoot.tgz structure I can see that they must be copied to the kbmenu_user folder and not to the kbmenu that the KSM7 uses.
Is this going to impose any more problems?

You are right! I totally forgot about this.

As for suspend, we could use preventfreeze.sh to log this and whether nickel, KOReader or PbChess was running.

[embryo]

Updated the archive for the KSM7 installation with the tshering's newer poweroff.sh script (1st post).

[tshering]

Updated the archive for the KSM8 (2nd post).

[Alan_S]

Originally Posted by embryo

I couldn't find any way to do that.

If you find way for measuring suspended time, please inform and update script.

And about message, battery spent is correct. But it can be also discharged, it isn't that important.

[embryo]

I wrote some instructions for using the uptime.sh script with KoReader.
I tested them with KSM7 and it *should* work with KSM8, but if someone try it, please post the results.