View a markdown version of this page

使用创建仪表板 Amazon CLI - Amazon IoT SiteWise
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

使用创建仪表板 Amazon CLI

注意

新客户不再可以使用 SiteWise 监控功能。现有客户可以继续正常使用该服务。有关更多信息,请参阅SiteWise 监控可用性变化。

使用在仪表板中定义可视化(或小部件)时 Amazon CLI,必须在 dashboardDefinition JSON 文档中指定以下信息。此定义是CreateDashboard和UpdateDashboard运算的参数。

displaySettings

具有以下参数的显示设置:

  • numRows— 仪表板布局中的行数。每行都是 cellSize 的宽度。

  • numColumbs— 仪表板布局中的列数。每列都是 cellSize 的宽度。

  • cellSize—(可选)布局中单元格的大小,以像素为单位。它必须是正数。默认值为 10。

  • significantDigits—(可选)仪表板中显示的有效位数。默认为 4。

querySettings

带有以下参数的查询信息:

  • refreshRate—(可选)以毫秒为单位的数据刷新速率。接受以下值-1000、5000、10000、60000、300000。

defaultViewport

如果未提供,则默认为最近五分钟。包含以下参数:

  • duration—(可选)确定从现在开始查询数据的时间有多远。

  • start—(可选)它的类型是日期。查询数据的开始时间范围。需要指定end日期。

  • end—(可选)它的类型是日期。查询数据的结束时间范围。需要指定start日期。

widgets

包含以下信息的控件定义结构列表:

type

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

  • xy-plot— 折线图或散点图,视配置而定。

  • bar-chart – 条形图。

  • kpi-chart— 关键绩效指标图表。

  • status-timeline— 一个状态小工具,用于可视化和导航来自一个或多个数据源的时间序列数据。

  • text— 文本小部件。

  • table – 表格控件。

id

控件的唯一标识符。

x

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

y

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

z

小部件的相对顺序。如果较大的 Z 值控件重叠,则较大的 Z 值控件会显示在较低的 Z 值控件前面。

width

控件的宽度,以仪表板上的单元格数表示。

height

控件的高度,以仪表板上的单元格数表示。

properties

控件的属性列表。它因小部件的类型而异。有关详细信息,请参阅 IoT 应用套件。

例示例控制面板定义

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

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

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

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