View a markdown version of this page

Cree paneles con AWS CLI - AWS IoT SiteWise

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Cree paneles con AWS CLI

nota

La función SiteWise Monitor ya no está disponible para los nuevos clientes. Los clientes existentes pueden seguir utilizando el servicio con normalidad. Para obtener más información, consulte SiteWise Supervisar el cambio de disponibilidad.

Al definir visualizaciones (o widgets) en los paneles de control mediante el AWS CLI, debe especificar la siguiente información en el documento dashboardDefinition JSON. Esta definición es un parámetro de las operaciones CreateDashboard and UpdateDashboard.

displaySettings

La configuración de pantalla con los siguientes parámetros:

  • numRows— Número de filas en el diseño del tablero. Cada fila mide el ancho de una celda.

  • numColumbs— Número de columnas en el diseño del tablero. Cada columna mide el ancho de una celda.

  • cellSize— (Opcional) El tamaño de una celda del diseño en píxeles. Debe ser un número positivo. El valor predeterminado es 10.

  • significantDigits— (Opcional) Número de dígitos significativos que se mostrarán en el tablero. El valor predeterminado es 4.

querySettings

La información de la consulta con el siguiente parámetro:

  • refreshRate— (Opcional) La velocidad a la que los datos se actualizan en milisegundos. Acepta los valores siguientes: 1000, 5000, 10000, 60000, 300000.

defaultViewport

Si no se proporciona, el valor predeterminado es los últimos cinco minutos. Contiene los siguientes parámetros:

  • duration— (Opcional) Determina en qué momento del pasado se deben consultar los datos a partir del presente.

  • start— (Opcional) Es del tipo Fecha. El intervalo de tiempo de inicio para consultar los datos. Necesita especificar una end fecha.

  • end— (Opcional) Es del tipo Fecha. El intervalo de tiempo de finalización para consultar los datos. Necesita especificar una start fecha.

widgets

Una lista de estructuras de definición de widgets que contienen la siguiente información:

type

El tipo de widget. AWS IoT SiteWise proporciona los siguientes tipos de widgets:

  • xy-plot— Un gráfico de líneas o un diagrama de dispersión según la configuración.

  • bar-chart: un gráfico de barras.

  • kpi-chart— Un gráfico de indicadores clave de rendimiento.

  • status-timeline— Un widget de estado que visualiza y navega por los datos de series temporales de una o más fuentes de datos.

  • text— Un widget de texto.

  • table: un widget de tabla.

id

Un identificador único para el widget.

x

La posición horizontal del widget, empezando por la izquierda del tablero. Este valor se refiere a la posición del widget en la cuadrícula del panel.

y

La posición vertical del widget, empezando por la parte superior del tablero. Este valor se refiere a la posición del widget en la cuadrícula del panel.

z

El orden relativo de los widgets. Si se superponen, se muestra un widget con un valor Z más grande delante del widget con un valor Z más bajo.

width

El ancho del widget, expresado en número de celdas en el tablero.

height

La altura del widget, expresada en número de celdas en el tablero.

properties

Una lista de propiedades del widget. Varía según el tipo de widget. Consulta el Kit de aplicaciones de IoT para obtener más información.

ejemplo Ejemplo de definición de panel

En el ejemplo siguiente se define un panel a partir de una carga almacenada en un archivo JSON.

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

El siguiente ejemplo JSON para dashboard-definition.json define un panel con los siguientes widgets de visualización:


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