Cartão de presença 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: Escolas. Tags: Escolas e campi, Gráficos e medidores, Números e métricas.

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

Este cartão usa suas propriedades configuradas e dados ao vivo do cartão.

Conta apenas, nunca nomes.

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
`goal`	integer	`95`	mínimo: `1`; máximo: `100`	A porcentagem de presença que uma turma ou escola alcança para ser considerada no caminho certo.
`showDate`	boolean	`true`
`hour12`	boolean	`false`
`timeZone`	string, nulo	`null`
`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
`title`	string	`"Attendance today"`	maxLength: `40`
`classes`	array	`[]`	minItems: `0`; maxItems: `16`	Frequência de hoje por turma: quantos estão presentes de quantos estão matriculados. Uma turma que ainda não reportou deixa os presentes de fora. Apenas contagens, nunca nomes.
`classes[].name`	string		minLength: `1`; maxLength: `28`; Obrigatório
`classes[].enrolled`	integer		mínimo: `1`; máximo: `9999`; Obrigatório
`classes[].present`	integer		mínimo: `0`; máximo: `9999`	Aqui hoje. Ausente: a turma ainda não reportou.
`classes[].streak`	integer	`0`	mínimo: `0`; máximo: `999`	Dias consecutivos no alvo ou acima dele.
`classes[].reportedAt`	string	`""`	maxLength: `40`	O instante em que a contagem desta turma mudou pela última vez, ISO 8601. Primetime reproduz o momento de 100 por cento da turma a partir dele.
`classes[].prevPresent`	integer		mínimo: `0`; máximo: `9999`	Aqui antes da mudança; o anel do momento se preenche a partir dele.
`schoolStreak`	integer	`0`	mínimo: `0`; máximo: `999`	Dias consecutivos em que toda a escola esteve no alvo ou acima dele.
`takenAt`	string	`""`	maxLength: `40`	Instante ISO 8601 em que a presença foi registrada. Vazio não mostra horário.
`schoolMetAt`	string	`""`	maxLength: `40`	O instante em que toda a escola atingiu sua meta, ISO 8601. Primetime reproduz seu momento META ATINGIDA a partir dele, em todas as telas ao mesmo tempo.

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 attendance --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": "attendance",
  "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:

{
  "title": "Attendance today",
  "classes": [],
  "schoolStreak": 0,
  "takenAt": "",
  "schoolMetAt": ""
}

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":{"title":"Attendance today","classes":[],"schoolStreak":0,"takenAt":"","schoolMetAt":""}}'