Set up device | TRMNL Octri Demo

3 parameters

IDstringrequired

Device MAC Address (eg. 41:B4:10:39:A1:24)

Modelstringrequired

DEVICE_MODEL from firmware definitions

Panel-Revstringoptional

Identifier of the ePaper panel fitted to the device

1 status code

200Success

api_keystringoptional

friendly_idstringoptional

image_urlstringoptional

messagestringoptional

statusintegeroptional

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

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

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

{
  "api_key": "abc-123",
  "friendly_id": "ABC-123",
  "image_url": "https://trmnl.com/images/system_screens/setup_logo/og_plus.png",
  "message": "Register at trmnl.com/start with Device ID 'ABC-123'",
  "status": 200
}

Request

Response