trmnl/api-docs
0
0
Fork 0
mirror of https://github.com/usetrmnl/api-docs.git synced 2026-08-13 23:18:08 -07:00
Code Issues Packages Projects Releases Wiki Activity

GITBOOK-209: No subject

Browse Source
This commit is contained in:
Ryan Kulp
2026-03-13 19:54:41 +00:00
committed by gitbook-bot
parent 799aeeac36
commit 2146a422b4
2 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitbook/assets/TRMNL-playlist-items.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 108 KiB

diy/byod-s.md
+12 -12
View File
@@ -4,11 +4,11 @@ description: Bring your own device, and build your own server for the device to
# BYOD/S
In the BYOD/S model, the only TRMNL IP is our [open source firmware](https://github.com/usetrmnl/firmware). Technically we don't owe you an explanation to get up and running, but we'll provide one anyway. ;)
In the BYOD/S configuration, the only TRMNL IP is our [open source firmware](https://github.com/usetrmnl/firmware).
### Device setup
See our [BYOD guide](byod.md) for instructions to build a device that's compatible with our firmware.
See our [alternate screens](https://github.com/usetrmnl/#alternative-screens-and-clients) and [BYOD guide](byod.md) for instructions to jailbreak or build a device that's compatible with our firmware.
### Server quickstart
@@ -20,13 +20,13 @@ The TRMNL web server generates PNG images. When a device pings our [Display API]
}
```
For several ready-made OSS server implementations, see [BYOS Implementations](https://docs.trmnl.com/go/diy/byos#implementations). To develop your own server that is TRMNL firmware compatible out of the box:
For ready-made OSS server clients, see [BYOS Implementations](https://docs.trmnl.com/go/diy/byos#implementations). To develop your own server that is TRMNL firmware compatible out of the box:
1. [build a device](byod.md)
2. change the base URL to your own server or local network from the WiFi Captive Portal
3. mimic the `api/setup` and `api/display` endpoints per our [firmware README](https://github.com/usetrmnl/firmware)
4. follow our [ImageMagick guide](imagemagick-guide.md) to create TRMNL firmware compatible images
5. profit
1. [Build or jailbreak a device](byod.md)
2. Change the base URL to your own server or local network from the WiFi Captive Portal
3. Mimic the `api/setup` and `api/display` endpoints per our [firmware README](https://github.com/usetrmnl/firmware)
4. Follow our [ImageMagick guide](imagemagick-guide.md) to create TRMNL firmware compatible images
5. Profit(?)
### Other infrastructure
@@ -34,14 +34,14 @@ In the quickstart above we glossed over a critical element: "next-in-queue" imag
At TRMNL we use a Playlists table to manage the ordering of plugin instances, letting users drag/drop different items in whatever sequence they prefer.
<figure><img src="../.gitbook/assets/trmnl-playlist-drag-drop.png" alt=""><figcaption><p>Drag/Drop Playlists UI</p></figcaption></figure>
<figure><img src="../.gitbook/assets/TRMNL-playlist-items.png" alt=""><figcaption><p>Drag/Drop Playlists UI</p></figcaption></figure>
Each item in a device's Playlist is an instance\* of a Plugin, something we call a PluginSetting.
Each item in a Playlist is an _instance_ of a Plugin, which we call a PluginSetting.
This keeps our Plugins table immutable, for example Google Calendar is just a name, icon, and form field parameters. Meanwhile details about a _connection_ to Google Calendar are stored inside a PluginSetting record. Keep this in mind as you build your own server -- do you want to allow multiple connections to the same parent plugin?
TRMNL also offers a [Scheduler](https://app.gitbook.com/u/m0dkWlfTUdWGp1iNjs5aX2kHq1F3). This makes it easy to dictate conditions for when and why a given plugin is displayed on your device.
TRMNL also offers a [Scheduler](https://help.trmnl.com/en/articles/11663305-playlist-scheduler). This makes it easy to dictate conditions for when and why a given plugin is displayed on your device.
<figure><img src="../.gitbook/assets/TRMNL-playlist-scheduler.png" alt="Scheduler in action"><figcaption><p>Playlist scheduler in action</p></figcaption></figure>
Following our architecture is unnecessary for a self-hosted e-ink dashboard, but we do encourage you to check out those which have already been implemented in [BYOS clients](byos.md).
Following our architecture is unnecessary for a self-hosted ePaper dashboard, but we do encourage you to check out those which have already been implemented in [BYOS clients](byos.md).