AWS IoT SiteWise ダッシュボードの作成 (AWS CLI) - AWS IoT SiteWise

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS IoT SiteWise ダッシュボードの作成 (AWS CLI)

注記

SiteWise Monitor 機能は、新規のお客様は利用できなくなりました。既存のお客様は、通常どおりサービスを引き続き使用できます。詳細については、SiteWise Monitor の可用性の変更」を参照してください。

を使用してダッシュボードで視覚化 (またはウィジェット) を定義する場合は AWS CLI、JSON dashboardDefinition ドキュメントで次の情報を指定する必要があります。この定義は、CreateDashboard および UpdateDashboard オペレーションのパラメータです。

widgets

ウィジェット定義構造のリスト。それぞれに次の情報が含まれています。

type

widget. のタイプは、次のウィジェットタイプ AWS IoT SiteWise を提供します。

  • sc-line-chart - 折れ線グラフ 詳しくは、[AWS IoT SiteWise Monitor Application Guide] (アプリケーションガイド) の[Line charts] (折れ線グラフ) をご覧ください。

  • sc-scatter-chart — 散布図。詳細については、AWS IoT SiteWise Monitor アプリケーションガイドの「散布図」を参照してください。

  • sc-bar-chart - 棒グラフ 詳細については、AWS IoT SiteWise Monitor アプリケーションガイドの「棒グラフ」を参照してください。

  • sc-status-grid - アセットプロパティの最新値をグリッドで表示する状態ウィジェットです。詳しくは、[AWS IoT SiteWise Monitor Application Guide] (アプリケーションガイド) の[Status widgets] (状態ウィジェット) をご覧ください。

  • sc-status-timeline - アセットプロパティの履歴値を時系列で表示する状態ウィジェットです。詳しくは、[AWS IoT SiteWise Monitor Application Guide] (アプリケーションガイド) の[Status widgets] (状態ウィジェット) をご覧ください。

  • sc-kpi - 重要業績評価指標 (KPI、 key performance indicator) の視覚化。詳しくは、[AWS IoT SiteWise Monitor Application Guide] (アプリケーションガイド) の[KPI widgets] (KPI ウィジェット) をご覧ください。

  • sc-table — テーブルウィジェット 詳しくは、[AWS IoT SiteWise Monitor Application Guide] (アプリケーションガイド) の[Table widgets] (テーブルウィジェット) をご覧ください。

title

ウィジェットのタイトル。

x

ウィジェットの水平位置。グリッドの左から開始します。この値は、ダッシュボードのグリッド内のウィジェットの位置を参照します。

y

グリッドの上部から始まる、ウィジェットの垂直位置。この値は、ダッシュボードのグリッド内のウィジェットの位置を参照します。

width

ダッシュボードのグリッド上のスペース数で表されるウィジェットの幅。

height

ダッシュボードのグリッド上のスペースの数で表されるウィジェットの高さ。

metrics

それぞれがこのウィジェットのデータストリームを定義するメトリクス構造のリスト。リスト内の各構造には、次の情報が含まれている必要があります。

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 Application Guide] (アプリケーションガイド) の[Configuring trend lines] (トレンドラインの設定) をご覧ください。ウィジェットのプロパティごとに、各型のトレンドラインを 1 つずつ追加することができます。解析構造には、次の情報が含まれています。

trends

(オプション) 各ウィジェットのトレンド分析を定義するトレンド構造のリスト。リスト内の各構造には、次の情報が含まれています。

type

トレンドラインの種類。次のオプションを選択します。

  • linear-regression - 線形回帰の表示。SiteWise Monitorは、最小二乗法で線形回帰を計算します。

annotations

(オプション) ウィジェットのしきい値を定義するアノテーション構造。詳しくは、[AWS IoT SiteWise Monitor Application Guide] (アプリケーションガイド) の[Configuring thresholds] (しきい値の設定) をご覧ください。1 つのウィジェットにつき最大 6 つのアノテーションを追加することができます。アノテーション構造には、次の情報が含まれます。

y

(オプション) このウィジェットの水平方向のしきい値をそれぞれ定義するアノテーション構造のリスト。リスト内の各構造には、次の情報が含まれています。

comparisonOperator

しきい値の比較演算子。次のいずれかを選択します。

  • LT - value より小さいデータポイントを少なくとも 1 つ持つプロパティがハイライトされます。

  • GT - value より大きいデータポイントを少なくとも 1 つ持つプロパティがハイライトされます。

  • LTE - value 以下のデータポイントを少なくとも 1 つ持つプロパティがハイライトされます。

  • GTE - value 以上のデータポイントを少なくとも 1 つ持つプロパティがハイライトされます。

  • EQ - value と同じデータポイントを少なくとも 1 つ持つプロパティがハイライトされます。

value

データポイントを comparisonOperator と比較するためのしきい値。

color

(オプション) しきい値の色を表す 6 桁の 16 進数コード。視覚化では、しきい値のルールを満たすデータポイントが少なくとも 1 つあるプロパティについて、この色でプロパティの凡例が表示されます。デフォルトは黒 (#000000) です。

showValue

(オプション) ウィジェットの余白にしきい値の値を表示するかどうかを設定します。デフォルトは true です。

properties

(オプション) ウィジェットのプロパティのフラットディクショナリです。この構造のメンバーはコンテキスト依存です。 AWS IoT SiteWise には、 を使用する以下のウィジェットが用意されていますproperties。

  • 折れ線グラフ、散布図、棒グラフには次のプロパティがあります。

    colorDataAcrossThresholds

    (オプション) このウィジェットでしきい値を超えたデータの色を変更するかどうかを設定します。このオプションを有効にすると、しきい値を超えたデータが選択した色で表示されます。デフォルトは true です。

  • [Status grids] (状態グリッド) は、次の特性を持ちます。

    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 例では、次の視覚化ウィジェットを使用してダッシュボードを定義します。

  • ダッシュボードの左上にある風力発電所の総電力を視覚化する折れ線グラフ。この折れ線グラフには、風力発電所の出力が期待される最小出力よりも小さくなるタイミングを示すしきい値が含まれています。この折れ線グラフには、線形回帰のトレンドラインも含まれています。

  • ダッシュボードの右上にある 4 つのタービンの風速を表示する棒グラフ。

注記

次の例は、ダッシュボードの折れ線グラフと棒グラフの視覚化を表します。このダッシュボードは、風力発電所のダッシュボードの例に似ています。

{
  "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"
        }
      ]
    }
  ]
}