BYOS

Buy a TRMNL device, then point it at your own server.

First, purchase a TRMNL from our home page.

Next, follow along this 10 minute video to bootstrap your own server client with ~zero coding required.

BYOS - Open Source TRMNL Project

Update following this video's release —

Modifying firmware is no longer required. Simply set a custom base URL from the WiFi Captive Portal while provisioning credentials during Step 2, here.

Why BYOS?

TRMNL intends to ensure that every device is un-brickable and can run with zero external dependencies.

Implementations

Below is a list of servers in various languages/frameworks you can use to self-host and connect your devices to:

• TRMNL Terminus (Ruby + Hanami) - Our flagship application.

• TRMNL Ruby + Sinatra - Our original implementation.

• TRMNL Elixir + Phoenix

• Community Python + Django

• Community PHP + Laravel

• Community Next.js

Feature Parity

The following documents the feature parity between BYOS and our own hosted solution. This allows you to compare/contrast accordingly. The goal isn't for BYOS to match parity with our hosted solution but to provide enough of a pleasant solution for your own customized experience. There are trade offs either way but we've got you covered for whatever path you wish to travel. 🎉

Legend

Use this legend to understand the matrix of features below.

• ⚪️ Planned.

• 🟢 Supported.

• 🟡 Partially supported.

• 🔴 Not supported, not implemented, or isn't applicable.

Matrix

The following shows what is and isn't supported between the BYOS and Hosted solutions.

Feature	BYOS	Hosted
Dashboard	🟡	🟢
Plugins	⚪️	🟢
Playlists	🟡	🟢
Image Previews	⚪️	🟢
Recipes	🔴	🟢
Devices	🟢	🟢
Account Management	🔴	🟢
JSON Data API	🟢	🟢
Open Source Components	🟡	🟡
Docker	🟢	🔴

⚠️ Not all BYOS implementations are the same. Some will offer different features or the same features with additional customization. We plan to provide a specification, in the future, that provides the base requirements for all BYOS solutions to adhere to.

API

At a minimum, the following API endpoints should be supported for all BYOS implementations:

Display

curl "http://byos.local/api/display" \
     -H 'ID: <redacted>' \
     -H 'Access-Token: <redacted>' \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json'

Images

curl -X "POST" "http://byos.local/api/images" \
    -H 'ID: <redacted>' \
    -H 'Access-Token: <redacted>' \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d $'{
 "image": {
   "content": "<p>Demo</p>"
   "file_name": "demo"
 }
}'

Logs

curl "http://byos.local/api/log" \
     -H 'ID: <redacted>' \
     -H 'Access-Token: <redacted>' \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json'

Setup

curl "https://byos.local/api/setup/" \
    -H 'ID: <redacted>' \
    -H 'Access-Token: <redacted>' \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'