Live-Karte
Kategorie: Betrieb. Tags: Büros und Arbeitsplätze, Zahlen und Kennzahlen, Warnungen und Status.
Layouts
Diese Vollbildkarte füllt den gesamten Bildschirm im Quer- oder Hochformat und wird nicht als Ecke, Chip oder Streifen platziert.
Layouts: voll. Formulare: Querformat, Hochformat.
Kartenlayouts, Designs und Veröffentlichung. Karten durchsuchen.
Daten und Datenschutz
Feed: screenrig.network/v1.
Feed-Dokumente tragen Quellenangaben. Der Player liefert den Feed an die Karte.
Zeigt nur Gerätenamen und Clientzahlen an; niemals den Namen, die Adresse oder den Datenverkehr eines Clients.
Eigenschaften
Für Thema, Hintergrund, Akzent und Position siehe Gemeinsame Eigenschaften.
Legen Sie statische Eigenschaften in den params der Karte fest, wenn Sie sie erstellen. Ihr Datendokument enthält nur dynamische Eigenschaften. Verschachtelte Zeilen beschreiben den Inhalt ihrer übergeordneten Eigenschaft.
Statische Eigenschaften
| Name | Typ | Standard | Werte und Grenzwerte | Beschreibung |
|---|---|---|---|---|
title | string | "Network status" | maxLength: 40 | |
staleMinutes | integer | 10 | Minimum: 1; Maximum: 1440 | Ein Feed, der älter ist als dieser Wert, zeigt an, wie lange die letzte Aktualisierung zurückliegt. |
backgroundColor | String, Null | null | Muster: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Überschreibt den Kartenhintergrund und die Platte mit einer flachen, CSS-geordneten Farbe. #RRGGBBAA gibt die Deckkraft an. Hintergrund none hat Vorrang. |
textColor | String, Null | null | Muster: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Überschreibt die Haupt- und Sekundärtextfarben. Akzent- und semantische Statusfarben behalten ihre Funktion. |
Dynamische Eigenschaften
| Name | Typ | Standard | Werte und Grenzwerte | Beschreibung |
|---|---|---|---|---|
site | string | "" | maxLength: 60 | Der Standort des Netzwerks; die Gewinne des Feeds. |
wan | array | [] | maxItems: 6 | WAN-Verbindungen, dasselbe Dokument wie der screenrig.network/v1-Feed wan. |
wan[].name | string | minLength: 1; maxLength: 40; Pflichtfeld | Die Verbindung (Glasfaser, Kabel, 5G-Backup). | |
wan[].status | string | "up" | maxLength: 24 | Up, degraded, down oder updating. |
wan[].latencyMs | Zahl, Null | null | Minimum: 0; Maximum: 100000 | |
wan[].downMbps | Zahl, Null | null | Minimum: 0; Maximum: 1000000 | Die aktuelle Downloadrate der Verbindung. |
wan[].since | string | "" | maxLength: 40 | ISO-8601-Zeitpunkt, zu dem sich der Status zuletzt änderte. Primetime spielt die Änderung (ein Blitz, Ringe, ein Bauchbinde) für einige Sekunden ab diesem Zeitpunkt ab. |
wan[].was | string | "" | maxLength: 24 | Der Status vor since. Solange since noch vor der Uhr des Bildschirms liegt, zeigt der Artikel diesen Status. |
devices | array | [] | maxItems: 200 | Geräte, dasselbe Dokument wie der Feed devices. |
devices[].name | string | minLength: 1; maxLength: 40; Pflichtfeld | Der Name des Geräts. | |
devices[].kind | string | "other" | maxLength: 24 | ap, Switch oder Gateway; alles andere ist ein Gerät. |
devices[].status | string | "online" | maxLength: 24 | Online, verschlechtert, offline oder aktualisiert. |
devices[].clients | Integer, null | null | Minimum: 0; Maximum: 100000 | Kunden an einem Zugangspunkt. |
devices[].since | string | "" | maxLength: 40 | ISO-8601-Zeitpunkt, zu dem sich der Status zuletzt änderte. Primetime spielt die Änderung (ein Blitz, Ringe, ein Bauchbinde) für einige Sekunden ab diesem Zeitpunkt ab. |
devices[].was | string | "" | maxLength: 24 | Der Status vor since. Solange since noch vor der Uhr des Bildschirms liegt, zeigt der Artikel diesen Status. |
clients | Integer, null | null | Minimum: 0; Maximum: 10000000 | Kunden im Netzwerk; leer summiert die Clients der Geräte. |
clientSeries | array | [] | maxItems: 60 | Kunden jede Minute, älteste zuerst; die letzten 30 werden angezeigt. |
downMbps | Zahl, Null | null | Minimum: 0; Maximum: 10000000 | Download-Durchsatz jetzt. |
upMbps | Zahl, Null | null | Minimum: 0; Maximum: 10000000 | Aktueller Upload-Durchsatz. |
downSeries | array | [] | maxItems: 60 | Download-Mbps jede Minute, älteste zuerst; die letzten 30 werden dargestellt. |
Canvas-Beispiel
Speichern Sie die statischen Eigenschaften als params.json und erstellen Sie die Karte. Das Ergebnis enthält ihre crd_ ID.
{
"theme": "neomustard"
}
screenrig card create --type network-status --major 1 --file params.json
Fügen Sie diesen Eintrag den primitives einer Playlist-Seite hinzu, mit dieser ID anstelle der Beispiel-ID. Veröffentlichen Sie die Playlist und weisen Sie einen Bildschirm zu.
{
"id": "network-status",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
Live-Daten schreiben
Schreiben Sie das Dokument nach dem Erstellen in die Karte und ersetzen Sie es dann, um den Bildschirm ohne erneute Veröffentlichung zu aktualisieren. Die Karte prüft jeden Schreibvorgang gegen ihre dynamischen Eigenschaften und lehnt ein Dokument ab, das sie nicht akzeptiert. Verwenden Sie dasselbe Projekt wie die Playlist.
Speichern Sie das Dokument als card-data.json. Die CLI liest das Dokument selbst, ohne Wrapper:
{
"site": "",
"wan": [],
"devices": [],
"clients": null,
"clientSeries": [],
"downMbps": null,
"upMbps": null,
"downSeries": []
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
Oder rufen Sie die API direkt auf. Die API verpackt dasselbe Dokument in ein document-Feld. Ein Agent-Token benennt bereits sein Projekt, daher wird kein Projekt-Header gesendet; wenn Sie ScreenRig-Project senden, muss es zum Token-Projekt passen. Stellen Sie Ihre API-Autorisierung über die Umgebung bereit; siehe API-Authentifizierung.
curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "Content-Type: application/json" \
--data '{"document":{"site":"","wan":[],"devices":[],"clients":null,"clientSeries":[],"downMbps":null,"upMbps":null,"downSeries":[]}}'