Création de tableaux de bord (AWS Command Line Interface)

Lorsque vous définissez des visualisations (ou des widgets) dans des tableaux de bord à l'aide de AWS CLI, vous devez spécifier les informations suivantes dans le document JSON dashboardDefinition. Cette définition est un paramètre des UpdateDashboardopérations CreateDashboardet.

widgets

Liste des structures de définition de widget contenant chacune les informations suivantes :

type

Type de widget. AWS IoT SiteWise fournit les types de widget suivants :

• sc-line-chart— Un graphique linéaire. Pour plus d'informations, voir les diagrammes linéaires dans le guide AWS IoT SiteWise Monitor d'application.

• sc-scatter-chart— Un diagramme de points. Pour plus d'informations, reportez-vous à la section Graphiques de points dans le guide AWS IoT SiteWise Monitor d'application.

• sc-bar-chart— Un graphique à barres. Pour plus d'informations, voir les diagrammes à barres dans le guide AWS IoT SiteWise Monitor d'application.

• sc-status-grid— Un widget d'état qui affiche la dernière valeur des propriétés des actifs sous forme de grille. Pour plus d'informations, consultez la section Widgets d'état dans le guide de AWS IoT SiteWise Monitor candidature.

• sc-status-timeline— Un widget d'état qui affiche les valeurs historiques des propriétés des actifs sous forme de chronologie. Pour plus d'informations, consultez la section Widgets d'état dans le guide de AWS IoT SiteWise Monitor candidature.

• sc-kpi— Une visualisation des indicateurs de performance clés (KPI). Pour plus d'informations, consultez la section Widgets KPI dans le guide de AWS IoT SiteWise Monitor l'application.

• sc-table— Un widget de tableau. Pour plus d'informations, consultez la section Widgets de tableau dans le guide de AWS IoT SiteWise Monitor l'application.

title

Le titre du widget.

x

Position horizontale du widget, à partir de la gauche de la grille. Cette valeur fait référence à la position du widget dans la grille du tableau de bord.

y

Position verticale du widget, à partir du haut de la grille. Cette valeur fait référence à la position du widget dans la grille du tableau de bord.

width

Largeur du widget, exprimée en nombre d'espaces sur la grille du tableau de bord.

height

Hauteur du widget, exprimée en nombre d'espaces sur la grille du tableau de bord.

metrics

Liste des structures de métrique qui définissent chacune un flux de données pour ce widget. Chaque structure de la liste doit contenir les informations suivantes :

label

Étiquette à afficher pour cette métrique.

type

Type de source de données pour cette mesure. AWS IoT SiteWise fournit les types de métriques suivants :

• iotsitewise— Le tableau de bord récupère les données d'une propriété d'actif dansAWS IoT SiteWise. Si vous choisissez cette option, vous devez définir assetId et propertyId pour cette métrique.

assetId

(Facultatif) ID d'une ressource dans AWS IoT SiteWise.

Ce champ est obligatoire si vous choisissez iotsitewise pour type cette métrique.

propertyId

(Facultatif) ID d'une propriété d'actif dans AWS IoT SiteWise.

Ce champ est obligatoire si vous choisissez iotsitewise pour type cette métrique.

analysis

(Facultatif) Structure qui définit l'analyse, telle que les courbes de tendance, à afficher pour le widget. Pour plus d'informations, consultez la section Configuration des courbes de tendance dans le Guide de AWS IoT SiteWise Monitor l'application. Vous pouvez ajouter une courbe de tendance de chaque type par propriété dans le widget. La structure d'analyse contient les informations suivantes :

trends

(Facultatif) Une liste de structures de tendance qui définissent chacune une analyse des tendances pour ce widget. Chaque structure de la liste contient les informations suivantes :

type

Type de ligne de tendance. Choisissez l'option suivante :

• linear-regression— Affiche une droite de régression linéaire. SiteWise Monitor utilise la méthode des moindres carrés pour calculer la régression linéaire.

annotations

(Facultatif) Une structure d'annotations qui définit les seuils pour le widget. Pour plus d'informations, consultez la section Configuration des seuils dans le Guide de AWS IoT SiteWise Monitor l'application. Vous pouvez ajouter jusqu'à six annotations par widget. La structure des annotations contient les informations suivantes :

y

(Facultatif) Liste des structures d'annotation qui définissent chacune un seuil horizontal pour ce widget. Chaque structure de la liste contient les informations suivantes :

comparisonOperator

L'opérateur de comparaison pour le seuil. Sélectionnez l'une des méthodes suivantes :

• LT— Mettez en évidence les propriétés dont au moins un point de données est inférieur àvalue.

• GT— Mettez en évidence les propriétés dont au moins un point de données est supérieur àvalue.

• LTE— Mettez en évidence les propriétés dont au moins un point de données est inférieur ou égal àvalue.

• GTE— Mettez en évidence les propriétés dont au moins un point de données est supérieur ou égal àvalue.

• EQ— Mettez en évidence les propriétés dont au moins un point de données est égal àvalue.

value

La valeur de seuil pour comparer les points de données aveccomparisonOperator.

color

(Facultatif) Le code hexadécimal à 6 chiffres de la couleur du seuil. La visualisation affiche les légendes des propriétés dans cette couleur pour les propriétés dont au moins un point de données répond à la règle du seuil. La valeur par défaut est black (#000000).

showValue

(Facultatif) Indique s'il faut afficher ou non la valeur du seuil dans les marges du widget. La valeur par défaut est true.

properties

(Facultatif) Un dictionnaire plat des propriétés du widget. Les membres de cette structure dépendent du contexte. AWS IoT SiteWisefournit les widgets suivants qui utilisent properties :

• Les graphiques linéaires, les graphiques en nuage de points et les graphiques à barres présentent les propriétés suivantes :

  colorDataAcrossThresholds

  (Facultatif) S'il faut ou non modifier la couleur des données qui dépassent les seuils dans ce widget. Lorsque vous activez cette option, les données qui franchissent un seuil apparaissent dans la couleur que vous choisissez. La valeur par défaut est true.

• Les grilles de statut ont les propriétés suivantes :

  labels

  (Facultatif) Structure qui définit les étiquettes à afficher sur la grille d'état. La structure des étiquettes contient les informations suivantes :

  showValue

  (Facultatif) Indique s'il faut afficher ou non l'unité et la valeur de chaque propriété d'actif dans ce widget. La valeur par défaut est true.

Exemple de définition de tableau de bord

L'exemple suivant définit un tableau de bord à partir d'une charge utile stockée dans un fichier JSON.

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

L'exemple JSON suivant pour dashboard-definition.json définit un tableau de bord avec les widgets de visualisation suivants :

• Graphique linéaire qui visualise la puissance totale du parc éolien en haut à gauche du tableau de bord. Ce graphique linéaire inclut un seuil qui indique le moment où le parc éolien produit moins d'énergie que sa production minimale attendue. Ce graphique linéaire inclut également une courbe de tendance de régression linéaire.

• Diagramme à barres qui visualise la vitesse du vent pour quatre turbines en haut à droite du tableau de bord.

Note

Cet exemple représente des visualisations de graphiques linéaires et à barres sur un tableau de bord. Ce tableau de bord est similaire à l'exemple de tableau de bord de parc éolien.

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