每日特价卡

显示今日特色菜及价格,并显示整周菜单。

突出今日菜品,方便浏览一周菜单。带日期的例外菜品替代常规菜品,但不改变周菜单。

直播卡片

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

类别:食品和饮料。标签:餐厅和咖啡馆,价格和费率,日程安排。

布局

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

布局:全屏。表单:横向,纵向。

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

数据与隐私

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

属性

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

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

静态属性

名称类型默认数值和限制描述
titlestring"Daily specials"maxLength:60
closedMessagestring"Explore the week’s specials below."maxLength:160
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})?$"覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称类型默认数值和限制描述
footnotestring""maxLength:160
updatedAtstring""maxLength:40同步菜单更新的 ISO 时间点。新本地日也是同步时刻。
specialsarray[]minItems:0;maxItems:14ISO 工作日,1 为周一至 7 为周日。重复日期以最后一条为准。
specials[].dayinteger最小值:1;最大值:7;必填
specials[].namestringminLength:1;maxLength:80;必填
specials[].descriptionstring""maxLength:240
specials[].pricestring""maxLength:30
exceptionsarray[]minItems:0;maxItems:32指定日期的替换或无特殊内容的天数。最后一个匹配日期优先生效。
exceptions[].datestring模式:"^\\d{4}-\\d{2}-\\d{2}$";必填
exceptions[].closedbooleanfalse
exceptions[].namestring"Special of the day"maxLength:80
exceptions[].descriptionstring""maxLength:240
exceptions[].pricestring""maxLength:30

画布示例

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

{
  "theme": "neomustard"
}
screenrig card create --type daily-specials --major 1 --file params.json

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

{
  "id": "daily-specials",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

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

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

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