8000 GitHub - daniyyer/kindle-dash: Power efficient dashboard for Kindle 5 NT devices · GitHub
[go: up one dir, main page]

Skip to content

About

Power efficient dashboard for Kindle 5 NT devices

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

Low-power Kindle dashboard

Turns out old Kindle devices make great, energy efficient dashboards :-)

What this repo is

This repo only contains the code that runs on the Kindle. It periodically fetches an image to be displayed on the screen and suspends the device to RAM (which is very power efficient) until the next screen update.

This code does not render the dashboard itself. It's expected that what to display on the screen is rendered elsewhere and can be fetchd via HTTP(s). This is both more power efficient and allows you to use any tool you like to produce the dashboard image.

In my case I use a dashbling dashboard that I render into a PNG screenshot on a server. See here for information on how these PNGs should be produced, including some sample code.

Prerequisites

  • A jailbroken Kindle, with Wi-Fi configured.
  • An SSH server on the Kindle (via USBNetwork)
  • Tested only on a Kindle 4 NT. Should work on other Kindle devices as well with minor modifications.

Installation

  1. Download the latest release on your computer and extract it.
  2. Modify local/fetch-dashboard.sh and optionally local/env.sh.
  3. Copy the files to the Kindle, for example: rsync -vr ./ kindle:/mnt/us/dashboard.
  4. Start dashboard with /mnt/us/dashboard/start.sh.
    Note that the device will go into suspend about 10-15 seconds after you start the dashboard.

Upgrading

If you're running kindle-dash already and want to update to the latest version follow the following steps.

  1. Download the latest release on your computer and extract it.
  2. Review the release notes. Some releases might require changes to files in local/.
  3. Copy the files to the Kindle, excluding the local directory. For example: rsync -vur --exclude=local ./ kindle:/mnt/us/dashboard.
  4. Modify files in /mnt/us/dashboard/local if applicable.
  5. Start dashboard with /mnt/us/dashboard/start.sh.
    Note that the device will go into suspend about 10-15 seconds after you start the dashboard.

KUAL

If you're using KUAL you can use simple extension to start this Dashboard

  1. Copy folder kindle-dash from KUAL folder to the kual extensions folder. (located in /mnt/us/extensions)

How this works

  • This code periodically downloads a dashboard image from an HTTP(s) endpoint.
  • The interval can be configured in dist/local/env.sh using a cron expression.
  • During the update intervals the device is suspended to RAM to save power.

Notes

  • The releases contain a pre-compiled binary of the ht command-line HTTP client. This fully supports modern HTTPS crypto, wheras the built-in curl and wget commands don't (because they rely on a very old openssl library).

Live Demo

Note: The server runs on Render free tier and may take 30-60s to wake up on first request.

UI Themes

This dashboard supports multiple themes to suit your e-ink display preferences:

  • New Theme (Default): A clean, vertical, pure-weather dashboard with a dark background and minimalist SVG icons. Highly optimized for Kindle e-ink readability.
  • Old Theme: The classic dashboard containing weather and news sections. Accessible via the ?theme=old query parameter.

Deployment

This project is configured to be deployed automatically using Render.com. Simply push your changes to the main branch on GitHub:

git add .
git commit -m "Update dashboard"
git push origin main

Render will automatically detect the push, rebuild the FastAPI server, and deploy it. The Kindle will automatically fetch the new dashboard image on its next scheduled wake cycle.

Server

The server/ directory contains a FastAPI server that renders the dashboard. See server/README.md for details.

Scheduled Updates with Trigger.dev

The trigger/ directory contains a Trigger.dev project that refreshes the dashboard every 30 minutes. This keeps the Render server active and ensures the dashboard image is always up-to-date.

Setup:

  1. cd trigger && npm install
  2. Copy .env.example to .env and add your TRIGGER_SECRET_KEY
  3. Deploy: npx trigger.dev@latest deploy

Credits

Thanks to davidhampgonsalves/life-dashboard for the inspiration!

About

Power efficient dashboard for Kindle 5 NT devices

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0