Tarjeta en vivo
Categoría: Operaciones. Etiquetas: Oficinas y lugares de trabajo, Números y métricas, Alertas y estado.
Diseños
Esta tarjeta de pantalla completa llena toda la pantalla en modo horizontal o vertical y no se coloca como esquina, chip o tira.
Diseños: completo. Formularios: horizontal, vertical.
Diseños, temas y publicación de tarjetas. Explorar las tarjetas.
Datos y privacidad
Feed: screenrig.network/v1.
Los documentos del feed llevan atribución de la fuente. El Player suministra el feed a la tarjeta.
Muestra solo nombres de dispositivos y conteos de clientes; nunca el nombre, dirección o tráfico de un cliente.
Propiedades
Para tema, fondo, acento y posición, consulte Propiedades comunes.
Establezca las propiedades estáticas en los params de la tarjeta al crearla. Su documento de datos solo contiene propiedades dinámicas. Las filas anidadas describen el contenido de su propiedad principal.
Propiedades estáticas
| Nombre | Tipo | Predeterminado | Valores y límites | Descripción |
|---|---|---|---|---|
title | string | "Network status" | maxLength: 40 | |
staleMinutes | integer | 10 | mínimo: 1; máximo: 1440 | Un feed más antiguo que este muestra hace cuánto se actualizó. |
backgroundColor | cadena, nulo | null | patrón: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Sobrescribe el fondo y la placa de la tarjeta con un color plano ordenado por CSS. #RRGGBBAA suministra opacidad. background none tiene prioridad. |
textColor | cadena, nulo | null | patrón: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | Sobrescribe los colores de texto principal y secundario. Los colores de acento y estado semántico mantienen sus roles. |
Propiedades dinámicas
| Nombre | Tipo | Predeterminado | Valores y límites | Descripción |
|---|---|---|---|---|
site | string | "" | maxLength: 60 | El sitio donde está la red; las ganancias del feed. |
wan | array | [] | maxItems: 6 | Enlaces WAN, el mismo documento que el screenrig.network/v1 feed wan. |
wan[].name | string | minLength: 1; maxLength: 40; Requerido | El enlace (Fibra, Cable, respaldo 5G). | |
wan[].status | string | "up" | maxLength: 24 | up, degradado, down o actualizando. |
wan[].latencyMs | número, nulo | null | mínimo: 0; máximo: 100000 | |
wan[].downMbps | número, nulo | null | mínimo: 0; máximo: 1000000 | La tasa de descarga actual del enlace. |
wan[].since | string | "" | maxLength: 40 | Instante ISO 8601 en que cambió el estado por última vez. Primetime reproduce el cambio (destello, campanas, tercio inferior) durante unos segundos desde este instante. |
wan[].was | string | "" | maxLength: 24 | El estado antes de since. Mientras since esté por delante del reloj de la pantalla, el artículo muestra este estado. |
devices | array | [] | maxItems: 200 | Dispositivos, el mismo documento que el devices del feed. |
devices[].name | string | minLength: 1; maxLength: 40; Requerido | El nombre del dispositivo. | |
devices[].kind | string | "other" | maxLength: 24 | ap, switch o gateway; cualquier otra cosa es un dispositivo. |
devices[].status | string | "online" | maxLength: 24 | en línea, degradado, sin conexión o actualizando. |
devices[].clients | entero, nulo | null | mínimo: 0; máximo: 100000 | Clientes en un punto de acceso. |
devices[].since | string | "" | maxLength: 40 | Instante ISO 8601 en que cambió el estado por última vez. Primetime reproduce el cambio (destello, campanas, tercio inferior) durante unos segundos desde este instante. |
devices[].was | string | "" | maxLength: 24 | El estado antes de since. Mientras since esté por delante del reloj de la pantalla, el artículo muestra este estado. |
clients | entero, nulo | null | mínimo: 0; máximo: 10000000 | Clientes en la red; vacío suma los clientes de los dispositivos. |
clientSeries | array | [] | maxItems: 60 | Clientes cada minuto, los más antiguos primero; se muestran los últimos 30. |
downMbps | número, nulo | null | mínimo: 0; máximo: 10000000 | Rendimiento de descarga ahora. |
upMbps | número, nulo | null | mínimo: 0; máximo: 10000000 | Velocidad de carga ahora. |
downSeries | array | [] | maxItems: 60 | Descarga Mbps cada minuto, los más antiguos primero; se dibujan los últimos 30. |
Ejemplo de lienzo
Guarde las propiedades estáticas como params.json y cree la tarjeta. El resultado incluye su id crd_.
{
"theme": "neomustard"
}
screenrig card create --type network-status --major 1 --file params.json
Agregue este elemento a los primitives de una página de la lista de reproducción, con ese id en lugar del del ejemplo. Publique la lista de reproducción y asigne una pantalla.
{
"id": "network-status",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
Escribir datos en vivo
Escriba el documento en la tarjeta después de crearla y luego reemplácelo para actualizar la pantalla sin republicar. La tarjeta verifica cada escritura contra sus propiedades dinámicas y rechaza un documento que no acepta. Use el mismo proyecto que la lista de reproducción.
Guarde el documento como card-data.json. La CLI lee el documento en sí, sin envoltorio:
{
"site": "",
"wan": [],
"devices": [],
"clients": null,
"clientSeries": [],
"downMbps": null,
"upMbps": null,
"downSeries": []
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
O llame a la API directamente. La API envuelve el mismo documento en un campo document. Un token de agente ya nombra su proyecto, por lo que no se envía encabezado de proyecto; si envía ScreenRig-Project, debe coincidir con el proyecto del token. Proporcione su autorización API a través del entorno; vea Autenticación API.
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":[]}}'