Planes overhead card

Category: Public information. Tags: Transit and travel, Weather and environment, Lobbies and reception.

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

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

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	`"Planes overhead"`	maxLength: `40`
`maxDistanceKm`	integer	`30`	minimum: `2`; maximum: `300`	Aircraft farther than this are left out; it is also the dial's outer ring.
`count`	integer	`6`	minimum: `3`; maximum: `12`	Most aircraft in the list beside the nearest.
`units`	string	`"metric"`	`"metric"`, `"imperial"`, `"aviation"`	metric: km, m, km/h. imperial: mi, ft, mph. aviation: nm, ft, kt.
`staleMinutes`	integer	`5`	minimum: `1`; maximum: `1440`
`hour12`	boolean	`false`

Dynamic properties

Name	Type	Default	Values and limits	Description
`aircraft`	array	`[]`	minItems: `0`; maxItems: `100`	Aircraft near the screen. A feed (screenrig.aircraft/v1) wins when present; the data store supplies the same rows otherwise.
`aircraft[].id`	string		maxLength: `40`
`aircraft[].callsign`	string		minLength: `1`; maxLength: `12`; Required
`aircraft[].registration`	string		maxLength: `12`
`aircraft[].type`	string		maxLength: `40`	Aircraft type, for example Boeing 787-9.
`aircraft[].operator`	string		maxLength: `60`
`aircraft[].from`	string		maxLength: `8`	Origin airport code.
`aircraft[].to`	string		maxLength: `8`	Destination airport code.
`aircraft[].fromCity`	string		maxLength: `40`
`aircraft[].toCity`	string		maxLength: `40`
`aircraft[].altitudeFt`	number		minimum: `-1500`; maximum: `70000`
`aircraft[].speedKt`	number		minimum: `0`; maximum: `2000`
`aircraft[].headingDeg`	number		minimum: `0`; maximum: `360`
`aircraft[].bearingDeg`	number		minimum: `0`; maximum: `360`	Bearing from the screen to the aircraft.
`aircraft[].distanceKm`	number		minimum: `0`; maximum: `1000`	Ground distance from the screen.
`aircraft[].verticalFpm`	number		minimum: `-10000`; maximum: `10000`
`aircraft[].onGround`	boolean	`false`
`updated`	string	`""`	maxLength: `32`	When the positions were fetched, 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": "planes-overhead",
  "primitive": "card",
  "card": "planes-overhead",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "planes-overhead-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/planes-overhead-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"aircraft":[],"updated":""}}'