学校午餐卡片

今天的学校餐食带有过敏原标记,并显示未来几天:主菜突出,配菜列出,标记说明。

直播卡片

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

类别:食品和饮料。标签:学校和校园,餐厅和咖啡馆。

布局

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

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

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

数据与隐私

信息源:screenrig.lunch/v1。

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

属性

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

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

静态属性

名称类型默认数值和限制描述
titlestring""maxLength:40空白显示学校午餐(学校早餐,学校点心)。
schoolstring""maxLength:60显示在标题旁。为空时显示订阅的学校名称。
mealstring"lunch""breakfast", "lunch", "snack"
countinteger4最小值:1;最大值:6特色日之后列出的天数。
showAllergensbooleantrue过敏原和饮食标记及其说明。
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})?$"覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称类型默认数值和限制描述
daysarray[]minItems:0;maxItems:31按天的菜单。存在数据源(screenrig.lunch/v1)时优先使用;否则由数据存储提供相同行。
days[].datestringmaxLength:10;必填YYYY-MM-DD 表示屏幕所在时区。
days[].closedbooleanfalse这天无餐(假期,无学校)。
days[].notestringmaxLength:80当天显示:披萨日,或无课原因。
days[].itemsarraymaxItems:12订购的餐点;第一项为主菜。
days[].items[].namestringminLength:1;maxLength:60;必填
days[].items[].allergensarraymaxItems:10牛奶、鸡蛋、鱼、贝类、坚果、花生、小麦、大豆、芝麻。每种以两个字母标记显示。
days[].items[].dietstring"vegetarian", "vegan"显示 V 或 VG 标记。
days[].mealsarraymaxItems:4源的当天餐点;卡片的餐点选择其中一个。无餐点时使用当天项目。
days[].meals[].kindstring"breakfast"、"lunch"、"snack";必填
days[].meals[].itemsarraymaxItems:12;必填
days[].meals[].items[].namestringminLength:1;maxLength:60;必填
days[].meals[].items[].allergensarraymaxItems:10牛奶、鸡蛋、鱼、贝类、坚果、花生、小麦、大豆、芝麻。每种以两个字母标记显示。
days[].meals[].items[].dietstring"vegetarian", "vegan"显示 V 或 VG 标记。

画布示例

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

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

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

{
  "id": "school-lunch",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

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

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

{
  "days": []
}
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":{"days":[]}}'