azure-iot-device package

  • Referenz

Klassen

Message

Das Message -Objekt wird für asynchrones Messaging zwischen dem Gerät und dem IoT Hub-Dienst für Telemetriedaten (Gerät zu Cloud) und Befehlen (Cloud-zu-Gerät) verwendet. Es ist transportagnostisch, d. h. es funktioniert genauso wie AMQP, MQTT und HTTP.
Client

IoT Hub Geräteclient, der verwendet wird, um ein Gerät mit einem Azure IoT Hub zu verbinden.

Benutzer des SDK sollten eine der Factorymethoden fromConnectionString oder fromSharedAccessSignature aufrufen, um einen IoT Hub Geräteclient zu erstellen.
DeviceMethodRequest

Stellt die Daten dar, die vom Dienst an das Gerät übergeben werden, wenn eine Gerätemethode aus der Cloud aufgerufen wird. Eine Instanz dieser Klasse wird an den über onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)registrierten Rückruf übergeben.
DeviceMethodResponse

Dem Benutzer wird ein DeviceMethodResponse -Objekt bereitgestellt, wobei jedes DeviceMethodRequest dem Benutzer das Erstellen und Senden einer gut formatierten Antwort an den Dienst für jeden Gerätemethodenaufruf ermöglicht. Eine Instanz dieser Klasse wird als zweiter Parameter an den über onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)registrierten Rückruf übergeben.
IotEdgeAuthenticationProvider

Stellt eine Implementierung bereit AuthenticationProvider , die die Tokengenerierung an iotedged delegiert. Diese Implementierung ist für die Verwendung des Modulclients mit Azure IoT Edge vorgesehen.

Dieser Typ erbt von SharedAccessKeyAuthenticationProvider und ist funktional identisch mit diesem Typ, mit Ausnahme des Tokengenerierungsteils, den er durch Implementierung der _sign -Methode überschreibt.
ModuleClient

IoT Hub Geräteclient, der verwendet wird, um ein Gerät mit einem Azure IoT Hub zu verbinden.

Benutzer des SDK sollten eine der Factorymethoden fromConnectionString oder fromSharedAccessSignature aufrufen, um einen IoT Hub Geräteclient zu erstellen.
SharedAccessKeyAuthenticationProvider

Stellt ein AuthenticationProvider Objekt bereit, das einfach mit einer Verbindungszeichenfolge erstellt werden kann und dann vom Geräteclient und den Transporten verwendet wird, um sich bei der Azure IoT Hub-Instanz zu authentifizieren.

Das SharedAccessKeyAuthenticationProvider -Objekt kümmert sich um die Erstellung von Shared Access Signature-Token in einem regulären Rhythmus und gibt das newTokenAvailable Ereignis für die Transporte aus, um ihre Anmeldeinformationen mit der Azure IoT Hub-Instanz zu erneuern und in Verbindung zu bleiben.
SharedAccessSignatureAuthenticationProvider

Stellt ein AuthenticationProvider Objekt bereit, das einfach mit einer Shared Access Signature erstellt werden kann und dann vom Geräteclient und den Transporten verwendet wird, um sich bei der Azure IoT Hub-Instanz zu authentifizieren.

Das SharedAccessSignatureAuthenticationProvider -Objekt erneuert das Shared Access Signature-Token nicht automatisch, sodass der Benutzer nicht abgelaufene Shared Access Signature-Token mithilfe der -Methode an das updateSharedAccessSignature Objekt senden muss. Für jeden Aufruf dieser Methode gibt ein SharedAccessSignatureAuthenticationProvidernewTokenAvailable Ereignis aus, das transportiert, um sich bei der Azure IoT Hub-Instanz zu authentifizieren.
Twin

Ein Gerätezwillen ist ein Dokument, das den Zustand eines Geräts beschreibt, das von einem Azure IoT Hub gespeichert wird und auch dann verfügbar ist, wenn das Gerät offline ist. Es ist um 3 Abschnitte gebaut:

  • Tags: Schlüssel-Wert-Paare, auf die nur von der Dienstseite zugegriffen werden kann
  • Gewünschte Eigenschaften: von einem Dienst aktualisiert und vom Gerät empfangen
  • Gemeldete Eigenschaften: Vom Gerät aktualisiert und vom Dienst empfangen.

Beachten Sie, dass, obwohl es möglich ist, gewünschte und gemeldete Eigenschaften nicht übereinstimmen müssen, und dass die Logik zum Synchronisieren dieser beiden Sammlungen, falls erforderlich, dem Benutzer des SDK überlassen bleibt.

Weitere Informationen finden Sie unter Grundlegendes zu Gerätezwillys.
X509AuthenticationProvider

Stellt ein AuthenticationProvider Objekt bereit, das einfach mit einem X509-Zertifikat und -Schlüssel erstellt werden kann und dann vom Geräteclient und den Transporten zur Authentifizierung bei der Azure IoT Hub-Instanz verwendet wird.

Im Gegensatz zu den SharedAccessSignatureAuthenticationProvider - und SharedAccessKeyAuthenticationProvider -Objekten gibt kein X509AuthenticationProvider Ereignis aus newTokenAvailable , da kein Token an der X509-Authentifizierung beteiligt ist. Die Transporte rufen die Anmeldeinformationen mithilfe der getDeviceCredentials -Methode ab.

Schnittstellen

AmqpTransportOptions

Optionen, die für den AMQP-Transport spezifisch sind.

Dies wird an setOptions als Eigenschaft mit dem Namen http in einem DeviceClientOptions-Objekt übergeben.

Finden Sie unter
DeviceClientOptions

Optionen für das Client-Objekt. An die setOptions-Funktion übergeben.

Beispiel

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

Die Optionsstruktur wird verwendet, um zu konfigurieren, wie oft der HTTP-Empfänger Nachrichten abruft. Jede dieser Optionen schließt sich gegenseitig aus, mit Ausnahme des drain booleschen Werts. Nur ein interval, atoder cronmanualPolling darf in der Optionsstruktur vorhanden sein.

Dies wird konfiguriert, indem setOptions mit dieser als Eigenschaft namens receivePolicy innerhalb eines HttpTransportOptions-Objekts in einem DeviceClientOptions-Objekt aufgerufen wird.

Finden Sie unter
HttpTransportOptions

Optionsstruktur zum Übergeben optionaler Konfigurationsparameter an den Http-Transport.

Dies wird an setOptions als Eigenschaft mit dem Namen http in einem DeviceClientOptions-Objekt übergeben.

Finden Sie unter
MqttTransportOptions

Spezifische Optionen für den MQTT-Transport

Dies wird an setOptions als Eigenschaft mit dem Namen mqtt in einem DeviceClientOptions-Objekt übergeben.
TwinProperties

Enthält die gewünschten und gemeldeten Eigenschaften für den Zwilling.

Typaliase

BufferConvertible

Functions

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

Details zur Funktion

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Parameter

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Gibt zurück

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

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

Parameter

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

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

Parameter

productInfo

string

Gibt zurück

Promise<string>