Twin class
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.
Konstruktoren
Twin(string | Device |
Instanziiert eine neue Twin. Die empfohlene Methode zum Abrufen eines neuen Twin-Objekts ist die Verwendung der getTwin(string, HttpResponseCallback<Twin>)-Methode. |
Eigenschaften
device |
Eindeutiger Bezeichner der Geräteidentität, die dem Zwilling zugeordnet ist, da sie in der Geräteidentitätsregistrierung vorhanden ist. |
etag | Tag, das in optimistischer Parallelität verwendet wird, um mehrere parallele Editionen des Geräte twin zu vermeiden. |
model |
Modell-ID der Geräteidentität, die dem Zwilling zugeordnet ist, wie sie in der Geräteidentitätsregistrierung vorhanden ist. |
module |
Modulbezeichner für das modul, das dem Zwilling zugeordnet ist, wie es in der Geräteidentitätsregistrierung vorhanden ist. |
properties | Die gewünschten und gemeldeten Eigenschaftenwörterbücher (bzw. in |
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(Incoming |
Ruft die neueste Version dieses Geräts Twin vom IoT Hub-Dienst ab. |
toJSON() | |
update(any) | |
update(any, Incoming |
Aktualisieren Sie das Gerät twin 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 Objekt, 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, da 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äte twin 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 es 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äts Twin vom IoT Hub-Dienst ab.
function get(done?: IncomingMessageCallback<Twin>)
Parameter
- done
-
IncomingMessageCallback<Twin>
Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist.
done
wird mit drei Argumenten aufgerufen: ein Error-Objekt (kann null sein), ein Twin-Objekt, das die erstellte Geräteidentität darstellt, und ein transportspezifisches Antwortobjekt, das zum Protokollieren oder 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 das Gerät twin 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 dieses Gerät twin angewendet werden sollen.
- done
-
IncomingMessageCallback<Twin>
Die optionale Funktion, die aufgerufen werden soll, wenn der Vorgang abgeschlossen ist.
done
wird mit drei Argumenten aufgerufen: ein Error-Objekt (kann null sein), ein Twin-Objekt, das die erstellte Geräteidentität darstellt, und ein transportspezifisches Antwortobjekt, das zum Protokollieren oder Debuggen nützlich ist.