建立儀表板 (AWS Command Line Interface) - AWS IoT SiteWise

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

建立儀表板 (AWS Command Line Interface)

當您使用 AWS CLI 來定義儀表板中的視覺效果 (或 Widget) 時,您必須在 dashboardDefinition JSON 文件中指定下列資訊。此定義是CreateDashboardUpdateDashboard作業的參數。

widgets

Widget 定義結構的清單,每個結構都包含下列資訊:

type

Widget 的類型。AWS IoT SiteWise 提供下列 Widget 類型:

  • sc-line-chart— 折線圖。如需詳細資訊,請參閱《AWS IoT SiteWise Monitor應用指南》中的折線圖

  • sc-scatter-chart— 散點圖。如需詳細資訊,請參閱《AWS IoT SiteWise Monitor應用指南》中的散佈圖

  • sc-bar-chart-條形圖。如需詳細資訊,請參閱《AWS IoT SiteWise Monitor應用指南》中的長條圖

  • sc-status-grid— 狀態小器具,以網格形式顯示資產屬性的最新值。如需詳細資訊,請參閱《AWS IoT SiteWise Monitor應用程式指南》中的狀態 Widget

  • sc-status-timeline— 狀態小器具,會將資產屬性的歷史值顯示為時間軸。如需詳細資訊,請參閱《AWS IoT SiteWise Monitor應用程式指南》中的狀態 Widget

  • sc-kpi— 一個關鍵績效指標 (KPI) 可視化. 如需詳細資訊,請參閱AWS IoT SiteWise Monitor應用程式指南中的 KPI 小器具

  • sc-table— 表格小器具。如需詳細資訊,請參閱《AWS IoT SiteWise Monitor應用程式指南》中的表格 Widget

title

Widget 的標題。

x

Widget 的水平位置,從格線的左側開始。此值是指 Widget 在儀表板格線中的位置。

y

Widget 的垂直位置,從格線的頂部開始。此值是指 Widget 在儀表板格線中的位置。

width

Widget 的寬度,以儀表板格線上的空格數表示。

height

Widget 的高度,以儀表板格線上的空格數表示。

metrics

指標結構的清單,每個結構都會定義此 Widget 的資料串流。清單中的每個結構都必須包含下列資訊:

label

要為此指標顯示的標籤。

type

此指標的資料來源類型。AWS IoT SiteWise 提供下列指標類型:

  • iotsitewise— 儀表板擷取中AWS IoT SiteWise資產屬性的資料。如果您選擇此選項,則必須為此指標定義 assetIdpropertyId

assetId

(選用) AWS IoT SiteWise 中的資產 ID。

如果您在此指標中為 type 選擇 iotsitewise,則此欄位為必要。

propertyId

(選用) AWS IoT SiteWise 中的資產屬性 ID。

如果您在此指標中為 type 選擇 iotsitewise,則此欄位為必要。

analysis

(選擇性) 定義 Widget 要顯示之分析 (例如趨勢線) 的結構。如需詳細資訊,請參《AWS IoT SiteWise Monitor應用指南》中的 < 設定趨勢線 >。您可以在 Widget 中為每個屬性新增每種類型的趨勢線之一。分析結構包含下列資訊:

trends

(選擇性) 趨勢結構清單,每個結構都會定義此 Widget 的趨勢分析。清單中的每個結構都包含下列資訊:

type

趨勢線的類型。選擇下列選項:

  • linear-regression— 顯示線性回歸線。 SiteWise 監視器使用最小平方法來計算線性回歸。

annotations

(選擇性) 定義小器具臨界值的註釋結構。如需詳細資訊,請參閱《AWS IoT SiteWise Monitor應用指南》中的 < 設定臨界值 > 每個小部件最多可以添加六個註釋。註釋結構包含下列資訊:

y

(選擇性) 註釋結構清單,每個註釋結構都會定義此 Widget 的水平臨界值。清單中的每個結構都包含下列資訊:

comparisonOperator

臨界值的比較運算子。選擇下列其中一項:

  • LT— 反白顯示至少有一個資料點小於的屬性value

  • GT— 反白顯示至少有一個資料點大於的屬性value

  • LTE— 反白顯示至少有一個資料點小於或等於的屬性value

  • GTE— 反白顯示至少有一個資料點大於或等於的屬性value

  • EQ— 反白顯示至少具有一個資料點等於的屬性value

value

用來比較資料點與的臨界值comparisonOperator

color

(選擇性) 閾值色彩的 6 位數十六進位碼。對於至少具有一個資料點符合臨界值規則的性質,視覺效果會以此顏色顯示性質圖例。默認為黑色(#000000)。

showValue

(選擇性) 是否要在 Widget 的邊界中顯示臨界值。預設為 true

properties

(選擇性) 小器具屬性的一般字典。此結構的成員與前後關聯相關。 AWS IoT SiteWise提供下列使用的小器具properties

  • 折線圖散佈圖和長條圖具有下列屬性:

    colorDataAcrossThresholds

    (選擇性) 是否要變更此 Widget 中跨越臨界值的資料色彩。啟用此選項時,超過臨界值的資料會以您選擇的顏色顯示。預設為 true

  • 狀態網格具有下列屬性:

    labels

    (選擇性) 定義要在狀態網格上顯示之標籤的結構。標示結構包含以下資訊:

    showValue

    (選擇性) 是否要在此 Widget 中顯示每個資產屬性的單位和值。預設為 true

範例儀表板定義

下列範例會從存放在 JSON 檔案中的承載來定義儀表板。

aws iotsitewise create-dashboard \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ --dashboard-name "Wind Farm Dashboard" \ --dashboard-definition file://dashboard-definition.json

dashboard-definition.json 的下列 JSON 範例,會使用下列視覺效果 Widget 來定義儀表板:

  • 在儀表板左上角將風力發電廠總電力視覺化的折線圖。此折線圖包括一個閾值,指示風電場輸出的功率少於其最小預期輸出的時間。此折線圖還包括線性回歸趨勢線。

  • 在儀表板右上角將四個渦輪機風速視覺化的長條圖。

注意

這個例子代表了儀表板上的折線圖和條形圖可視化。此儀表板類似於範例風力發電廠儀表板

{ "widgets": [ { "type": "sc-line-chart", "title": "Total Average Power", "x": 0, "y": 0, "height": 3, "width": 3, "metrics": [ { "label": "Power", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "analysis": { "trends": [ { "type": "linear-regression" } ] } } ], "annotations": { "y": [ { "comparisonOperator": "LT", "value": 20000, "color": "#D13212", "showValue": true } ] } }, { "type": "sc-bar-chart", "title": "Wind Speed", "x": 3, "y": 3, "height": 3, "width": 3, "metrics": [ { "label": "Turbine 1", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-2a2a2EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE" }, { "label": "Turbine 2", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-2b2b2EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE" }, { "label": "Turbine 3", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-2c2c2EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE" }, { "label": "Turbine 4", "type": "iotsitewise", "assetId": "a1b2c3d4-5678-90ab-cdef-2d2d2EXAMPLE", "propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE" } ] } ] }