View a markdown version of this page

Créez des tableaux de bord avec AWS CLI - AWS IoT SiteWise

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Créez des tableaux de bord avec AWS CLI

Note

La fonction SiteWise Surveiller n'est plus disponible pour les nouveaux clients. Les clients existants peuvent continuer à utiliser le service normalement. Pour plus d'informations, voir SiteWise Surveiller les changements de disponibilité.

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 dashboardDefinition JSON. Cette définition est un paramètre des UpdateDashboard opérations CreateDashboard et.

displaySettings

Les paramètres d'affichage avec les paramètres suivants :

  • numRows— Nombre de lignes dans la disposition du tableau de bord. La largeur de chaque ligne est celle de CellSize.

  • numColumbs— Nombre de colonnes dans la disposition du tableau de bord. La largeur de chaque colonne est celle de CellSize.

  • cellSize— (Facultatif) Taille d'une cellule dans la mise en page en pixels. Ce doit être un nombre positif. La valeur par défaut est 10.

  • significantDigits— (Facultatif) Nombre de chiffres significatifs à afficher dans le tableau de bord. La valeur par défaut est 4.

querySettings

Les informations de requête avec le paramètre suivant :

  • refreshRate— (Facultatif) Vitesse d'actualisation des données en millisecondes. Accepte les valeurs suivantes : 1000, 5000, 10000, 60000, 300000.

defaultViewport

S'il n'est pas fourni, la valeur par défaut est les cinq dernières minutes. Contient les paramètres suivants :

  • duration— (Facultatif) Détermine jusqu'à quelle distance dans le passé les données doivent être consultées à partir du moment présent.

  • start— (Facultatif) Il est de type Date. La plage horaire de début pour interroger les données. Nécessite qu'une end date soit spécifiée.

  • end— (Facultatif) Il est de type Date. La plage horaire de fin pour interroger les données. Nécessite qu'une start date soit spécifiée.

widgets

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

type

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

  • xy-plot— Un graphique linéaire ou un nuage de points selon la configuration.

  • bar-chart— Un graphique à barres.

  • kpi-chart— Un graphique des principaux indicateurs de performance.

  • status-timeline— Un widget d'état qui permet de visualiser et de parcourir les données de séries chronologiques provenant d'une ou de plusieurs sources de données.

  • text— Un widget de texte.

  • table— Un widget de tableau.

id

Identifiant unique pour le widget.

x

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

y

Position verticale du widget, en commençant par le haut du tableau de bord. Cette valeur fait référence à la position du widget dans la grille du tableau de bord.

z

L'ordre relatif des widgets. Un widget de valeur Z plus grand est affiché devant le widget de valeur Z inférieur, s'ils se chevauchent.

width

Largeur du widget, exprimée en nombre de cellules sur le tableau de bord.

height

Hauteur du widget, exprimée en nombre de cellules sur le tableau de bord.

properties

Liste des propriétés du widget. Cela varie en fonction du type de widget. Consultez le kit d'applications IoT pour plus de détails.

Exemple 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 "Example 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 :


{
    "displaySettings": {
        "numColumns": 200,
        "numRows": 1000,
        "cellSize": 20,
        "significantDigits": 4
    },
    "widgets": [{
        "id": "Ot73JcxUoc6oEXAMPLE",
        "type": "xy-plot",
        "width": 33,
        "height": 20,
        "x": 0,
        "y": 0,
        "z": 0,
        "properties": {
            "aggregationType": "AVERAGE",
            "queryConfig": {
                "source": "iotsitewise",
                "query": {
                    "assets": [{
                        "assetId": "97c97abf-e883-47bb-a3f4-EXAMPLE",
                        "properties": [{
                            "propertyId": "97cc61f4-57a4-4c5f-a82c-EXAMPLE",
                            "refId": "692ce941-f3d9-4074-a297-EXAMPLE",
                            "aggregationType": "AVERAGE",
                            "color": "#7d2105",
                            "resolution": "1m"
                        }]
                    }],
                    "properties": [],
                    "assetModels": [],
                    "alarms": [],
                    "alarmModels": []
                }
            },
            "line": {
                "connectionStyle": "linear",
                "style": "solid"
            },
            "symbol": {
                "style": "filled-circle"
            },
            "axis": {
                "yVisible": true,
                "xVisible": true
            },
            "legend": {
                "visible": true,
                "position": "right",
                "width": "30%",
                "height": "30%",
                "visibleContent": {
                    "unit": true,
                    "asset": true,
                    "latestValue": true,
                    "latestAlarmStateValue": true,
                    "maxValue": false,
                    "minValue": false
                }
            }
        }
    }, {
        "id": "fto7rF40Ny1EXAMPLE-G",
        "type": "bar-chart",
        "width": 33,
        "height": 20,
        "x": 0,
        "y": 20,
        "z": 0,
        "properties": {
            "aggregationType": "AVERAGE",
            "queryConfig": {
                "source": "iotsitewise",
                "query": {
                    "assets": [{
                        "assetId": "97c97abf-e883-47bb-a3f4-EXAMPLE",
                        "properties": [{
                            "propertyId": "c84ca8f3-3dea-478a-afec-EXAMPLE",
                            "aggregationType": "AVERAGE",
                            "refId": "2960b958-2034-4d6e-bcc2-EXAMPLE"
                        }]
                    }],
                    "properties": [],
                    "assetModels": [],
                    "alarms": [],
                    "alarmModels": [],
                    "requestSettings": {
                        "aggregation": "AVERAGE"
                    }
                }
            },
            "axis": {
                "showX": true,
                "showY": true
            },
            "styleSettings": {
                "2960b958-2034-4d6e-bcc2-360f1f02e505": {
                    "color": "#7d2105"
                }
            }
        }
    }],
    "querySettings": {
        "refreshRate": 5000
    }
}