azure-iothub package

Sınıflar

Client

IoT Hub hizmeti istemcisi, bir Azure IoT hub'ı aracılığıyla cihazlarla iletişim kurmak için kullanılır. SDK kullanıcısının şunları yapmasını sağlar:

  • cihazlara buluttan cihaza (komut olarak da bilinir) gönderme: komutlar IoT Hub kuyruğa alınır ve yalnızca cihaz bağlandığında zaman uyumsuz olarak teslim edilir. Cihaz başına yalnızca 50 komut kuyruğa alınabiliyor.
  • cihazlarda doğrudan yöntemleri çağırma (yalnızca cihaz şu anda bağlıysa çalışır: cihazla zaman uyumlu bir iletişim yöntemidir)
  • önceki komutlar için cihazlar tarafından gönderilen geri bildirim iletilerini dinleyin.
  • cihazlardan dosya yükleme bildirimlerini dinleyin.

Kullanıcılar bir IoT Hub hizmeti İstemcisi oluşturmak içinConnectionString veya fromSharedAccessSignature'dan fabrika yöntemlerinden birini çağırarak yeni Client örnekler oluşturmalıdır.

Device

Cihaz kimliği kayıt defteri API'leriyle kullanılacak bir cihazın gösterimini oluşturur.

Cihaz kimliği kayıt defteri, cihazın kısmi açıklamasını içeren JSON nesneleriyle doğrudan çalışabildiğinden, nesnenin tamamının olması gerekmediğinden bu sınıf kullanım dışı bırakıldı. Bunun üzerine, başlangıçta bu sınıf özellik adında bir yazım hatası symmetricKey ile gönderildi (camel-cased yerine pascal-cased idi). SDK, mevcut kodu bozmamak için bu sınıfı çevrelemektedir, ancak gelecek bir ana sürüm güncelleştirmesinde kaldırılacaktır ve müşterilerin bunun yerine düz JSON nesneleri kullanması gerekir.

JobClient

Bir IoT Hub örneğinde uzun süre çalışan işleri oluşturma, güncelleştirme, izleme ve iptal etme yöntemlerinin yanı sıra var olan işleri sorgulama yöntemleri sağlar. Azure IoT Hub'deki İşler API'si, birden çok cihazda doğrudan yöntem çağrıları ve ikiz güncelleştirmeleri zamanlamanıza olanak tanır.

SDK kullanıcılarının ve fromSharedAccessSignature(string)fabrika yöntemlerini kullanarak örnekler oluşturması JobClient beklenirfromConnectionString(string).

Registry

Registry sınıfı, IoT Hub cihaz kimliği hizmetine erişim sağlar. SDK kullanıcıları bu sınıfı fabrika yöntemlerinden biriyle başlatmalıdır: fromConnectionString veya fromSharedAccessSignature.

Cihaz kimliği kayıt defteri işlemleri için kullanılan protokol HTTPS'dir.

Amqp

Hizmet istemcisi tarafından amqp protokolü kullanarak Azure IoT hub'ına güvenli (TLS) yuva üzerinden bağlanmak için kullanılan aktarım sınıfı. Bu sınıf doğrudan kullanılmamalı ve bunun yerine fabrika yöntemlerinden Client birine geçirilmelidir: fromConnectionString veya fromSharedAccessSignature.

AmqpWs

Hizmet istemcisi tarafından güvenli web yuvaları üzerinden AMQP protokolunu kullanarak Azure IoT hub'ına bağlanmak için kullanılan aktarım sınıfı. Bu sınıf doğrudan kullanılmamalı ve bunun yerine fabrika yöntemlerinden Client birine geçirilmelidir: fromConnectionString veya fromSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Oluşturucuya geçirilen bağlantı dizesini temel alan paylaşılan erişim imzaları oluşturur. Bu sınıf, SDK'nın protokol katmanı tarafından her isteğe kimlik doğrulama üst bilgileri eklemek için kullanılır.

Twin

Cihaz İkizi, Azure IoT hub'ı tarafından depolanan ve cihaz çevrimdışı olsa bile kullanılabilen bir cihazın durumunu açıklayan belgedir. Yaklaşık 3 bölümde oluşturulmuş:

  • Etiketler: yalnızca hizmet tarafından erişilebilen anahtar/değer çiftleri
  • İstenen Özellikler: Bir hizmet tarafından güncelleştirildi ve cihaz tarafından alındı
  • Bildirilen Özellikler: cihaz tarafından güncelleştirilir ve hizmet tarafından alınır.

Bu bir olasılık olsa da, istenen ve bildirilen özelliklerin eşleşmesi gerekmediğini ve gerekirse bu iki koleksiyonu eşitleme mantığının SDK kullanıcısına bırakıldığını unutmayın.

Daha fazla bilgi için bkz . Cihaz İkizlerini Anlama.

Belirli bir cihaz için bir Twin elde etmenin önerilen yolu yöntemini kullanmaktır getTwin(string, HttpResponseCallback<Twin>) .

Arabirimler

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

Configuration nesnesi tek bir cihazın yapılandırmasını temsil eder veya targetCondition temelinde cihazlara yapılandırma olarak uygulanabilen bir dağıtımı temsil edebilir.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

Doğrudan yöntemlerle (cihaz yöntemleri olarak da adlandırılır) kullanılabilen parametreleri açıklar

Module

Tür Diğer Adları

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback