Koreader HF?

[andreimuscvasi]

The plugin is amazing, it works on the pw2 or regular versions of koreader, but since I have a kindle PW5SE i had to jailbreak it using winterbreak so I use the koreader hf (hard float) version.

I tried about 4-5 different forks of the original AskGPT plugin and all of them seem to have an issue with the API calls or something of the nature saying "Error: Failed to connect to Gemini api - code:wantread". The API config is correct and the same exact copy-pasted plugin works on non HF versions of koreader. Any idea why that might be?

[omer-faruq]

Thanks for the feedback. Unfortunately, I don't have a suitable device to test this.

[andreimuscvasi]

I completeley forgot I asked this question. It's fine, I managed to fix it :)

[Xytronix]

Let me know how we can assist you

[andreimuscvasi]

That is exactly where it was crashing for me as well, but now it's fixed. I forgot what I did to make it work, but I believe I changed the gemini.lua file to use curl requests and then fallback on HTTPS, and also some more error handling.

[omer-faruq]

@andreimuscvasi, if you can share your revised files in some way, it would be great. ( If it does not break the plugin for non-kf format, I'll update the current code so that it will work on all systems.) I'm happy that you fixed your issue anyway.

[szymonpiechowiak]

That is exactly where it was crashing for me as well, but now it's fixed. I forgot what I did to make it work, but I believe I changed the gemini.lua file to use curl requests and then fallback on HTTPS, and also some more error handling.

Hey, could you share compatible files with HF version, please?

[andreimuscvasi]

Yes, sorry about the delay. Here is my gemini.lua file, that was the only thing I modified from what I can remember, and you can maybe try and adapt the curl requests to any of the other providers maybe? I am not sure if/how that would work.

local BaseHandler = require("api_handlers.base")
local https = require("ssl.https")
local ltn12 = require("ltn12")
local json = require("json")
local socket = require("socket")
local logger = require("logger")
local Device = require("device")

local GeminiHandler = BaseHandler:new()

-- Add fallback HTTP request function
function GeminiHandler:makeRequest(url, headers, body)
    logger.dbg("Attempting Gemini API request:", {
        url = url,
        headers = headers,
        body_length = #body
    })
    
    -- Try using curl first (more reliable on Kindle)
    if Device:isKindle() then
        local tmp_request = "/tmp/gemini_request.json"
        local tmp_response = "/tmp/gemini_response.json"
        
        -- Write request body
        local f = io.open(tmp_request, "w")
        if f then
            f:write(body)
            f:close()
        end
        
        -- Construct curl command with proper options for Kindle
        local curl_cmd = string.format(
            'curl -k -s -X POST -H "Content-Type: application/json" '..
            '--connect-timeout 30 --retry 2 --retry-delay 3 '..
            '--data-binary @%s "%s" -o %s',
            tmp_request, url, tmp_response
        )
        
        logger.dbg("Executing curl command:", curl_cmd)
        local curl_result = os.execute(curl_cmd)
        logger.dbg("Curl execution result:", curl_result)
        
        -- Read response
        local response = nil
        f = io.open(tmp_response, "r")
        if f then
            response = f:read("*all")
            f:close()
            logger.dbg("Curl response length:", #response)
        else
            logger.warn("Failed to read curl response file")
        end
        
        -- Cleanup
        os.remove(tmp_request)
        os.remove(tmp_response)
        
        if response then
            return true, response
        end
    end
    
    -- Fallback to standard HTTPS if curl fails
    logger.dbg("Attempting HTTPS fallback request")
    local responseBody = {}
    local success, code, headers_response = https.request({
        url = url,
        method = "POST",
        headers = headers,
        source = ltn12.source.string(body),
        sink = ltn12.sink.table(responseBody),
        timeout = 30,
        verify = "none", -- Disable SSL verification for Kindle
    })
    
    logger.warn("HTTPS request details:", {
        success = success,
        code = code,
        response_headers = headers_response,
        response_length = responseBody and #table.concat(responseBody) or 0,
        error_type = type(code),
        error_message = tostring(code)
    })
    
    if success then
        return true, table.concat(responseBody)
    end
    
    -- Log detailed error information
    local error_info = {
        error_type = type(code),
        error_message = tostring(code),
        ssl_loaded = package.loaded["ssl"] ~= nil,
        https_loaded = package.loaded["ssl.https"] ~= nil,
        socket_loaded = package.loaded["socket"] ~= nil,
        device_info = {
            is_kindle = Device:isKindle(),
            model = Device:getModel(),
            firmware = Device:getFirmware(),
        }
    }
    
    logger.warn("Gemini API request failed with details:", error_info)
    return false, code
end

function GeminiHandler:query(message_history, config)
    if not config or not config.api_key then
        return "Error: Missing API key in configuration"
    end

    -- Gemini API requires messages with explicit roles
    local contents = {}
    local systemMessage = nil

    for i, msg in ipairs(message_history) do
        -- First message is treated as system message
        if i == 1 and msg.role ~= "user" then
            systemMessage = {
                role = "user",
                parts = {{ text = msg.content }}
            }
        else
            table.insert(contents, {
                role = "user",
                parts = {{ text = msg.content }}
            })
        end
    end

    -- If a system message exists, insert it at the beginning
    if systemMessage then
        table.insert(contents, 1, systemMessage)
    end

    local requestBodyTable = {
        contents = contents,
        safety_settings = {
            { category = "HARM_CATEGORY_SEXUALLY_EXPLICIT", threshold = "BLOCK_NONE" },
            { category = "HARM_CATEGORY_HATE_SPEECH", threshold = "BLOCK_NONE" },
            { category = "HARM_CATEGORY_HARASSMENT", threshold = "BLOCK_NONE" },
            { category = "HARM_CATEGORY_DANGEROUS_CONTENT", threshold = "BLOCK_NONE" }
        }
    }

    local requestBody = json.encode(requestBodyTable)
    
    local headers = {
        ["Content-Type"] = "application/json"
    }

    local gemini_settings = config.provider_settings and config.provider_settings.gemini or {}
    local model = gemini_settings.model or "gemini-1.5-pro-latest"
    local base_url = gemini_settings.base_url or "https://generativelanguage.googleapis.com/v1beta/models/"
    
    local url = string.format("%s%s:generateContent?key=%s", base_url, model, config.api_key)
    logger.dbg("Making Gemini API request to model:", model)
    
    local success, response = self:makeRequest(url, headers, requestBody)

    if not success then
        logger.warn("Gemini API request failed:", {
            error = response,
            model = model,
            base_url = base_url:gsub(config.api_key, "***"), -- Hide API key in logs
            request_size = #requestBody,
            message_count = #message_history
        })
        return "Error: Failed to connect to Gemini API - " .. tostring(response)
    end

    local success, parsed = pcall(json.decode, response)
    
    if not success then
        logger.warn("JSON Decode Error:", parsed)
        return "Error: Failed to parse Gemini API response"
    end
    
    if parsed and parsed.candidates and parsed.candidates[1] and 
       parsed.candidates[1].content and parsed.candidates[1].content.parts and
       parsed.candidates[1].content.parts[1] then
        return parsed.candidates[1].content.parts[1].text
    else
        return "Error: Unexpected response format from Gemini API"
    end
end

return GeminiHandler

[omer-faruq]

Thanks for sharing the file. I just updated all the handlers using this pattern. I tested the current form on Kobo Forma, Kindle Touch, and an Android device (except Ollama ); hopefully, nothing broke on these devices. Now, we need tests on Kindle devices that use the HF version.

[Steve-Data]

It may be user error on my part, but I tried the new files on my Kindle PaperWhite 5 (2021), and the same as it was doing before, when I select text and then hit the Assistant button, it quits out of Koreader. I see the following in the crash.log:

03/15/25-15:36:01 INFO Inhibiting user input
03/15/25-15:36:01 INFO Looking for plugins in directory: plugins
03/15/25-15:36:03 INFO Restoring user input handling
./luajit: plugins/assistant.koplugin/dialogs.lua:255: attempt to index field 'features' (a nil value)
stack traceback:
plugins/assistant.koplugin/dialogs.lua:255: in function 'showChatGPTDialog'
plugins/assistant.koplugin/main.lua:38: in function 'callback'
frontend/ui/network/manager.lua:647: in function 'runWhenOnline'
plugins/assistant.koplugin/main.lua:33: in function 'callback'
frontend/ui/widget/buttontable.lua:81: in function 'callback'
frontend/ui/widget/button.lua:482: in function 'handleEvent'
frontend/ui/widget/container/inputcontainer.lua:266: in function 'handleEvent'
frontend/ui/widget/container/widgetcontainer.lua:83: in function 'propagateEvent'
frontend/ui/widget/container/widgetcontainer.lua:101: in function 'handleEvent'
frontend/ui/widget/container/widgetcontainer.lua:83: in function 'propagateEvent'
frontend/ui/widget/container/widgetcontainer.lua:101: in function 'handleEvent'
...
frontend/ui/widget/container/widgetcontainer.lua:101: in function 'handleEvent'
frontend/ui/widget/container/widgetcontainer.lua:83: in function 'propagateEvent'
frontend/ui/widget/container/widgetcontainer.lua:101: in function 'handleEvent'
frontend/ui/uimanager.lua:896: in function 'sendEvent'
frontend/ui/uimanager.lua:53: in function 'default'
frontend/ui/uimanager.lua:1423: in function 'handleInputEvent'
frontend/ui/uimanager.lua:1523: in function 'handleInput'
frontend/ui/uimanager.lua:1567: in function 'run'
./reader.lua:265: in main chunk
[C]: at 0x00013ea9
lipc-wait-event exited normally with status: 0

Thanks for working on this!

[Steve-Data]

I did a fresh install from the newest repository, including copying a new 'configuration.lua' from the fresh 'configuration.lua.sample'.

Now, when I highlight text and hit the 'Assistant' button, I do get a popup "Ask a question about the highlighted text". But when I enter text into the box and hit "Ask", Koreader quits.

I now see the following in crash.log:

03/16/25-12:13:28 INFO Inhibiting user input
03/16/25-12:13:28 INFO Looking for plugins in directory: plugins
03/16/25-12:13:30 INFO Restoring user input handling
./luajit: plugins/assistant.koplugin/gpt_query.lua:56: attempt to concatenate local 'provider' (a nil value)
stack traceback:
plugins/assistant.koplugin/gpt_query.lua:56: in function 'queryChatGPT'
plugins/assistant.koplugin/dialogs.lua:286: in function 'action'
frontend/ui/uimanager.lua:1001: in function '_checkTasks'
frontend/ui/uimanager.lua:1447: in function 'handleInput'
frontend/ui/uimanager.lua:1567: in function 'run'
./reader.lua:265: in main chunk
[C]: at 0x00013ea9
lipc-wait-event exited normally with status: 0

I did copy the 'configuration.lua' from the current 'configuration.lua.sample' from the updated repo. The only changes I made were adding api keys and changing the provider in Line 3 (I tried both 'gemini' and 'deepseek', both with the same results). Eventually I will change the instances of 'Turkish' to 'English' but I left them as Turkish for now in order to make as few changes as possible.

Thanks again for all your efforts on this!

[omer-faruq]

Did you write gemini as "gemini" ( with double quotes), or just gemini (without double quotes) ?

It should be like this: (within double quotes, also don't delete the comma at the end of it)

local CONFIGURATION = {
    -- Choose your preferred AI provider: "anthropic", "openai", "gemini", "openrouter" or "deepseek"
    provider = "gemini",

BTW, If everything is OK, you should have an assistant popup like this one with the default setup (not just "ask" and "cancel" buttons):

[Steve-Data]

Yes, with double quotes and keeping the comma, for example:

local CONFIGURATION = {
-- Choose your preferred AI provider: "anthropic", "openai", "gemini", "openrouter", "deepseek" or "ollama"
provider = "gemini",

Screenshot also below.

I have also now tried openai with the same results.

On my assistant popup, I only see the "ask" and "cancel" buttons, as seen in the attached screenshot.

[Xytronix]

@omer-faruq I got it working after troubleshooting with the help of AI.

I will make a PR

[NewsGuyTor]

@Xytronix - PR soon?

[Stiruam14]

I am running into the exact same issue on my new PW6SE.

[omer-faruq]

Thanks for the feedback. If the error is like "Error: Failed to connect to Gemini api - code:wantread, " please ensure that you downloaded the code from the repository, not the release. I mean please use the Code> Download ZIP button.