Tutorial: Interaktion mit Device Shadow über die Beispiel-App und den MQTT-Testclient

Öffnen Sie den MQTT-Testclient

Öffnen SieMQTT-Testclient imAWS IoTKonsolein einem neuen Fenster, damit Sie die von den MQTT-Themen empfangenen Nachrichten beobachten können, ohne die Konfiguration Ihres MQTT-Test-Clients zu verlieren. Der MQTT-Testclient behält keine Abonnements oder Nachrichtenprotokolle bei, wenn Sie ihn verlassen, um auf eine andere Seite in der Konsole zu gelangen. Für diesen Abschnitt des Tutorials können Sie das Shadow-Dokument IhrerAWS IoTDing und der MQTT-Test-Client öffnen sich in separaten Fenstern, um die Interaktion mit Device Shadows leichter zu beobachten.

Abonnieren Sie die reservierten MQTT Shadow-Themen

Sie können den MQTT-Test-Client verwenden, um die Namen der reservierten MQTT-Themen des Device Shadow einzugeben und diese zu abonnieren, um Updates zu erhalten, wenn Sie dieshadow.pyBeispiel-App. So abonnieren Sie die Themen:

1. In derMQTT-Test-ClientimAWS IoTKonsole, wählenAbonnieren eines Themasaus.

2. In derThemenfilter, geben Sie ein:$aws/things/ things/thingName/shadow/update/ #aus. Hierthingnameist der Name der -Ressource, die Sie zuvor erstellt haben (z. B.My_light_bulb) enthalten.

3. Behalten Sie die Standardwerte für die zusätzlichen Konfigurationseinstellungen bei und wählen Sie dannAbonnierenaus.

Durch die Verwendung des#Platzhalter im Themen-Abonnement können Sie mehrere MQTT-Themen gleichzeitig abonnieren und alle Nachrichten beobachten, die zwischen dem Gerät und seinem Schatten ausgetauscht werden, in einem einzigen Fenster. Weitere Informationen zu den Platzhalterzeichen und ihrer Verwendung finden Sie unterMQTTThemenaus.

Führen Sie Folgendes aus:shadow.pyBeispielprogramm und Beobachtung von Nachrichten

Wenn Sie das Programm getrennt haben, führen Sie in Ihrem Befehlszeilenfenster des Raspberry Pi die Beispiel-App erneut aus und sehen Sie sich die Nachrichten imMQTT-Test-ClientimAWS IoTKonsoleaus.

1. Führen Sie den folgenden Befehl aus, um das Beispielprogramm neu zu starten. Ersetzenyour-iot-thing-Nameundyour-iot-endpointmit den Namen derAWS IoTSache, die Sie vorher erstellt haben (z. B.My_light_bulb) und den Endpunkt, um mit dem Gerät zu interagieren.

   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

   Dieshadow.pyDie Beispiel-App wird dann ausgeführt und ruft den aktuellen Schattenstatus ab. Wenn Sie den Schatten gelöscht oder die aktuellen Status gelöscht haben, legt das Programm den aktuellen Wert aufoffund fordert Sie dann auf, eindesiredWert.

   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:

   Wenn das Programm hingegen ausgeführt wurde und Sie es neu gestartet haben, wird der neueste Farbwert im Terminal angezeigt. Im MQTT-Testclient sehen Sie ein Update der Themen$aws/things/ things/thingName/shadow/getund$aws/things/ things/thingName/shadow/get/akzeptiertaus.

   Angenommen, die neueste gemeldete Farbe wargreenaus. Im Folgenden werden die Inhalte des$aws/things/ things/thingName/shadow/get/akzeptiertJSON-Datei enthält.

   {
   "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. Geben Sie eindesiredWert im Terminal, wieyellowaus. Dieshadow.pyBeispiel-App antwortet und zeigt die folgenden Nachrichten im Terminal an, die die Änderung imreportedValue aufyellowaus.

   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'.

   In derMQTT-Test-ClientimAWS IoTKonsole, unterAbonnementssehen Sie, dass die folgenden Themen eine Nachricht erhalten haben:

   • $aws/things/ things/thingName/shadow/update: zeigt, dass beidedesiredundupdatedWerte ändern sich in die Farbeyellowaus.

   • $aws/things/ things/thingName/shadow/update/documents: zeigt die aktuellen Werte desdesiredundreportedZustände und ihre Metadaten und Versionsinformationen.

   • $aws/things/ things/thingName/shadow/update/documents: zeigt die vorherigen und aktuellen Werte desdesiredundreportedZustände und ihre Metadaten und Versionsinformationen.

   Wie das Dokument$aws/things/ things/thingName/shadow/update/documentsenthält auch Informationen, die in den beiden anderen Themen enthalten sind, wir können sie überprüfen, um die Statusinformationen anzuzeigen. Der vorherige Status zeigt den gemeldeten Wert an, der aufgreen, seine Metadaten und Versionsinformationen sowie der aktuelle Status, der den gemeldeten Wert anzeigt, aktualisiert aufyellowaus.

   {
   "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. Nun, wenn du einen anderen eingibstdesiredWert sehen Sie weitere Änderungen an derreportedWerte und Nachrichtenaktualisierungen, die von diesen Themen empfangen wurden. Die Versionsnummer erhöht sich ebenfalls um 1. Wenn Sie z. B. den Wert eingebengreengibt der vorherige Status den Wert anyellowund der aktuelle Status meldet den Wertgreenaus.

Schatten-Dokument bearbeiten, um Delta-Ereignisse zu beobachten

Um Änderungen am Delta-Thema zu beobachten, bearbeiten Sie das Shadow-Dokument imAWS IoTconsole. So können Sie beispielsweise diedesiredWert auf die Farberedaus. Um dies zu tun, finden Sie imAWS IoT-Konsole, Wählen SieBearbeitenund setze dann diedesiredWert auf Rot im JSON, während derreportedWert aufgreenaus. Bevor Sie die Änderung speichern, lassen Sie das Terminal geöffnet, da die Delta-Nachricht im Terminal angezeigt wird.

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

Dieshadow.pyDie Beispiel-App reagiert auf diese Änderung und zeigt Nachrichten im Terminal an, die das Delta anzeigen. Im MQTT-Testclient wird derupdatethemen haben eine Nachricht erhalten, in der Änderungen an derdesiredundreported-Werte.

Sie sehen auch, dass das Thema$aws/things/thingName/shadow/update/deltahat eine Nachricht erhalten. Um die Nachricht zu sehen, wählen Sie dieses Thema aus, das unterAbonnementsaus.

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