azure-iot-device package

  • Referensi

Kelas

Message

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

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

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

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).
DeviceMethodResponse

DeviceMethodResponse objek diberikan kepada pengguna dengan masing-masing 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).
IotEdgeAuthenticationProvider

AuthenticationProvider Menyediakan implementasi yang mendelegasikan pembuatan token ke iotedged. 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 _sign metode .
ModuleClient

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

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

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

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

AuthenticationProvider Menyediakan objek 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 ke dalamnya menggunakan updateSharedAccessSignature metode . Untuk setiap panggilan ke metode ini, akan memancarkan SharedAccessSignatureAuthenticationProvidernewTokenAvailable peristiwa yang akan digunakan transportasi untuk mengautentikasi dengan instans hub Azure IoT.
Twin

Device Twin adalah dokumen yang menjelaskan status perangkat yang disimpan oleh hub Azure IoT dan tersedia meskipun perangkat sedang 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 Device Twins.
X509AuthenticationProvider

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

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

Antarmuka

AmqpTransportOptions

Opsi yang khusus untuk transportasi AMQP.

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

Lihat
DeviceClientOptions

Opsi untuk objek Klien. Diteruskan ke fungsi setOptions .

Contoh

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

Struktur opsi yang digunakan untuk mengonfigurasi seberapa sering penerima HTTP melakukan polling untuk pesan. Masing-masing opsi ini saling eksklusif, kecuali untuk drain boolean. Hanya satu interval, at, cron atau manualPolling akan hadir 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
HttpTransportOptions

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

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

Lihat
MqttTransportOptions

Opsi yang khusus untuk transportasi MQTT

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

Berisi properti yang diinginkan dan dilaporkan untuk Twin.

Alias Jenis

BufferConvertible

Fungsi

getUserAgentString(NoErrorCallback<string>)
getUserAgentString()
getUserAgentString(string, NoErrorCallback<string>)
getUserAgentString(string)

Detail Fungsi

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Parameter

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Mengembalikan

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)

Parameter

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

function getUserAgentString(productInfo: string): Promise<string>

Parameter

productInfo

string

Mengembalikan

Promise<string>