适用于数字标牌屏幕的构建板卡片

直播卡片

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

类别：运营。标签：警报与状态，数字与指标，办公室与工作场所。

布局

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

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

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

数据与隐私

信息源：screenrig.builds/v1。

信息源文档带有来源归属。播放器向卡片提供信息源。

属性

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

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

静态属性

名称	类型	默认	数值和限制	描述
`title`	string	`"Builds"`	maxLength：`40`
`branch`	string	`""`	maxLength：`60`	仅显示此分支的运行；为空则显示所有分支。
`show`	string	`"all"`	`"all"`, `"builds"`, `"deploys"`
`staleMinutes`	integer	`10`	最小值：`1`；最大值：`1440`	早于此时间的数据显示为 N 分钟前更新。
`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})?$"`	覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称	类型	默认	数值和限制	描述
`updatedAt`	string	`""`	maxLength：`40`	管道被采集的 ISO 8601 时间点（仅数据存储；数据源携带 fetchedAt）。
`pipelines`	array	`[]`	maxItems：`60`
`pipelines[].id`	string	`""`	maxLength：`60`
`pipelines[].name`	string		minLength：`1`；maxLength：`60`；必填	仓库或流水线。
`pipelines[].branch`	string	`""`	maxLength：`60`
`pipelines[].kind`	string	`"build"`	`"build"`, `"deploy"`
`pipelines[].environment`	string	`""`	maxLength：`30`	部署的位置，例如生产环境。
`pipelines[].status`	string	`""`	maxLength：`24`	通过、失败、运行中、排队或取消。也可读作：成功、已成功、正常、绿色、已部署；失败、错误、损坏、红色、超时；进行中、构建中、部署中、已开始；待定、等待、已安排；已取消、跳过、中止。其他任何词均显示为灰色。
`pipelines[].startedAt`	string	`""`	maxLength：`40`	运行开始的 ISO 8601 时间点（排队运行为排队时间）。运行中管道的持续时间从此计时。
`pipelines[].finishedAt`	string	`""`	maxLength：`40`	运行结束的 ISO 8601 时间点。
`pipelines[].durationSeconds`	integer	`0`	最小值：`0`；最大值：`8640000`	运行时长。省略时为 finishedAt 减去 startedAt。
`pipelines[].actor`	string	`""`	maxLength：`60`	谁启动或触发了它。

画布示例

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

{
  "theme": "neomustard"
}

screenrig card create --type build-board --major 1 --file params.json

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

{
  "id": "build-board",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

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

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

{
  "updatedAt": "",
  "pipelines": []
}

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":{"updatedAt":"","pipelines":[]}}'