Category: Food and drink. Tags: Restaurants and cafes, Queues and waits, Countdowns and timers.
Previews
Views and forms
Views: canvas, corner, chip. Canvas forms: landscape, portrait, square, strip.
Card views, themes and publishing. Browse the gallery.
Data and privacy
This card uses its configured properties and live card data.
Properties
For theme, background, accent and position, see Common properties.
Set static properties in params. Bind data to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in params. Nested rows describe the contents of their parent property.
Static properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
title | string | "Kitchen" | maxLength: 30 | |
station | string | "" | maxLength: 24 | Shows only the items of this station (and tickets that have one); empty shows every item. |
warnMinutes | number | 6 | minimum: 0.5; maximum: 120 | A ticket this old turns amber. |
lateMinutes | number | 10 | minimum: 0.5; maximum: 240 | A ticket this old turns red and counts as late. |
Dynamic properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
tickets | array | [] | maxItems: 60 | |
tickets[].id | string | "" | maxLength: 40 | |
tickets[].number | string | "" | maxLength: 10 | |
tickets[].type | string | "" | maxLength: 20 | dine-in, pickup, delivery, drive-thru or curbside; other text shows as given. |
tickets[].ref | string | "" | maxLength: 24 | A table or a first name. |
tickets[].firedAt | string | "" | maxLength: 40 | ISO 8601 instant the ticket reached the kitchen; it drives the timer and the colour. |
tickets[].status | string | "" | "", "new", "cooking", "ready", "bumped" | ready shows READY in place of the timer; bumped leaves the board and is counted. |
tickets[].note | string | "" | maxLength: 60 | For example an allergy. |
tickets[].items | array | maxItems: 30; Required | ||
tickets[].items[].qty | integer | 1 | minimum: 1 | |
tickets[].items[].name | string | minLength: 1; maxLength: 60; Required | ||
tickets[].items[].mods | string or array | "" | anyOf: [{"type":"string","maxLength":80},{"type":"array","maxItems":8,"items":{"type":"string","maxLength":40}}] | |
tickets[].items[].station | string | "" | maxLength: 24 | The station that makes the item; a station display shows only its own items. |
Canvas example
Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.
{
"id": "kitchen-display",
"primitive": "card",
"card": "kitchen-display",
"major": 1,
"params": {
"theme": "neomustard"
},
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"layer": 0,
"content_fit": "fill",
"data": "kitchen-display-main"
}Write live data
Create this document before showing the card, then replace it to update the screen without republishing. Use the same project as the playlist. Supply your API authorization through the environment; see API authentication.
curl --request PUT "https://api.screenrig.ai/api/card-data/kitchen-display-main" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "ScreenRig-Project: $SCREENRIG_PROJECT" \
--header "Content-Type: application/json" \
--data '{"document":{"tickets":[]}}'