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

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

建立儀表板 (AWS Command Line Interface)

當您使用 AWS CLI 來定義儀表板中的視覺效果 (或 Widget) 時，您必須在 dashboardDefinition JSON 文件中指定下列資訊。這個定義是CreateDashboard和UpdateDashboard操作。

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應用程式指南。

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

  • sc-kpi— 關鍵績效指標 (KPI) 視覺效果。如需詳細資訊，請參閱「」KPI 小工具中的AWS IoT SiteWise Monitor應用程式指南。

  • sc-table— 表格小部件。如需詳細資訊，請參閱「」表格小工具中的AWS IoT SiteWise Monitor應用程式指南。

title

Widget 的標題。

x

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

y

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

width

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

height

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

metrics

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

label

要為此指標顯示的標籤。

type

此指標的資料來源類型。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應用程式指南。您可以在 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

（可選）是否在小部件的邊距中顯示閾值。預設為 true。

properties

(選用) Widget 屬性的平坦字典。此結構的成員相依於內容。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"
        }
      ]
    }
  ]
}