适用于数字标牌屏幕的网络状态卡片

直播卡片

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

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

布局

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

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

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

数据与隐私

信息源：screenrig.network/v1。

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

仅显示设备名称和客户端数量；绝不显示客户端名称、地址或流量。

属性

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

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

静态属性

名称	类型	默认	数值和限制	描述
`title`	string	`"Network status"`	maxLength：`40`
`staleMinutes`	integer	`10`	最小值：`1`；最大值：`1440`	超过此时间的源显示上次更新时间。
`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})?$"`	覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称	类型	默认	数值和限制	描述
`site`	string	`""`	maxLength：`60`	网络所在站点；数据源的胜利。
`wan`	array	`[]`	maxItems：`6`	WAN 链接，与 screenrig.network/v1 源的 `wan` 文档相同。
`wan[].name`	string		minLength：`1`；maxLength：`40`；必填	链接（光纤、有线、5G 备份）。
`wan[].status`	string	`"up"`	maxLength：`24`	up、degraded、down 或 updating。
`wan[].latencyMs`	数字，空值	`null`	最小值：`0`；最大值：`100000`
`wan[].downMbps`	数字，空值	`null`	最小值：`0`；最大值：`1000000`	链接当前的下载速率。
`wan[].since`	string	`""`	maxLength：`40`	状态最后变更的 ISO 8601 时间点。Primetime 从此时间点播放变更（闪烁、铃声、下三分之一字幕）数秒。
`wan[].was`	string	`""`	maxLength：`24`	`since` 之前的状态。在 `since` 仍在屏幕时钟前时，物品显示此状态。
`devices`	array	`[]`	maxItems：`200`	设备，与数据源的文档相同 `devices`。
`devices[].name`	string		minLength：`1`；maxLength：`40`；必填	设备名称。
`devices[].kind`	string	`"other"`	maxLength：`24`	ap、交换机或网关；其他均为设备。
`devices[].status`	string	`"online"`	maxLength：`24`	在线、降级、离线或更新中。
`devices[].clients`	整数，空值	`null`	最小值：`0`；最大值：`100000`	接入点上的客户。
`devices[].since`	string	`""`	maxLength：`40`	状态最后变更的 ISO 8601 时间点。Primetime 从此时间点播放变更（闪烁、铃声、下三分之一字幕）数秒。
`devices[].was`	string	`""`	maxLength：`24`	`since` 之前的状态。在 `since` 仍在屏幕时钟前时，物品显示此状态。
`clients`	整数，空值	`null`	最小值：`0`；最大值：`10000000`	网络上的客户；空白表示设备客户总数。
`clientSeries`	array	`[]`	maxItems：`60`	每分钟客户，最旧的优先；绘制最近 30 个。
`downMbps`	数字，空值	`null`	最小值：`0`；最大值：`10000000`	当前下载吞吐量。
`upMbps`	数字，空值	`null`	最小值：`0`；最大值：`10000000`	当前上传吞吐量。
`downSeries`	array	`[]`	maxItems：`60`	每分钟下载 Mbps，最旧的优先；绘制最近 30 个。

画布示例

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

{
  "theme": "neomustard"
}

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

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

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

写入实时数据

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

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

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

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":{"site":"","wan":[],"devices":[],"clients":null,"clientSeries":[],"downMbps":null,"upMbps":null,"downSeries":[]}}'