Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Tutorial: Menginstal Device SDK dan menjalankan aplikasi sampel untuk Device Shadows

Bagian ini menunjukkan bagaimana Anda dapat menginstal perangkat lunak yang diperlukan danAWS IoTPerangkat SDK untuk Python dan jalankanshadow.pycontoh aplikasi untuk mengedit dokumen Shadow dan mengontrol status bayangan.

Sebelum Anda menjalankan tutorial ini:

Anda harus telah mengaturAkun AWS, mengkonfigurasi perangkat Raspberry Pi Anda, dan membuatAWS IoThal dan kebijakan yang memberikan izin perangkat untuk mempublikasikan dan berlangganan topik yang dipesan MQTT dari layanan Device Shadow. Untuk informasi selengkapnya, lihat Tutorial: Mempersiapkan Raspberry Pi Anda untuk menjalankan aplikasi bayangan.

Anda juga harus menginstal Git, Python, danAWS IoTSDK for Python. Tutorial ini dibangun di atas konsep-konsep yang disajikan dalam tutorialConnect Raspberry Pi atau perangkat lain. Jika Anda belum mencoba tutorial itu, kami sarankan Anda mengikuti langkah-langkah yang dijelaskan dalam tutorial itu untuk menginstal file sertifikat dan Device SDK dan kemudian kembali ke tutorial ini untuk menjalankanshadow.pyaplikasi sampel.

Tutorial ini memakan waktu sekitar 20 menit untuk menyelesaikannya.

Langkah 1: Jalankan aplikasi contoh shadow.py

Sebelum Anda menjalankanshadow.pycontoh aplikasi, Anda akan memerlukan informasi berikut selain nama dan lokasi file sertifikat yang Anda instal.

Masukkan nilai dan amati pembaruan dalam dokumen Shadow

Anda dapat memasukkan nilai di terminal untuk menentukandesirednilai, yang juga memperbaruireportednilai. Katakanlah Anda memasukkan warnayellowdi terminal. Parameterreportednilai juga diperbarui untuk warnayellow. Berikut ini menunjukkan pesan yang ditampilkan di terminal:

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

Ketika Anda mempublikasikan permintaan pemutakhiran ini,AWS IoTmenciptakan default, bayangan klasik untuk sumber daya hal. Anda dapat mengamati permintaan pembaruan yang Anda publikasikan kereporteddandesirednilai-nilai dalamAWS IoTkonsol dengan melihat dokumen Shadow untuk sumber daya hal yang Anda buat (misalnya,My_light_bulb). Untuk melihat pembaruan dalam dokumen Shadow:

Dokumen Shadow akan serupa dengan yang berikut ini, menunjukkanreporteddandesirednilai diatur ke warnayellow. Anda melihat nilai-nilai ini diStatus bayanganbagian dari dokumen.

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

Anda juga melihatMetadatabagian yang berisi informasi timestamp dan nomor versi permintaan.

Anda dapat menggunakan versi dokumen negara untuk memastikan Anda memperbarui versi terbaru dari dokumen Shadow perangkat. Jika Anda mengirim permintaan pembaruan lain, nomor versi bertambah 1. Ketika Anda menyediakan versi dengan permintaan pembaruan, layanan menolak permintaan dengan kode respons konflik HTTP 409 jika versi dokumen status saat ini tidak cocok dengan versi yang disediakan.

{
"metadata": {
  "desired": {
    "welcome": {
      "timestamp": 1620156892
    },
    "color": {
      "timestamp": 1620156893
    }
  },
  "reported": {
    "welcome": {
      "timestamp": 1620156892
    },
    "color": {
      "timestamp": 1620156893
    }
  }
},
"version": 10
}        

Untuk mempelajari lebih lanjut tentang dokumen Shadow dan mengamati perubahan pada informasi negara, lanjutkan ke tutorial berikutnyaTutorial: Berinteraksi dengan Device Shadow menggunakan aplikasi sampel dan klien uji MQTTseperti yang dijelaskan dalamLangkah 4: Tinjau hasil dan langkah selanjutnyabagian dari tutorial ini. Opsional, Anda juga dapat mempelajari tentangshadow.pykode sampel dan bagaimana menggunakan protokol MQTT di bagian berikut.

Langkah 2: Tinjau aplikasi sampel shadow.py Device SDK

Bagian ini mengulasshadow.pycontoh aplikasi dariAWS IoTSDK v2 for Pythondigunakan dalam tutorial ini. Di sini, kami akan meninjau bagaimana menghubungkannyaAWS IoT Coredengan menggunakan MQTT dan MQTT lebih protokol WSS. ParameterAWSwaktu aktif umum (AWS-CRT)perpustakaan menyediakan dukungan protokol komunikasi tingkat rendah dan disertakan denganAWS IoTSDK v2 for Python.

Sementara tutorial ini menggunakan MQTT dan MQTT lebih WSS,AWS IoTmendukung perangkat yang mempublikasikan permintaan HTTPS. Untuk contoh program Python yang mengirimkan pesan HTTP dari perangkat, lihatContoh kode HTTPSmenggunakan Pythonrequestsperpustakaan.

Untuk informasi tentang bagaimana Anda dapat membuat keputusan berdasarkan informasi tentang protokol mana yang akan digunakan untuk komunikasi perangkat Anda, tinjauMemilih protokol aplikasi untuk komunikasi perangkat Anda.

MQTT

Parametershadow.pypanggilan sampelmtls_from_path(ditampilkan di sini) dimqtt_connection_builderuntuk membangun koneksi denganAWS IoT Coredengan menggunakan protokol MQTT.mtls_from_pathmenggunakan sertifikat X.509 dan TLS v1.2 untuk mengotentikasi perangkat. ParameterAWSperpustakaan -CRT menangani rincian tingkat yang lebih rendah dari koneksi itu.

mqtt_connection = mqtt_connection_builder.mtls_from_path(
  endpoint=args.endpoint,
  cert_filepath=args.cert,
  pri_key_filepath=args.key,
  ca_filepath=args.ca_file,
  client_bootstrap=client_bootstrap,
  on_connection_interrupted=on_connection_interrupted,
  on_connection_resumed=on_connection_resumed,
  client_id=args.client_id,
  clean_session=False,
  keep_alive_secs=6
)

Parametershadow.pysampel juga panggilanwebsockets_with_default_aws_signingdi dalammqtt_connection_builderuntuk membangun koneksi denganAWS IoT Coremenggunakan protokol MQTT lebih WSS. MQTT lebih WSS juga menggunakan parameter yang sama seperti MQTT dan mengambil parameter tambahan:

Berlangganan topik dan acara Shadow

Parametershadow.pysampel mencoba untuk membangun koneksi dan menunggu untuk sepenuhnya terhubung. Jika tidak terhubung, perintah akan antri. Setelah terhubung, sampel berlangganan peristiwa delta dan memperbarui dan mendapatkan pesan, dan menerbitkan pesan dengan kualitas layanan (QoS) tingkat 1 (mqtt.QoS.AT_LEAST_ONCE).

Ketika perangkat berlangganan pesan dengan QoS level 1, broker pesan menyimpan pesan bahwa perangkat berlangganan sampai mereka dapat dikirim ke perangkat. Broker pesan mengirim ulang pesan sampai menerimaPUBACKrespon dari perangkat.

Untuk informasi selengkapnya tentang protokol MQTT, lihatTinjau MQTT protokolnyadanMQTT.

Untuk informasi lebih lanjut tentang bagaimana MQTT, MQTT lebih WSS, sesi persisten, dan tingkat QoS yang digunakan dalam tutorial ini, lihatTinjau aplikasi SDK contoh Perangkat pubsub.py.

Langkah 3: Memecahkan masalah denganshadow.pyaplikasi sampel

Ketika Anda menjalankanshadow.pycontoh aplikasi, Anda akan melihat beberapa pesan yang ditampilkan di terminal dan prompt untuk memasukkandesirednilai. Jika program melempar kesalahan, maka untuk men-debug kesalahan, Anda dapat mulai dengan memeriksa apakah Anda menjalankan perintah yang benar untuk sistem Anda.

Dalam beberapa kasus, pesan kesalahan mungkin menunjukkan masalah koneksi dan terlihat mirip dengan:Host name was invalid for dns resolutionatauConnection was closed unexpectedly. Dalam kasus tersebut, berikut adalah beberapa hal yang dapat Anda periksa:

Langkah 4: Tinjau hasil dan langkah selanjutnya

Langkah selanjutnya

Sekarang Anda dapat menjalankanshadow.pycontoh aplikasi dan menggunakan Device Shadows untuk mengontrol negara. Anda dapat mengamati pembaruan pada dokumen Shadow diAWS IoTKonsol dan amati peristiwa delta yang merespons aplikasi sampel. Dengan menggunakan klien uji MQTT, Anda dapat berlangganan topik bayangan yang dipesan dan mengamati pesan yang diterima oleh topik saat menjalankan program sampel. Untuk informasi selengkapnya tentang cara menjalankan tutorial ini, lihatTutorial: Berinteraksi dengan Device Shadow menggunakan aplikasi sampel dan klien uji MQTT.