KuroshiroUnleash your TRMNL

An open-source, self-hosted BYOS server for TRMNL e-ink devices. One Docker image with the API and admin UI, plus your own Postgres.

Try the live demo

Get started

GitHub

A Device's Screens in the Kuroshiro admin UI

Auto provisioning

Enter the server URL on a Device's Wi-Fi setup page and it shows up the moment it calls in. Rename, reset, tweak refresh rates and trigger Special Functions from there.

Devices

Screens galore

Upload images, fetch links, write HTML with a live preview, or combine Plugins into Mashups. Gate any Screen to a day/time Schedule.

Screens

Plugins and Recipes

Poll external APIs through multiple named Data Sources or accept pushed Webhooks, render with Liquid, or import a Recipe straight from trmnl.com.

Plugins

Alerts

A periodic sweep watches for low battery, offline Devices and failing Data Sources, and notifies you through an Apprise sidecar.

Alerts

Firmware & Device Models

Every panel size and colour depth TRMNL sells, synced daily. Official or custom Firmware, blocked unless it fits the Device's model.

Firmware & Device Models

Metrics and a Device Simulator

Scrape battery, Wi-Fi, Sensor and Alert gauges with Prometheus, and poll as any Device without hardware.

Prometheus Metrics