Erstellen von Dashboards (AWS Command Line Interface)

Wenn Sie Visualisierungen (oder Widgets) in Dashboards über die AWS CLI definieren, müssen Sie im dashboardDefinition-JSON-Dokument die folgenden Informationen angeben. Diese Definition ist ein Parameter der UpdateDashboard Operationen CreateDashboard und .

widgets

Eine Liste von Widget-Definitionsstrukturen, die jeweils die folgenden Informationen enthalten:

type

Der Typ des Widgets. AWS IoT SiteWise stellt die folgenden Widget-Typen bereit:

• sc-line-chart – Ein Liniendiagramm. Weitere Informationen finden Sie unter Liniendiagramme im AWS IoT SiteWise Monitor Anwendungshandbuch für .

• sc-scatter-chart – Ein Streudiagramm. Weitere Informationen finden Sie unter Musterdiagramme im AWS IoT SiteWise Monitor Anwendungshandbuch für .

• sc-bar-chart – Ein Balkendiagramm. Weitere Informationen finden Sie unter Balkendiagramme im AWS IoT SiteWise Monitor Anwendungshandbuch für .

• sc-status-grid – Ein Status-Widget, das den neuesten Wert von Komponenteneigenschaften als Raster anzeigt. Weitere Informationen finden Sie unter Status-Widgets im AWS IoT SiteWise Monitor Anwendungshandbuch für .

• sc-status-timeline – Ein Status-Widget, das die historischen Werte von Komponenteneigenschaften als Zeitleiste anzeigt. Weitere Informationen finden Sie unter Status-Widgets im AWS IoT SiteWise Monitor Anwendungshandbuch für .

• sc-kpi – Eine Key Performance Indikator (KPI)-Visualisierung. Weitere Informationen finden Sie unter KPI-Widgets im AWS IoT SiteWise Monitor Anwendungshandbuch für .

• sc-table – Ein Tabellen-Widget. Weitere Informationen finden Sie unter Tabellen-Widgets im AWS IoT SiteWise Monitor Anwendungshandbuch für .

title

Der Titel des Widgets.

x

Die horizontale Position des Widgets ausgehend von der linken Seite des Rasters. Dieser Wert bezieht sich auf die Position des Widgets im Raster des Dashboards.

y

Die vertikale Position des Widgets ausgehend vom oberen Rand des Rasters. Dieser Wert bezieht sich auf die Position des Widgets im Raster des Dashboards.

width

Die Breite des Widgets ausgedrückt als Anzahl der Leerzeichen im Raster des Dashboards.

height

Die Höhe des Widgets ausgedrückt als Anzahl der Leerzeichen im Raster des Dashboards.

metrics

Eine Liste von Metrikstrukturen, die jeweils einen Datenstrom für dieses Widget definieren. Jede Struktur in der Liste muss folgende Informationen enthalten:

label

Eine Beschriftung, die für diese Metrik angezeigt werden soll.

type

Der Typ der Datenquelle für diese Metrik. AWS IoT SiteWise stellt die folgenden Metriktypen bereit:

• iotsitewise – Das Dashboard ruft Daten für eine Komponenteneigenschaft in abAWS IoT SiteWise. Bei Auswahl dieser Option müssen Sie assetId und propertyId für diese Metrik definieren.

assetId

(Optional) Die ID einer Komponente in AWS IoT SiteWise.

Dieses Feld ist erforderlich, wenn Sie iotsitewise für type in dieser Metrik auswählen.

propertyId

(Optional) Die ID einer Komponenteneigenschaft in AWS IoT SiteWise.

Dieses Feld ist erforderlich, wenn Sie iotsitewise für type in dieser Metrik auswählen.

analysis

(Optional) Eine Struktur, die die Analyse definiert, z. B. Trendlinien, die für das Widget angezeigt werden soll. Weitere Informationen finden Sie unter Konfigurieren von Trendlinien im AWS IoT SiteWise Monitor Anwendungshandbuch für . Sie können eine jeden Typ von Trendlinie pro Eigenschaft im Widget hinzufügen. Die Analysestruktur enthält die folgenden Informationen:

trends

(Optional) Eine Liste von Trendstrukturen, die jeweils eine Trendanalyse für dieses Widget definieren. Jede Struktur in der Liste enthält die folgenden Informationen:

type

Der Typ der Trendlinie. Wählen Sie die folgende Option aus:

• linear-regression – Zeigen Sie eine lineare Regressionslinie an. SiteWise Monitor verwendet die Methode mit den geringsten Quadraten, um die lineare Regression zu berechnen.

annotations

(Optional) Eine Anmerkungsstruktur, die Schwellenwerte für das Widget definiert. Weitere Informationen finden Sie unter Konfigurieren von Schwellenwerten im AWS IoT SiteWise Monitor -Anwendungshandbuch. Sie können bis zu sechs Anmerkungen pro Widget hinzufügen. Die Annotationsstruktur enthält die folgenden Informationen:

y

(Optional) Eine Liste von Anmerkungsstrukturen, die jeweils einen horizontalen Schwellenwert für dieses Widget definieren. Jede Struktur in der Liste enthält die folgenden Informationen:

comparisonOperator

Der Vergleichsoperator für den Schwellenwert. Wählen Sie eine der folgenden Optionen aus:

• LT – Markieren Sie Eigenschaften, die mindestens einen Datenpunkt haben, der kleiner ist als value.

• GT – Markieren Sie Eigenschaften, die mindestens einen Datenpunkt größer als habenvalue.

• LTE – Markieren Sie Eigenschaften, die mindestens einen Datenpunkt haben, der kleiner oder gleich dem istvalue.

• GTE – Markieren Sie Eigenschaften, die mindestens einen Datenpunkt haben, der größer oder gleich der istvalue.

• EQ – Markieren Sie Eigenschaften, die mindestens einen Datenpunkt haben, der gleich istvalue.

value

Der Schwellenwert für den Vergleich von Datenpunkten mit dem comparisonOperator.

color

(Optional) Der sechsstellige Hexadezimalcode der Schwellenwertfarbe. Die Visualisierung zeigt Eigenschaftslegenden in dieser Farbe für Eigenschaften mit mindestens einem Datenpunkt an, der die Schwellenwertregel erfüllt. Standardmäßig schwarz (#000000).

showValue

(Optional) Gibt an, ob der Wert des Schwellenwerts in den Rändern des Widgets angezeigt werden soll oder nicht. Standardeinstellung: true.

properties

(Optional) Ein flaches Wörterbuch mit Eigenschaften für das Widget. Die Mitglieder dieser Struktur sind kontextabhängig. AWS IoT SiteWise bietet die folgenden Widgets, die verwendenproperties:

• Liniendiagramme , Streudiagramme und Balkendiagramme haben die folgende Eigenschaft:

  colorDataAcrossThresholds

  (Optional) Gibt an, ob die Farbe der Daten geändert werden soll, die die Schwellenwerte in diesem Widget überschreiten. Wenn Sie diese Option aktivieren, werden die Daten, die einen Schwellenwert überschreiten, in der von Ihnen ausgewählten Farbe angezeigt. Standardeinstellung: true.

• Statusraster haben die folgende Eigenschaft:

  labels

  (Optional) Eine Struktur, die die Beschriftungen definiert, die im Statusraster angezeigt werden sollen. Die Beschriftungsstruktur enthält die folgenden Informationen:

  showValue

  (Optional) Gibt an, ob die Einheit und der Wert für jede Komponenteneigenschaft in diesem Widget angezeigt werden sollen oder nicht. Standardeinstellung: true.

Beispiel Dashboard-Beispieldefinition

Im folgenden Beispiel wird ein Dashboard aus einer Nutzlast definiert, die in einer JSON-Datei gespeichert ist.

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

Das folgende JSON-Beispiel für dashboard-definition.json definiert ein Dashboard mit den folgenden Visualisierungs-Widgets:

• Ein Liniendiagramm, das die Gesamtleistung des Windparks oben links im Dashboards visualisiert. Dieses Liniendiagramm enthält einen Schwellenwert, der angibt, wann die Stromfarm weniger Strom ausgibt als seine minimal erwartete Ausgabe. Dieses Liniendiagramm enthält auch eine lineare Regressionstrendlinie.

• Ein Balkendiagramm, das die Windgeschwindigkeit für vier Turbinen oben rechts im Dashboard visualisiert.

Anmerkung

Dieses Beispiel stellt Linien- und Balkendiagrammvisualisierungen auf einem Dashboard dar. Dieses Dashboard ist dem Beispiel-Dashboard für einen Windpark ähnlich.

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