Freigeben über


azure-iothub package

Klassen

Client

Der IoT Hub-Dienstclient wird für die Kommunikation mit Geräten über einen Azure IoT-Hub verwendet. Er ermöglicht dem SDK-Benutzer:

  • Senden von Cloud-zu-Gerät (auch als Befehle bezeichnet) an Geräte: Befehle werden auf IoT Hub in die Warteschlange gestellt und werden nur asynchron bereitgestellt, wenn das Gerät verbunden ist. Pro Gerät können nur 50 Befehle in die Warteschlange gestellt werden.
  • Aufrufen direkter Methoden auf Geräten (die nur funktionieren, wenn das Gerät derzeit verbunden ist: es ist eine synchrone Methode der Kommunikation mit dem Gerät)
  • Auf Feedbackmeldungen lauschen, die von Geräten für vorherige Befehle gesendet wurden.
  • Auf Dateiuploadbenachrichtigungen von Geräten lauschen.

Benutzer sollten neue Client Instanzen erstellen, indem Sie eine der Factorymethoden aufrufen, fromConnectionString oder vonSharedAccessSignature, um einen IoT Hub-Dienstclient zu erstellen.

Device

Erstellt eine Darstellung eines Geräts zur Verwendung mit der Geräteidentitätsregistrierung APIs.

Diese Klasse ist veraltet, da die Geräteidentitätsregistrierung direkt mit JSON-Objekten arbeiten kann, die eine teilweise Beschreibung des Geräts enthalten, nicht unbedingt das vollständige Objekt. Darüber hinaus wurde diese Klasse zunächst mit einem Tippfehler auf dem symmetricKey Eigenschaftsnamen ausgeliefert (es wurde pascal-cased anstelle von Kamel cased). Das SDK behält diese Klasse bei, um vorhandenen Code nicht zu unterbrechen, dies wird jedoch in einem zukünftigen Update der Hauptversion entfernt, und Kunden sollten stattdessen einfache JSON-Objekte verwenden.

JobClient

Stellt Methoden zum Erstellen, Aktualisieren, Überwachen und Abbrechen von lang ausgeführten Aufträgen in einer IoT Hub-Instanz sowie zum Abfragen vorhandener Aufträge bereit. Die Auftrags-API in Azure IoT Hub ermöglicht das Planen von direkten Methodenaufrufen und Zwillingsupdates auf mehreren Geräten.

SDK-Benutzer werden voraussichtlich JobClient Instanzen mithilfe der Factorymethoden fromConnectionString(string) und fromSharedAccessSignature(string)erstellen.

Registry

Die Registrierungsklasse bietet Zugriff auf den IoT Hub-Geräteidentitätsdienst. Benutzer des SDK sollten diese Klasse mit einer der Factorymethoden instanziieren: fromConnectionString oder fromSharedAccessSignature.

Das Protokoll, das für Geräteidentitätsregistrierungsvorgänge verwendet wird, ist HTTPS.

Amqp

Transportklasse, die vom -Dienstclient verwendet wird,, um eine Verbindung mit dem Azure IoT-Hub mithilfe des AMQP-Protokolls über einen sicheren (TLS)-Socket herzustellen. Diese Klasse sollte nicht direkt verwendet werden und stattdessen an eine der Client Factorymethoden übergeben werden: fromConnectionString oder fromSharedAccessSignature.

AmqpWs

Transportklasse, die vom -Dienstclient verwendet wird,, um mithilfe des AMQP-Protokolls über sichere Websockets eine Verbindung mit dem Azure IoT-Hub herzustellen. Diese Klasse sollte nicht direkt verwendet werden und stattdessen an eine der Client Factorymethoden übergeben werden: fromConnectionString oder fromSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Erstellt freigegebene Zugriffssignaturen basierend auf der Verbindungszeichenfolge, die an den Konstruktor übergeben wird. Diese Klasse wird von der Protokollebene des SDK verwendet, um jeder Anforderung Authentifizierungsheader hinzuzufügen.

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.

Die empfohlene Methode zum Abrufen einer Twin für ein bestimmtes Gerät ist die Verwendung der getTwin(string, HttpResponseCallback<Twin>)-Methode.

Schnittstellen

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration

Das Configuration -Objekt stellt die Konfiguration eines einzelnen Geräts dar oder kann eine Bereitstellung darstellen, die als Konfiguration auf Geräte basierend auf der targetCondition angewendet werden kann.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

Beschreibt die Parameter, die für die Verwendung mit direkten Methoden (auch als Gerätemethoden bezeichnet) verfügbar sind.

Module

Typaliase

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback