边缘智能的官方 REST 驱动提供了基于 HTTP 协议的数据通信方式,支持第三方应用以异步的形式将数据推送到边缘智能平台。您可以在节点(一体机)上部署 REST 驱动,并添加设备来接收 HTTP 数据。本文介绍了官方 REST 驱动的使用方法。
您可以在边缘智能控制台的 设备管理 > 驱动模板 页面,查看边缘智能的官方 REST驱动。
使用 REST 驱动前,您需要准备一台边缘智能节点,并完成以下工作:
物模型是现场设备实体在边缘智能控制台的数字化表示。您通过物模型定义设备相关的数据对象。
登录边缘智能控制台。
在左侧导航栏顶部的 我的项目 区域,选择您的项目。
在左侧导航栏,选择 设备管理 > 设备模板。
(可选)创建一个设备模板。
如果您已经有设备模板,可以跳过该步骤。
本教程中使用 REST-device 作为设备模板的名称。
选择要使用的设备模板,单击模板的名称。
定义物模型。
在设备模板详情页,单击 物模型定义 页签。
单击 编辑。
在 默认模块 下,添加以下自定义功能。
说明
此处的 自定义功能 对应于 REST 驱动接收的数据对象。本文以接收整型数(int)为例进行介绍。
功能类型 | 名称 | 标识符 | 读写类型 | 数据类型 |
---|---|---|---|---|
属性 | 测试接收整型数 | test_int | 只读 | int |
单击 保存。
在 发布新版本 对话框,设置 版本号 和 描述,然后单击 确定。
本教程中使用 1.0.0.0 作为物模型的版本号。
发布版本后,您将会得到如下图所示的物模型。
您必须在节点上部署 REST 驱动,然后才可以添加 REST 设备到节点。
您提交部署请求后,系统将在节点上部署驱动实例。部署过程涉及到数据传输。根据现场网络环境不同,部署所需时间不同。请确保您的节点在线,并耐心等待部署完成。
驱动部署成功后,驱动实例状态 将变为 运行中。
在 基本信息 标签页,单击 添加设备。
在 添加设备 面板,完成以下配置,然后单击 确定。
配置项 | 说明 |
---|---|
名称 | 为设备设置一个名称。
|
标识符 | 为设备设置一个标识符。
|
设备模板 | 选择您在步骤1创建的设备模板。 |
点表 | 选择在创建点表中创建的点表。
|
子协议名称 | 选择 other。 |
标签 | 为设备添加标签。如果需要创建新的标签,输入 key 和 value 后,单击 创建标签。 |
描述 | 为设备添加描述信息。 |
完成以上操作后,您可以在设备列表查看新添加的设备。最初,设备的 状态 为 添加中。当设备的状态变为 在线 后,表示设备已经添加成功。
在 基本信息 标签页,单击 批量添加。
在 添加设备 页面,您可以在 驱动信息 区域查看驱动相关信息,并参考下表说明完成 设备配置,然后单击 确定。
子协议类型 | 选择 other。 |
---|---|
设备模板 | 选择您在步骤1创建的设备模板。 |
设备名称 | 为设备设置一个名称。
|
标识符 | 为设备设置一个标识符。
|
标签 | 为设备添加标签。如果需要创建新的标签,输入 key 和 value 后,单击 创建标签。 |
描述 | 为设备添加描述信息。 |
(可选)如果需要同时添加多个设备实例,在 添加设备 后的输入框中输入要添加的设备个数,然后单击 添加设备。系统会自动生成多个设备配置条目。
(可选)如果需要批量设置一些设备参数,先勾选右上角的 批量编辑所有配置项,然后修改某个参数值,系统会同步修改所有设备的对应参数值。
说明
勾选 批量编辑所有配置项 后,如果参数配置框置灰,表示该参数不支持批量设置。
完成以上操作后,您可以在设备列表查看新添加的设备。最初,设备的 状态 为 添加中。当设备的状态变为 在线 后,表示设备已经添加成功。
要验证 REST 驱动已在节点上成功部署,您可以通过 HTTP 协议向节点发送数据,然后在边缘智能控制台检查数据是否成功上报。
您在节点上部署官方 REST 驱动后,会使节点的 59986 端口开放,并提供以下 Endpoints 来接收来自第三方应用或端设备的异步数据:
/api/v2/resource/{deviceName}/{resourceName}
参数说明:
deviceName
:对应您在添加设备时为设备设置的名称。
本教程中,
deviceName
的示例值为 rest_device_1。
resourceName
:对应您在定义物模型时所添加的自定义功能的标识符。
本教程中,
resourceName
的示例值为 test_int。
您可以通过以下方式发送测试数据到节点:
注意
您必须先获取节点的 IP 地址,并使用和节点在同一网络中的设备发送数据。您可以在节点的基本信息中获取节点的 内网IP地址,或者通过 远程SSH 的方式连接节点,然后使用ifconfig
命令查询节点的 IP 地址。相关操作,请参见查看节点信息、访问节点。
在终端工具上使用curl
命令
curl <ip>:59986/api/v2/resource/device-name/property -XPOST -d '123'
示例:
下图演示了通过curl
命令向 REST 设备发送数据 “123”。
在 Postman 发送 API 请求
API 请求地址如下:
<ip>:59986/api/v2/resource/:deviceName/:resourceName
示例:
下图演示了通过 Postman 向 REST 设备发送数据 “456”。
测试数据发送后,您可以登录边缘智能控制台查看设备的运行数据。