Get mashup options for a device

2 parameters

device_idintegerrequired

The integer identifier of the device to retrieve mashup options for.

mashup_idintegeroptional

The integer identifier of a mashup to use when retrieving compatible options.

1 status code

200Returns the available preset layouts and compatible plugin settings for the device.

dataobjectoptional

Error handling

The device_id path parameter must be an integer identifying the device whose options to retrieve. If supplied, mashup_id must be an integer identifying the mashup to use for context.

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

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

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

{
  "data": {
    "layouts": [
      {
        "columns": 1,
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Example Name",
        "rows": 1,
        "sections": [
          {
            "column": 1,
            "column_span": 1,
            "position": "example_value",
            "row": 1,
            "row_span": 1
          }
        ]
      }
    ],
    "plugins": [
      {
        "compatible_layouts": [
          "example_value"
        ],
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Example Name",
        "plugin_name": "Example Name"
      }
    ]
  }
}

Request

Response

Errors