azure-iothub package

Kelas

Client

Klien layanan IoT Hub digunakan untuk berkomunikasi dengan perangkat melalui hub Azure IoT. Ini memungkinkan pengguna SDK:

  • kirim cloud-ke-perangkat (juga dikenal sebagai perintah) ke perangkat: perintah diantrekan pada IoT Hub dan dikirimkan secara asinkron hanya saat perangkat terhubung. Hanya 50 perintah yang dapat diantrekan per perangkat.
  • memanggil metode langsung pada perangkat (yang hanya akan berfungsi jika perangkat saat ini terhubung: ini adalah cara sinkron untuk berkomunikasi dengan perangkat)
  • dengarkan pesan umpan balik yang dikirim oleh perangkat untuk perintah sebelumnya.
  • dengarkan pemberitahuan unggahan file dari perangkat.

Pengguna harus membuat instans baru Client dengan memanggil salah satu metode pabrik, dariConnectionString atau dariSharedAccessSignature, untuk membuat Klien layanan IoT Hub.

Device

Membuat representasi perangkat untuk digunakan dengan API registri identitas perangkat .

Kelas ini tidak digunakan lagi karena registri identitas perangkat dapat bekerja langsung dengan objek JSON yang berisi deskripsi parsial perangkat, belum tentu objek lengkapnya. Di atas itu awalnya kelas ini dikirim dengan kesalahan ketik pada symmetricKey nama properti (itu pascal-cased alih-alih camel-cased). SDK menyimpan kelas ini agar tidak merusak kode yang ada tetapi ini akan dihapus dalam pembaruan versi utama di masa mendatang dan pelanggan harus menggunakan objek JSON biasa.

JobClient

Menyediakan metode untuk membuat, memperbarui, memantau, dan membatalkan pekerjaan yang berjalan lama pada instans IoT Hub, serta mengkueri pekerjaan yang ada. API Pekerjaan di Azure IoT Hub memungkinkan untuk menjadwalkan panggilan metode langsung dan pembaruan kembar di beberapa perangkat.

Pengguna SDK diharapkan membuat JobClient instans menggunakan metode fromConnectionString(string) pabrik dan fromSharedAccessSignature(string).

Registry

Kelas Registri menyediakan akses ke layanan identitas perangkat IoT Hub. Pengguna SDK harus membuat instans kelas ini dengan salah satu metode pabrik: dariConnectionString atau dariSharedAccessSignature.

Protokol yang digunakan untuk operasi registri identitas perangkat adalah HTTPS.

Amqp

Kelas transportasi yang digunakan oleh klien layanan untuk terhubung ke hub Azure IoT menggunakan protokol AMQP melalui soket aman (TLS). Kelas ini tidak boleh digunakan secara langsung dan sebaliknya diteruskan ke salah Client satu metode pabrik: dariConnectionString atau dariSharedAccessSignature.

AmqpWs

Kelas transportasi yang digunakan oleh klien layanan untuk terhubung ke hub Azure IoT menggunakan protokol AMQP melalui websocket yang aman. Kelas ini tidak boleh digunakan secara langsung dan sebaliknya diteruskan ke salah Client satu metode pabrik: dariConnectionString atau dariSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Membuat tanda tangan akses bersama berdasarkan string koneksi yang diteruskan ke konstruktor. Kelas ini digunakan oleh lapisan protokol SDK untuk menambahkan header autentikasi ke setiap permintaan.

Twin

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

Cara yang Twin disarankan untuk mendapatkan untuk perangkat tertentu adalah dengan menggunakan metode .getTwin(string, HttpResponseCallback<Twin>)

Antarmuka

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration

Objek Konfigurasi mewakili konfigurasi satu perangkat atau dapat mewakili penyebaran yang dapat diterapkan sebagai konfigurasi ke perangkat berdasarkan targetCondition.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

Menjelaskan parameter yang tersedia untuk digunakan dengan metode langsung (juga disebut metode perangkat)

Module

Alias Jenis

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback