DOCSEARCHbyAlgolia
Submit Docs

trmnl-kindle

repository·main·Indexed 18 days ago

https://github.com/usetrmnl/trmnl-kindle

A guide and set of resources to transform an Amazon Kindle (6th generation or later) into a TRMNL dashboard. This process involves jailbreaking the device using the WinterBreak method (for firmware versions prior to 5.18.1), installing KUAL and MRPI, and configuring the TRMNL extension via a BYOD license or BYOS client.

Tokens
1.7K
Snippets
2
Records
11
Agent score
14%

What's inside trmnl-kindle

  1. Check Kindle firmware compatibility for WinterBreak

    main

    The WinterBreak jailbreak (based on Mesquito) is NOT compatible with Kindle firmware 5.18.1 and later.

    To check your version:

    1. Open Kindle settings tray.
    2. Go to All Settings > Device options > Device info.

    If your firmware is between 5.18.1 and 5.18.5.0.1, you should use AdBreak to jailbreak instead.

  2. Jailbreak Kindle using WinterBreak

    main

    Follow these steps to jailbreak your Kindle using the WinterBreak method:

    1. Download WinterBreak: Get the latest WinterBreak.tar.gz.
    2. Enable Airplane Mode: Swipe down or tap the battery icon on your Kindle and turn on Airplane Mode.
    3. Restart Kindle: Go to All Settings > Device options > Restart.
    4. Extract and Copy Files:
      • Connect Kindle to PC.
      • Extract WinterBreak.tar.gz and copy all files to the Kindle.
      • Linux/Mac users: You must also copy the .active_content_sandbox folder. To ensure hidden files are copied on Mac, open the folder via terminal and drag the store directory into the Kindle's existing .active_content_sandbox directory.
    5. Enter Mesquito: Eject the Kindle. Open the Kindle Store (cart icon) and turn Airplane Mode off when prompted.
    6. Run WinterBreak: Click the WinterBreak icon in the Kindle store. Wait ~30 seconds for the "Finished installing jailbreak" message.
    7. Finalize: Turn Airplane Mode back on.
    # For Mac users ensuring hidden files are copied:
# Open terminal, navigate to extracted folder, and move 'store' to Kindle's sandbox
mv ./store /Volumes/Kindle/.active_content_sandbox/

  3. Install the TRMNL extension on Kindle

    main

    Once you have downloaded and unzipped the TRMNL_KINDLE_<date>.zip package, follow these steps to install it on your device:

    1. Connect Kindle: Connect your Kindle to your computer via USB and enter drag-and-drop mode.
    2. Copy Files: Copy the TRMNL_KINDLE folder (which may include a datestamp, e.g., TRMNL_KINDLE_20250415) into the extensions folder on your Kindle.
    3. Configure API Key (Required for BYOS/Example users): If you are not using the official package or are using the repository examples, you must manually provide your API Key. Create a file named apikey.txt inside the TRMNL_KINDLE directory and paste only your TRMNL API Key into it.
    4. Disconnect: Safely eject the Kindle from your computer.

  4. Install and run the Post-Jailbreak Hotfix

    main

    The hotfix is required to maintain the jailbreak and should be run after every OTA update.

    1. Download: Get Update_hotfix_universal.bin.
    2. Copy: Connect Kindle to PC, copy the .bin file to the Kindle, and delete any other .bin files present.
    3. Install: Eject Kindle. Go to All Settings > Three dots > Update Your Kindle. Confirm the update.
    4. Run: After installation, open Run Hotfix or Run Bridge from your Kindle library. The device will show a progress bar and then restart.

  5. Prerequisites for turning a Kindle into a TRMNL

    main

    Before starting the jailbreak and conversion process, ensure you have the following:

    • A PC or Mac.
    • A TRMNL BYOD license or BYOD/S client. (Note: You can achieve a 100% free DIY approach by modifying the TRMNL_KINDLE Zip to point to your own server).
    • A registered Kindle (6th generation or later).
    • A Kindle connected to WiFi.

    Important Recommendation: As of 2026, it is recommended to use the KOReader method instead, as it is faster, easier, and has a higher success rate.

  6. Download the TRMNL KUAL Package

    main

    To download the necessary software package, you need your TRMNL Device ID.

    1. Log into usetrmnl.com.
    2. Find your Device ID by clicking a device in the top-right dropdown; the ID is the numeric value in the URL (e.g., 1234).
    3. Construct and visit the following URL in a new tab to download the .zip file:

    https://usetrmnl.com/<device-id>/kindle/TRMNL_KINDLE.zip

    Note: If you are using a BYOS (Bring Your Own Server) setup without a TRMNL account, use the contents from the zip_example directory in this repository and point the URL to your local setup.

    https://usetrmnl.com/<device-id>/kindle/TRMNL_KINDLE.zip

  7. Install KUAL and MRPI on Kindle

    main

    To install KUAL (Kindle Unified Application Launcher) and MRPI (Mobile Read Package Installer):

    1. Download MRPI and KUAL: Get the KUAL-MRPI package.
    2. Select KUAL Version:
    3. Copy Files:
      • Extract MRPI and copy the extensions and mrpackages folders to the Kindle.
      • Extract KUAL and copy the .bin file into the Kindle's mrpackages folder.
    4. Run MRPI: Eject Kindle. In the Kindle search bar, type ;log mrpi and press enter. The screen may go blank while it processes.
    5. Complete: Wait for the KUAL book to appear in your library. (An "Application Error" dialog is normal).

  8. Configure Kindle device settings in TRMNL

    main

    If you are using a TRMNL account with a BYOD (Bring Your Own Device) license, you must register your Kindle in the TRMNL dashboard before installing the software.

    1. Set Device Model: Navigate to your BYOD device settings via the top-right gear icon in the TRMNL dashboard. Select your specific Kindle edition from the Device Model dropdown.
    2. Add MAC Address: In the Device Credentials section of the same page, enter your Kindle's MAC address.

    To find your Kindle MAC address: On your Kindle device, go to Settings → Device Options → Device Info (paths may vary slightly depending on model and firmware).

  11. Troubleshoot JSON fetching errors

    main

    If you encounter the error Fetching JSON... error.. Retry in 60s., it is most likely because the device is still in Airplane Mode.

    Resolution:

    1. Disable Airplane Mode on your Kindle.
    2. Re-open KUAL.
    3. Navigate to TRMNL and select Start TRMNL.