使用官方 REST 驱动

边缘智能的官方 REST 驱动提供了基于 HTTP 协议的数据通信方式，支持第三方应用以异步的形式将数据推送到边缘智能平台。您可以在一体机上部署 REST 驱动，并添加设备来接收 HTTP 数据。本文介绍了官方 REST 驱动的使用方法。

驱动说明

您可以在边缘智能控制台的 设备管理 > 驱动模板 页面，查看边缘智能的官方 REST驱动。

准备一体机

使用 REST 驱动前，您需要准备一台边缘一体机，并完成以下工作：

• 为一体机配置网络
• 为一体机绑定项目

步骤1：创建物模型

物模型是现场设备实体在边缘智能控制台的数字化表示。您通过物模型定义设备相关的数据对象。

1. 登录边缘智能控制台。

2. 在左侧导航栏顶部的 我的项目 区域，选择您的项目。

3. 在左侧导航栏，选择 设备管理 > 设备模板。

4. （可选）创建一个设备模板。
   如果您已经有设备模板，可以跳过该步骤。

   1. 单击 创建设备模板。
   2. 在 创建设备模板 对话框，为模板设置一个 名称 并添加 描述，然后单击 确定。

      本教程中使用 REST-device 作为设备模板的名称。

5. 选择要使用的设备模板，单击模板的名称。

6. 定义物模型。

   1. 在设备模板详情页，单击 物模型定义 页签。

   2. 单击 编辑。

   3. 在 默认模块 下，添加以下自定义功能。

      说明

      此处的 自定义功能 对应于 REST 驱动接收的数据对象。本文以接收整型数（int）为例进行介绍。

      功能类型	名称	标识符	读写类型	数据类型
      属性	测试接收整型数	test_int	只读	int

   4. 单击 确定。

   5. 在 发布新版本 对话框，设置 版本号 和 描述，然后单击 确定。

      本教程中使用 1.0.0.0 作为物模型的版本号。

发布版本后，您将会得到如下图所示的物模型。

步骤2：部署 REST 驱动

您必须在一体机上部署 REST 驱动，然后才可以添加 REST 设备到一体机。

1. 在左侧导航栏，单击 一体机。
2. 在 一体机 页面，找到要部署 REST 驱动的一体机，单击一体机名称。
3. 单击 设备接入 页签。
4. 部署驱动实例。
   • 如果您是首次在当前一体机上部署驱动实例，单击 立即部署。
   • 如果您不是首次在当前一体机上部署驱动实例，可以单击左侧驱动列表上方的 + 按钮。
5. 在 新建驱动实例 对话框，选择 REST驱动 的最新版本，然后单击 确定。

您提交部署请求后，系统将在一体机上部署驱动实例。部署过程涉及到数据传输。根据现场网络环境不同，部署所需时间不同。请确保您的一体机在线，并耐心等待部署完成。

步骤3：添加设备

当驱动部署成功后，驱动实例状态 将变为 运行中。这时，您可以在驱动下添加设备。

1. 单击 添加设备。

2. 在 添加设备 面板，根据以下配置说明完成设备配置，然后单击 确定。
   

   配置项	说明
   名称	为设备设置一个名称。 本教程中使用 rest-device-1 作为设备名称。
   设备模板	选择您在步骤1创建的设备模板。
   子协议类型	选择 other。
   描述	为设备添加描述说明。

完成以上操作后，您可以在 设备实例 列表查看新添加的设备。

步骤4：创建北向通道

默认情况下，一体机未开启向边缘智能控制台上报数据的功能。您必须在一体机上部署 数据上报 类型的北向通道，才能允许一体机将设备的属性数据上报到边缘智能控制台。

1. 在左侧导航栏，选择 设备管理 > 北向通道。
2. 单击 创建北向通道。
3. 在 创建北向通道 页面，选择 数据上云 类型，并选择将北向通道部署到您的边缘一体机。

   注意

   每种类型的北向通道仅允许有一个。如果您已经创建过 数据上云 类型的北向通道，则无需创建新的北向通道。您只需编辑已有北向通道的配置，将您的边缘一体机添加到部署列表。更多信息，请参见编辑北向通道。

4. 等待北向通道在一体机部署成功。
   部署成功后，北向通道在一体机上的状态将变为 运行中。
   

步骤5：验证

要验证 REST 驱动已在一体机上成功部署，您可以通过 HTTP 协议向一体机发送数据，然后在边缘智能控制台检查数据是否成功上报。

发送测试数据

您在一体机上部署官方 REST 驱动后，会使一体机的 59986 端口开放，并提供以下 Endpoints 来接收来自第三方应用或端设备的异步数据：

/api/v2/resource/{deviceName}/{resourceName}

参数说明：

• deviceName ：对应您在添加设备时为设备设置的名称。

  本教程中，deviceName的示例值为 rest_device_1。

• resourceName ：对应您在定义物模型时所添加的自定义功能的标识符。

  本教程中，resourceName的示例值为 test_int。

您可以通过以下方式发送测试数据到一体机：

• 在终端工具上使用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”。
  

  

查看测试数据

测试数据发送后，您可以登录边缘智能控制台查看设备的运行数据。

1. 在左侧导航栏，选择 设备管理 > 设备实例。
2. 找到 REST 设备，单击设备的名称。
3. 单击 运行状态 页签。
4. 设置一个时间段（包含您发送测试数据的时间），查看 REST 设备的数据。
   下图展示了通过终端工具和 Postman 发送的测试数据。