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

Buka klien uji MQTT

BukaKlien uji MQTT diAWS IoTkonsoldi 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 jika Anda membiarkannya pergi ke halaman lain di konsol. Untuk bagian tutorial ini, Anda dapat memiliki dokumen Shadow dari AndaAWS IoThal dan klien uji MQTT terbuka di jendela terpisah untuk lebih mudah mengamati interaksi dengan Device Shadows.

Berlangganan topik Shadow yang dipesan MQTT

Anda dapat menggunakan klien uji MQTT untuk memasukkan nama topik yang dipesan MQTT Device Shadow dan berlangganan ke mereka untuk menerima pembaruan saat menjalankanshadow.pyaplikasi sampel. Untuk berlangganan topik:

1. DiKlien uji MQTTdi dalamAWS IoTkonsol, pilihBerlangganan topik.

2. DiFilter topikbagian, masukkan:$ aws/hal/thingname/bayangan/update/ #. Di sini,thingnameadalah nama sumber daya yang Anda buat sebelumnya (misalnya,My_light_bulb).

3. Menjaga nilai default untuk pengaturan konfigurasi tambahan, lalu pilihLangganan.

Dengan menggunakan#wildcard dalam langganan topik, Anda dapat berlangganan beberapa topik MQTT pada saat yang sama dan mengamati semua pesan yang dipertukarkan antara perangkat dan Shadow dalam satu jendela. Untuk informasi selengkapnya tentang karakter wildcard dan penggunaannya, lihatMQTTtopik.

Jalankanshadow.pyprogram sampel dan mengamati pesan

Di jendela baris perintah Raspberry Pi Anda, jika Anda telah memutuskan program, jalankan aplikasi sampel lagi dan tonton pesan diKlien uji MQTTdi dalamAWS IoTkonsol.

1. Jalankan perintah berikut untuk me-restart program sampel. Gantiyour-iot-thing-namadanyour-iot-endpointdengan nama-namaAWS IoThal yang Anda buat sebelumnya (misalnya,My_light_bulb), dan titik akhir untuk berinteraksi dengan perangkat.

   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

   Parametershadow.pycontoh aplikasi kemudian berjalan dan mengambil status bayangan saat ini. Jika Anda telah menghapus bayangan atau menghapus status saat ini, program menetapkan nilai saat ini keoffdan kemudian meminta Anda untuk memasukkandesirednilai.

   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 berjalan dan Anda me-restart, Anda akan melihat nilai warna terbaru yang dilaporkan di terminal. Di klien uji MQTT, Anda akan melihat pembaruan ke topik$ aws/hal/thingname/bayangan/dapatkandan$ aws/hal/thingname/bayangan/mendapatkan/diterima.

   Misalkan warna terbaru yang dilaporkangreen. Berikut ini menunjukkan isi dari$ aws/hal/thingname/bayangan/mendapatkan/diterimaFile 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. Masukkandesirednilai di terminal, sepertiyellow. Parametershadow.pycontoh aplikasi merespon dan menampilkan pesan berikut di terminal yang menunjukkan perubahan dalamreportednilaiyellow.

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

   DiKlien uji MQTTdi dalamAWS IoTkonsol, di bawahLangganan, Anda melihat bahwa topik berikut menerima pesan:

   • $ aws/hal/thingname/bayangan/update: menunjukkan bahwa keduanyadesireddanupdatednilai berubah menjadi warnayellow.

   • $ aws/hal/thingname/shadow/update/accepted: menunjukkan nilai-nilai saatdesireddanreportednegara dan metadata dan informasi versi mereka.

   • $ aws/hal/thingname/bayangan/perbaruan/dokumen: menunjukkan nilai sebelumnya dan saat ini daridesireddanreportednegara dan metadata dan informasi versi mereka.

   Sebagai dokumen$ aws/hal/thingname/bayangan/perbaruan/dokumenjuga berisi informasi yang terkandung dalam dua topik lainnya, kita dapat meninjau untuk melihat informasi negara. Keadaan sebelumnya menunjukkan nilai yang dilaporkan diatur kegreen, metadata dan informasi versinya, dan keadaan saat ini yang menunjukkan nilai dilaporkan diperbarui untukyellow.

   {
   "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 yang laindesirednilai, Anda melihat perubahan lebih lanjut kereportednilai dan pembaruan pesan yang diterima oleh topik ini. Nomor versi juga bertambah sebesar 1. Misalnya, jika Anda memasukkan nilaigreen, keadaan sebelumnya melaporkan nilainyayellowdan keadaan saat ini melaporkan nilainyagreen.

Edit dokumen Shadow untuk mengamati peristiwa delta

Untuk mengamati perubahan pada topik delta, edit dokumen Shadow diAWS IoTkonsol. Misalnya, Anda dapat menggantidesirednilai untuk warnared. Untuk melakukannya, diAWS IoTkonsol, pilihMengeditdan kemudian mengaturdesirednilai merah di JSON, sambil menjagareportednilai diatur kegreen. Sebelum menyimpan perubahan, buka terminal karena Anda akan melihat pesan delta yang dilaporkan di terminal.

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

Parametershadow.pyaplikasi sampel merespons perubahan ini dan menampilkan pesan di terminal yang menunjukkan delta. Dalam klien uji MQTT,updatetopik akan menerima pesan yang menunjukkan perubahan padadesireddanreportednilai.

Anda juga melihat bahwa topik$ aws/hal/thingname/shadow/update/deltamenerima pesan. Untuk melihat pesan, pilih topik ini, yang tercantum di bawahLangganan.

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