Simulate a device's coming check-ins, deciding each one the way a

2 parameters

device_idintegerrequired

Device id

hoursintegeroptional

How far ahead to simulate, 1 to 48. Defaults to 24

3 status codes

200The simulated steps

dataobjectoptional

401Unauthorized

errorstringoptional

404Device belongs to another user

errorstringoptional

Error handling

A 401 is returned: Unauthorized. A 404 is returned: Device belongs to another user.

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

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

const result = await client.forecast.list({
  deviceId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  hours: "example",
});

{
  "data": {
    "steps": [
      {
        "at": "example_value",
        "name": "Example Name",
        "playlist_item_id": "550e8400-e29b-41d4-a716-446655440000",
        "plugin_setting_id": "550e8400-e29b-41d4-a716-446655440000",
        "reason": "example_value",
        "refresh_rate_seconds": 1,
        "refresh_seconds": 1,
        "render_at": "example_value",
        "render_reason": "example_value"
      }
    ]
  }
}

Request

Response

Errors