azure-iot-device package

  • Başvuru

Sınıflar

Message

Message nesnesi, cihazla IoT Hub hizmeti arasında telemetri (cihazdan buluta) ve komutlar (buluttan cihaza) zaman uyumsuz mesajlaşma için kullanılır. Aktarımdan 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ı, bir IoT Hub cihaz istemcisi oluşturmak içinConnectionString veya fromSharedAccessSignature 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 aracılığıyla onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)kaydedilen geri çağırmaya geçirilir.
DeviceMethodResponse

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

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

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

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

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

Yalnızca bir bağlantı dizesiyle oluşturulabilen bir AuthenticationProvider nesne sağlar ve daha sonra cihaz istemcisi tarafından kullanılır ve Azure IoT hub örneğiyle kimlik doğrulaması yapmak için aktarımlar yapar.

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

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

SharedAccessSignatureAuthenticationProvider Nesnesi paylaşılan erişim imzası belirtecini otomatik olarak yenilemez, bu nedenle kullanıcının süresi dolmamış paylaşılan erişim imzası belirteçlerini yöntemini kullanarak bu belirteçlere beslemesi updateSharedAccessSignature 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ü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ştirildi ve hizmet tarafından alındı.

Mümkün 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.
X509AuthenticationProvider

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

ve nesnelerinin SharedAccessSignatureAuthenticationProvider aksine, X509AuthenticationProvider X509 kimlik doğrulamasında belirteç olmadığından bir olay yaymaznewTokenAvailable.SharedAccessKeyAuthenticationProvider Aktarımlar, yöntemini kullanarak getDeviceCredentials kimlik bilgilerini alır.

Arabirimler

AmqpTransportOptions

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

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

Bkz.
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 boole dışında drain birbirini dışlar. Seçenekler yapısında yalnızca bir interval, atcron veya manualPolling bulunmalıdır.

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

Bkz.
HttpTransportOptions

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

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

Bkz.
MqttTransportOptions

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

Bu, setOptions'abir DeviceClientOptions nesnesinin içinde adlı mqtt bir özellik olarak 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>