Kobo Start Menu 07

[tshering]

This thread is outdated, please go to the KSM 08 thread.

Spoiler:

This mod is supposed to work under FW 2.6.0 to 3.18.0.

Avoid FW 3.16.10 and 3.17.0 if you can because of the sickel issue.

The Kobo Start Menu (KSM) is launched at start up and lets you

• choose between available readers and other applications
• manage FW packages (install, install and preserve the Kobo Start Menu, delete)
• download the most recent Kobo FW update as soon as it is available, if you wish so
• connect the device as usb mass storage
• enable USBNet
  Spoiler:

  For instructions on how to make USBNet work on windows see these instructions. To make telnet work install KevinShort's package. For telnet you can simply use windows's own telnet (if you are a windows user that means). On how to install and enable it on Windows 8 and 8.1 see for instance these instructions. If vlasovsoft is available on your device you can optionally start dropbear together with USBnet.
• execute scripts from the internal and external sd
• ...

Since larger parts of the package consist of sh files, you can modify and enlarge the functions easily.

For a general overview of the KSM features please refer ot the (however partly outdated) informations in this thread. I try to provide more updated information as soon as time permits.

First time installation (consists of 2 steps)

Spoiler:

Preparation: Make sure that your reader is fully charged and generally in a good operating state (for instance, there must not be any problems with a corrupted database etc.) Switch off Wifi. You will need ca. 26 Mb of free disk space (apart from 12 Mb of KoboRoot.tgz, which will be deleted after installation). Check that enough free disk space is available on the reader.
Download the archive KBStartMenu_07inclUp4.zip to your pc and extract the content.

Step 1

1. connect the Kobo to the PC
2. copy the folder kbmenupngs to the root of the device (e.g. K:\)
3. eject safely and disconnect
4. check that the TWO images (exit_nickel.png, switchtokoreader.png) are listed in the library and their thumbnails are displayed there, and as tiles on the home screen. Only then proceed to step two.

Step 2

1. connect the Kobo device to the PC
2. copy KoboRoot.tgz to the folder .kobo of the device
3. eject safely and disconnect
4. wait until the update is finished (do not interrupt it, even if it takes some time)

Consult also the helpful guide to Adding alternative readers using Kobo Start Menu by Ken Maltby.

Installation on devices on which currently a version of KSM is running

Spoiler:

Step 1

1. Contemplate the points Preparation and Step 1 of First time installation and apply them according to circumstances.

Step 2

1. connect the Kobo device to the PC
2. copy KoboRoot.tgz to the folder .kobo of the device
3. eject safely and disconnect
4. select in KSM "handle updates" > "install update" (do NOT select "install partial update")
5. wait until the update is finished (do not interrupt it, even if it takes some time)
6. delete the subfolder kbmenu of the folder .kobo
   The location of KSM 07 is .adds/kbmenu. Do not copy usersettings.txt or any script files from the old KSM version to the new version!

KSM is by default configured to run only after every second reboot, and nickel automatically runs after every other second reboot. This is a kind of security measure in case KSM does not properly run after installation (something that cannot be excluded with future firmwares or changed hardware). After KSM has started the first time, please change this behaviour:

• select "tools" > "activate" > "set runmenu settings.msh" > "always"

Spoiler:

If there is a problem and you cannot interact with KSM, force the reader to power off (by holding the power button in the off position for 20 seconds), and power on again. Connect from nickel via usb to the pc. Change the value of "runmenu" in .adds\kbmenu\runsettings.txt to "never":

runmenu=never

You must use a unix style editor for doing this change.

After installing KSM 07 it is advisable to install all updates, which are available from this post, immediately. Visit this post frequently for further updates!

I did not yet upload a necessary update for Glo HD that fixes the rotation problem in some situations. For the time being, please do not use the KSM functions for searching and downloading Kobo FW update files, KSM functions for backing up and restoring files, or for manipulating the database. If you have to use one of those functions, set preventPickel to true. Instead of a progress animation you will see a distorted screen, but everything else should work as expected.


Be aware that downgrading the Kobo firmware without doing a factory reset might prevent nickel from running. The reason for this is that the Kobo Start Menu tries to work with all FW versions starting with 2.6.0. In order to do this it determines the currently running FW version by looking whether specific files are available on the device. After downgrading (without factory reset), version specific files of the higher firmware version are still living on the device, and this fact may result in false identification. (Changing firmwares in the range from 3.3.0 to 3.12.1 should be okay, I guess.)

The package contains materials provided by Sergey (Qt libraries), Cecell3000 (modified Qt mouse/touch driver), NiLuJe (FBGrab), KevinShort (Frontlight control), Lucas Malor (screen-refresh).

When editing .adds\kbmenu\usersettings or any other text/script files, it is important to use a unix style editor.

Further informations
Setting up a factory reset device (includes information on bypassing registration)
New location of KSM (concerns also Koreader, Kobo Launcher)
Night mode and Screensaver
Change options in configuration files
fmon and kbmenupngs
Display random html file
Power-off screen
pbchess 2015-05
start CoolReader from KSM main menu
fonts in KSM
add tiles of chess and other beta features to the nickle home screen
how to install kobo update packages
back up the internal sd with netcat
screen rotation issue on some models
initiate factory reset by script (only for emergency cases), read especially posts #1 and 9.
KSM 08 test version

Update packages:
You do not need update 1-4 if you have installed KBStartMenu_07inclUp4.zip. If you have installed an earlier version (with or without updates), apply update 4.

Spoiler:

KSM07_update001 (read the install instructions in the spoiler)
Fixes double booting and some smaller issues. The user settings (kbmenu\usersettings.txt) are being preserved. You may want to change them after updating, or delete the file so that a new one will be created by KSM.
KSM07_update002 (read the install instructions in the spoiler)
Fixes some smaller issues. Introduces the possibility to set options in the configuration files for KSM and for nickel by menu; random power off screen, improved handling of utf8 by kbmessage. (I will give some more information as soon as I have a chance.)
KSM07_update003 (read the install instructions in the spoiler)
Fixes some smaller issues. Re-introduces support for toggling nightmode (Put an image file with the name toggle_nightmode.png into the folder kbmenupngs). Introduces the possibility to set options in the configuration files for nightmode by menu.

KSM07_update004 (read the install instructions in the spoiler)
Handles pbchess-2015.05, some minor changes, includes also updates 1 to 3. If there is still a problem finishing this update on Glo HD, force it to power off by pressing the on/off button for at least 25 seconds, release the button and power on after some seconds. Future updates will handle this automatically.

Spoiler:

• copy the KSM07_updateXXX.zip (as it is, do not unzip) into .adds\kbmenu
• safely eject the device and select "usb disable.sh" (of course only, when you connected via usb enable.sh)
• (from KSM home) select "handle KSM update"
• check the displayed capacity of the battery and decide whether to continue at this point or to charge the device
• select "install KSM update"
• wait (some seconds)
• read the information that appears on the screen, tap on the middle of the screen to open the bottom menu, press "close" and wait until the device has restarted. When pressing "close", you will not see an effect immediately, but only after the device has rebooted, so be patient.

Note: If there are several update archives to install, you can copy them together into .adds\kbmenu

Uninstall KSM

Spoiler:

• extract the content of KBStartMenu_07_uninstall.zip on your pc
• copy the file KoboRoot.tgz of the folder that corresponds to your current firmware to .kobo
• select in KSM "handle update" > "install update"
• restart the device
• delete the folder kbmenu of .adds and the folder kbmenupngs

USE THIS PACKAGE AT YOUR OWN RISK!

[tshering]

In order to prevent KSM from being wiped off when you sign out from your Kobo account, the recent version is located in the folder .adds (previous versions were located in .kobo).

If you like you can also change the position of koreader and vlasovsoft (Kobo Launcher, including Cool Reader).

Koreader:
When installing Koreader, copy the folder koreader into .adds instead of .kobo. If Koreader is already installed, move the folder koreader from .kobo to .adds.

Kobo Launcher, Cool Reader:
Move the folder vlasovsoft from .kobo to .adds.
For pbchess-2015-05 cf. this post.

If you want to be able to start the Kobo Launcher from within nickel via fmon (which I do not recommend), you would have to modify the script .kobo\fmon\launcher.sh to account for the new location of the vlasovsoft folder. (If you move the folder fmon, and the script on_start.sh too to .adds, you will have to modify also the scripts on_start.sh, and etc\init.d\on-animator.sh.)

Spoiler:

If you do not care for fmon, wave the original install instructions for Kobo Launcher, and simply copy the folder vlasovsoft (which you can find inside of KoboRoot.tgz of pbchess-XXX_kobo.zip) to .adds. (Older models of Kobo Touch might however need g_ether.ko from the ppchess package in order to get usbnet working.)

[tshering]

In order to install the night mode hack and the screensaver hack just follow the usual procedure (copy the KoboRoot.tgz to .kobo). Both packages contain install routines that are superfluous when used with KSM, but that must not bother you.
The referred version of the screen saver seems not to work under FW 3.13.1. (Edit: for FW 3.15.0 and newer use the screen saver version you can findhere.)

Since update 2 (of KSM 07), there is a configuration manu available.
In order to enable the screensaver hack select in (KSM home) "configure", in the section [nickel]:
nickelpreload="/opt/cfw/preload/hook.so"
to enable night mode:
nickelpreload="/root/screenInv.so"
to enable both:
nickelpreload="/opt/cfw/preload/hook.so /root/screenInv.so"

[Reventlov]

Tested on a kobo aura H2O with software version 3.12.1 (c1198635ca), it seems to work as expected for the moment. Thank you

edit: And koreader works as expected \o/

[tshering]

Originally Posted by Reventlov

Tested on a kobo aura H2O with software version 3.12.1 (c1198635ca), it seems to work as expected for the moment. Thank you

Thank you for testing on H2O!

[booklover6]

Tested on my Kobo Aura, seems to work great! Thanks for your hard work!

[truemarine]

Tested on H2O as well and all looks very smooth. Nice work and many thanks for this special gift😁!

[Markismus]

Installed on H2O. Works fine with koreader.

Question: Only 2/3 of the height and width are used for the menu resulting in an 4 12/16 inch window. How can I change it to full screen?


EDIT: Going to the USB menu for the 1st time draws it in the lower right corner first, before going back to the upper left corner. The second time it stays in de upper left corner.

[libertango]

I am on KSM 06 and kobo 3.11. I would like to upgrade nickel firmware before installing KSM07. Is it advised to uninstall KSM 06 first?

[boriar]

Originally Posted by libertango

I am on KSM 06 and kobo 3.11. I would like to upgrade nickel firmware before installing KSM07. Is it advised to uninstall KSM 06 first?

To update firmware you don't need to uninstall KSM06. The only effect will be that KSM don't start again but if you go to install the new KSM07 don't worry about that.
After update firmware install KSM07 with first time option in OP. Them you can delete .kobo/kbmenu of old KSM06 because there's nothing to save from it.

[boriar]

@tshering
I think there's something to change in onstart/showimage.sh:

where: imgprg=/mnt/onboard/.Kobo/kbmenu/kbmessage
whould be: imgprg=/mnt/onboard/.adds/kbmenu/kbmessage

isn't it?

[tshering]

Originally Posted by Markismus

Installed on H2O. Works fine with koreader.

This is good to hear.

Originally Posted by Markismus

Question: Only 2/3 of the height and width are used for the menu resulting in an 4 12/16 inch window. How can I change it to full screen?

Please have a look at this and that post. The geometry settings go into usersettings.txt. After you found the optimal values for H20 please post them here so that I can take them as default (I actually asked already about this and got an answer, but evidently I was unable to interpret the answer correctly). And if you are already at it, could you also activate rotation in usersettings.txt, and find good geometry settings for all 4 directions (just in case the bezel does not overlap the screen on all sides symmetrically) ?

Originally Posted by Markismus

EDIT: Going to the USB menu for the 1st time draws it in the lower right corner first, before going back to the upper left corner. The second time it stays in de upper left corner.

I think this is related to the line shifting problem that you already reported with regard to H2O. I hope when you have set the geometry to full screen, it will be less noticeable.

[tshering]

Originally Posted by libertango

I am on KSM 06 and kobo 3.11. I would like to upgrade nickel firmware before installing KSM07. Is it advised to uninstall KSM 06 first?

As Boriar said, the sequence does not matter. If you install the FW with "handle update" > "install partial update", KSM 06 will stay in power. If you install it with "handle update" > "install update", KSM 06 will be disabled (but you have to delete the folder .kobo/kbmenu afterwards yourself).

[tshering]

Originally Posted by boriar

@tshering
I think there's something to change in onstart/showimage.sh:

where: imgprg=/mnt/onboard/.Kobo/kbmenu/kbmessage
whould be: imgprg=/mnt/onboard/.adds/kbmenu/kbmessage

isn't it?

Good! You are very watchful! Fortunately this script is not any longer used.

[Markismus]

Originally Posted by tshering

Please have a look at this and that post. The geometry settings go into usersettings.txt.

After the last line in usersettings.txt I've added:

ksmGeometryValuesN=748x1014+5+5
ksmGeometryValuesS=748x1014+5+5
ksmGeometryValuesE=1014x748+5+5
ksmGeometryValuesW=1014x748+5+5

After rebooting it didn't result in any change.

Looking at the koreader code

-- Kobo Aura H2O:
local KoboDahlia = Kobo:new{
    model = "Kobo_dahlia",
   ...
   ...
    -- bezel:
    viewport = Geom:new{x=0, y=10, w=1080, h=1430},

I would assume that values would become:

ksmGeometryValuesS= 1070x1430+5+5

Is this correct?