azure-iot-device package

Objek Message digunakan untuk telemetri (perangkat-ke-cloud) dan perintah (cloud-ke-perangkat) pesan asinkron antara perangkat dan layanan IoT Hub. Ini adalah transport-agnostic, yang berarti bekerja dengan cara yang sama melalui AMQP, MQTT dan HTTP.

Klien perangkat IoT Hub yang digunakan untuk menyambungkan perangkat dengan hub Azure IoT.

Pengguna SDK harus memanggil salah satu metode pabrik, dariConnectionString atau dari SharedAccessSignature untuk membuat klien perangkat IoT Hub.

Mewakili data yang diteruskan dari layanan ke perangkat saat metode perangkat dipanggil dari cloud. Instans kelas ini diteruskan ke panggilan balik yang terdaftar melalui onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

objek DeviceMethodResponse diberikan kepada pengguna dengan setiap DeviceMethodRequest memungkinkan pengguna untuk membangun dan mengirim respons yang diformat dengan baik kembali ke layanan untuk setiap panggilan metode perangkat. Instans kelas ini diteruskan sebagai parameter kedua ke panggilan balik yang terdaftar melalui onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Menyediakan implementasi AuthenticationProvider yang mendelegasikan pembuatan token untuk diiot. Implementasi ini dimaksudkan untuk digunakan saat menggunakan klien modul dengan Azure IoT Edge.

Jenis ini mewarisi dari SharedAccessKeyAuthenticationProvider dan secara fungsional identik dengan jenis tersebut kecuali untuk bagian pembuatan token yang ditimpanya dengan menerapkan metode _sign.

Klien perangkat IoT Hub yang digunakan untuk menyambungkan perangkat dengan hub Azure IoT.

Pengguna SDK harus memanggil salah satu metode pabrik, dariConnectionString atau dari SharedAccessSignature untuk membuat klien perangkat IoT Hub.

Menyediakan objek AuthenticationProvider yang dapat dibuat hanya dengan string koneksi dan kemudian digunakan oleh klien perangkat dan transportasi untuk mengautentikasi dengan instans hub Azure IoT.

Objek SharedAccessKeyAuthenticationProvider mengurus pembuatan token tanda tangan akses bersama pada irama reguler dan memancarkan peristiwa newTokenAvailable bagi transportasi untuk memperbarui kredensial mereka dengan instans hub Azure IoT dan tetap terhubung.

Menyediakan objek AuthenticationProvider yang dapat dibuat hanya dengan tanda tangan akses bersama dan kemudian digunakan oleh klien perangkat dan transportasi untuk mengautentikasi dengan instans hub Azure IoT.

Objek SharedAccessSignatureAuthenticationProvider tidak memperbarui token tanda tangan akses bersama secara otomatis, sehingga pengguna perlu memberi umpan token tanda tangan akses bersama yang tidak kedaluwarsa menggunakan metode updateSharedAccessSignature. Untuk setiap panggilan ke metode ini, SharedAccessSignatureAuthenticationProvider akan memancarkan peristiwa newTokenAvailable yang akan digunakan transportasi untuk mengautentikasi dengan instans hub Azure IoT.

Device Twin adalah dokumen yang menjelaskan status perangkat yang disimpan oleh hub Azure IoT dan tersedia bahkan jika perangkat offline. Ini dibangun sekitar 3 bagian:

• Tag: pasangan kunci/nilai hanya dapat diakses dari sisi layanan
• Properti yang Diinginkan: diperbarui oleh layanan dan diterima oleh perangkat
• Properti yang Dilaporkan: diperbarui oleh perangkat dan diterima oleh layanan.

Perhatikan bahwa meskipun itu adalah kemungkinan, properti yang diinginkan dan dilaporkan tidak harus cocok dan bahwa logika untuk menyinkronkan kedua koleksi ini, jika perlu, diserahkan kepada pengguna SDK.

Untuk informasi selengkapnya, lihat Memahami Perangkat Kembar.

Menyediakan objek AuthenticationProvider yang dapat dibuat hanya dengan sertifikat dan kunci X509 dan kemudian digunakan oleh klien perangkat dan transportasi untuk mengautentikasi dengan instans hub Azure IoT.

Tidak seperti objek SharedAccessSignatureAuthenticationProvider dan SharedAccessKeyAuthenticationProvider, X509AuthenticationProvider tidak memancarkan peristiwa newTokenAvailable karena tidak ada token yang terlibat dalam autentikasi X509. Transportasi akan mendapatkan kredensial menggunakan metode getDeviceCredentials.

Opsi yang khusus untuk transportasi AMQP.

Ini diteruskan ke setOptions sebagai properti bernama http di dalam objek DeviceClientOptions.

Lihat

Opsi untuk objek Klien. Diteruskan ke fungsi setOptions.

Contoh

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);

Struktur opsi yang digunakan untuk mengonfigurasi seberapa sering penerima HTTP melakukan polling untuk pesan. Masing-masing opsi ini saling eksklusif, kecuali untuk boolean drain. Hanya satu interval, at, cron atau manualPolling yang akan ada dalam struktur opsi.

Ini dikonfigurasi dengan memanggil setOptions dengan ini sebagai properti bernama receivePolicy di dalam objek HttpTransportOptions yang berada di dalam objek DeviceClientOptions.

Lihat

Struktur opsi untuk meneruskan parameter konfigurasi opsional ke dalam Http Transport.

Ini diteruskan ke setOptions sebagai properti bernama http di dalam objek DeviceClientOptions.

Lihat

Opsi yang khusus untuk transportasi MQTT

Ini diteruskan ke setOptions sebagai properti bernama mqtt di dalam objek DeviceClientOptions.

Berisi properti yang diinginkan dan dilaporkan untuk Twin.