NickelMenu: An integrated launcher for Kobo eReaders

[Aleron Ives]

I've made another update to my battery statistics calculation script. Version 1.2 brings a few improvements:

• The v_pct divisor is now calculated automatically from v_max and v_min, rather than using a hardcoded value.
• v_now no longer displays nonsensical values like 4.8 V.

I had hoped to use bc to do proper floating-point arithmetic, but it seems that Kobo's version of BusyBox doesn't have it, so instead I've resorted to manipulating v_now, v_min, and v_max as strings, which avoids doing any actual arithmetic for the units conversion.

Remember that if you have the Libra Colour, you must replace:

/sys/class/power_supply/battery/
with
/sys/class/power_supply/bd71827_bat/

in order for the script to work. Other Kobo models may require greater changes, as some statistics may not be available.

# Battery Statistics Calculator 1.2 (2024-08-28) by Aleron Ives
#
# This script calculates battery statistics for the Kobo Libra 2.
# Check the contents of /sys/class/power_supply/ if you use a different
# model to ensure that the statistics you want to track are available.
#
# You can use NickelMenu to invoke this script like so:
# menu_item :main :Battery :cmd_output :500 :/mnt/onboard/.adds/battcalc.sh

# Gather the necessary statistics

meter=$(cat /sys/class/power_supply/battery/capacity)
v_now=$(cat /sys/class/power_supply/battery/voltage_now)
v_min=$(cat /sys/class/power_supply/battery/voltage_min)
v_max=$(cat /sys/class/power_supply/battery/voltage_max)
c_now=$(cat /sys/class/power_supply/battery/charge_now)
c_full=$(cat /sys/class/power_supply/battery/charge_full)
c_dfull=$(cat /sys/class/power_supply/battery/charge_full_design)

# Format the statistics

let c_now/=1000; let c_full/=1000; let c_dfull/=1000 # Convert to mAh
let charge=$c_now*100/$c_full     # Calculate charge percentage from mAh
let c_health=$c_full*100/$c_dfull # Calculate health percentage from mAh
let v_div=$v_max-$v_min; let v_div/=100    # Calculate charge percentage from V
let v_pct=$v_max-$v_now; let v_pct/=$v_div # "
let v_pct=100-$v_pct                       # "
v_nowr=$(echo $v_now | cut -b 2-4) # Simulate floating-point arithmetic
v_now=$(echo $v_now | cut -b 1)    # "
v_minr=$(echo $v_min | cut -b 2-3) # "
v_min=$(echo $v_min | cut -b 1)    # "
v_maxr=$(echo $v_max | cut -b 2-3) # "
v_max=$(echo $v_max | cut -b 1)    # "

# Display the results

echo Capacity: $c_now mAh / $charge% / $meter%
echo Voltage: $v_min.$v_minr V / $v_now.$v_nowr V / $v_max.$v_maxr V / $v_pct%
echo Health: $c_full mAh / $c_dfull mAh / $c_health%

If you download the attached version, remember to remove the .txt extension! The forum doesn't allow uploading text files with the .sh extension.

[bohn]

Originally Posted by silvern0va

Yeah I would prefer if we could get a new release. I tried compiling it and maybe it's because I'm on Windows but it is NOT working.

yeah, me too.

[NeoGenesisX]

Originally Posted by bohn

yeah, me too.

The lastest build from master branch, not tested yet.

https://drive.filen.io/f/d0f6be6c-e5...bUIFbgLUJuttaY

[bohn]

Originally Posted by NeoGenesisX

The lastest build from master branch, not tested yet.

https://drive.filen.io/f/d0f6be6c-e5...bUIFbgLUJuttaY

Thanks, this works.

[mooncatfairy]

Originally Posted by NeoGenesisX

The lastest build from master branch, not tested yet.

https://drive.filen.io/f/d0f6be6c-e5...bUIFbgLUJuttaY

Usage examples:
menu_item :main :Bluetooth (enable) :nickel_bluetooth :enable
menu_item :main :Bluetooth (disable) :nickel_bluetooth :disable
menu_item :main :Bluetooth (toggle) :nickel_bluetooth :toggle

[star-soup]

Hello!
I found a guide on reddit for how to use NickelMenu to create a translation feature on Kobo. However, when I try to use it, I get the following error:

/bin/sh: jq: not found

Anyone here know what this error is or how to fix it? For reference the original code to create the translation function was:

menu_item :selection eepL Translation :cmd_output :9999:/usr/bin/wget --header='Authorization: DeepL-Auth-Key $MY_KEY' --post-data='target_lang=EN&text={1|S|%}' -qO - https://api-free.deepl.com/v2/translate | jq '.translations[0].text' | fold -s -w 55

[kusanagi]

Hello everyone, I have kobo libra 2, software version 4.38.23038
I have a small problem, I already done this part

Installation

Connect your Kobo eReader to your computer over USB.
Download KoboRoot.tgz (release notes) into KOBOeReader/.kobo. You may need to show hidden files to see the folder.
Safely eject your eReader and wait for it to reboot.
Ensure there is a new menu item in the top-left main menu entitled NickelMenu (it will appear in the bottom-right on firmware 4.23.15505+).

But I'm a bit unsure what to do with this part https://github.com/pgaskin/NickelMen...v0.5.4/res/doc
That is something new for me...
I don't understand how all of this is supposed to look in the file "config" as the result, can someone with the libra 2 send me a config or nm folder file so I can understand how it's supposed to look in the end?

I want to install KOReader but as far as I understood, I first need to install NickelMenu and then install there KOReader

[DNSB]

Originally Posted by kusanagi

I want to install KOReader but as far as I understood, I first need to install NickelMenu and then install there KOReader

Basically, if you install KOReader or Plato using the One Click Packages and the install script, the entries to launch them will be placed in the .adds/nm directory. See the One-Click Install Packages for KOReader & Plato thread with the package in the first message and the installer scripts in the second message. Those packages will install KFMON, NickelMenu, KOReader and/or Plato.

My preferred method is to use the installer then uninstall KFMon and delete the kfmon, koreader and plato files in the .adds/nm directory. The attached nm_kp.txt file has the entries to run KOReader and Plato directly from NickelMenu. Simply remove the # in front the menu-item for either or both and copy the file into .adds/nm where you should see that file and the doc file.

You can find the KFMON-Uninstaller link in this Kute File Monitor: A smarter file-trigger based launcher thread.

[kusanagi]

Originally Posted by DNSB

Basically, if you install KOReader or Plato using the One Click Packages and the install script, the entries to launch them will be placed in the .adds/nm directory. See the One-Click Install Packages for KOReader & Plato thread with the package in the first message and the installer scripts in the second message. Those packages will install KFMON, NickelMenu, KOReader and/or Plato.

Well I saw that topic, but I've learned from experience and I'm not in a rush to install everything, because installing is much easier than getting rid of it later. I'm an experienced Windows user. Plato is a good reader? I need it for reading PDF books, but I was recommended KOREADER, it's the first time I've heard about Plato. I also read about cases where devices can be damaged by reading PDFs, but I was told that KOREADER is safe if properly configured.

My preferred method is to use the installer then uninstall KFMon and delete the kfmon, koreader and plato files in the .adds/nm directory. The attached nm_kp.txt file has the entries to run KOReader and Plato directly from NickelMenu. Simply remove the # in front the menu-item for either or both and copy the file into .adds/nm where you should see that file and the doc file.

Thanks, so you are recommending using a script instead of a clean installation from scratch? Is KFMon some kind of file manager? Because I need something like that as well, basic navigation by authors and series is inconvenient for me. I would also like to add some kind of folder navigation

[Ceiyne]

Originally Posted by star-soup

Hello!
I found a guide on reddit for how to use NickelMenu to create a translation feature on Kobo. However, when I try to use it, I get the following error:


Anyone here know what this error is or how to fix it? For reference the original code to create the translation function was:

This thread seems to have a solution to your issue; basically, you're missing jq and the thread says where to get it from. (I don't really know anything about this, so I don't think I'd be of further help. I just happened to see your post and I have an interest in translation stuff with the Kobo, so I did a little googling.)

https://github.com/pgaskin/NickelMen...ent-1546998211

[DNSB]

Originally Posted by kusanagi

Thanks, so you are recommending using a script instead of a clean installation from scratch? Is KFMon some kind of file manager? Because I need something like that as well, basic navigation by authors and series is inconvenient for me. I would also like to add some kind of folder navigation

The installer script does the same things you could do manually but without the risk of a typing error or skipping a step.

For folder navigation, you will need to use KOReader or Plato. Nickel does not have folder navigation. Personally, I use search since it is a lot faster than tapping my way through a directory structure. Nickel can search author, title, series, etc. while KOReader if the calibre generated metadata.calibre is present, can also do searching.

KFMon is a program launcher, for instance, you might see a KOReader png image displayed in your Kobo books. Tap on it and KFMon will launch KOReader. To learn more, check out NiLuJe's kfmon GitHub page.

[Dirk-71]

How is the command to simpy open the (general) settings

menu_item : reader: Settings : nickel_open : settings
.....doesn't work

[hatuluang]

Originally Posted by Dirk-71

How is the command to simpy open the (general) settings

menu_item : reader: Settings : nickel_open : settings
.....doesn't work

See the doc configuration of Nickelmenu line 58-68, the use of nickel_settings

#                   nickel_setting     - <action>:<setting>
#                                        action is one of:
#                                          toggle  - toggles between true/false
#                                          enable  - sets to true
#                                          disable - sets to false
#                                        setting is one of:
#                                          invert          - FeatureSettings.InvertScreen
#                                          lockscreen      - PowerSettings.UnlockEnabled (4.12.12111+)
#                                          screenshots     - FeatureSettings.Screenshots
#                                          force_wifi      - DeveloperSettings.ForceWifiOn (note: the setting doesn't apply until you toggle WiFi)
#                                          auto_usb_gadget - Automatically enable USB mass storage on connection

and line 87 - 101, the use of nickel_open

#                   nickel_open        - one of:
#                                          discover:storefront       - Kobo Store
#                                          discover:wishlist         - Wishlist
#                                          library:library           - My Books (with last tab and filter)
#                                          library:all               - Books
#                                          library:authors           - Authors
#                                          library:series            - Series (4.20.14601+)
#                                          library:shelves           - Collections
#                                          library:pocket            - Articles
#                                          library:dropbox           - Dropbox (4.18.13737+)
#                                          reading_life:reading_life - Activity (with last tab)
#                                          reading_life:stats        - Activity
#                                          reading_life:awards       - Awards
#                                          reading_life:words        - My Words
#                                          store:overdrive           - OverDrive (4.10.11655+) (note: if you don't have an active OverDrive account, it will give you a "Network Error")
#                                          store:search              - Search

ref: https://pgaskin.net/NickelMenu

[Dirk-71]

@hatuluang Ok, I don't find any command to open the settings. However thank you for your reply.

[elaeoth]

Hello guys! I have a question with the nickel menu: I recently updated from a Kobo Clara HD to a Kobo Clara BW, and even thought it seems to be axactly the same, some things don't work well.

The first thing is the landscape mode: the screen rotates, but the touch is inverted! (if I touch the upper part, the lower part reacts, very weird).

The second thing is Vlasovsoft: I used to play chess a lot with it, and now Vlasovsoft doesn't launch at all, when I click on it from the nickel menu, it just freezes the whole e-reader...

If you have any ideas on how to solve this, I would be so grateful!