Study rooms card

Category: Schools. Tags: Schools and campuses, Wayfinding and directories, Queues and waits.

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.rooms/v1.

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

Times only: booking titles and names never show.

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	`"Study rooms"`	maxLength: `40`
`minFreeMinutes`	integer	`20`	minimum: `0`; maximum: `240`	A room free for less than this reads as booked soon, not free.
`opensAt`	string	`""`	maxLength: `5`	When the library opens, HH:MM in the screen's zone. Empty: always open.
`closesAt`	string	`""`	maxLength: `5`	When the library closes, HH:MM. Rooms read free until then; empty: until the day's end.
`sort`	string	`"free"`	`"free"`, `"feed"`	free puts the room free the longest first; feed keeps the order given.
`showSeats`	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
`rooms`	array	`[]`	maxItems: `60`	The rooms. A feed (screenrig.rooms/v1) wins when present; the data store supplies the same rows otherwise.
`rooms[].name`	string		minLength: `1`; maxLength: `40`; Required
`rooms[].floor`	string		maxLength: `24`	Level 2.
`rooms[].capacity`	integer		minimum: `1`; maximum: `500`	Seats.
`rooms[].events`	array		maxItems: `60`	The room's bookings. Titles and names never show.
`rooms[].events[].start`	string		maxLength: `32`; Required	ISO 8601; with an offset or wall time in the screen's zone.
`rooms[].events[].end`	string		maxLength: `32`	Without it a booking lasts an hour.
`updated`	string	`""`	maxLength: `32`	When the bookings were read, 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": "study-rooms",
  "primitive": "card",
  "card": "study-rooms",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "study-rooms-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/study-rooms-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"rooms":[],"updated":""}}'