BrewForge Docs

BrewForge for TRMNL

What BrewForge is and how the TRMNL plugin works: connect TRMNL, pick a fermenting batch or your beer stock, preview the screen.

BrewForge is brewing software for planning, tracking, and managing beer batches. The TRMNL plugin puts key BrewForge batch and stock information on your TRMNL e-ink display.

What the Plugin Shows

Each installed BrewForge TRMNL plugin instance can show one of two screens.

The fermentation tracking screen shows:

  • selected fermenting batch
  • current gravity and temperature
  • fermentation progress toward final gravity
  • recent gravity and temperature trend
  • last updated time

The beer stock screen shows:

  • active finished beer stock
  • remaining beer by batch or beer name
  • low-stock beers first
  • total beer left
  • last updated time

Screen Examples

BrewForge TRMNL fermentation screen showing current temperature, gravity, and a gravity plus temperature trend chart

BrewForge TRMNL beer stock screen showing total beer left and stock remaining for each beer

What You Need

Plan

The TRMNL plugin is part of the Pro plan and higher. See pricing. On a lower plan, the TRMNL page in BrewForge says Part of BrewForge Pro and links to See plans.

  • a BrewForge account on the Pro plan or higher
  • a TRMNL account with the BrewForge plugin installed
  • for the fermentation screen, at least one batch in the Fermenting state
  • for the stock screen, active beer stock in BrewForge

If you are coming from Brewfather, you can import your existing batches into BrewForge first: Migrating from Brewfather.

Connect TRMNL

You add BrewForge in TRMNL, not in BrewForge. There is no API token to copy: the plugin uses TRMNL's install flow and connects to the BrewForge account you sign in with.

Open BrewForge in the TRMNL integrations directory and install it (or search for BrewForge in TRMNL's plugins).

TRMNL opens BrewForge. Sign in when asked. BrewForge connects this plugin copy to your account and sends you back to TRMNL.

Open the BrewForge settings of the plugin from TRMNL, or in BrewForge go to Settings → Integrations → TRMNL displays. Choose what the screen shows (see Set up a screen).

Click Back to TRMNL and add the plugin to your TRMNL playlist.

Until a TRMNL plugin is connected, the TRMNL page in BrewForge shows these steps under How it works, with Open TRMNL and a link to this guide.

TRMNL page in BrewForge before a TRMNL plugin is connected, with Open TRMNL and the three steps under How it works

When the install can't finish

If the connection doesn't work, BrewForge shows a short page with Back to TRMNL and TRMNL guide instead of finishing the install:

  • This install link has expired: install links from TRMNL work for 10 minutes. Start the install again in TRMNL. Your BrewForge data is untouched.
  • Couldn't finish connecting TRMNL: TRMNL didn't accept the connection. Try again in a minute. If it keeps failing, contact support and mention the time shown on the page.
  • This link didn't come from TRMNL: the page was opened without the details TRMNL sends. Install BrewForge from its TRMNL plugin page instead.

Install error page: This install link has expired, with Back to TRMNL and TRMNL guide

Set up a screen

The TRMNL page (TRMNL in the sidebar under Setup once you've connected one, or Settings → Integrations → TRMNL displays) has one tab per BrewForge plugin copy in your TRMNL account. Tabs are named the way the plugin is named in TRMNL and stay in the order you installed them. A tab with an amber dot is a fermentation screen that still needs a batch. Under the title, BrewForge shows how many screens are on your TRMNL.

Each tab has three sections: Screen, Preview and Connection.

TRMNL page with three screen tabs: Fermenter 1 shows Citra Pale Ale with the preview of the fermentation screen and the connection details

Screen

  • Shows: Fermentation (one fermenting batch with gravity and temperature over time) or Beer stock (your packaged beer, lowest stock first).
  • Batch (fermentation): click the row to open the Batch dialog. It lists your brews in the Fermenting state with batch number and a search field. Pick one and click Show this batch.
  • Amounts on the full screen (beer stock): Text or Bottle and keg icons. Smaller layouts always show text.

Batch dialog listing the fermenting brews with search

A beer stock screen with Bottle and keg icons and its preview

Every change is saved right away. The line under the title shows Saving…, then Saved. If a change can't be saved, it shows Not saved, the choice goes back to the last saved setting, and a red line says why (for example, the batch isn't fermenting anymore).

A fermentation screen without a batch is allowed: TRMNL then shows "Select a Brewforge batch" until you choose one, and the page warns you about it. If no brew is fermenting, the Batch row is disabled and the page links to Open brews: move a brew to Fermenting, then pick it here. When a batch stops fermenting, the screen needs a new batch.

Fermentation screen without a batch: Choose a batch and the warning that TRMNL shows Select a Brewforge batch

When you switch a screen to Beer stock, BrewForge keeps its batch. Switching back to Fermentation shows the same batch again, as long as it is still fermenting.

Preview

The Preview renders the screen from your saved settings, the way TRMNL will show it. Choose the device (TRMNL or TRMNL X) and the layout (Full, Half horizontal, Half vertical, Quadrant); the section bar shows the size in pixels. The preview updates after every saved change. A fermentation screen without a batch shows placeholder data.

Connection

Connection shows when TRMNL last fetched the screen and these details:

  • TRMNL plugin: the number of the plugin copy in TRMNL.
  • Last fetched: date and time of TRMNL's last fetch, or Never.
  • Times on the screen: the time zone the screen uses for its times.
  • TRMNL user: the TRMNL account the screen belongs to.

Right after an install, TRMNL plugin and TRMNL user can show Waiting for TRMNL. The screen gets its name from TRMNL when TRMNL fetches it for the first time.

Header actions

  • Back to TRMNL (when you came from TRMNL) or Open TRMNL opens this plugin's settings in TRMNL.
  • The ⋯ menu has Add or remove TRMNL screens…, which explains where that happens (see below), and TRMNL guide, which opens this page.

Add, rename or remove screens

Screens are managed in TRMNL, not in BrewForge. Each copy of the BrewForge plugin in your TRMNL account is one screen.

Add or remove TRMNL screens dialog

  • Add a screen: in TRMNL, install the BrewForge plugin once more and sign in to BrewForge when asked. The new screen shows up as its own tab. Use this for several playlist items, for example one fermentation screen and one beer stock screen.
  • Rename or remove a screen: in TRMNL, open the plugin's settings to rename it, or uninstall it. A removed screen disappears from the TRMNL page in BrewForge.

If you open a screen that was removed in TRMNL, BrewForge says it isn't connected anymore. Install the plugin again in TRMNL to bring it back.

TRMNL in Settings

Settings → Integrations → TRMNL displays opens the TRMNL page. The row shows the state at a glance: how many screens you have (for example 2 screens), how many need a batch (1 needs a batch, with an amber dot), Not connected, or Pro if your plan doesn't include TRMNL.

Settings, Integrations tab with the TRMNL displays row showing 1 needs a batch

Updating the Display

TRMNL refreshes the plugin from BrewForge on its normal playlist schedule. To change what appears, open the TRMNL page in BrewForge and change the screen or batch; the next fetch shows the change.

More About BrewForge

BrewForge helps homebrewers manage the full brewing workflow: recipes, brew days, fermentation, inventory, equipment profiles, packaging, and batch history.

Create an account at brewforge.sh.

On this page