You need to enable JavaScript to run this app.
导航
使用官方 REST 驱动
最近更新时间:2024.08.21 11:09:35首次发布时间:2023.06.21 19:08:51

边缘智能的官方 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. 驱动实例 列表选中 REST驱动
  2. 基本信息 标签页,您可以选择以下方式添加设备:
    • 添加设备:一次添加一个设备实例。
    • 批量添加:一次添加一个或多个设备实例。最多可以同时添加 100 个设备实例,并批量设置一些设备参数。

添加设备

  1. 基本信息 标签页,单击 添加设备

  2. 添加设备 面板,完成以下配置,然后单击 确定

    配置项

    说明

    名称

    为设备设置一个名称。

    本教程中使用 rest-device-1 作为设备名称。

    标识符

    为设备设置一个标识符。

    本教程中使用 device-rest 作为设备的标识符。

    设备模板

    选择您在步骤1创建的设备模板。

    点表

    选择在创建点表中创建的点表。

    本教程中选择 gb28181-pt。

    子协议名称

    选择 other

    标签

    为设备添加标签。如果需要创建新的标签,输入 keyvalue 后,单击 创建标签

    描述

    为设备添加描述信息。

完成以上操作后,您可以在设备列表查看新添加的设备。最初,设备的 状态添加中。当设备的状态变为 在线 后,表示设备已经添加成功。

批量添加

  1. 基本信息 标签页,单击 批量添加

  2. 添加设备 页面,您可以在 驱动信息 区域查看驱动相关信息,并参考下表说明完成 设备配置,然后单击 确定

    子协议类型

    选择 other

    设备模板

    选择您在步骤1创建的设备模板。

    设备名称

    为设备设置一个名称。

    本教程中使用 rest-device-1 作为设备名称。

    标识符

    为设备设置一个标识符。

    本教程中使用 device-rest 作为设备的标识符。

    标签

    为设备添加标签。如果需要创建新的标签,输入 keyvalue 后,单击 创建标签

    描述

    为设备添加描述信息。

  3. (可选)如果需要同时添加多个设备实例,在 添加设备 后的输入框中输入要添加的设备个数,然后单击 添加设备。系统会自动生成多个设备配置条目。

  4. (可选)如果需要批量设置一些设备参数,先勾选右上角的 批量编辑所有配置项,然后修改某个参数值,系统会同步修改所有设备的对应参数值。

    说明

    勾选 批量编辑所有配置项 后,如果参数配置框置灰,表示该参数不支持批量设置。

完成以上操作后,您可以在设备列表查看新添加的设备。最初,设备的 状态添加中。当设备的状态变为 在线 后,表示设备已经添加成功。

步骤4:验证

要验证 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”。
    图片

    图片

查看测试数据

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

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