Tutorial: Berinteraksi dengan Device Shadow menggunakan aplikasi sampel dan klien uji MQTT

Buka klien uji MQTT

Buka klien uji MQTT di AWS IoT konsol di jendela baru sehingga Anda dapat mengamati pesan yang diterima oleh topik MQTT tanpa kehilangan konfigurasi klien uji MQTT Anda. Klien uji MQTT tidak menyimpan langganan atau log pesan apa pun jika Anda membiarkannya pergi ke halaman lain di konsol. Untuk bagian tutorial ini, Anda dapat membuka dokumen Shadow dari AWS IoT benda Anda dan klien uji MQTT di jendela terpisah untuk lebih mudah mengamati interaksi dengan Device Shadows.

Berlangganan topik Shadow yang dicadangkan MQTT

Anda dapat menggunakan klien uji MQTT untuk memasukkan nama topik cadangan MQTT Device Shadow dan berlangganan untuk menerima pembaruan saat menjalankan aplikasi shadow.py sampel. Untuk berlangganan topik:

1. Di klien uji MQTT di AWS IoT konsol, pilih Berlangganan topik.

2. Di bagian Filter Topik, masukkan: $aws/things/thingname/shadow/update/#. Di sini, thingname adalah nama sumber daya benda yang Anda buat sebelumnya (misalnya,My_light_bulb).

3. Simpan nilai default untuk pengaturan konfigurasi tambahan, lalu pilih Ber langganan.

Dengan menggunakan # wildcard dalam langganan topik, Anda dapat berlangganan beberapa topik MQTT secara bersamaan dan mengamati semua pesan yang dipertukarkan antara perangkat dan Bayangannya dalam satu jendela. Untuk informasi selengkapnya tentang karakter wildcard dan penggunaannya, lihatTopik MQTT.

Jalan kan program sampel shadow.py dan amati pesan

Di jendela baris perintah Raspberry Pi Anda, jika Anda telah memutuskan program, jalankan aplikasi sampel lagi dan tonton pesan di klien uji MQTT di AWS IoT konsol.

1. Jalankan perintah berikut untuk memulai ulang program sampel. Ganti your-iot-thing-name dan your-iot-endpoint dengan nama AWS IoT benda yang Anda buat sebelumnya (misalnya,My_light_bulb), dan titik akhir untuk berinteraksi dengan perangkat.

   cd ~/aws-iot-device-sdk-python-v2/samples/service-clients
   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

   Aplikasi shadow.py sampel kemudian berjalan dan mengambil status bayangan saat ini. Jika Anda telah menghapus bayangan atau menghapus status saat ini, program menetapkan nilai saat ini ke off dan kemudian meminta Anda untuk memasukkan desired nilai.

   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:

   Di sisi lain, jika program sedang berjalan dan Anda memulai ulang, Anda akan melihat nilai warna terbaru yang dilaporkan di terminal. Di klien uji MQTT, Anda akan melihat pembaruan untuk topik $aws/things//shadow/getdan $ thingname aws/thingsthingname/shadow/get//diterima.

   Misalkan warna terbaru yang dilaporkan adalahgreen. Berikut ini menunjukkan isi file JSON $ aws/things thingname shadow/get //diterima.

   {
   "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. Masukkan desired nilai di terminal, sepertiyellow. Aplikasi shadow.py sampel merespons dan menampilkan pesan berikut di terminal yang menunjukkan perubahan reported nilai keyellow.

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

   Di klien uji MQTT di AWS IoT konsol, di bawah Langganan, Anda melihat bahwa topik berikut menerima pesan:

   • $aws/things/thingname/shadow/update: menunjukkan bahwa keduanya desired dan updated nilai berubah menjadi warnayellow.

   • $aws/things/thingname/shadow/update/: menunjukkan nilai status dan saat ini desired serta reported metadata dan informasi versinya.

   • $aws/things/thingname/shadow/update/dokumen: menunjukkan nilai sebelumnya dan saat ini dari status desired dan reported serta metadata dan informasi versinya.

   Karena dokumen $ aws/thingsthingname/shadow/update/dokumen juga berisi informasi yang terkandung dalam dua topik lainnya, kita dapat meninjaunya untuk melihat informasi status. Status sebelumnya menunjukkan nilai yang dilaporkan disetel kegreen, metadata dan informasi versinya, dan status saat ini yang menunjukkan nilai yang dilaporkan diperbarui keyellow.

   {
   "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. Sekarang, jika Anda memasukkan desired nilai lain, Anda melihat perubahan lebih lanjut pada reported nilai dan pembaruan pesan yang diterima oleh topik ini. Nomor versi juga bertambah 1. Misalnya, jika Anda memasukkan nilaigreen, status sebelumnya melaporkan nilai yellow dan status saat ini melaporkan nilainyagreen.

Edit dokumen Shadow untuk mengamati peristiwa delta

Untuk mengamati perubahan pada topik delta, edit dokumen Shadow di AWS IoT konsol. Misalnya, Anda dapat mengubah desired nilai menjadi warnared. Untuk melakukan ini, di AWS IoT konsol, pilih Edit dan kemudian atur desired nilainya menjadi merah di JSON, sambil tetap reported mengatur nilai kegreen. Sebelum Anda menyimpan perubahan, biarkan terminal tetap terbuka karena Anda akan melihat pesan delta dilaporkan di terminal.

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

Aplikasi shadow.py sampel merespons perubahan ini dan menampilkan pesan di terminal yang menunjukkan delta. Di klien uji MQTT, update topik akan menerima pesan yang menunjukkan perubahan pada reported nilai desired dan.

Anda juga melihat bahwa topik $ aws/thingsthingname/shadow/update//delta menerima pesan. Untuk melihat pesan, pilih topik ini, yang tercantum di bawah Lang ganan.

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