Device API

Fetch the next screen

get/api/display

Request

  • Base URL: https://trmnl.com
  • URL: https://trmnl.com/api/display
  • Auth: none declared. Required headers: Access-Token

Headers

Access-Tokenstring required

Device API Key (eg. abc-123)

Battery-Voltagenumber

Device battery voltage (eg. 3.7)

Percent-Chargednumber

Device percent charged (eg. 69.4)

Battery-Countnumber

Number of batteries in device (e.g. 1-2)

Battery-Chargingnumber

Whether device is plugged into power (eg. true)

Battery-Healthnumber

Quality of battery (eg. -1-100)

Battery-Currentnumber

Battery current (eg. -1-N)

Battery-Tempnumber

Battery temperature in celsius (eg. -1-N)

Battery-Capacitynumber

Ratio of current / max capacity (eg. -1/-1 in fault case)

USB-Connectedstring

Whether device is plugged into power via USB ("true" or "false")

WiFi-Bandstring

WiFi band the device is connected on ("2.4" or "5")

Panel-Revstring

Identifier of the ePaper panel fitted to the device

FW-Versionstring

Device firmware version (eg. 0.0.1)

FW-Commitstring

Device firmware commit hash, for the development channel (eg. a14914c)

RSSInumber

Device RSSI (eg. -69)

Heightstring

Device screen height (eg. 480)

Widthstring

Device screen width (eg. 800)

Special-Functionstring

Run a special function: true for the one set for the button, or a function name:

  • true
  • identify
  • sleep
  • restart_playlist
  • rewind
  • send_to_me
  • guest_mode
  • refresh
BASE64boolean

Encode image function (eg. true)

Sensorsstring

Environmental sensor data

Image-Cachedstring

Whether the device served the previous image from cache (eg. true / false)

Wake-Timeinteger

Seconds the device was awake during the last cycle (eg. 12)

Response

Success

statusinteger
image_urlstring nullable
filenamestring nullable
refresh_rateinteger
reset_firmwareboolean
update_firmwareboolean
firmware_urlstring nullable
special_functionstring
actionstring nullable

Example response

{
  "status": 200,
  "image_url": "https://trmnl.com/images/system_screens/setup_logo/og_plus.png",
  "filename": "setup-logo.bmp",
  "refresh_rate": 300,
  "firmware_url": "https://trmnl.com/firmware/1.0.0.bin",
  "special_function": "identify",
  "action": "identify"
}

Changes

No recorded changes to this operation across all 1 revision of this API.