Register Guidelines E-Books Search Today's Posts Mark Forums Read

Go Back   MobileRead Forums > E-Book Software > Calibre > Plugins

Notices

Reply
 
Thread Tools Search this Thread
Old 04-19-2013, 08:09 PM   #1
jgoguen
Generally Awesome Person
jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.
 
Posts: 947
Karma: 2071392
Join Date: Jan 2013
Location: San Francisco Bay Area
Device: Kobo Aura, Kindle Paperwhite 2
[Device Plugin] Kobo Touch Extended Driver

THIS PLUGIN IS BEING INTERMITTENTLY DEVELOPED! FEATURE REQUESTS AND BUG REPORTS MAY TAKE A FEW DAYS TO BE REPLIED TO.



This plugin enables some additional features for all Kobo devices supported by calibre from the Kobo Touch onwards. ePub books processed with this plugin will be rendered using Kobo's internal kepub renderer instead of the standard ePub renderer.



The main benefits of using the kepub renderer (which some may prefer not to have) are:


  • Page numbers show the number of page turns remaining in the current chapter instead of the estimated number of pages for the entire book.
    • If you don't want this, there is an option in the driver settings to force full-book page numbers.
  • Reading statistics (time left in this chapter, time for the next chapter, time to complete the book)
  • The book title is shown at the top of each page.
  • The chapter title, if any, is shown at the bottom of each page with the page numbers.



You are encouraged to install these two plugins as well, to ensure KePub metadata is correctly processed when sending to your Kobo device:



Usage

To use this plugin after installing:


  • Connect your Kobo Touch/Glo/Mini device and wait for it to be detected by calibre
  • Select the book(s) you want to send to your device.
  • Click the Send to device button.



Special Notes
  • This plugin requires calibre 2.60.0 or later and is only tested with calibre 3.10.
  • It is recommended that you disable the built-in KoboTouch driver (but not the built-in Kobo driver) while this plugin is installed. On rare occasions, calibre may select the built-in KoboTouch driver instead of this plugin.
  • This device plugin enables access to Kobo features that are written with the expectation that only unmodified Kobo-purchased books will be used. Kobo reserves the right to make any change at any time, including changes that will cause problems with books created using this plugin ranging from minor to severe, without notice.
  • When configuring the plugin, it is not necessary to include the '.kepub' portion of the file name; the plugin will add that automatically.
  • Modified ePub books are not saved to your calibre library in their kepub form; the kepub is only sent to your device, your copy in calibre is never modified.



Installation Directions

Open Preferences -> Plugins -> Get new plugins and install the 'Kobo Touch Extended' plugin. You may also download the attached zip file and install the plugin manually, then restart calibre as described in the Introduction to Plugins thread.



Known Issues

Not everything works perfectly all the time. Here are some of the issues I know about that are likely to stick around for a while.



Spoiler:

  • When using Kobo firmware 2.9.0 or later, sideloaded KePub files do not display full in-book statistics.
  • If you have previously installed this plugin in calibre 0.9.18 or earlier, then you upgrade to calibre 0.9.19 or later and can't update the plugin, you must close calibre and manually remove the plugin ZIP file:
    • Open the calibre plugin directory.
      • Don't know where this is? Before you close calibre, open calibre's preferences, choose Miscellaneous, and click the Open calibre configuration directory button. The plugin directory is in there.
    • Delete the file named KoboTouchExtended.zip.
    • Start calibre and re-install the plugin.
  • If you get an error similar to the following:

    Code:
    Traceback (most recent call last):
    
    File "site-packages\calibre\gui2\preferences\plugins.py", line 310, in add_plugin
    
    File "site-packages\calibre\customize\ui.py", line 361, in add_plugin
    
    File "site-packages\calibre\customize\ui.py", line 53, in load_plugin
    
    File "site-packages\calibre\customize\zipplugin.py", line 169, in load
    
    File "importlib__init__.py", line 37, in import_module
    
    File "site-packages\calibre\customize\zipplugin.py", line 147, in load_module
    
    File "calibre_plugins.kobotouch_extended.__init__", line 4
    
    ^
    
    SyntaxError: invalid syntax
    The solution is to read the README file from top to bottom
  • In some circumstances people have reported that while reading a book uploaded with this plugin they suddenly realize that a large amount of time (two hours or more) has passed without their awareness of the passage of time. The only known solution is to finish reading your current book. Voracious readers tend to report this issue more frequently. Please note, sleep is only a temporary resolution.





Contributing

Decided you want to contribute to the development of this plugin? Awesome! If you want to contribute to the development of this plugin, you have many options:


  • Contribute code, whether for existing bug reports, for new bugs that you found, or for new features that you really want to see implemented. To contribute code, you may fork the repository and send a pull request, or you may send me a PM here with a Git patch file.
  • Submit bug reports on GitHub. Although I'm happy to discuss the plugin here, I may still ask you to create a bug report; this is so I actually remember to investigate your request!
  • Test pre-released code from GitHub. Between releases, new code is committed and may be installed using directions provided in the README file. Based on your testing, you may submit bug reports, provide feedback, think of new feature requests, or just generally enjoy early access (and not necessarily stable code!) to upcoming versions of the plugin.
  • Translate the plugin on the plugin's Launchpad Translations page.



Submitting Bugs

Found an issue? Have a new feature request? Great, I want to hear from you! Go to the GitHub commit log

[/SPOILER]
Attached Files
File Type: zip KoboTouchExtended.zip (31.3 KB, 310 views)

Last edited by jgoguen; 07-15-2019 at 04:59 PM.
jgoguen is offline   Reply With Quote
Old 04-20-2013, 03:28 AM   #2
ShellShock
Wizard
ShellShock ought to be getting tired of karma fortunes by now.ShellShock ought to be getting tired of karma fortunes by now.ShellShock ought to be getting tired of karma fortunes by now.ShellShock ought to be getting tired of karma fortunes by now.ShellShock ought to be getting tired of karma fortunes by now.ShellShock ought to be getting tired of karma fortunes by now.ShellShock ought to be getting tired of karma fortunes by now.ShellShock ought to be getting tired of karma fortunes by now.ShellShock ought to be getting tired of karma fortunes by now.ShellShock ought to be getting tired of karma fortunes by now.ShellShock ought to be getting tired of karma fortunes by now.
 
ShellShock's Avatar
 
Posts: 1,146
Karma: 2361736
Join Date: Sep 2008
Device: IPad Mini 2 Retina
thanks. When using this plugin, is the title bar displayed when reading, as usual with kepubs but not with epubs?
ShellShock is offline   Reply With Quote
Old 04-20-2013, 04:21 AM   #3
jgoguen
Generally Awesome Person
jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.
 
Posts: 947
Karma: 2071392
Join Date: Jan 2013
Location: San Francisco Bay Area
Device: Kobo Aura, Kindle Paperwhite 2
The title bar is another kepub feature. I don't believe I can disable it.
jgoguen is offline   Reply With Quote
Old 04-20-2013, 10:43 AM   #4
buffaloseven
Watching the Sky
buffaloseven ought to be getting tired of karma fortunes by now.buffaloseven ought to be getting tired of karma fortunes by now.buffaloseven ought to be getting tired of karma fortunes by now.buffaloseven ought to be getting tired of karma fortunes by now.buffaloseven ought to be getting tired of karma fortunes by now.buffaloseven ought to be getting tired of karma fortunes by now.buffaloseven ought to be getting tired of karma fortunes by now.buffaloseven ought to be getting tired of karma fortunes by now.buffaloseven ought to be getting tired of karma fortunes by now.buffaloseven ought to be getting tired of karma fortunes by now.buffaloseven ought to be getting tired of karma fortunes by now.
 
buffaloseven's Avatar
 
Posts: 234
Karma: 634112
Join Date: Sep 2012
Location: Winnipeg, MB
Device: Kobo Aura
So just out of curiosity, Calibre plugins are entirely python-based (just making sure I'm not missing anything)? If so I could definitely contribute code from time to time. Seems like container.py is the part Calibre talks to and driver.py does the heavy lifting?

The plugin is great; so far I've had no troubles with annotations or bookmarks, but that's probably just as likely to be luck of the draw with my .epub structures. Also, thanks for so quickly addressing the issue with car/cbz files.
buffaloseven is offline   Reply With Quote
Old 04-20-2013, 06:25 PM   #5
jgoguen
Generally Awesome Person
jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.
 
Posts: 947
Karma: 2071392
Join Date: Jan 2013
Location: San Francisco Bay Area
Device: Kobo Aura, Kindle Paperwhite 2
Yes, so far as I'm aware, plugins are purely Python. For me, container.py is the interface to the unpacked ePub structure, and it's where I do most of the book modification work, and driver.py does the rest of the heavy lifting. There is some modification (hyphenation mostly) outside container.py but I plan to work on moving that around later.
jgoguen is offline   Reply With Quote
Old 04-22-2013, 05:00 AM   #6
Moonraker
Addict
Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.
 
Moonraker's Avatar
 
Posts: 305
Karma: 1002965
Join Date: Mar 2006
Location: UK
Device: ILiad. Gen 3, PocketBook 360, Kobo Aura HD, Kindle Oasis 2
How do I disable the main Kobo driver when I am installing this plugin?

Calibre tells me it cannot be disabled.

Am I selecting the correct one to disable?
Moonraker is offline   Reply With Quote
Old 04-22-2013, 07:38 AM   #7
bookwurm70
Addict
bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.
 
bookwurm70's Avatar
 
Posts: 256
Karma: 89314
Join Date: Nov 2009
Location: Southern Illinois
Device: eSlick, Pocketbook IQ, iPad, Kobo Aura
Extended plugin question

Okay, so I've downloaded the kobo extended plugin. How do I use it? Will the resulting kepubs say kepub? Will I be able to use the kepub on my iPad/iPhone?
bookwurm70 is offline   Reply With Quote
Old 04-22-2013, 07:44 AM   #8
jgoguen
Generally Awesome Person
jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.
 
Posts: 947
Karma: 2071392
Join Date: Jan 2013
Location: San Francisco Bay Area
Device: Kobo Aura, Kindle Paperwhite 2
Quote:
Originally Posted by Moonraker View Post
How do I disable the main Kobo driver when I am installing this plugin?

Calibre tells me it cannot be disabled.

Am I selecting the correct one to disable?
First, make sure you don't have your Kobo device plugged in while you're doing this.

Then, in calibre open Preferences -> Plugins and look under the Device Interface Plugins list for Kobo Reader Device Interface and KoboTouch. For each one, select it and click the Enable/Disable plugin button. As long as your device isn't plugged in, they should be disabled.
jgoguen is offline   Reply With Quote
Old 04-22-2013, 07:54 AM   #9
jgoguen
Generally Awesome Person
jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.
 
Posts: 947
Karma: 2071392
Join Date: Jan 2013
Location: San Francisco Bay Area
Device: Kobo Aura, Kindle Paperwhite 2
Quote:
Originally Posted by bookwurm70 View Post
Okay, so I've downloaded the kobo extended plugin. How do I use it?
To use the plugin, you just send books to your Kobo device.

Quote:
Originally Posted by bookwurm70 View Post
Will the resulting kepubs say kepub?
On the Kobo device, yes the modified books are identified as KOBO EPUB while unmodified ePub files are identified as EPUB. If you mean in calibre, then no they aren't identified in any way because the kepub version is never saved to your calibre library.

Quote:
Originally Posted by bookwurm70 View Post
Will I be able to use the kepub on my iPad/iPhone?
I don't know if you can use the generated kepubs on your iOS app. I don't see why not, but it's not something that I've tested. If you would like to try it and report back on how it worked, there may be other people who would also like to know.
jgoguen is offline   Reply With Quote
Old 04-22-2013, 08:24 AM   #10
bookwurm70
Addict
bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.bookwurm70 considers 'yay' to be a thoroughly cromulent word.
 
bookwurm70's Avatar
 
Posts: 256
Karma: 89314
Join Date: Nov 2009
Location: Southern Illinois
Device: eSlick, Pocketbook IQ, iPad, Kobo Aura
Quote:
Originally Posted by jgoguen View Post
First, make sure you don't have your Kobo device plugged in while you're doing this.

Then, in calibre open Preferences -> Plugins and look under the Device Interface Plugins list for Kobo Reader Device Interface and KoboTouch. For each one, select it and click the Enable/Disable plugin button. As long as your device isn't plugged in, they should be disabled.
Thanks! I disabled the other Kobo plugins. Now all I need is for my Aura to arrive and I'm ready to side load!
bookwurm70 is offline   Reply With Quote
Old 04-22-2013, 08:31 AM   #11
davidfor
Grand Sorcerer
davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.davidfor ought to be getting tired of karma fortunes by now.
 
Posts: 16,970
Karma: 26408020
Join Date: Jul 2011
Location: Sydney, Australia
Device: Kobo:Touch,Glo,Aura H2O,Glo HD,Aura ONE,Clara HD,Forma;tolino epos
Quote:
Originally Posted by bookwurm70 View Post
Thanks! I disabled the other Kobo plugins. Now all I need is for my Aura to arrive and I'm ready to side load!
Sorry, you aren't ready. The drivers don't support the Aura HD yet. The next calibre release should include the changes needed.
davidfor is online now   Reply With Quote
Old 04-22-2013, 08:47 AM   #12
jgoguen
Generally Awesome Person
jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.jgoguen ought to be getting tired of karma fortunes by now.
 
Posts: 947
Karma: 2071392
Join Date: Jan 2013
Location: San Francisco Bay Area
Device: Kobo Aura, Kindle Paperwhite 2
This plugin explicitly only supports the Kobo Touch, Kobo Glo, and Kobo Mini. I don't have an Aura to test with so any updates to my plugin will have to be done by someone else with an Aura, or someone will have to send me an Aura.

EDIT: And by "explicitly only supports", I mean that this plugin will completely fail to recognize any other devices. Once the mainline Kobo driver includes Aura support, you will have to use the mainline driver and not my plugin to use calibre to send books over.

Last edited by jgoguen; 04-22-2013 at 08:51 AM.
jgoguen is offline   Reply With Quote
Old 04-22-2013, 11:10 AM   #13
Moonraker
Addict
Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.Moonraker ought to be getting tired of karma fortunes by now.
 
Moonraker's Avatar
 
Posts: 305
Karma: 1002965
Join Date: Mar 2006
Location: UK
Device: ILiad. Gen 3, PocketBook 360, Kobo Aura HD, Kindle Oasis 2
Thank you for these instructions. I have now got it to work.

I am very pleased that the problematic fonts (Nickel etc) are now working as they should and not showing italics as regular bold.

I am also pleased that my own installed fonts are showing their true weight instead of appearing anaemic and thin. The Advanced option is not available but it's no matter because my own fonts display their weight and I can still adjust font-size, line spaces and margins.

I'm not sure about the page numbers only showing number of pages left in a chapter but I can live with this because of the other advantages. I love that the title of the book is displayed in the header.

So one very happy customer here, Thank you.

Last edited by Moonraker; 04-22-2013 at 11:12 AM.
Moonraker is offline   Reply With Quote
Old 04-26-2013, 09:02 AM   #14
Mingyar
Connoisseur
Mingyar is a marvel to beholdMingyar is a marvel to beholdMingyar is a marvel to beholdMingyar is a marvel to beholdMingyar is a marvel to beholdMingyar is a marvel to beholdMingyar is a marvel to beholdMingyar is a marvel to beholdMingyar is a marvel to beholdMingyar is a marvel to beholdMingyar is a marvel to behold
 
Posts: 84
Karma: 11824
Join Date: Feb 2013
Device: Kobo Mini/Aura H2O/Aura One LE / Tea Inkpad 3
Hello jgoguen,

Does the plugin work with the new kobo driver of Calibre 0.9.28 ?

What's new for 0.9.28 :
Kobo driver: Add support for the new Kobo Aura HD and firmware version 2.5.0

Thanks
Mingyar is offline   Reply With Quote
Old 04-26-2013, 09:06 AM   #15
Canuck_in_Japan
Wizard
Canuck_in_Japan ought to be getting tired of karma fortunes by now.Canuck_in_Japan ought to be getting tired of karma fortunes by now.Canuck_in_Japan ought to be getting tired of karma fortunes by now.Canuck_in_Japan ought to be getting tired of karma fortunes by now.Canuck_in_Japan ought to be getting tired of karma fortunes by now.Canuck_in_Japan ought to be getting tired of karma fortunes by now.Canuck_in_Japan ought to be getting tired of karma fortunes by now.Canuck_in_Japan ought to be getting tired of karma fortunes by now.Canuck_in_Japan ought to be getting tired of karma fortunes by now.Canuck_in_Japan ought to be getting tired of karma fortunes by now.Canuck_in_Japan ought to be getting tired of karma fortunes by now.
 
Canuck_in_Japan's Avatar
 
Posts: 1,451
Karma: 11067907
Join Date: May 2009
Location: Tokyo, Japan
Device: Aura, Aura H2O, Kindle PW3
Quote:
Originally Posted by jgoguen View Post
[*]It is recommended that you disable the built-in Kobo drivers while this plugin is installed. On rare occasions, calibre may select the built-in driver instead of this plugin.
Thank you for this. I see looking at Calibre, I have Kobo Reader Device Interface and KoboTouch plugins. Should I be disabling both of those?
Canuck_in_Japan is offline   Reply With Quote
Reply

Tags
error, kobo aura one

Thread Tools Search this Thread
Search this Thread:

Advanced Search

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
Kobo Device Driver Update davidfor Devices 284 05-24-2019 05:24 PM
[Device Plugin] Kindle 2, 3, 4, Touch Device Interface MBP Update Mod cryzed Plugins 7 10-28-2012 04:58 PM
[Device Interface Plugin] Update for Nook Color Driver jmricker Plugins 0 10-22-2011 10:11 AM
Touch Kobo Touch Extended 2 Year Warranty - Is it worth the $34.99? EverC Kobo Reader 11 08-31-2011 11:47 PM
Touch Kobo Touch Extended Warranty Program SensualPoet Kobo Reader 1 07-17-2011 04:08 AM


All times are GMT -4. The time now is 11:06 AM.


MobileRead.com is a privately owned, operated and funded community.