创建控制面板 (Amazon Command Line Interface) - Amazon IoT SiteWise
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

创建控制面板 (Amazon Command Line Interface)

当您使用 Amazon CLI 在控制面板中定义可视化内容(或小部件)时,必须在 dashboardDefinition JSON 文档中指定以下信息。这个定义是的参数CreateDashboardUpdateDashboard操作。

widgets

小部件定义结构的列表,其中每个结构均包含以下信息:

type

小部件的类型。Amazon IoT SiteWise 提供了以下小部件类型:

  • sc-line-chart— 折线图。有关更多信息,请参阅折线图在里面Amazon IoT SiteWise Monitor应用指南.

  • sc-scatter-chart— 散点图。有关更多信息,请参阅散点图在里面Amazon IoT SiteWise Monitor应用指南.

  • sc-bar-chart— 条形图。有关更多信息,请参阅条图在里面Amazon IoT SiteWise Monitor应用指南.

  • sc-status-grid— 一个状态控件,以网格形式显示资产属性的最新值。有关更多信息,请参阅Status 小组件在里面Amazon IoT SiteWise Monitor应用指南.

  • sc-status-timeline— 一个状态控件,以时间轴的形式显示资产属性的历史值。有关更多信息,请参阅Status 小组件在里面Amazon IoT SiteWise Monitor应用指南.

  • sc-kpi— 关键绩效指标 (KPI) 可视化。有关更多信息,请参阅KPI 小组件在里面Amazon IoT SiteWise Monitor应用指南.

  • sc-table— 表格控件。有关更多信息,请参阅表格小组件在里面Amazon IoT SiteWise Monitor应用指南.

title

小部件的标题。

x

小部件的水平位置,从网格的左侧开始。此值表示小部件在控制面板网格中的位置。

y

小部件的垂直位置,从网格的顶部开始。此值表示小部件在控制面板网格中的位置。

width

小部件的宽度,用控制面板网格上的空格数表示。

height

小部件的高度,用控制面板网格上的空格数表示。

metrics

指标结构的列表,其中每个结构均为此小部件定义一个数据流。此列表中的每个结构都必须包含以下信息:

label

要为此指标显示的标签。

type

此指标的数据源类型。Amazon IoT SiteWise 提供以下指标类型:

  • iotsitewise— 仪表板在中获取资产属性的数据Amazon IoT SiteWise. 如果选择此选项,则必须为此指标定义 assetIdpropertyId

assetId

(可选)Amazon IoT SiteWise 中的资产的 ID。

如果您在该指标中为 type 选择 iotsitewise,则此字段是必填字段。

propertyId

(可选)Amazon IoT SiteWise 中的资产属性的 ID。

如果您在该指标中为 type 选择 iotsitewise,则此字段是必填字段。

analysis

(可选)定义要为构件显示的分析(例如趋势线)的结构。有关更多信息,请参阅配置趋势线在里面Amazon IoT SiteWise Monitor应用指南. 您可以在控件中为每个属性添加每种类型的趋势线中的一条。分析结构包含以下信息:

trends

(可选)趋势结构列表,每个趋势结构定义了此控件的趋势分析。此列表中的每个结构包含以下信息:

type

趋势线的类型。选择以下选项:

  • linear-regression— 显示线性回归线。 SiteWise Monity 使用最小二乘户计算线性回归的方法。

annotations

(可选)定义构件阈值的注释结构。有关更多信息,请参阅配置阈值在里面Amazon IoT SiteWise Monitor应用指南. 您最多可以为每个控件添加六个注释。注释结构包含以下信息:

y

(可选)注释结构列表,每个注释结构都定义了此构件的水平阈值。此列表中的每个结构包含以下信息:

comparisonOperator

阈值的比较运算符。选择以下选项之一:

  • LT— 突出显示至少少一个数据点的属性value.

  • GT— 突出显示至少一个数据点大于value.

  • LTE— 突出显示至少有一个数据点小于或等于以下的属性value.

  • GTE— 突出显示至少具有大于或等于以下数据点的属性value.

  • EQ— 突出显示至少有一个数据点等于value.

value

用于将数据点与数据点进行比较的阈值comparisonOperator.

color

(可选)阈值颜色的 6 位十六进制代码。对于至少有一个符合阈值规则的数据点的属性,可视化以这种颜色显示属性图例。默认值为黑色 (#000000)。

showValue

(可选)是否在构件的空白处显示阈值的值。默认值为 true

properties

(可选)构件属性的平面字典。此结构的成员取决于上下文。Amazon IoT SiteWise提供以下使用的小部件properties

  • 折线图,散点图,以及条图具有以下属性:

    colorDataAcrossThresholds

    (可选)是否更改此小组件中超过阈值的数据的颜色。启用此选项时,超过阈值的数据将以您选择的颜色显示。默认值为 true

  • Status G户具有以下属性:

    labels

    (可选)一种结构,用于定义要在状态网格上显示的标签。标签结构包含以下信息:

    showValue

    (可选)是否在此控件中显示每个资产属性的单位和值。默认值为 true

例 示例控制面板定义

以下示例从存储在 JSON 文件中的负载定义控制面板。

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

针对 dashboard-definition.json 的以下 JSON 示例定义具有以下可视化小部件的控制面板:

  • 控制面板左上角的直观显示风电场总功率的折线图。此折线图包括一个阈值,该阈值表示风电场的输出功率何时低于其最低预期输出。此折线图还包括线性回归趋势线。

  • 控制面板右上角的直观显示四个涡轮机的风速的折线图。

注意

此示例表示仪表板上的折线图和条形图可视化。此控制面板与示例风电场控制面板类似。

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