Mashups

Add a mashup to a device playlist

Splits one screen between plugin settings. getDevice lists the layouts the device can show and the positions each layout has. The 1x1 layout adds a plain playlist item instead of a mashup.

post/api/devices/{device_id}/mashups

Request

  • Base URL: https://trmnl.com
  • URL: https://trmnl.com/api/devices/{device_id}/mashups
  • Auth: HTTP bearer

Path parameters

device_idinteger required

Device id

Request body

layout'1x1' | '1Tx1B' | '1Lx1R' | '1Tx2B' | '2Tx1B' | '1Lx2R' | '2Lx1R' | '2x2' | '3x3' required

One of the layouts getDevice lists for the device

contentsobject required

Plugin setting id by position; a position left out renders empty

Response

Added to the playlist

Example response

{
  "data": {
    "created_at": "2023-10-01T12:00:00Z",
    "configuration_state": "configured",
    "device_id": 1,
    "id": 1,
    "mashup_id": 1,
    "mirror": true,
    "plugin": {
      "id": 1,
      "name": "Weather",
      "keyname": "weather"
    },
    "plugin_id": 1,
    "plugin_setting": {
      "id": 1,
      "name": "My Plugin Setting",
      "description": "Upcoming train departures",
      "plugin_id": 1,
      "refresh_interval": 60,
      "icon_url": "https://trmnl-public.s3.com/qwertyasdf",
      "icon_content_type": "image/png",
      "strategy": "webhook"
    },
    "plugin_setting_id": 1,
    "rendered_at": "2023-10-01T12:00:00Z",
    "row_order": 1,
    "updated_at": "2023-10-01T12:00:00Z",
    "visible": true,
    "palette_id": "bw",
    "font_family": "classic",
    "text_scale": "large",
    "theme": "dark"
  }
}

Changes

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