# usetrmnl/trmnl-firmware

TRMNL ePaper device firmware

Repository: https://github.com/usetrmnl/trmnl-firmware
Canonical: https://ross.abutalabs.com/products/trmnl-firmware
Homepage: https://docs.trmnl.com
Language: C
License: GPL-3.0
License Family: copyleft
Topics: e-ink, iot-device, trmnl
Last push: 2026-09-03T01:07:00+00:00

## Health v2 (maintenance only)
Score: 93/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 100, release rhythm 99, longevity 68
- inputs: {"age_days": 963, "days_push": 0, "days_rel": 6, "gap_med": 9, "n_releases_24m": 48}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1155, forks 245 (observed 2026-09-03T02:15:20.222084+00:00)

## What it is
Open-source firmware for the TRMNL e-ink display device, written in C for embedded hardware. It handles Wi-Fi provisioning via a captive portal, syncing with the TRMNL server API, OTA firmware updates, and deep-sleep power management.

## Use cases
- flash custom firmware onto a TRMNL e-ink display
- build my own e-paper dashboard device
- connect a BYOD e-ink screen to the TRMNL server
- customize e-ink device firmware behavior
- set up wifi provisioning on an esp32 e-paper display
- run an e-ink display against my own server (BYOS)

## When to choose
- you own a TRMNL device or compatible e-ink hardware and want the official or customized firmware
- you want to build your own e-paper display device that talks to the TRMNL API
- you need OTA updates, captive-portal Wi-Fi setup, and deep-sleep battery management out of the box

## When to avoid
- you want a general-purpose e-paper driver library rather than full device firmware
- you need a display solution that works fully offline without a TRMNL-compatible server
- you require a non-GPL license for derivative firmware

## Facets
- artifact type: application
- maturity: active
- function: embedded, iot, http-client
- domain: iot, embedded-systems, hardware, self-hosted
- platform: embedded, iot, cpp
- tags: e-ink, epaper, esp32, firmware, trmnl, display-device, ota-updates, wifi

## Member repositories
- usetrmnl/trmnl-firmware (main) score 93

## Provenance
- Observed fields: from GitHub, fetched 2026-09-03T02:15:20.222084+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T06:34:13.381695+00:00, confidence not recorded.
  - readme: https://github.com/usetrmnl/trmnl-firmware (fetched 2026-09-03T02:15:20.222084+00:00, sha b97bc819f6dc)
  - homepage: https://docs.trmnl.com (fetched 2026-08-29T12:39:33.093021+00:00, sha 481b60b0ad17)
  - site_page: https://docs.trmnl.com/go/plugin-marketplace/plugin-installation-flow (fetched 2026-08-29T12:39:33.102303+00:00, sha e529dce11440)
  - site_page: https://docs.trmnl.com/go/plugin-marketplace/plugin-uninstallation-flow (fetched 2026-08-29T12:39:33.104267+00:00, sha 5b82b6c34cd8)
  - site_page: https://docs.trmnl.com/go/partners-api/getting-started (fetched 2026-08-29T12:39:33.105849+00:00, sha 18c016036f3d)
- Data as of 2026-08-30T08:39:29.467469+00:00.