Computer labs card

Category: Schools. Tags: Schools and campuses, Numbers and metrics.

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

Feed: screenrig.labs/v1.

Feed documents carry source attribution. The Player supplies the feed to the card.

Counts only, never who is at a workstation.

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	`"Computer labs"`	maxLength: `40`
`sort`	string	`"feed"`	`"feed"`, `"free"`	feed keeps the order given; free puts the lab with the most free workstations first.
`lowPercent`	integer	`20`	minimum: `1`; maximum: `50`	A lab with this percent or fewer of its workstations free reads Filling up.
`showPlatforms`	boolean	`true`
`showPrinters`	boolean	`true`
`staleMinutes`	integer	`10`	minimum: `1`; maximum: `1440`
`hour12`	boolean	`false`
`timeZone`	string, null	`null`

Dynamic properties

Name	Type	Default	Values and limits	Description
`labs`	array	`[]`	minItems: `0`; maxItems: `8`	The labs. A feed (screenrig.labs/v1) wins when present; the data store supplies the same rows otherwise.
`labs[].name`	string		minLength: `1`; maxLength: `40`; Required
`labs[].location`	string		maxLength: `40`	Building and room: Irving K. Barber, level 2.
`labs[].total`	integer		minimum: `0`; maximum: `2000`; Required	Workstations in the lab.
`labs[].free`	integer		minimum: `0`; maximum: `2000`	Workstations free now. Without it the card uses total minus inUse.
`labs[].inUse`	integer		minimum: `0`; maximum: `2000`
`labs[].open`	boolean	`true`
`labs[].closesAt`	string		maxLength: `32`	ISO 8601; with an offset or wall time in the screen's zone.
`labs[].opensAt`	string		maxLength: `32`	When a closed lab opens next, ISO 8601.
`labs[].platforms`	array		maxItems: `4`	Free workstations by operating system.
`labs[].platforms[].os`	string		maxLength: `20`; Required
`labs[].platforms[].free`	integer		minimum: `0`; maximum: `2000`; Required
`labs[].printers`	array		maxItems: `12`
`labs[].printers[].name`	string		maxLength: `30`
`labs[].printers[].status`	string		`"ready"`, `"low-paper"`, `"out-of-paper"`, `"low-toner"`, `"out-of-toner"`, `"jam"`, `"offline"`, `"error"`; Required
`updated`	string	`""`	maxLength: `32`	When the counts were taken, ISO 8601 (data store only; a feed carries fetchedAt).

Canvas example

Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.

{
  "id": "computer-labs",
  "primitive": "card",
  "card": "computer-labs",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "computer-labs-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/computer-labs-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"labs":[],"updated":""}}'