Skip to main content

Work with TRMNL

This guide is the single source of truth for using TRMNL with any compatible Seeed ePaper product. Pick your hardware once at each step that needs it, and the rest of the workflow is identical.

Hardware support

TRMNL officially supports the reTerminal E1001, reTerminal E1002, TRMNL 7.5" (OG) DIY Kit, and XIAO 7.5" ePaper Panel. On the E1002 content is currently rendered in monochrome mode — full-color rendering is planned for a future release.

What is TRMNL?​

TRMNL is an innovative platform designed to help people stay focused and calm in our increasingly distracting digital world. Founded in 2023, TRMNL has quickly become a leading solution for E Ink® dashboard management, offering a unique approach to displaying information without the constant notifications and distractions of traditional screens.

At its core, TRMNL is built on the philosophy that technology should enhance our lives without demanding constant attention. The platform provides an elegant way to view important information at a glance through E Ink® displays, creating a more mindful and less intrusive technological experience.

Why use TRMNL?​

  • Simplified dashboard creation: TRMNL's growing library of apps and integrations makes it easy to create custom information displays without complex programming.
  • Low power consumption: TRMNL's efficient software combined with E Ink® minimal power requirements creates an extremely energy-efficient solution.
  • Distraction-free information: Get the information you need without notifications and eye strain.
  • Regular updates: TRMNL's active development means new features and integrations are added weekly.
  • Developer-friendly: TRMNL's open API and developer tools allow custom plugins and integrations.

Compatible Hardware​

reTerminal E1001reTerminal E1002TRMNL 7.5" (OG) DIY KitXIAO 7.5" ePaper Panel
7.5" Monochrome
Integrated terminal		7.3" Spectra 6 (Color)
Integrated terminal
Mono mode in TRMNL		7.5" Mono + DIY case
XIAO ESP32-S3 Plus driver		7.5" Mono bare panel
XIAO ESP32-C3 directly
Get One Now 🖱️
Get One Now 🖱️
Get One Now 🖱️
Get One Now 🖱️

Step 1: TRMNL Account Setup and BYOD Access​

Before connecting your device to TRMNL you need a TRMNL account and BYOD (Bring Your Own Device) access — the same flow regardless of hardware.

  1. Purchase TRMNL Access

  2. Create a TRMNL Account

    • Visit TRMNL's website
    • Click on "Sign Up" to create a new account.
    • Follow the registration process.
note

Your TRMNL credentials are sensitive information. Never share them publicly or commit them to version control systems.

If you encounter any issues, contact the TRMNL team directly at [email protected].

Step 2: Hardware Setup​

The reTerminal E Series and the XIAO 7.5" Panel are pre-assembled — you only need to power them on. The TRMNL DIY Kit requires assembly.

The reTerminal E Series is fully integrated. Just connect the USB-C cable and power it on. No assembly steps are needed.

Step 3: Flash the TRMNL Firmware​

Three flashing methods are available. Method 1 (Web Flasher) is the easiest and works for all supported hardware. Method 2 (SenseCraft HMI) is exclusive to reTerminal E Series. Method 3 (Build from Source) is for advanced users.

Brand-new TRMNL DIY Kits already ship with TRMNL firmware

If you bought a brand-new TRMNL 7.5" (OG) DIY Kit, it already has TRMNL firmware preinstalled — you can skip the flashing step entirely and jump to Step 4.

The TRMNL Web Flasher works directly in the browser and supports every device on this page.

  1. Visit https://usetrmnl.com/flash.
  2. Plug in your device via USB-C and follow the on-screen instructions.
  3. Pick the firmware that matches your hardware:

Use FW 1.6.7 or newer for Seeed compatibility on reTerminal E Series.

Method 2: Flash via SenseCraft HMI Platform (reTerminal E Series only)​

info

This method is only applicable to reTerminal E1001 / E1002. The SenseCraft HMI flasher knows how to switch between SenseCraft HMI firmware and TRMNL firmware on the same device.

  1. Visit the SenseCraft HMI device page.

  2. Select your device.

  3. Choose the TRMNL firmware (you can switch back to HMI firmware here later). Click Full Flash then Flash.

  4. Connect your device to the computer and select the serial port.

  5. The screen will refresh and display the TRMNL logo and MAC address.

Method 3: Build and Flash from Source (advanced)​

  1. Clone the firmware repository

    tip

    Sometimes our PRs to TRMNL upstream are still under review. If you want the latest Seeed-side patches, use the Seeed mirror instead:

    git clone https://github.com/Seeed-Projects/Seeed_TRMNL_Eink_Project.git

  2. Install PlatformIO as a VS Code extension or via the command line.

  3. Open the project: open the cloned firmware folder in VS Code.

  4. Select the correct PlatformIO environment for your hardware:

    In platformio.ini:

    • For reTerminal E1001, select the seeed_reTerminal_E1001 environment.
    • For reTerminal E1002, select the seeed_reTerminal_E1002 environment (TRMNL renders content in monochrome on E1002).

  5. Connect your device via USB-C.

  6. Build and upload: click the PlatformIO Upload button or run:

    pio run --target upload

Step 4: Configure Wi-Fi and Provision the Device​

The Wi-Fi provisioning workflow is identical for all supported hardware.

💡 Trouble connecting Wi-Fi? See the TRMNL Device Wi-Fi Troubleshooting Guide.

Power on and enter provisioning mode​

After flashing the TRMNL firmware and powering on your device, it will automatically enter provisioning mode if it is not yet connected to Wi-Fi.

Connect to the TRMNL Wi-Fi​

On your phone or computer, open the list of available Wi-Fi networks. Look for a network named TRMNL and connect to it (no password required by default).

Open the captive portal​

Once connected, open a web browser. The device should automatically redirect you to the TRMNL configuration page; if it does not, manually visit http://4.3.2.1.

Enter your Wi-Fi credentials​

  • Select your 2.4 GHz Wi-Fi network (5 GHz networks are not supported).
  • Enter your Wi-Fi password and click Save / Connect.

⚠️ Important: make sure to use a 2.4 GHz Wi-Fi network. The ESP32-C3 / ESP32-S3 chips on these devices do not support 5 GHz networks.

Device joins your network​

The device will disconnect from the TRMNL Wi-Fi and join your home network. The captive-portal window will show the device's MAC address. Record the MAC address — you'll need it in the next step.

⚠️ Note: the MAC address is only visible in the captive portal for 1–2 seconds. If you miss it you can also:

  • Retrieve it from the VS Code → PlatformIO build/upload logs.
  • Use the usetrmnl.com/flash method and check the browser developer console during flashing.
  • Find it in your router or mesh-network app's list of connected devices.

See the official guide: Finding your TRMNL MAC address.

Step 5: Register the Device on TRMNL​

After your device is connected to Wi-Fi and you have its MAC address, register it on the TRMNL web interface:

  1. Open the TRMNL web interface at https://trmnl.app.

  2. Go to the Devices page.

  3. Add a new device (button at top right or in the page center).

  4. Enter the Device ID you received when you purchased BYOD access (this is not the MAC address — find the Device ID in your purchase confirmation email or TRMNL dashboard). Click Add new device.

  5. Bind the device's MAC address in the device settings page:

    You can also set a custom name and adjust other settings here.

Your device is now linked to your TRMNL account! You can now send playlists, images, and other content directly from the TRMNL interface.

💡 Tip: if you have multiple devices, repeat the above steps for each one using their unique Device IDs.

Disable Firmware Early Release & OTA Updates

After adding your device in the TRMNL web interface, go to the device's settings page and turn off both Firmware Early Release and OTA Updates Enabled.

If left enabled, your device may automatically download firmware updates intended for official TRMNL hardware that are not compatible with Seeed devices. Installing incompatible firmware may cause your device to malfunction or become unresponsive.

Always keep both options disabled to ensure stable operation.

Buttons Usage​

The reTerminal E Series exposes a single user-facing button under TRMNL firmware:

  • Green Button — long press 5 s: enter Wi-Fi reconfiguration mode.
  • Reset button: single click to reboot the device.

Understanding the TRMNL Playlist​

The TRMNL Playlist controls exactly what is displayed on your ePaper device and when.

Playlist overview​

  • Playlist Title: the name of your TRMNL device.
  • Display Time Range: when the playlist is active (e.g. 00:00–23:45).
  • Update Interval: how often the display refreshes (e.g. every 5 minutes).
  • Add a Group / Add a Plugin: organise the playlist into groups or add new content plugins.

Playlist items​

Each row is a screen or widget that will be shown on your device. Examples:

  1. Weather — current weather information for your location.
  2. Days Left This Year — countdown of days remaining in the current year.
  3. Custom Text — display any custom message (e.g. "Hello World").

For each item:

  • Settings (gear icon): configure the plugin's options.
  • Delete (X icon): remove the item from your playlist.
  • Preview (eye icon): preview what the screen will look like.
  • Reorder (bars icon): drag to change the order.

Smart Playlist​

At the bottom you can choose whether to automatically skip screens whose content hasn't changed. See the Smart Playlists blog post for details.

Exploring TRMNL Plugins​

Plugins are modular content blocks that can show weather, calendar events, stock prices, RSS feeds, motivational quotes, GitHub activity, and much more.

Connected plugins​

At the top of the Plugins page you see all the plugins already connected to your TRMNL account. Examples include Weather, Days Left This Year, Stock Price, RSS Feed, Reddit, Hacker News, Language Learning, Motivational Quote, Custom Text, …

Plugin marketplace​

Below your connected plugins you'll find the marketplace. Plugins are organized by categories and tags (#productivity, #news, #ecommerce, …). Browse, search, and click any plugin to connect it to your account.

Developers can also create and publish their own plugins — see the plugin marketplace docs for details.

For more advanced features see the official TRMNL documentation: https://docs.usetrmnl.com/go.

Troubleshooting​

How to reconfigure the network?​

Press and hold the Green Button for 5 seconds. The device will return to the initial TRMNL interface and activate the AP.

Web Flasher / PlatformIO can't find the device or upload fails​

Sometimes the wrong program can cause the XIAO to lose its port or not function correctly:

  • The XIAO is connected but no port number is found.
  • The XIAO is connected, the port appears, but the upload fails.

Put the XIAO into BootLoader mode to recover:

  • Step 1: press and hold the BOOT button on the XIAO ESP32-S3 / ESP32-C3 without releasing it.
  • Step 2: while still holding BOOT, connect the device to the computer via USB-C. Release BOOT after the device is connected.
  • Step 3: re-run the upload / flash. Most "device not recognised" or "upload failed" issues are solved by this.

Special Thanks​

Special thanks to the entire TRMNL team for their strong support and invaluable help across this integration. In particular we want to thank Bogdan, Ryan Kulp, Fr3d, Schappi, and all other team members for their dedication throughout development and documentation.

Their expertise made this integration possible and greatly improved the experience for the reTerminal E Series, TRMNL DIY Kit, and XIAO 7.5" ePaper Panel communities.

Resources​

Tech Support & Product Discussion​

Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs.

Loading Comments...