Network status card

Category: Operations. Tags: Offices and workplaces, Numbers and metrics, Alerts and status.

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

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

Shows device names and client counts only; never a client's name, address or traffic.

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	`"Network status"`	maxLength: `40`
`staleMinutes`	integer	`10`	minimum: `1`; maximum: `1440`	A feed older than this shows how long ago it updated.

Dynamic properties

Name	Type	Default	Values and limits	Description
`site`	string	`""`	maxLength: `60`	The site the network is at; the feed's wins.
`wan`	array	`[]`	maxItems: `6`	WAN links, the same document as the screenrig.network/v1 feed's `wan`.
`wan[].name`	string		minLength: `1`; maxLength: `40`; Required	The link (Fibre, Cable, 5G backup).
`wan[].status`	string	`"up"`	maxLength: `24`	up, degraded, down or updating.
`wan[].latencyMs`	number, null	`null`	minimum: `0`; maximum: `100000`
`wan[].downMbps`	number, null	`null`	minimum: `0`; maximum: `1000000`	The link's current download rate.
`devices`	array	`[]`	maxItems: `200`	Devices, the same document as the feed's `devices`.
`devices[].name`	string		minLength: `1`; maxLength: `40`; Required	The device's name.
`devices[].kind`	string	`"other"`	maxLength: `24`	ap, switch or gateway; anything else is a device.
`devices[].status`	string	`"online"`	maxLength: `24`	online, degraded, offline or updating.
`devices[].clients`	integer, null	`null`	minimum: `0`; maximum: `100000`	Clients on an access point.
`clients`	integer, null	`null`	minimum: `0`; maximum: `10000000`	Clients on the network; empty adds up the devices' clients.
`clientSeries`	array	`[]`	maxItems: `60`	Clients each minute, oldest first; the last 30 are drawn.
`downMbps`	number, null	`null`	minimum: `0`; maximum: `10000000`	Download throughput now.
`upMbps`	number, null	`null`	minimum: `0`; maximum: `10000000`	Upload throughput now.
`downSeries`	array	`[]`	maxItems: `60`	Download Mbps each minute, oldest first; the last 30 are drawn.

Canvas example

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

{
  "id": "network-status",
  "primitive": "card",
  "card": "network-status",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "network-status-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/network-status-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"site":"","wan":[],"devices":[],"clients":null,"clientSeries":[],"downMbps":null,"upMbps":null,"downSeries":[]}}'