Creación de paneles de control (AWS Command Line Interface)

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

widgets

Llista de estructuras de definición de widgets que contiene cada una la siguiente información:

type

Tipo de widget. AWS IoT SiteWise proporciona los siguientes tipos de widget:

• sc-line-chart: un gráfico de líneas. Para obtener más información, consulte Gráficos de líneas en la Guía de la aplicación AWS IoT SiteWise Monitor.

• sc-scatter-chart: un gráfico de dispersión. Para obtener más información, consulte Gráficos de dispersión en la Guía de la aplicación AWS IoT SiteWise Monitor.

• sc-bar-chart: un gráfico de barras. Para obtener más información, consulte Gráficos de barras en la Guía de la aplicación AWS IoT SiteWise Monitor.

• sc-status-grid: un widget de estado que muestra el último valor de las propiedades de recursos en forma de cuadrícula. Para obtener más información, consulte Widgets de estado en la Guía de la aplicación AWS IoT SiteWise Monitor.

• sc-status-timeline: un widget de estado que muestra los valores históricos de las propiedades de recursos como línea temporal. Para obtener más información, consulte Widgets de estado en la Guía de la aplicación AWS IoT SiteWise Monitor.

• sc-kpi: una visualización de indicadores clave de rendimiento (KPI). Para obtener más información, consulte Widgets de KP en la Guía de la aplicación AWS IoT SiteWise Monitor.

• sc-table: un widget de tabla. Para obtener más información, consulte Widgets de tabla en la Guía de la aplicación AWS IoT SiteWise Monitor.

title

Título del widget.

x

Posición horizontal del widget, comenzando desde la izquierda de la cuadrícula. Este valor se refiere a la posición del widget en la cuadrícula del panel.

y

Posición vertical del widget, comenzando desde la parte superior de la cuadrícula. Este valor se refiere a la posición del widget en la cuadrícula del panel.

width

Anchura del widget, expresada en número de espacios en la cuadrícula del panel.

height

Altura del widget, expresada en número de espacios en la cuadrícula del panel.

metrics

Lista de estructuras métricas que definan cada una un flujo de datos para este widget. Cada estructura de la lista debe contener la siguiente información:

label

Etiqueta que se mostrará para esta métrica.

type

Tipo de origen de datos para esta métrica. AWS IoT SiteWise proporciona los siguientes tipos de métrica:

• iotsitewise: el panel de control obtiene datos de una propiedad de recurso en AWS IoT SiteWise. Si elige esta opción, deberá definir assetId y propertyId para esta métrica.

assetId

(Opcional) ID de un activo en AWS IoT SiteWise.

Este campo es obligatorio si elige iotsitewise para type en esta métrica.

propertyId

(Opcional) ID de una propiedad de activo en AWS IoT SiteWise.

Este campo es obligatorio si elige iotsitewise para type en esta métrica.

analysis

(Opcional) Una estructura que define el análisis, como líneas de tendencia, que se mostrará para el widget. Para obtener más información, consulte Configuración de líneas de tendencia en la Guía de la aplicación AWS IoT SiteWise Monitor. Puede añadir una línea de tendencia de cada tipo por propiedad en el widget. La estructura de análisis contiene la siguiente información:

trends

(Opcional) Lista de estructuras de tendencia que definan cada una un análisis de tendencia para este widget. Cada estructura de la lista contiene la siguiente información:

type

El tipo de línea de tendencia. Elija la opción siguiente:

• linear-regression— Mostrar una línea de regresión lineal. SiteWise El monitor utiliza el método de mínimos cuadrados para calcular la regresión lineal.

annotations

(Opcional) Una estructura de anotaciones que define umbrales para el widget. Para obtener más información, consulte Configuración de umbrales en la Guía de la aplicación AWS IoT SiteWise Monitor. Puede añadir hasta seis anotaciones por widget. La estructura de anotación contiene la siguiente información:

y

(Opcional) Lista de estructuras de anotación que definan cada una un umbral horizontal para este widget. Cada estructura de la lista contiene la siguiente información:

comparisonOperator

El operador de comparación para el umbral. Seleccione una de las siguientes opciones:

• LT: resalta las propiedades que tienen al menos un punto de datos menor que value.

• GT: resalta las propiedades que tienen al menos un punto de datos mayor que value.

• LTE: resalta las propiedades que tienen al menos un punto de datos menor o igual que value.

• GTE: resalta las propiedades que tienen al menos un punto de datos mayor o igual que value.

• EQ: Resalta las propiedades que tienen al menos un punto de datos igual que value.

value

El valor de umbral para comparar los puntos de datos con comparisonOperator.

color

(Opcional) El código hexadecimal de 6 dígitos del color del umbral. La visualización muestra leyendas de propiedades en este color para las propiedades con al menos un punto de datos que cumpla la regla de umbral. De forma predeterminada es negro (#000000).

showValue

(Opcional) Mostrar o no el valor del umbral en los márgenes del widget. El valor predeterminado es true.

properties

(Opcional) Un diccionario plano de propiedades para el widget. Los miembros de esta estructura dependen del contexto. AWS IoT SiteWise proporciona los siguientes widgets que utilizan properties:

• Los Gráficos de líneas, Gráficos de dispersión, y Gráficos de barras tienen la siguiente propiedad:

  colorDataAcrossThresholds

  (Opcional) Cambiar o no el color de los datos que cruzan los umbrales en este widget. Al habilitar esta opción, los datos que cruzan un umbral aparecen en el color que usted elija. El valor predeterminado es true.

• Las cuadrículas de estado tienen la siguiente propiedad:

  labels

  (Opcional) Una estructura que defina las etiquetas que se mostrarán en la cuadrícula de estado. La estructura de etiquetas contiene la siguiente información:

  showValue

  (Opcional) Mostrar o no la unidad y el valor de cada propiedad de recurso en este widget. El valor predeterminado es true.

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 "Wind Farm 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:

• Un gráfico de líneas que muestra la energía eólica total en la parte superior izquierda del panel. Este gráfico de líneas incluye un umbral que indica cuándo el parque eólico produce menos energía que su producción mínima prevista. Este gráfico de líneas también incluye una línea de tendencia de regresión lineal.

• Un gráfico de barras que muestra la velocidad del viento de cuatro turbinas en la parte superior derecha del panel.

nota

Este ejemplo representa visualizaciones de gráficos de líneas y barras en un panel de control. Este panel es similar al ejemplo de panel de energía eólica.

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