View a markdown version of this page

建立 AWS IoT SiteWise 儀表板 (AWS CLI) - AWS IoT SiteWise

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

建立 AWS IoT SiteWise 儀表板 (AWS CLI)

注意

SiteWise Monitor 功能不再可供新客戶使用。現有客戶可以繼續正常使用該服務。如需詳細資訊,請參閱 SiteWise Monitor 可用性變更。

當您使用 在儀表板中定義視覺效果 (或小工具) 時 AWS CLI,您必須在 dashboardDefinition JSON 文件中指定下列資訊。此定義是 CreateDashboard 和 UpdateDashboard 操作的參數。

widgets

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

type

widget. 的類型 AWS IoT SiteWise 提供下列小工具類型:

  • 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 應用程式指南》中的狀態小工具。

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

  • sc-kpi – 關鍵效能指標 (KPI) 視覺化。如需詳細資訊,請參閱《 AWS IoT SiteWise Monitor 應用程式指南》中的 KPI 小工具。

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

title

Widget 的標題。

x

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

y

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

width

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

height

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

metrics

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

label

要為此指標顯示的標籤。

type

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

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

assetId

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

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

propertyId

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

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

analysis

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

trends

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

type

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

  • linear-regression – 顯示線性迴歸線。SiteWise Monitor 使用最小平方方法來計算線性迴歸。

annotations

(選用) 註釋結構,定義小工具的閾值。如需詳細資訊,請參閱《 AWS IoT SiteWise Monitor 應用程式指南》中的設定閾值。每個小工具最多可以新增六個註釋。註釋結構包含下列資訊:

y

(選用) 註釋結構的清單,每個結構都會定義此小工具的水平閾值。清單中的每個結構都包含下列資訊:

comparisonOperator

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

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

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

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

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

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

value

用來比較資料點與 的閾值comparisonOperator。

color

(選用) 閾值顏色的 6 位數十六進位代碼。對於至少有一個資料點符合閾值規則的屬性,視覺效果會顯示此顏色的屬性圖例。預設為黑色 (#000000)。

showValue

(選用) 是否在小工具的邊界中顯示閾值的值。預設為 true。

properties

(選用) 小工具屬性的平面字典。此結構的成員取決於內容。 AWS IoT SiteWise 提供下列使用 的小工具properties:

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

    colorDataAcrossThresholds

    (選用) 是否要變更此小工具中超過閾值的資料顏色。當您啟用此選項時,超過閾值的資料會以您選擇的顏色顯示。預設為 true。

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

    labels

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

    showValue

    (選用) 是否要顯示此小工具中每個資產屬性的單位和值。預設為 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" } ] } ] }