Cartão de status da rede para telas de sinalização digital

Cartão ao vivo

Este cartão é desenhado no seu navegador pelo mesmo código que os Players executam, com dados de exemplo.

Categoria: Operações. Tags: Escritórios e locais de trabalho, Números e métricas, Alertas e status.

Layouts

Este cartão em tela cheia preenche toda a tela em paisagem ou retrato e não é colocado como canto, chip ou faixa.

Layouts: cheio. Formas: paisagem, retrato.

Layouts, temas e publicação de cartões. Veja os cartões.

Dados e privacidade

Feed: screenrig.network/v1.

Documentos do feed carregam atribuição da fonte. O Player fornece o feed para o cartão.

Mostra apenas nomes de dispositivos e contagens de clientes; nunca o nome, endereço ou tráfego de um cliente.

Propriedades

Para tema, fundo, destaque e posição, veja Propriedades comuns.

Defina as propriedades estáticas nos params do cartão ao criá-lo. O documento de dados dele contém apenas propriedades dinâmicas. Linhas aninhadas descrevem o conteúdo da propriedade pai.

Propriedades estáticas

Nome	Tipo	Padrão	Valores e limites	Descrição
`title`	string	`"Network status"`	maxLength: `40`
`staleMinutes`	integer	`10`	mínimo: `1`; máximo: `1440`	Um feed mais antigo que isso mostra há quanto tempo foi atualizado.
`backgroundColor`	string, nulo	`null`	padrão: `"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	Substitui o fundo e a placa do cartão por uma cor plana ordenada por CSS. #RRGGBBAA fornece opacidade. background none tem precedência.
`textColor`	string, nulo	`null`	padrão: `"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	Substitui as cores do texto principal e secundário. As cores de destaque e status semântico mantêm seus papéis.

Propriedades dinâmicas

Nome	Tipo	Padrão	Valores e limites	Descrição
`site`	string	`""`	maxLength: `60`	O site onde a rede está; as vitórias do feed.
`wan`	array	`[]`	maxItems: `6`	Links WAN, o mesmo documento que o feed screenrig.network/v1 do `wan`.
`wan[].name`	string		minLength: `1`; maxLength: `40`; Obrigatório	O link (Fibra, Cabo, backup 5G).
`wan[].status`	string	`"up"`	maxLength: `24`	up, degraded, down ou updating.
`wan[].latencyMs`	número, nulo	`null`	mínimo: `0`; máximo: `100000`
`wan[].downMbps`	número, nulo	`null`	mínimo: `0`; máximo: `1000000`	A taxa atual de download do link.
`wan[].since`	string	`""`	maxLength: `40`	Instante ISO 8601 em que o status mudou pela última vez. Primetime reproduz a mudança (um flash, toques, um rodapé) por alguns segundos a partir desse instante.
`wan[].was`	string	`""`	maxLength: `24`	O status antes de `since`. Enquanto `since` ainda estiver à frente do relógio da tela, o item mostra esse status.
`devices`	array	`[]`	maxItems: `200`	Dispositivos, o mesmo documento do `devices` do feed.
`devices[].name`	string		minLength: `1`; maxLength: `40`; Obrigatório	O nome do dispositivo.
`devices[].kind`	string	`"other"`	maxLength: `24`	ap, switch ou gateway; qualquer outra coisa é um dispositivo.
`devices[].status`	string	`"online"`	maxLength: `24`	online, degradado, offline ou atualizando.
`devices[].clients`	integer, null	`null`	mínimo: `0`; máximo: `100000`	Clientes em um ponto de acesso.
`devices[].since`	string	`""`	maxLength: `40`	Instante ISO 8601 em que o status mudou pela última vez. Primetime reproduz a mudança (um flash, toques, um rodapé) por alguns segundos a partir desse instante.
`devices[].was`	string	`""`	maxLength: `24`	O status antes de `since`. Enquanto `since` ainda estiver à frente do relógio da tela, o item mostra esse status.
`clients`	integer, null	`null`	mínimo: `0`; máximo: `10000000`	Clientes na rede; vazio soma os clientes dos dispositivos.
`clientSeries`	array	`[]`	maxItems: `60`	Clientes a cada minuto, os mais antigos primeiro; os últimos 30 são exibidos.
`downMbps`	número, nulo	`null`	mínimo: `0`; máximo: `10000000`	Taxa de download agora.
`upMbps`	número, nulo	`null`	mínimo: `0`; máximo: `10000000`	Taxa de upload agora.
`downSeries`	array	`[]`	maxItems: `60`	Mbps de download a cada minuto, os mais antigos primeiro; os últimos 30 são desenhados.

Exemplo de tela

Salve as propriedades estáticas como params.json e crie o cartão. O resultado traz o id crd_ dele.

{
  "theme": "neomustard"
}

screenrig card create --type network-status --major 1 --file params.json

Adicione este item aos primitives de uma página da playlist, com esse id no lugar do id do exemplo. Publique a playlist e atribua uma tela.

{
  "id": "network-status",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

Escrever dados ao vivo

Escreva o documento no cartão depois de criá-lo e depois substitua-o para atualizar a tela sem republicar. O cartão verifica cada gravação contra suas propriedades dinâmicas e recusa um documento que ele rejeita. Use o mesmo projeto da playlist.

Salve o documento como card-data.json. O CLI lê o documento em si, sem invólucro:

{
  "site": "",
  "wan": [],
  "devices": [],
  "clients": null,
  "clientSeries": [],
  "downMbps": null,
  "upMbps": null,
  "downSeries": []
}

screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json

Ou chame a API diretamente. A API envolve o mesmo documento em um campo document. Um token de agente já nomeia seu projeto, então nenhum cabeçalho de projeto é enviado; se você enviar ScreenRig-Project, ele deve corresponder ao projeto do token. Forneça sua autorização de API pelo ambiente; veja Autenticação da 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":[]}}'