Fetch the current device screen

1 parameter

Access-Tokenstringrequired

The device API key used to identify the device.

1 status code

200Returns the current screen details, including its filename, image URL, refresh rate, render time, and status.

filenamestringoptional

image_urlstringoptional

refresh_rateintegeroptional

rendered_atstringoptional

statusintegeroptional

Error handling

The Access-Token header must contain the device API key.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.current.list();

{
  "filename": "setup-logo.bmp",
  "image_url": "https://trmnl.com/images/system_screens/setup_logo/og_plus.png",
  "refresh_rate": 300,
  "rendered_at": "2023-01-01T00:00:00Z",
  "status": 200
}

Request

Response

Errors