TRMNL Octri Demo
GET/api/display

Get the next screen for a device

Retrieves the next screen instructions for a device using its device API key. Supply the Access-Token header and, when available, device telemetry headers; Special-Function must be one of the listed values.

22 parameters
Access-Tokenstringrequired
The device API key used to identify the device.
Battery-Voltagenumberoptional
The device battery voltage.
Percent-Chargednumberoptional
The device's percentage charged.
Battery-Countnumberoptional
The number of batteries in the device.
Battery-Chargingnumberoptional
Indicates whether the device is plugged into power.
Battery-Healthnumberoptional
The device battery's health value.
Battery-Currentnumberoptional
The device battery current.
Battery-Tempnumberoptional
The device battery temperature in Celsius.
Battery-Capacitynumberoptional
The ratio of current battery capacity to maximum capacity.
USB-Connectedstringoptional
Indicates whether the device is connected to power via USB.
WiFi-Bandstringoptional
The Wi-Fi band the device is connected to: 2.4 or 5.
Panel-Revstringoptional
The identifier of the ePaper panel fitted to the device.
FW-Versionstringoptional
The device firmware version.
FW-Commitstringoptional
The firmware commit hash for the development channel.
RSSInumberoptional
The device's received signal strength indicator.
Heightstringoptional
The device screen height.
Widthstringoptional
The device screen width.
Special-Functionstringoptional
Runs the button-configured function when set to true, or the named function: identify, sleep, restart_playlist, rewind, send_to_me, guest_mode, or refresh.
Allowed:trueidentifysleeprestart_playlistrewindsend_to_meguest_moderefresh
BASE64booleanoptional
Indicates whether to use the image encoding function.
Sensorsstringoptional
Environmental sensor data from the device.
Image-Cachedstringoptional
Indicates whether the device served the previous image from cache.
Wake-Timeintegeroptional
The number of seconds the device was awake during the last cycle.

1 status code
200Returns a JSON object with the requested action, filename, firmware and image URLs, refresh rate, firmware reset or update instructions, special function, and status.
actionstringoptional
filenamestringoptional
firmware_urlstringoptional
image_urlstringoptional
refresh_rateintegeroptional
reset_firmwarebooleanoptional
special_functionstringoptional
statusintegeroptional
update_firmwarebooleanoptional

Error handling

The Access-Token header is required and must contain the device API key. If you provide Special-Function, its value must be one of: true, identify, sleep, restart_playlist, rewind, send_to_me, guest_mode, or refresh.