Freigeben über

azure-iot-device package

  • Referenz

Klassen

Message

Das Message-Objekt wird für Telemetrie (Geräte-zu-Cloud) und Befehle (Cloud-zu-Gerät) asynchrones Messaging zwischen dem Gerät und dem IoT Hub-Dienst verwendet. Es ist transportagnostisch, d. h., es funktioniert auf die gleiche Weise über AMQP, MQTT und HTTP.
Client

IoT Hub-Geräteclient, der zum Verbinden eines Geräts mit einem Azure IoT-Hub verwendet wird.

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

Stellt die vom Dienst an das Gerät übergebenen Daten dar, 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 mit jedem DeviceMethodRequest bereitgestellt, mit dem der Benutzer eine gut formatierte Antwort für jeden Gerätemethodenaufruf erstellen und senden kann. 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 AuthenticationProvider Implementierung bereit, die die Tokengenerierung an iotedged delegiert. Diese Implementierung soll bei Verwendung des Modulclients mit Azure IoT Edge verwendet werden.

Dieser Typ erbt von SharedAccessKeyAuthenticationProvider und ist funktionell identisch mit diesem Typ, mit Ausnahme des Tokengenerierungsteils, der durch die Implementierung der _sign-Methode außer dem Tokengenerierungsteil überschrieben wird.
ModuleClient

IoT Hub-Geräteclient, der zum Verbinden eines Geräts mit einem Azure IoT-Hub verwendet wird.

Benutzer des SDK sollten eine der Factorymethoden aufrufen, fromConnectionString oder fromSharedAccessSignature, 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 Transporten zur Authentifizierung bei der Azure IoT-Hubinstanz verwendet wird.

Das SharedAccessKeyAuthenticationProvider-Objekt kümmert sich um das Erstellen freigegebener Zugriffssignaturtoken in regelmäßigen Abständen und gibt das newTokenAvailable Ereignis für die Transporte aus, um ihre Anmeldeinformationen mit der Azure IoT-Hubinstanz zu erneuern und mit der Azure IoT-Hubinstanz in Verbindung zu bleiben.
SharedAccessSignatureAuthenticationProvider

Stellt ein AuthenticationProvider -Objekt bereit, das einfach mit einer freigegebenen Zugriffssignatur erstellt werden kann und dann vom Geräteclient und Transporten zur Authentifizierung mit der Azure IoT-Hubinstanz verwendet wird.

Das SharedAccessSignatureAuthenticationProvider-Objekt erneuert das Signaturtoken für den freigegebenen Zugriff nicht automatisch, sodass der Benutzer nicht abgelaufene Freigegebene Zugriffssignaturtoken mithilfe der updateSharedAccessSignature-Methode einfeed. Für jeden Aufruf dieser Methode gibt die SharedAccessSignatureAuthenticationProvider ein newTokenAvailable Ereignis aus, das für die Authentifizierung mit der Azure IoT-Hubinstanz verwendet wird.
Twin

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

  • Tags: Schlüssel-Wert-Paare, auf die nur über die 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 die Logik zum Synchronisieren dieser beiden Auflistungen, falls erforderlich, dem Benutzer des SDK überlassen wird, obwohl es eine Möglichkeit ist, gewünschte und gemeldete Eigenschaften nicht übereinstimmen zu müssen.

Weitere Informationen finden Sie unter Understanding Device Twins.
X509AuthenticationProvider

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

Im Gegensatz zu den objekten SharedAccessSignatureAuthenticationProvider und SharedAccessKeyAuthenticationProvider gibt die X509AuthenticationProvider kein newTokenAvailable Ereignis aus, 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 innerhalb eines DeviceClientOptions--Objekts übergeben.

Siehe
DeviceClientOptions

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

Beispiel

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

Optionsstruktur, die verwendet wird, 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, at, cron oder manualPolling ist in der Optionsstruktur vorhanden.

Dies wird durch Aufrufen von setOptions mit dieser als Eigenschaft namens receivePolicy innerhalb eines HttpTransportOptions--Objekts konfiguriert, das sich innerhalb eines DeviceClientOptions--Objekts befindet.

Siehe
HttpTransportOptions

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

Dies wird an setOptions als Eigenschaft mit dem Namen http innerhalb eines DeviceClientOptions--Objekts übergeben.

Siehe
MqttTransportOptions

Spezifische Optionen für den MQTT-Transport

Dies wird an setOptions als Eigenschaft mit dem Namen mqtt innerhalb eines DeviceClientOptions--Objekts übergeben.
TwinProperties

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

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>