Skip to content
noobyme edited this page Jul 25, 2024 · 3 revisions

The calibre plugin supports sending documents from your calibre library using a wireless connection. It also supports searching across the calibre metadata available on the device.

1. Metadata search

TODO

2. Wireless client

To use this plugin you need to keep your PC that runs Calibre and your KOReader device in one local network usually in one router. Then start your Calibre wireless device connection as the following screenshot shows: Start calibre wireless connection

Use the default option in the popup window should be OK as for Calibre version 4.19.

After the calibre wireless device connection is established (the red indicator of the connection button changes into green), go to the plugin tab of KOReader and select "Connect" option in the "Calibre" plugin. If all things go right Koreader should say "Connected to Calibre Server at somehost:someport" and your Calibre should recognize KOReader as a wireless device like this: Connected calibre server

You can send one or more documents to your KOreader device from your Calibre Library now: Send documents to KOReader

Note that if it's the first time you run Calibre plugin, you may be prompted to choose the "Inbox" directory in which the received documents will be saved.

If your device doesn't show up but you can connect to Calibre on your ereader, your wifi is probably disabled after being inactive.


2.1 Faster sync

If you're trying to copy many files wirelessly onto your device and the process seems to be taking a long time, try navigating one directory "up" in KOReader (if you're viewing the directory into which the files are being imported). Sync will continue, but will now be significantly faster since KOReader will no longer be trying to update your list of files with every new book that's received.

This is particularly noticeable on Android.


2.2 Changing filename template

The usual way of changing filename templates doesn't work with the SmartDevice driver used for calibre wireless connection. Instead you need to customize the SmartDevice App Interface plugin directly by following these instructions.

Select "Preferences" in the Calibre toolbar, then select "Plugins" under the advanced row. calibre1

Then search for "SmartDevice", selecting SmartDevice App Interface. calibre1

Select Customize Plugin, here you can change your filename template and click ok to save your template.

calibre1

To understand how calibre's template language works see the instructions in the calibre manual: https://manual.calibre-ebook.com/template_lang.html

2.3 Compatibility between wireless and wired libraries.

None, by default. See https://github.com/koreader/koreader/issues/12062#issuecomment-2190044070

Usage

Basic reading controls (click to open)
Advanced reading controls (click to open)
Clone this wiki locally