Aracılığıyla paylaş

azure-iot-device package

Sınıflar

Message

Message nesnesi, cihaz ile IoT Hub hizmeti arasındaki telemetri (cihazdan buluta) ve komutlar (buluttan cihaza) zaman uyumsuz mesajlaşma için kullanılır. Taşımadan bağımsızdır, yani AMQP, MQTT ve HTTP üzerinde aynı şekilde çalışır.
Client

Bir cihazı Azure IoT hub'ına bağlamak için kullanılan IoT Hub cihaz istemcisi.

SDK kullanıcıları, IoT Hub cihaz istemcisi oluşturmak içinConnectionString veyaSharedAccessSignature 'dan fabrika yöntemlerinden birini çağırmalıdır.
DeviceMethodRequest

Buluttan bir cihaz yöntemi çağrıldığında hizmetten cihaza geçirilen verileri temsil eder. Bu sınıfın bir örneği, onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)aracılığıyla kaydedilen geri çağırmaya geçirilir.
DeviceMethodResponse

kullanıcıya her DeviceMethodResponse sahip bir DeviceMethodRequest nesnesi sağlanır ve bu da kullanıcının her cihaz yöntemi çağrısı için hizmete iyi biçimlendirilmiş bir yanıt oluşturmasına ve göndermesine olanak tanır. Bu sınıfın bir örneği, onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)aracılığıyla kaydedilen geri çağırmaya ikinci parametre olarak geçirilir.
IotEdgeAuthenticationProvider

Belirteç oluşturmayı iotedged olarak temsil eden bir AuthenticationProvider uygulaması sağlar. Bu uygulama, Azure IoT Edge ile modül istemcisi kullanılırken kullanılacaktır.

Bu tür SharedAccessKeyAuthenticationProvider devralır ve _sign yöntemini uygulayarak geçersiz kıldığı belirteç oluşturma bölümü dışında işlevsel olarak bu türle aynıdır.
ModuleClient

Bir cihazı Azure IoT hub'ına bağlamak için kullanılan IoT Hub cihaz istemcisi.

SDK kullanıcıları, IoT Hub cihaz istemcisi oluşturmak içinConnectionString veyaSharedAccessSignature 'dan fabrika yöntemlerinden birini çağırmalıdır.
SharedAccessKeyAuthenticationProvider

Yalnızca bir bağlantı dizesiyle oluşturulabilen ve ardından cihaz istemcisi tarafından kullanılan ve Azure IoT hub örneğiyle kimlik doğrulaması yapmak için aktarımları yapılan bir AuthenticationProvider nesnesi sağlar.

SharedAccessKeyAuthenticationProvider nesnesi, düzenli bir tempoda paylaşılan erişim imzası belirteçleri oluşturmayı üstlenir ve aktarımların kimlik bilgilerini Azure IoT hub örneğiyle yenilemesi ve bağlantıda kalması için newTokenAvailable olayı yayar.
SharedAccessSignatureAuthenticationProvider

Yalnızca paylaşılan erişim imzası ile oluşturulabilen ve ardından cihaz istemcisi ve aktarımları tarafından Azure IoT hub örneğiyle kimlik doğrulaması yapmak için kullanılan bir AuthenticationProvider nesnesi sağlar.

SharedAccessSignatureAuthenticationProvider nesnesi paylaşılan erişim imzası belirtecini otomatik olarak yenilemez, bu nedenle kullanıcının updateSharedAccessSignature yöntemini kullanarak süresi dolmamış paylaşılan erişim imzası belirteçlerini ona beslemesi gerekir. Bu yönteme yapılan her çağrı için, SharedAccessSignatureAuthenticationProvider aktarımların Azure IoT hub örneğiyle kimlik doğrulaması yapmak için kullanacağı bir newTokenAvailable olayı yayar.
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.
X509AuthenticationProvider

Yalnızca bir X509 sertifikası ve anahtarıyla oluşturulabilen ve ardından cihaz istemcisi ve aktarımları tarafından Azure IoT hub örneğiyle kimlik doğrulaması yapmak için kullanılan bir AuthenticationProvider nesnesi sağlar.

SharedAccessSignatureAuthenticationProvider ve SharedAccessKeyAuthenticationProvider nesnelerden farklı olarak, X509 kimlik doğrulamasında belirteç olmadığından X509AuthenticationProvider bir newTokenAvailable olayı yaymaz. Aktarımlar getDeviceCredentials yöntemini kullanarak kimlik bilgilerini alır.

Arabirimler

AmqpTransportOptions

AMQP aktarımına özgü seçenekler.

Bu, DeviceClientOptions nesnesinin içinde http adlı bir özellik olarak setOptions geçirilir.

Görmek
DeviceClientOptions

İstemci nesnesi için seçenekler. setOptions işlevine geçirildi.

Örnek

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

HTTP alıcısının iletileri ne sıklıkta yoklamasını yapılandırmak için kullanılan seçenekler yapısı. Bu seçeneklerin her biri, drain boole dışında birbirini dışlar. Seçenekler yapısında yalnızca bir interval, at, cron veya manualPolling bulunmalıdır.

Bu, bir DeviceClientOptions nesnesinin içindeki receivePolicy nesnesinin içinde adlı bir özellik olarak setOptions çağrılarak yapılandırılır.

Görmek
HttpTransportOptions

İsteğe bağlı yapılandırma parametrelerini Http Aktarım'a geçirmek için seçenekler yapısı.

Bu, DeviceClientOptions nesnesinin içinde http adlı bir özellik olarak setOptions geçirilir.

Görmek
MqttTransportOptions

MQTT aktarımına özgü seçenekler

Bu, DeviceClientOptions nesnesinin içinde mqtt adlı bir özellik olarak setOptions geçirilir.
TwinProperties

İkiz için istenen ve bildirilen özellikleri içerir.

Tür Diğer Adları

BufferConvertible

İşlevler

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

İşlev Ayrıntıları

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Parametreler

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Döndürülenler

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

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

Parametreler

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

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

Parametreler

productInfo

string

Döndürülenler

Promise<string>