ライブカード
カテゴリ: 運用。タグ: 数値と指標、チャートとゲージ、工場と倉庫、オフィスと職場。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
このカードは設定されたプロパティとライブカードデータを使用します。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。
静的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
title | string | "Energy now" | maxLength:40 | |
co2Factor | number | 0.4 | 最小値:0;最大値:2 | co2SavedKg が指定されていない場合に使用される、kWh あたりの回避されたCO₂キログラム数。 |
backgroundColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | カードの背景とプレートをフラットなCSS順序の色で上書きします。#RRGGBBAAは不透明度を指定します。background noneが優先されます。 |
textColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
solarKw | number | 最小値:0 | 現在の太陽光発電量、kWで表示。 | |
loadKw | number | 最小値:0 | 現在の消費量、kW単位。 | |
batteryKw | number | kW のバッテリー電力:正の充電、負の放電。バッテリーがない場合は batteryPct を使用して除外します。 | ||
batteryPct | number | 最小値:0;最大値:100 | バッテリー充電量、0から100まで。 | |
gridKw | number | kWのグリッド電力:正の輸入、負の輸出。省略時は他のフローから導出されます。 | ||
generatedTodayKwh | number | 最小値:0 | 本日これまでに生成されたエネルギー、単位はkWhです。 | |
co2SavedKg | number | 最小値:0 | 回避されたCO₂(kg)。省略時は generatedTodayKwh と co2Factor から計算。 | |
footnote | string | "" | maxLength:80 | |
peakKw | number | 最小値:0 | サイトのピーク需要、kW単位。負荷が90%以上でPrimetimeのホームタイルが監視状態に。 | |
gridAlert | string | "" | maxLength:60 | グリッドアラート、オペレーター自身の言葉で(グリッド停止、周波数異常など)。テキストがあると、Primetimeでカードが赤い警告モードになり、ステータス行が置き換わります。 |
gridAlertAt | string | "" | maxLength:40 | グリッドアラート発生時刻、ISO 8601形式です。Primetimeはこの時刻から全スクリーンでアラートの表示を再生します。 |
updatedAt | string | "" | maxLength:40 | 最新の読み取り時刻、ISO 8601形式です。Primetimeはこれを基にデータを更新し、すべてのライブラインに光を当て、数値に強調を加えます。 |
キャンバス例
静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。
{
"theme": "neomustard"
}
screenrig card create --type energy --major 1 --file params.json
このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。
{
"id": "energy",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
ライブデータを書き込む
カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。
ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。
{
"solarKw": 1,
"loadKw": 1,
"batteryKw": 1,
"batteryPct": 1,
"gridKw": 1,
"generatedTodayKwh": 1,
"co2SavedKg": 1,
"footnote": "",
"peakKw": 1,
"gridAlert": "",
"gridAlertAt": "",
"updatedAt": ""
}
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":{"solarKw":1,"loadKw":1,"batteryKw":1,"batteryPct":1,"gridKw":1,"generatedTodayKwh":1,"co2SavedKg":1,"footnote":"","peakKw":1,"gridAlert":"","gridAlertAt":"","updatedAt":""}}'