Twin class

Paquet:

azure-iothub

Un jumeau d’appareil est un document décrivant l’état d’un appareil stocké par un hub Azure IoT et disponible même si l’appareil est hors connexion. Il est construit autour de 3 sections :

• Balises : paires clé/valeur accessibles uniquement du côté service
• Propriétés souhaitées : mises à jour par un service et reçues par l’appareil
• Propriétés signalées : mises à jour par l’appareil et reçues par le service.

Notez que bien qu’il s’agisse d’une possibilité, les propriétés souhaitées et signalées ne doivent pas correspondre et que la logique de synchronisation de ces deux collections, si nécessaire, est laissée à l’utilisateur du KIT de développement logiciel (SDK).

Pour plus d’informations, consultez Présentation des jumeaux d’appareil.

La méthode recommandée pour obtenir un Twin pour un appareil spécifique consiste à utiliser la getTwin(string, HttpResponseCallback<Twin>) méthode .

Constructeurs

Twin(string | DeviceIdentity, Registry)

Instancie un nouveau Twin. La méthode recommandée pour obtenir un nouvel Twin objet consiste à utiliser la getTwin(string, HttpResponseCallback<Twin>) méthode .

Propriétés

deviceId	Identificateur unique de l’identité d’appareil associée au jumeau, tel qu’il existe dans le registre des identités d’appareil.
etag	Balise utilisée dans l’accès concurrentiel optimiste pour éviter plusieurs éditions parallèles du jumeau d’appareil.
modelId	ID de modèle de l’identité d’appareil associée au jumeau, tel qu’il existe dans le registre des identités d’appareil.
moduleId	Identificateur de module pour le module associé au jumeau, tel qu’il existe dans le registre des identités d’appareil.
properties	Les dictionnaries des propriétés souhaitées et signalées (respectivement dans properties.desired et properties.reported).
tags	Collection de paires clé/valeur qui est disponible uniquement côté service et qui peut être utilisée dans les requêtes pour rechercher des appareils spécifiques.

Méthodes

get()
get(IncomingMessageCallback<Twin>)	Obtient la dernière version de ce jumeau d’appareil à partir du service IoT Hub.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)	Mettez à jour le jumeau d’appareil avec le correctif fourni en tant qu’argument.

Détails du constructeur

Twin(string | DeviceIdentity, Registry)

Instancie un nouveau Twin. La méthode recommandée pour obtenir un nouvel Twin objet consiste à utiliser la getTwin(string, HttpResponseCallback<Twin>) méthode .

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

Paramètres

device

string | DeviceIdentity

Chaîne d’identificateur d’appareil ou objet décrivant l’appareil. S’il s’agit d’un objet, il doit contenir une propriété deviceId.

registryClient

Registry

Client de Registre HTTP utilisé pour exécuter des appels d’API REST.

Détails de la propriété

deviceId

Identificateur unique de l’identité d’appareil associée au jumeau, tel qu’il existe dans le registre des identités d’appareil.

deviceId: string

Valeur de propriété

string

etag

Balise utilisée dans l’accès concurrentiel optimiste pour éviter plusieurs éditions parallèles du jumeau d’appareil.

etag: string

Valeur de propriété

string

modelId

ID de modèle de l’identité d’appareil associée au jumeau, tel qu’il existe dans le registre des identités d’appareil.

modelId?: string

Valeur de propriété

string

moduleId

Identificateur de module pour le module associé au jumeau, tel qu’il existe dans le registre des identités d’appareil.

moduleId?: string

Valeur de propriété

string

properties

Les dictionnaries des propriétés souhaitées et signalées (respectivement dans properties.desired et properties.reported).

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

Valeur de propriété

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

tags

Collection de paires clé/valeur qui est disponible uniquement côté service et qui peut être utilisée dans les requêtes pour rechercher des appareils spécifiques.

tags: {[key: string]: string}

Valeur de propriété

{[key: string]: string}

Détails de la méthode

get()

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

Retours

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Obtient la dernière version de ce jumeau d’appareil à partir du service IoT Hub.

function get(done?: IncomingMessageCallback<Twin>)

Paramètres

done

IncomingMessageCallback<Twin>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un objet Twin représentant l’identité d’appareil créée et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.

toJSON()

function toJSON(): object

Retours

object

update(any)

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

Paramètres

patch

any

Retours

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Mettez à jour le jumeau d’appareil avec le correctif fourni en tant qu’argument.

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

Paramètres

patch

any

Objet contenant les nouvelles valeurs à appliquer à ce jumeau d’appareil.

done

IncomingMessageCallback<Twin>

Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un objet Twin représentant l’identité d’appareil créée et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.