[Device Plugin] Kobo Touch Extended Driver

jgoguen · 04-19-2013, 09:09 PM

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.

Please see the README file for the most current details. I will try to keep this post up to date, but the README is always up to date.

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:

KePub Metadata Reader - https://www.mobileread.com/forums/sh...d.php?t=261009
KePub Metadata Writer - https://www.mobileread.com/forums/sh...d.php?t=261010

Usage
To use this plugin after installing:

Connect your Kobo 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 5.0.0 or later!
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.
[/SPOILER]

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 Transifex page.

Although I'm generally perfectly happy to discuss possible issues here, any issues sent to me through any means other than the Github bug tracker (including email, PM, etc.) may be silently ignored. This is not because I don't care! It's because I have a terrible memory, the Github issue tracker is my "to-do list" for this plugin, and there's been instances where I've seen a post or PM here and promptly forgotten all about it until I happened to stumble across the post again later. If you aren't sure if you have an issue, feel free to post here and we can work together to decide if you need to make a new Github issue or not. If you are sure you have an issue, or if you have an error or exception from calibre, post a new issue. It isn't necessary to post here when you make a new issue, I get notified of all new bugs and I check the list regularly. The worst that could possibly happen on Github is the same that could happen here: I'll tell you that it's not a bug and you'll have the opportunity to convince me otherwise!

Version History

Spoiler:

ShellShock · 04-20-2013, 04:28 AM

thanks. When using this plugin, is the title bar displayed when reading, as usual with kepubs but not with epubs?

jgoguen · 04-20-2013, 05:21 AM

The title bar is another kepub feature. I don't believe I can disable it.

buffaloseven · 04-20-2013, 11:43 AM

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.

jgoguen · 04-20-2013, 07:25 PM

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.

Moonraker · 04-22-2013, 06:00 AM

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?

bookwurm70 · 04-22-2013, 08:38 AM

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?

jgoguen · 04-22-2013, 08:44 AM

Quote:

Originally Posted by Moonraker

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 · 04-22-2013, 08:54 AM

Quote:

Originally Posted by bookwurm70

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

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

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.

bookwurm70 · 04-22-2013, 09:24 AM

Quote:

Originally Posted by jgoguen

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!

davidfor · 04-22-2013, 09:31 AM

Quote:

Originally Posted by bookwurm70

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.

jgoguen · 04-22-2013, 09:47 AM

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.

Moonraker · 04-22-2013, 12:10 PM

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.

Mingyar · 04-26-2013, 10:02 AM

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

Canuck_in_Japan · 04-26-2013, 10:06 AM

Quote:

Originally Posted by jgoguen

[*]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?

04-22-2013, 08:38 AM	#7
bookwurm70 Addict Posts: 265 Karma: 89314 Join Date: Nov 2009 Location: Southern Illinois Device: eSlick, Pocketbook IQ, iPad, Kobo Aura, Kobo Aura ONE	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?

04-22-2013, 09:47 AM	#12
jgoguen Generally Awesome Person Posts: 1,090 Karma: 2178847 Join Date: Jan 2013 Location: /dev/kmem Device: Kobo Clara HD, Kindle Oasis	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 09:51 AM.

04-22-2013, 12:10 PM	#13
Moonraker Addict Posts: 314 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 12:12 PM.

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

04-20-2013, 04:28 AM	#2
ShellShock Wizard Posts: 1,177 Karma: 2431850 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?

04-20-2013, 05:21 AM	#3
jgoguen Generally Awesome Person Posts: 1,090 Karma: 2178847 Join Date: Jan 2013 Location: /dev/kmem Device: Kobo Clara HD, Kindle Oasis	The title bar is another kepub feature. I don't believe I can disable it.

04-20-2013, 11:43 AM	#4
buffaloseven Watching the Sky Posts: 239 Karma: 634112 Join Date: Oct 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.

04-20-2013, 07:25 PM	#5
jgoguen Generally Awesome Person Posts: 1,090 Karma: 2178847 Join Date: Jan 2013 Location: /dev/kmem Device: Kobo Clara HD, Kindle Oasis	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.

04-22-2013, 06:00 AM	#6
Moonraker Addict Posts: 314 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?

04-26-2013, 10:02 AM	#14
Mingyar Connoisseur Posts: 93 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

Advert

Advert