适用于数字标牌屏幕的出勤卡片

直播卡片

此卡由浏览器绘制，使用与播放器相同的代码，带示例数据。

类别：学校。标签：学校和校园，图表和仪表，数字和指标。

布局

此全屏卡在横屏或竖屏时填满整个屏幕，不作为角落、芯片或条带放置。

布局：全屏。表单：横向，纵向。

卡片布局、主题和发布。浏览卡片。

数据与隐私

此卡使用其配置的属性和实时卡数据。

仅计数，绝不显示姓名。

属性

有关主题、背景、强调色和位置，请参见通用属性。

创建卡片时，在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。

静态属性

名称	类型	默认	数值和限制	描述
`goal`	integer	`95`	最小值：`1`；最大值：`100`	班级或学校达到的出勤率百分比，视为进度正常。
`showDate`	boolean	`true`
`hour12`	boolean	`false`
`timeZone`	字符串，空值	`null`
`backgroundColor`	字符串，空值	`null`	模式：`"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	用纯色 CSS 顺序覆盖卡片背景和底板。#RRGGBBAA 提供透明度。背景无则优先。
`textColor`	字符串，空值	`null`	模式：`"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称	类型	默认	数值和限制	描述
`title`	string	`"Attendance today"`	maxLength：`40`
`classes`	array	`[]`	minItems：`0`；maxItems：`16`	今天按班级的出勤情况：在籍人数中有多少到场。尚未报告的班级不计在内。仅计数，不显示姓名。
`classes[].name`	string		minLength：`1`；maxLength：`28`；必填
`classes[].enrolled`	integer		最小值：`1`；最大值：`9999`；必填
`classes[].present`	integer		最小值：`0`；最大值：`9999`	今日在此。缺席：课程尚未报告。
`classes[].streak`	integer	`0`	最小值：`0`；最大值：`999`	连续达到或超过目标的天数。
`classes[].reportedAt`	string	`""`	maxLength：`40`	该班级计数最后变化的时间点，ISO 8601。黄金时段从此时间点播放班级百分百时刻。
`classes[].prevPresent`	integer		最小值：`0`；最大值：`9999`	变更前此处；时刻环从这里填充。
`schoolStreak`	integer	`0`	最小值：`0`；最大值：`999`	全校连续达到或超过目标的天数。
`takenAt`	string	`""`	maxLength：`40`	记录出勤的 ISO 8601 瞬时。空值不显示时间。
`schoolMetAt`	string	`""`	maxLength：`40`	整个学校达成目标的时间点，ISO 8601。黄金时段从此时间点播放目标达成时刻，所有屏幕同时显示。

画布示例

将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。

{
  "theme": "neomustard"
}

screenrig card create --type attendance --major 1 --file params.json

将此项目添加到播放列表页面的primitives中，并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。

{
  "id": "attendance",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

创建卡片后向其写入文档，之后替换该文档即可更新屏幕，无需重新发布。卡片会按其动态属性检查每次写入，并拒绝它不接受的文档。请使用与播放列表相同的项目。

将文档保存为card-data.json。CLI直接读取文档，无需包装：

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

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

或直接调用 API。API 将相同文档包装在 document 字段中。智能体令牌已指定其项目，因此不发送项目头；若发送 ScreenRig-Project，必须与令牌项目匹配。通过环境提供 API 授权；详见 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":""}}'