使用-EdgeX-Kuiper-规则引擎控制物联网设备

该文章描述了如何在 EdgeX 中使用 Kuiper 规则引擎，根据分析结果来实现对设备的控制。为了便于理解，该文章使用 device-virtual 示例，它对 device-virtual 服务发送的数据进行分析，然后根据由 Kuiper 规则引擎生成的分析结果来控制物联网设备。

在本文中，将创建并运行以下两条规则。

监视 Random-UnsignedInteger-Device 设备的规则，如果 uint8 值大于 20，则向 Random-Boolean-Device 设备发送命令，并开启布尔值的随机生成。
监视 Random-Integer-Device 设备的规则，如果每 20 秒 int8的平均值大于 0，则向Random-Boolean-Device 设备服务发送命令以关闭布尔值的随机生成。

该场景不含任何真实的业务逻辑，而只是为了演示 EdgeX Kuiper 规则引擎的功能。您可以根据我们的演示制定合理的业务规则。

本文档将不涉及 EdgeX 和 EMQ X Kuiper 的基本操作，因此读者应具有以下基本知识：

了解 EdgeX 的基础知识，最好完成快速入门。
阅读 EdgeX Kuiper 规则引擎入门教程：您最好阅读此入门教程，并开始在 EdgeX 中试用规则引擎。
Go 模板：EMQ X Kuiper 使用 Go 模板从分析结果中提取数据。了解 Go 模板可以帮助您从分析结果中提取所需的数据。

请务必遵循文档 EdgeX Kuiper 规则引擎入门教程，确保教程能够成功运行。

在创建规则之前，应创建一个流，该流可以使用来自 EdgeX 应用程序服务的流数据。如果您已经完成 EdgeX Kuiper 规则引擎入门教程，则不需要此步骤。

curl -X POST \
  http://$kuiper_docker:48075/streams \
  -H 'Content-Type: application/json' \
  -d '{"sql":"create stream demo() WITH (FORMAT=\"JSON\", TYPE=\"edgex\")"}'

由于这两个规则都会向设备 Random-UnsignedInteger-Device 发送控制命令，通过运行命令 curl http://localhost:48082/api/v1/device/name/Random-Boolean-Device | jq 可以获取该设备的可用命令列表。它将打印类似的输出，如下所示。

{
  "id": "9b051411-ca20-4556-bd3e-7f52475764ff",
  "name": "Random-Boolean-Device",
  "adminState": "UNLOCKED",
  "operatingState": "ENABLED",
  "labels": ["device-virtual-example"],
  "commands": [
    {
      "created": 1589052044139,
      "modified": 1589052044139,
      "id": "28d88bb3-e280-46f7-949f-37cc411757f5",
      "name": "Bool",
      "get": {"path": "/api/v1/device/{deviceId}/Bool",
        "responses": [
          {
            "code": "200",
            "expectedValues": ["Bool"]
          },
          {
            "code": "503",
            "description": "service unavailable"
          }
        ],
        "url": "http://edgex-core-command:48082/api/v1/device/bcd18c02-b187-4f29-8265-8312dc5d794d/command/d6d3007d-c4ce-472f-a117-820b5410e498"
      },
      "put": {"path": "/api/v1/device/{deviceId}/Bool",
        "responses": [
          {"code": "200"},
          {
            "code": "503",
            "description": "service unavailable"
          }
        ],
        "url": "http://edgex-core-command:48082/api/v1/device/bcd18c02-b187-4f29-8265-8312dc5d794d/command/d6d3007d-c4ce-472f-a117-820b5410e498",
        "parameterNames": [
          "Bool",
          "EnableRandomization_Bool"
        ]
      }
    }
  ]
}

从输出中，您能看出有两个命令，第二个命令用于更新设备的配置。此设备有两个参数：

Bool：当其他服务想要获取设备数据时，设置返回值。仅当 EnableRandomization_Bool 设置为 false 时，才使用该参数。
EnableRandomization_Bool：是否启用 Bool 的随机生成。如果将此值设置为 true，则将忽略第一个参数。

因此，示例控制命令将类似于如下命令：

curl -X PUT \
  http://edgex-core-command:48082/api/v1/device/c1459444-79bd-46c8-8b37-d6e1418f2a3a/command/fe202437-236d-41c5-845e-3e6013b928cd \
  -H 'Content-Type: application/json' \
  -d '{"Bool":"true","EnableRandomization_Bool":"true"}'

第一条规则是监视 Random-UnsignedInteger-Device 设备的规则，如果 uint8 值大于“20”，则向 Random-Boolean-Device 设备发送命令，并开启布尔值的随机生成。以下是规则定义，请注意：

当 uint8 的值大于 20 时将触发该动作。由于 uint8 的值不用于向 Random-Boolean-Device 发送控制命令，因此在 rest 操作的 dataTemplate 属性中不使用 uint8 值。

curl -X POST \
  http://$kuiper_server:48075/rules \
  -H 'Content-Type: application/json' \
  -d '{"id":"rule1","sql":"SELECT uint8 FROM demo WHERE uint8 > 20","actions": [
    {
      "rest": {
        "url": "http://edgex-core-command:48082/api/v1/device/bcd18c02-b187-4f29-8265-8312dc5d794d/command/d6d3007d-c4ce-472f-a117-820b5410e498",
        "method": "put",
        "retryInterval": -1,
        "dataTemplate": "{\"Bool\":\"true\", \"EnableRandomization_Bool\": \"true\"}",
        "sendSingle": true
      }
    },
    {"log":{}
    }
  ]
}'

第二条规则监视 Random-Integer-Device 设备，如果每 20 秒 int8的平均值大于 0，则向Random-Boolean-Device 设备服务发送命令以关闭布尔值的随机生成。

uint8 的平均值每 20 秒计算一次，如果平均值大于 0，则向 Random-Boolean-Device 服务发送控制命令。

curl -X POST \
  http://$kuiper_server:48075/rules \
  -H 'Content-Type: application/json' \
  -d '{"id":"rule2","sql":"SELECT avg(int8) AS avg_int8 FROM demo WHERE int8 != nil GROUP BY  TUMBLINGWINDOW(ss, 20) HAVING avg(int8) > 0","actions": [
    {
      "rest": {
        "url": "http://edgex-core-command:48082/api/v1/device/bcd18c02-b187-4f29-8265-8312dc5d794d/command/d6d3007d-c4ce-472f-a117-820b5410e498",
        "method": "put",
        "retryInterval": -1,
        "dataTemplate": "{\"Bool\":\"false\", \"EnableRandomization_Bool\": \"false\"}",
        "sendSingle": true
      }
    },
    {"log":{}
    }
  ]
}'

现在创建了两个规则，您可以查看 edgex-kuiper 的日志以获取规则执行结果。

# docker logs edgex-kuiper

由于分析结果也需要发送到 command rest 服务，如何从分析结果中提取数据？通过 SQL 过滤数据的示例如下所示：

SELECT int8, "true" AS randomization FROM demo WHERE uint8 > 20

SQL 的输出内容如下：

[{"int8":-75, "randomization":"true"}]

当从字段 int8 读取 value 字段，从字段 randomization 读取 EnableRandomization_Bool 时，假设服务需要以下数据格式：

curl -X PUT \
  http://edgex-core-command:48082/api/v1/device/${deviceId}/command/xyz \
  -H 'Content-Type: application/json' \
  -d '{"value":-75,"EnableRandomization_Bool":"true"}'

Kuiper 使用 Go 模板从分析结果中提取数据，并且dataTemplate 内容如下：

"dataTemplate": "{\"value\": {{.int8}}, \"EnableRandomization_Bool\": \"{{.randomization}}\"}"

在某些情况下，您可能需要迭代返回的数组值，或使用 if 条件设置不同的值，然后参考此链接写入更复杂的数据模板表达式。

如果您想了解 EMQ X Kuiper 的更多特性，请阅读下面的参考资料：

EMQ X Kuiper Github
EMQ X Kuiper 参考指南

版权声明：本文为 EMQ 原创，转载请注明出处。

原文链接：https://www.emqx.io/cn/blog/c…

使用-EdgeX-Kuiper-规则引擎控制物联网设备

概述

场景

预备知识

开始使用

创建 EdgeX 流

创建规则

第一条规则

第二条规则

如何从分析结果中提取数据？

补充阅读材料