Criando painéis (AWS Command Line Interface) - AWS IoT SiteWise

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Criando painéis (AWS Command Line Interface)

Ao definir visualizações (ou widgets) em painéis usando a AWS CLI, você deve especificar as seguintes informações no documento JSON dashboardDefinition. Essa definição é um parâmetro das UpdateDashboardoperações CreateDashboarde.

widgets

Uma lista de estruturas de definição de widget que contêm as seguintes informações:

type

O tipo de widget. O AWS IoT SiteWise fornece os seguintes tipos de widget:

  • sc-line-chart: um gráfico de linhas. Para obter mais informações, consulte Gráficos de linhas no Guia de aplicativo do AWS IoT SiteWise Monitor.

  • sc-scatter-chart: um gráfico de dispersão. Para obter mais informações, consulte Gráficos de dispersão no Guia de aplicativo do AWS IoT SiteWise Monitor.

  • sc-bar-chart: um gráfico de barras. Para obter mais informações, consulte Gráficos de barras no Guia de aplicativo do AWS IoT SiteWise Monitor.

  • sc-status-grid: um widget de status que mostra o valor mais recente das propriedades do ativo como uma grade. Para obter mais informações, consulte Widgets de status no Guia do aplicativo do AWS IoT SiteWise Monitor.

  • sc-status-timeline: um widget de status que mostra o valor mais recente das propriedades do ativo como uma linha do tempo. Para obter mais informações, consulte Widgets de status no Guia do aplicativo do AWS IoT SiteWise Monitor.

  • sc-kpi: uma visualização do indicador chave de desempenho (KPI). Para obter mais informações, consulte Widgets de KPI no Guia do aplicativo do AWS IoT SiteWise Monitor.

  • sc-table: um widget de tabela. Para obter mais informações, consulte Widgets de tabela no Guia do aplicativo do AWS IoT SiteWise Monitor.

title

O título do widget.

x

A posição horizontal do widget, começando à esquerda da grade. Esse valor se refere à posição do widget na grade do painel.

y

A posição vertical do widget, começando pelo topo da grade. Esse valor se refere à posição do widget na grade do painel.

width

A largura do widget, expressa em número de espaços na grade do painel.

height

A altura do widget, expressa em número de espaços na grade do painel.

metrics

Uma lista de estruturas de métricas em que cada uma define um fluxo de dados para este widget. Cada estrutura na lista deve conter as seguintes informações:

label

Um rótulo a ser exibido para essa métrica.

type

O tipo de fonte de dados para esta métrica. O AWS IoT SiteWise fornece os seguintes tipos de métrica:

  • iotsitewise: o painel obtém dados da propriedade de um ativo no AWS IoT SiteWise. Se você escolher essa opção, deverá definir assetId e propertyId para essa métrica.

assetId

(Opcional) O ID de um ativo no AWS IoT SiteWise.

Esse campo será obrigatório se você escolher iotsitewise para type nessa métrica.

propertyId

(Opcional) O ID de uma propriedade de ativo no AWS IoT SiteWise.

Esse campo será obrigatório se você escolher iotsitewise para type nessa métrica.

analysis

(Opcional) Uma estrutura que define a análise, como linhas de tendência, a ser exibida para o widget. Para obter mais informações, consulte Configurar linhas de tendência em Guia do aplicativo AWS IoT SiteWise Monitor. Você pode adicionar uma linha de tendência de cada tipo por propriedade no widget. A estrutura de análise contém as seguintes informações:

trends

(Opcional) Uma lista de estruturas de tendência, cada uma definindo uma análise de tendência para esse widget. Cada estrutura na lista contém as seguintes informações:

type

O tipo de linha de tendência. Escolha a seguinte opção:

  • linear-regression— Exibir uma linha de regressão linear. SiteWise O monitor usa o método dos mínimos quadrados para calcular a regressão linear.

annotations

(Opcional) Uma estrutura de anotações que define limites para o widget. Para obter mais informações, consulte Configurar limites em Guia do aplicativo do AWS IoT SiteWise Monitor. Você pode adicionar até seis anotações por widget. A estrutura de anotações contém as seguintes informações:

y

(Opcional) Uma lista de estruturas de anotação, cada uma definindo um limite horizontal para esse widget. Cada estrutura na lista contém as seguintes informações:

comparisonOperator

O operador de comparação para o limite. Escolha uma das seguintes opções:

  • LT: destaque propriedades que tenham pelo menos um ponto de dados menor que value.

  • GT: destaque propriedades que tenham pelo menos um ponto de dados maior que value.

  • LTE: destaque propriedades que tenham pelo menos um ponto de dados menor ou igual a value.

  • GTE: destaque propriedades que tenham pelo menos um ponto de dados maior ou igual a value.

  • EQ: destaque propriedades que tenham pelo menos um ponto de dados igual a value.

value

O valor limite para comparar os pontos de dados com o comparisonOperator.

color

(Opcional) O código hexadecimal de 6 dígitos da cor limite. A visualização exibe legendas de propriedades nesta cor para propriedades com pelo menos um ponto de dados que atenda à regra de limite. Padrões do preto (#000000).

showValue

(Opcional) Se deve ou não mostrar o valor do limite nas margens do widget. Padronizado como true.

properties

(Opcional) Um dicionário simples de propriedades para o widget. Os membros dessa estrutura dependem do contexto. AWS IoT SiteWise fornece os seguintes widgets que usam properties:

  • Gráficos de linhas, gráficos de dispersão e gráficos de barras têm a seguinte propriedade:

    colorDataAcrossThresholds

    (Opcional) Se deve ou não alterar a cor dos dados que ultrapassam os limites desse widget. Quando você ativa essa opção, os dados que ultrapassam um limite aparecem na cor que você escolher. Padronizado como true.

  • As grades de status têm a seguinte propriedade:

    labels

    (Opcional) Uma estrutura que define os rótulos a serem exibidos na grade de status. A estrutura dos rótulos contém as seguintes informações:

    showValue

    (Opcional) Se deve ou não exibir a unidade e o valor de cada propriedade do ativo nesse widget. Padronizado como true.

exemplo Exemplo de definição de painel

O exemplo a seguir define um painel de uma carga útil armazenada em um arquivo JSON.

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

O exemplo de JSON a seguir para dashboard-definition.json define o painel com os seguintes widgets de visualização:

  • Um gráfico de linhas que visualiza a potência total do parque eólico no canto superior esquerdo do painel. Esse gráfico de linhas inclui um limite que indica quando o parque eólico gera menos energia do que a produção mínima esperada. Esse gráfico de linhas também inclui uma linha de tendência de regressão linear.

  • Um gráfico de barras que visualiza a velocidade do vento para quatro turbinas no canto superior direito do painel.

nota

Esse exemplo representa visualizações de gráfico de linhas e de barras em um painel. Este painel é semelhante ao painel de exemplo do parque eólico.

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