创建物联网数据

1. 概述

1.1 功能概述

Wyn 提供了三种高效的数据传输模式，用于接入物联网数据：MQTT、HTTP和WebSocket。每种模式均具备独特的优势，适用于不同的场景需求。

• MQTT： 一种轻量级的发布/订阅模式协议，特别适合资源受限或网络不稳定的环境。通过“订阅”机制，仅接收所需的主题消息，从而节省带宽与能耗，实现高效的信息交换。

• HTTP： 互联网上广泛的一种网络协议。在物联网场景中，采用HTTP轮询方式，设备定期向服务器请求最新状态或控制指令，适合数据更新频率较低的应用，确保数据的准确性和安全性。

• WebSocket： 提供全双工通信渠道，允许服务器主动向客户端推送数据，无需客户端频繁请求，适合需要持续接收消息的场景。

根据系统需求选择合适的数据接入方式。在接入物联网数据时，您需要填写连接信息、设计消息模板，并基于消息模板创建虚拟实体，以便在仪表板中消费数据。本节将详细介绍如何接入简单的物联网数据并进行管理，后续章节将详细讲解设计器中的具体操作。

2. 操作步骤

2.1 前提条件

1. 数据集使用限制：物联网数据集仅限用于仪表板。

2. 权限要求： 系统管理员可创建物联网数据。其他用户如需创建物联网数据，需满足以下条件：

   1. 用户权限设置：系统管理员给用户对应的角色/组织设置创建物联网数据的权限，否则无法无法创建物联网数据。具体权限说明详见权限说明。

2.2 操作步骤

步骤一：创建文档，选择仪表板的准备数据

1. 文档门户单击创建文档 ，选择仪表板的准备数据，然后选择物联网数据集的创建按钮，进入物联网数据集的数据准备界面。

   
   

步骤二：进入物联网数据设计器

1. 物联网数据集设计界面分为三部分：

• 上方为菜单栏： 可以保存/更新/关闭文档、测试连接，并显示文档名称。

• 左侧： ：连接信息的表单，用于填写和修改连接信息及消息模板。

• 右侧： ：设计虚拟实体的区域。

  
  

步骤三：填写连接配置信息

1. 带红色星号的配置为必填项。以下是各协议的配置示例：

   类型	配置示例
   MQTT 协议
   WebSocket 协议
   HTTP 协议

2. 配置说明：

   连接类型	参数	是否必填	说明
   MQTT	服务器地址	是	MQTT Broker地址和端口，支持主机名或IP地址，默认端口1883，也支持填写ws地址。 示例: localhost或10.32.3.173
   	主题	是	需要订阅的MQTT主题。
   	用户名	否	开启匿名访问时可不填。
   	密码	否	开启匿名访问时可不填。
   	开启SSL/TLS加密	是	默认关闭。
   	字符集	是	支持UTF-8、GBK、Big5三种字符集，默认字符集UTF-8。
   WebSocket	接口地址	是	只需填写WebSocket 接口地址。
   HTTP	端点地址	是	HTTP请求的端点地址。
   	请求方法	是	可选 GET 或 POST，默认GET。
   	地址请求头	否	为当前选择的端点地址配置请求头，可添加 Http 头字段，可设置字段名称和字段值。
   	有效载荷	否	当使用 POST 请求方法时，可根据需要传输数据的类型设置有效载荷。 选项：none, raw, x-www-form-urlencoded
   	Raw类型	否	当有效载荷选择raw时，可选择raw类型，选项：text、javascript、json、html、xml。

步骤四：测试连接（可选）

1. 配置信息全部填写完毕后，单击页面上方菜单栏中的测试连接按钮，验证配置是否正确。

   
   

2. 连接成功后，单击确定按钮。

   
   

步骤五：输入示例消息

1. 在文本框中输入示例消息，确保消息模板的内容与接收的消息格式一致。

   
   

2. 当输入非法 JSON 时，系统会显示警告或错误提示；若输入合法 JSON，可单击“格式化”按钮美化显示。

步骤六：生成示例消息结构的JSON树

1. 单击示例消息输入框下方的设计虚拟实体按钮，右侧将显示示例消息的结构。

   
   

• 搜索框： 上方搜索框中可搜索消息结构中的节点。

• 消息结构： 中间红框内呈现消息结构，如果节点较深或层级较多，无法完整呈现整个消息结构时，可以拖拽右侧和下方滚动条。

• 操作按钮： 下方为操作按钮，当选中消息结构中的节点时，可单击创建实体并添加或添加到选中的实体。

JSON树

• JSON树中，数组节点会显示数组图标 ，对象节点会显示对象图标 ；

• 展开按钮 指挥呈现在数组和对象节点；

• 示例消息如果是JSON数组，根节点显示“Array“，否则显示“Object“；

• 选中父节点会自动全选子节点，选中根节点会自动全选所有节点；

• 如果示例消息中节点是数组且包含多个元素，消息结构中仅呈现第一个元素的结构。

步骤七：添加字段到虚拟实体

选中消息结构中的一个或多个节点，单击消息结构下方的创建实体并添加按钮，将节点添加到虚拟实体。

1. 首次添加时，系统会自动创建一个虚拟实体，并将选中的节点添加到这个新的虚拟实体中。

2. 如果已有创建好的虚拟实体，选中消息结构的节点，选中虚拟实体，单击添加到选中的实体按钮，将选中的节点添加到指定的虚拟实体。

   
   

   type=info

   注意： 如果选中的节点在数组节点下，在单击添加到虚拟实体时，需为选中的数组节点添加过滤器，详情请参考对象数据使用过滤器筛选数据。

步骤八：虚拟实体中的数据类型

将选中的JSON的节点添加到虚拟实体中后，在虚拟实体的卡片中会呈现出这个属性的值，值的数据来自于示例消息中的JSON文本。

1. 系统会根据示例消息中的值推断数据类型。以下为示例：

   属性	值	类型	推断理由
   deviceId	device001	字符串	包含数字、字母或其它字符，无法转换为其它类型的是字符串。
   timestamp	2023-07-08T14:30:00Z	日期时间	格式符合ISO 8601标准，通常用于表示具体的日期和时间。在 Wyn 中，这种格式的数据通常会被解析为日期时间类型。
   temperature	25.3	数字	浮点数和整数都是数字类型。
   battery	82	数字	浮点数和整数都是数字类型。
   online	true	布尔	值为true和false时是布尔类型。

   
   

步骤九：虚拟实体卡片的操作

1. 修改虚拟实体名称

   系统默认分配虚拟实体名称（如”虚拟实体1“），可单击名称直接编辑。

   
   

2. 为属性创建别名

   默认使用节点名作为虚拟实体中的属性名称。若不希望在仪表板中使用默认名称，可为属性添加别名。若节点名与现有属性名重复，系统会自动分配别名（可修改）。

   
   

   type=info

   命名规则： 虚拟实体名称与属性别名仅支持中文、数字、字母、下划线。

3. 收起展开虚拟实体卡片

   单击虚拟实体标题栏左侧的收起/展开按钮，可操作虚拟实体卡片中属性展开或收起。

   
   

4. 删除虚拟实体或删除虚拟实体中的属性

• 删除虚拟实体： 单击标题栏最右侧的删除按钮。

• 删除属性： 单击属性行最右侧的删除按钮。

  
  

步骤十：保存文档

1. 创建好虚拟实体后，单击保存按钮，弹出保存文档的对话框，填写文档名称和文档描述信息，单击确定即可保存文档。

   
   

2. 保存成功后，系统会自动开启物联网数据的订阅，此时即可在仪表板中使用该文档。

2.3 成果展示

成功展示请参考在仪表板中使用物联网数据。

Wyn 成功创建物联网数据集后，可以在「文档门户>我的分析>物联网数据」列表中找到创建成功的物联网数据集。更多介绍，请见数据集/数据模型协作与管理。

3. 注意事项

1. 物联网数据设计器中必填项未填时无法单击保存按钮。

2. 保存文档前至少需要设计一个有字段的虚拟实体。

3. 测试连接结果不影响文档保存。