npm 包 aws-iot-shadow-helper 使用教程

阅读时长 9 分钟读完

AWS IoT 是亚马逊 Web 服务 (AWS) 的一个服务,为物联网 (IoT) 设备提供安全、可管理和跨平台的通讯。AWS IoT 使用 MQTT 和 WebSocket 协议来支持设备到云端的通讯。而 AWS IoT 中的设备状态则通过影子(Shadow)来表示。

AWS IoT Shadow Helper 是一个可以协助从 AWS IoT 服务轻松实现设备影子功能的 npm 包。通过使用该工具包,您可以更轻松地管理设备的状态并进行远程控制。本文将详细介绍 aws-iot-shadow-helper 的使用教程,包含索取设备影子、创建/更新设备影子,以及应对 shadow 更新和 shadow 操作回传等相关操作。

安装和配置

npm 包 aws-iot-shadow-helper 可以通过 npm 命令进行安装:

在您使用该工具包之前,需要确保您已经在 AWS IoT 所属的 AWS 账户下进行了相关的设备和发布/订阅的设置。接着,您需要使用 AWS IoT Certificate 以及 Private Key 进行身份验证。此处以在 Linux 环境下进行操作为例:

以上,在设置依据您期望的情况进行修改后,即可载入相关的信息以开始 hwtch 使用 aws-iot-shadow-helper 进行开发。

注意:要求您已经下载 AWS 根证书。

访问设备影子

使用 aws-iot-shadow-helper 的基础是访问设备影子。设备影子实际上是远程存储设备状态的镜像。要访问设备影子,首先需要创建一个 AWSIoTData 对象:

-- -------------------- ---- -------
----- --- - -------------------
----------------- - --------------
----- ---------- - -------------------------------------

----- ---------- - ------------
  ------- -----------------------
---

----- ------- - --- -------------
  --------- -----------------------------
  ------- -----------------------
---

上述代码中,我们通过创建 AWSIotData 对象并加载 AWS SDK 和设备 SDK 来访问设备影子。在该对象中,传递了 AWS_REGIONAWS_IOT_ENDPOINT 两个必要参数并分别被替换为实际的值。

接下来,您可以请求设备的影子,并获取时间戳:

-- -------------------- ---- -------
----- -------- - ------------
----- ------- - -
  ---------
--

------------------------
  ---------- ---------------------------
-- ----- ----- -- -
  -- ----- ----- ----

  ----- ------- - -------------------------
  ----- ----- - -----------------------------------

  ------------------ -------------------
---

在上述代码中,我们通过调用 getThingShadow 方法来请求设备影子,并将 process.env.IOT_THING_NAME 属性形式上指向具体的设备名称以进行检索。请求的结果会被存储到 data 中,随后进行 JSON 解析。最后,您可以从 payload 中获取特定的属性、值对。对于状态的获取,我们在获取到 payload 后先进行 JSON 解析,然后再从 state 对象中获取特定的属性值。

创建/更新设备影子

要创建/更新设备影子,您需要构造具有特定属性的 JSON 对象并提交更新请求。要更新设备影子,您需要确保在 iot.updateThingShadow() 中使用版本号作为更新标识符。

以下是创建和更新设备影子的示例代码:

-- -------------------- ---- -------
----- ---------- - ------------
  ---------
  ------- -----------------------
  ----- -----------------------------
  --------- -----
---

----- -------- - --------- ------------ -- -
  ------ -
    -------- -
      ---------- -----------
    --
    ---------- --------
  -
-

----- ------------ - ------ -- -
  ------ --- ----------------- ------- -- -
    ----------------------------------------------------------------------------- -------------------------------
    ----------
  ---
--

-- -----------------
-------------------------------------------- -
  ------ -
    --------- -
      ------------ --
    --
    -------- -
      ------------ --
    -
  --
-- ----- ----- -- -
  -- ----- ----- ----

  ------------------
--

以上,我们从定义 opUpdate 方法开始,该方法的作用是创建一个新的设备影子更新请求。在此更新请求中,您需要向 AWS API 提交一组您希望在影子中更新的属性,如 desired。此外,您还需要提供版本号以进行状态标识。

随后,我们定义了 shadowUpdate 方法,并将其返回为 Promise。在这个方法中,我们使用 AWS IoT Data 来进行实际的影子更新,并将它们发送到特定的 MQTT 主题。

最后,我们使用 iovShadow.update 方法来请求设备影子的更新。在该方法中,我们同样需要指明具有特定属性的 JSON 对象以进行影子更新,并在提交更新请求时指定版本号。

应对影子回传

当设备影子的状态发生变化时,AWS IoT 服务会向客户端发送回传。为了应对影子回传,您需要注册一个回传处理程序并将其附加到您的客户端上:

-- -------------------- ---- -------
-----------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------

------------------------ ----- ------- -------------- -- -
    -- ------------------------------- --- --- -
      ----- ------- - -------------------------------------
      ----- ----- - ------------- -- ----------------------
      ----- ---------------------------
    -
---

----- ------------------- - ------- -- -
    ------ --- ----------------- ------- -- -
        -- -------- -------

        ----- - ----------- - - ------
        ------------------------ --- ---- ------- -- -----------------
        ------ ----------
    ---
--

以上,我们首先使用 mqttClient.subscribe() 方法来附加我们该客户端的回传处理程序,消息的订阅方法接收一个主题,即实际的目标路径。在这个示例中,我们将通知订阅 $aws/things/${process.env.IOT_THING_NAME}/shadow/update/accepted$aws/things/${process.env.IOT_THING_NAME}/shadow/update/documents

接下来,我们使用 mqttClient.on('message', ...) 方法来注册处理程序。这个处理程序将接收消息的主题和消息本身,并使用 JSON 解析将其转换为处理可能状态更新的 JavaScript 对象。在此后,我们定义和注册了 processShadowUpdate 方法,该方法将在每次更新被提交时处理对更新的应答。

对于读者而言,您还可以使用以下代码来防范并检查影子是否未更新:

-- -------------------- ---- -------
------------------------
  ---------- ---------------------------
-- ----- ----- -- -
  -- ----- ----- ----

  ----- ------- - -------------------------

  ----- ----------- - ----------------------------------
  ----- ------------ - -----------------------------------

  -- ------------ --- --------- -- ----------- --- ------------- -
    --------------------- ----------- -------------- ------ ---- -------- ----------- ------------------
  - ---- -- ------------ --- ---------- -
    --------------------- ----------- -------------- ------- -------- --------------
  - ---- -
    --------------- ------ -- ------- --------------
  -
---

以上,这个代码片段包含以下步骤:

  • 获取设备的设备影子,并保存在 data.payload 中。
  • 使用 JSONdata.payload 进行解析,并检查如果 desired.temperature 属性存在,则从设备影子中提取它的值。
  • 如果应用程序当前记录的温度与设备影子中的值不匹配,则说明有应用程序更新。

现在您已经了解了 aws-iot-shadow-helper 的工作原理,您可以在 AWS IoT 上开始尝试更多有趣的东西。不要害怕深入其中,并享受自动化未来所带来的无尽可能性。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005590681e8991b448d65e3

纠错
反馈