Twin class

  • Riferimento
Pacchetto:
azure-iothub

Un dispositivo gemello è un documento che descrive lo stato di un dispositivo archiviato da un hub IoT di Azure ed è disponibile anche se il dispositivo è offline. Si basa su 3 sezioni:

  • Tag: coppie chiave/valore accessibili solo dal lato servizio
  • Proprietà desiderate: aggiornata da un servizio e ricevuta dal dispositivo
  • Proprietà segnalate: aggiornate dal dispositivo e ricevute dal servizio.

Si noti che, anche se è una possibilità, le proprietà desiderate e segnalate non devono corrispondere e che la logica per sincronizzare queste due raccolte, se necessario, viene lasciata all'utente dell'SDK.

Per altre informazioni, vedere Informazioni sui dispositivi gemelli.

Il modo consigliato per ottenere un Twin oggetto per un dispositivo specifico consiste nell'usare il getTwin(string, HttpResponseCallback<Twin>) metodo .

Costruttori

Twin(string | DeviceIdentity, Registry)

Crea un'istanza di un nuovo oggetto Twin. Il modo consigliato per ottenere un nuovo Twin oggetto consiste nell'usare il getTwin(string, HttpResponseCallback<Twin>) metodo .

Proprietà

deviceId

Identificatore univoco dell'identità del dispositivo associata al gemello, come esiste nel Registro identità del dispositivo.
etag

Tag usato nella concorrenza ottimistica per evitare più edizioni parallele del dispositivo gemello.
modelId

ID modello dell'identità del dispositivo associata al gemello, come esiste nel Registro identità del dispositivo.
moduleId

Identificatore del modulo per il modulo associato al gemello, come esiste nel Registro identità del dispositivo.
properties

Le proprietà desiderate e segnalate dictionnaries (rispettivamente in properties.desired e properties.reported).
tags

Raccolta di coppie chiave/valore disponibili solo sul lato servizio e possono essere usate nelle query per trovare dispositivi specifici.

Metodi

get()
get(IncomingMessageCallback<Twin>)

Ottiene la versione più recente di questo dispositivo gemello dal servizio hub IoT.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)

Aggiornare il dispositivo gemello con la patch fornita come argomento.

Dettagli costruttore

Twin(string | DeviceIdentity, Registry)

Crea un'istanza di un nuovo oggetto Twin. Il modo consigliato per ottenere un nuovo Twin oggetto consiste nell'usare il getTwin(string, HttpResponseCallback<Twin>) metodo .

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

Parametri

device

string | DeviceIdentity

Stringa di identificatore del dispositivo o oggetto che descrive il dispositivo. Se un oggetto deve contenere una proprietà deviceId.

registryClient
Registry

Client del Registro di sistema HTTP usato per eseguire chiamate API REST.

Dettagli proprietà

deviceId

Identificatore univoco dell'identità del dispositivo associata al gemello, come esiste nel Registro identità del dispositivo.

deviceId: string

Valore della proprietà

string

etag

Tag usato nella concorrenza ottimistica per evitare più edizioni parallele del dispositivo gemello.

etag: string

Valore della proprietà

string

modelId

ID modello dell'identità del dispositivo associata al gemello, come esiste nel Registro identità del dispositivo.

modelId?: string

Valore della proprietà

string

moduleId

Identificatore del modulo per il modulo associato al gemello, come esiste nel Registro identità del dispositivo.

moduleId?: string

Valore della proprietà

string

properties

Le proprietà desiderate e segnalate dictionnaries (rispettivamente in properties.desired e properties.reported).

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

Valore della proprietà

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

tags

Raccolta di coppie chiave/valore disponibili solo sul lato servizio e possono essere usate nelle query per trovare dispositivi specifici.

tags: {[key: string]: string}

Valore della proprietà

{[key: string]: string}

Dettagli metodo

get() 

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

Restituisce

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Ottiene la versione più recente di questo dispositivo gemello dal servizio hub IoT.

function get(done?: IncomingMessageCallback<Twin>)

Parametri

done

IncomingMessageCallback<Twin>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere null), un oggetto Twin che rappresenta l'identità del dispositivo creata e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

toJSON() 

function toJSON(): object

Restituisce

object

update(any) 

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

Parametri

patch

any

Restituisce

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Aggiornare il dispositivo gemello con la patch fornita come argomento.

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

Parametri

patch

any

Oggetto contenente i nuovi valori da applicare a questo dispositivo gemello.

done

IncomingMessageCallback<Twin>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere null), un oggetto Twin che rappresenta l'identità del dispositivo creata e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.