Twin class

Paket:

azure-iothub

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 besteht aus 3 Abschnitten:

• 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 gewünschte und gemeldete Eigenschaften zwar möglich sind, aber nicht übereinstimmen müssen und dass die Logik zum Synchronisieren dieser beiden Sammlungen, falls erforderlich, dem Benutzer des SDK überlassen wird.

Weitere Informationen finden Sie unter Grundlegendes zu Gerätezwillwillen.

Die empfohlene Methode zum Abrufen eines Twin für ein bestimmtes Gerät besteht darin, die getTwin(string, HttpResponseCallback<Twin>) -Methode zu verwenden.

Konstruktoren

Twin(string | DeviceIdentity, Registry)

Instanziiert eine neue Twin. Die empfohlene Methode zum Abrufen eines neuen Twin Objekts ist die Verwendung der getTwin(string, HttpResponseCallback<Twin>) -Methode.

Eigenschaften

deviceId	Eindeutiger Bezeichner der Geräteidentität, die dem Zwilling zugeordnet ist, wie sie in der Geräteidentitätsregistrierung vorhanden ist.
etag	Tag, das in optimistischer Parallelität verwendet wird, um mehrere parallele Editionen des Gerätezwillens zu vermeiden.
modelId	Modell-ID der Geräteidentität, die dem Zwilling zugeordnet ist, wie sie in der Geräteidentitätsregistrierung vorhanden ist.
moduleId	Modulbezeichner für das Modul, das dem Zwilling zugeordnet ist, wie er in der Geräteidentitätsregistrierung vorhanden ist.
properties	Die gewünschten und gemeldeten Eigenschaftenwörterbücher (bzw. in properties.desired und properties.reported).
tags	Sammlung von Schlüssel-Wert-Paaren, die nur auf der Dienstseite verfügbar sind und in Abfragen verwendet werden können, um bestimmte Geräte zu finden.

Methoden

get()
get(IncomingMessageCallback<Twin>)	Ruft die neueste Version dieses Gerätezwillens aus dem IoT Hub-Dienst ab.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)	Aktualisieren Sie den Gerätezwillen mit dem als Argument bereitgestellten Patch.

Details zum Konstruktor

Twin(string | DeviceIdentity, Registry)

Instanziiert eine neue Twin. Die empfohlene Methode zum Abrufen eines neuen Twin Objekts ist die Verwendung der getTwin(string, HttpResponseCallback<Twin>) -Methode.

new Twin(device: string | DeviceIdentity, registryClient: Registry)

Parameter

device

string | DeviceIdentity

Eine Gerätebezeichnerzeichenfolge oder ein Objekt, das das Gerät beschreibt. Wenn ein Object-Objekt vorhanden ist, muss es eine deviceId-Eigenschaft enthalten.

registryClient

Registry

Der HTTP-Registrierungsclient, der zum Ausführen von REST-API-Aufrufen verwendet wird.

Details zur Eigenschaft

deviceId

Eindeutiger Bezeichner der Geräteidentität, die dem Zwilling zugeordnet ist, wie sie in der Geräteidentitätsregistrierung vorhanden ist.

deviceId: string

Eigenschaftswert

string

etag

Tag, das in optimistischer Parallelität verwendet wird, um mehrere parallele Editionen des Gerätezwillens zu vermeiden.

etag: string

Eigenschaftswert

string

modelId

Modell-ID der Geräteidentität, die dem Zwilling zugeordnet ist, wie sie in der Geräteidentitätsregistrierung vorhanden ist.

modelId?: string

Eigenschaftswert

string

moduleId

Modulbezeichner für das Modul, das dem Zwilling zugeordnet ist, wie er in der Geräteidentitätsregistrierung vorhanden ist.

moduleId?: string

Eigenschaftswert

string

properties

Die gewünschten und gemeldeten Eigenschaftenwörterbücher (bzw. in properties.desired und properties.reported).

properties: { desired: {[key: string]: any}, reported: {[key: string]: any} }

Eigenschaftswert

{ desired: {[key: string]: any}, reported: {[key: string]: any} }

tags

Sammlung von Schlüssel-Wert-Paaren, die nur auf der Dienstseite verfügbar sind und in Abfragen verwendet werden können, um bestimmte Geräte zu finden.

tags: {[key: string]: string}

Eigenschaftswert

{[key: string]: string}

Details zur Methode

get()

function get(): Promise<ResultWithIncomingMessage<Twin>>

Gibt zurück

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Ruft die neueste Version dieses Gerätezwillens aus dem IoT Hub-Dienst ab.

function get(done?: IncomingMessageCallback<Twin>)

Parameter

done

IncomingMessageCallback<Twin>

Die optionale Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem Twin-Objekt , das die erstellte Geräteidentität darstellt, und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

toJSON()

function toJSON(): object

Gibt zurück

object

update(any)

function update(patch: any): Promise<ResultWithIncomingMessage<Twin>>

Parameter

patch

any

Gibt zurück

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Aktualisieren Sie den Gerätezwillen mit dem als Argument bereitgestellten Patch.

function update(patch: any, done?: IncomingMessageCallback<Twin>)

Parameter

patch

any

Objekt, das die neuen Werte enthält, die auf diesen Gerätezwillen angewendet werden sollen.

done

IncomingMessageCallback<Twin>

Die optionale Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem Twin-Objekt , das die erstellte Geräteidentität darstellt, und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.