Aracılığıyla paylaş


azure-iothub package

Sınıflar

Client

IoT Hub hizmet 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'da 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 iletişim kurmanın zaman uyumlu bir yoludur)
  • önceki komutlar için cihazlar tarafından gönderilen geri bildirim iletilerini dinleyin.
  • cihazlardan dosya yükleme bildirimlerini dinleyin.

Kullanıcıların, IoT Hub hizmet İstemcisi oluşturmak için, Fabrika yöntemlerinden birini çağırarak yeni Client örnekleri oluşturması, ConnectionString veyaSharedAccessSignature 'danoluşturması gerekir.

Device

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

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

JobClient

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 mevcut işleri sorgulamaya yönelik yöntemler sağlar. Azure IoT Hub'daki İş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 fromConnectionString(string) ve fromSharedAccessSignature(string)fabrika yöntemlerini kullanarak JobClient örnekleri oluşturması beklenir.

Registry

Registry sınıfı, IoT Hub cihaz kimliği hizmetine erişim sağlar. SDK kullanıcıları bu sınıfın örneğini fabrika yöntemlerinden biriyle oluşturmalıdır:ConnectionString 'dan veyaSharedAccessSignature 'dan.

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

Amqp

hizmet istemcisi tarafından kullanılan aktarım sınıfı, güvenli (TLS) yuva üzerinden AMQP protokolunu kullanarak Azure IoT hub'ına bağlanmak için. Bu sınıf doğrudan kullanılmamalıdır ve bunun yerine Client fabrika yöntemlerinden birine geçirilmelidir: ConnectionString veya SharedAccessSignature.

AmqpWs

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

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üme sahiptir:

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

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. Device Twins'i anlama.

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

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