教程：示例应用程序及 MQTT 测试客户端与 Device Shadow 交互

打开 MQTT 测试客户端

打开 Amazon IoT控制台中的 MQTT 测试客户端，以便您可以观察 MQTT 主题收到的消息，而不会丢失 MQTT 测试客户端的配置。如果您让 MQTT 测试客户端进入控制台中的其它页面，则 MQTT 测试客户端不会保留任何订阅或消息日志。对于本教程的这一部分，您可以在单独的窗口中打开 Amazon IoT事物的影子文档和 MQTT 测试客户端，以便更轻松地观察与 Device Shadow 的交互。

订阅 MQTT 预留的影子主题

您可以使用 MQTT 测试客户端输入 Device Shadow 的 MQTT 预留主题的名称，并在运行 shadow.py示例应用程序时订阅它们以接收更新。要订阅主题：

1. 在 Amazon IoT控制台中的 MQTT 测试客户端中，选择 Subscribe to a topic（订阅主题）。

2. 在 Topic filter（主题筛选条件）部分，输入：$aws/things/thingname/shadow/update/#。在这里，thingname 是您之前创建的事物资源的名称（例如，My_light_bulb）。

3. 保留附加配置设置的默认值，然后选择 Subscribe（订阅）。

通过使用 # 通配符，您可以同时订阅多个 MQTT 主题，并在单个窗口中观察设备与其影子之间交换的所有消息。有关通配符及其用法的更多信息，请参阅 MQTT 主题。

运行 shadow.py示例程序和观察消息

在 Raspberry Pi 的命令行窗口中，如果您已经断开程序的连接，请再次运行示例应用程序，并在 Amazon IoT控制台中的 MQTT 测试客户端观察消息。

1. 运行以下命令以重新启动示程序。将 your-iot-thing-name 和 your-iot-endpoint 替换为您早前创建的 Amazon IoT事物名称（例如，My_light_bulb）以及与设备交互的端点名称。

   cd ~/aws-iot-device-sdk-python-v2/samples
   python3 shadow.py --ca_file ~/certs/Amazon-root-CA-1.pem --cert ~/certs/device.pem.crt --key ~/certs/private.pem.key --endpoint your-iot-endpoint --thing_name your-iot-thing-name

   shadow.py 示例应用程序随后会开始运行并检索当前影子状态。如果已删除影子或清除当前状态，程序会将当前值设置为 off，然后提示您输入 desired 值。

   Connecting to a3qEXAMPLEffp-ats.iot.us-west-2.amazonaws.com with client ID 'test-0c8ae2ff-cc87-49d2-a82a-ae7ba1d0ca5a'...
   Connected!
   Subscribing to Delta events...
   Subscribing to Update responses...
   Subscribing to Get responses...
   Requesting current shadow state...
   Launching thread to read user input...
   Finished getting initial shadow state.
   Shadow document lacks 'color' property. Setting defaults...
   Changed local shadow value to 'off'.
   Updating reported shadow value to 'off'...
   Update request published.
   Finished updating reported shadow value to 'off'...
   Enter desired value:

   另一方面，如果程序正在运行，并且您将程序重新启动，您将看到终端中报告的最新颜色值。在 MQTT 测试客户端中，您将看到主题 $aws/things/thingname/shadow/get 和 $aws/things/thingname/shadow/get/accepted 的更新。

   假设报告的最新颜色为 green。下面显示的是 $aws/things/thingname/shadow/get/accepted JSON 文件的内容。

   {
   "state": {
     "desired": {
       "welcome": "aws-iot",
       "color": "green"
     },
     "reported": {
       "welcome": "aws-iot",
       "color": "green"
     }
   },
   "metadata": {
     "desired": {
       "welcome": {
         "timestamp": 1620156892
       },
       "color": {
         "timestamp": 1620161643
       }
     },
     "reported": {
       "welcome": {
         "timestamp": 1620156892
       },
       "color": {
         "timestamp": 1620161643
       }
     }
   },
   "version": 10,
   "timestamp": 1620173908
   }            
                 

2. 在终端中输入 desired值，例如 yellow。shadow.py 示例应用程序响应并在终端中显示以下消息，这些消息显示了 reported值变更为 yellow的情况。

   Enter desired value:
   yellow
   Changed local shadow value to 'yellow'.
   Updating reported shadow value to 'yellow'...
   Update request published.
   Finished updating reported shadow value to 'yellow'.

   在 Amazon IoT 控制台中的 MQTT 测试客户端中，您会在 Subscriptions（订阅）下看到以下主题收到一条消息：

   • $aws/things/thingname/shadow/update：显示两个 desired和 updated值更改为颜色 yellow。

   • $aws/things/thingname/shadow/update/accepted：显示 desired和 reported状态当前的值及其元数据和版本信息。

   • $aws/things/thingname/shadow/update/documents：显示 desired和 reported状态之前以及当前的值，及其元数据和版本信息。

   由于文档 $aws/things/thingname/shadow/update/documents 还包含其它两个主题中包含的信息，我们可以查看该文档以查看状态信息。上一个状态显示报告的值设置为 green、其元数据和版本信息，而当前的状态显示报告的值更新为 yellow。

   {
   "previous": {
     "state": {
       "desired": {
         "welcome": "aws-iot",
         "color": "green"
       },
       "reported": {
         "welcome": "aws-iot",
         "color": "green"
       }
     },
     "metadata": {
       "desired": {
         "welcome": {
           "timestamp": 1617297888
         },
         "color": {
           "timestamp": 1617297898
         }
       },
       "reported": {
         "welcome": {
           "timestamp": 1617297888
         },
         "color": {
           "timestamp": 1617297898
         }
       }
     },
     "version": 10
   },
   "current": {
     "state": {
       "desired": {
         "welcome": "aws-iot",
         "color": "yellow"
       },
       "reported": {
         "welcome": "aws-iot",
         "color": "yellow"
       }
     },
     "metadata": {
       "desired": {
         "welcome": {
           "timestamp": 1617297888
         },
         "color": {
           "timestamp": 1617297904
         }
       },
       "reported": {
         "welcome": {
           "timestamp": 1617297888
         },
         "color": {
           "timestamp": 1617297904
         }
       }
     },
     "version": 11
   },
   "timestamp": 1617297904
   }

3. 现在，如果您输入另一个 desired值，您可以看到 reported值的进一步更改和这些主题收到的消息更新。版本号也会增加 1。例如，如果您输入值 green，之前的状态会报告值 yellow，而当前状态报告值 green。

编辑影子文档以观察增量事件

要观察对增量主题的更改，请在 Amazon IoT控制台编辑影子文档。例如，您可以将 desired值更改为颜色 red。为此，请在 Amazon IoT控制台中，选择 Edit（编辑），然后在 JSON 中将 desired值设置为红色，同时保持 reported设置为 green。在保存更改之前，请保持终端处于开启状态，因为您将看到终端中报告的增量消息。

{
"desired": {
  "welcome": "aws-iot",
  "color": "red"
},
"reported": {
  "welcome": "aws-iot",
  "color": "green"
}
}

shadow.py 示例应用程序响应此更改，并在终端中显示指示增量的消息。在 MQTT 测试客户端中，update 主题将收到一条消息，显示对 desired和 reported值的更改。

您还可以看到主题 $aws/things/thingname/shadow/update/delta 收到一条消息。要查看消息，请选择该主题，其列于 Subscriptions（订阅）下方。

{
"version": 13,
"timestamp": 1617318480,
"state": {
  "color": "red"
},
"metadata": {
  "color": {
    "timestamp": 1617318480
  }
}
}