TRMNL BYOS (Bring-Your-Own-Server) - Phoenix

This is a standalone "bring-your-own-server" for TRMNL devices.

Whether you have official TRMNL hardware or have built your own, you can re-flash the firmware and point at a self-hosted server like this one.

It's a standard Phoenix application with support for multiple TRMNL devices. A playlist rotates through a screen playlist, automatically advancing every 15 minutes. puppeteer-img renders screens in a headless browser, and ImageMagick converts the screenshots to 1-bit bitmaps for display.

Setup

Prerequisites:

• puppeteer-img
• ImageMagick

To start your Phoenix server:

• Run mix setup to install and setup dependencies
• Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

Now you can visit localhost:4000 from your browser to add your first device.

Modules to check out

• Trmnl.Inventory.Device - Ecto schema
• Trmnl.Inventory - device management
• Trmnl.Playlist - device playlist management
• Trmnl.Screen - screen rendering
• Trmnl.ScreenGenerator - GenServer for periodically re-rendering screens
• Trmnl.Screens.HelloWorld - a basic example screen
• TrmnlWeb.APIController - the device endpoint
• TrmnlWeb.ScreenController and TrmnlWeb.ScreenHTML - renders a device's current screen as HTML, which is screenshot by puppeteer-img

Looking for another language?

• usetrmnl/byos_sinatra (Ruby)