Plugin Screen Generation Flow
Creating image content to display on a user's device.
Last updated
Creating image content to display on a user's device.
Last updated
TRMNL generates a screen every X minutes, where X is the refresh frequency set by the user.
TRMNL generates screens by sending a POST request to the plugin_markup_url
endpoint you specified during . The request body will include the user_uuid
(that particular user's plugin connection UUID). The request header contains an authorization
key with the user's plugin connection access_token
as the Bearer token. Here's an example of our server request:
Your web server should respond with HTML inside root nodes named markup
, markup_quadrant
, and so on to satisfy each layout offered by TRMNL. This markup should include whatever values you want the user to see rendered on their screen.
TRMNL uses the markup in your server's response to generate an e-ink friendly image. If the user connecting your plugin created a "full screen" playlist item, TRMNL will leverage the HTML inside the markup
node. If they connected your plugin as part of a left/right Mashup, TRMNL will look for HTML inside the markup_half_vertical
node.
Here's an example of a valid server response:
Pro tip: use the markup editor to develop the frontend of your plugin. This in-browser text editor supports live refresh and automatically applies the correct styling and JavaScript helpers to your markup.
Note: in order for your plugin to be published in the TRMNL public marketplace, you must provide HTML for all available markup layouts. .