Partilhar via

Twin class

  • Referência
Pacote:
azure-iothub

Um Gêmeo de Dispositivo é um documento que descreve o estado de um dispositivo armazenado por um hub IoT do Azure e está disponível mesmo se o dispositivo estiver offline. É construído em torno de 3 seções:

  • Tags: pares chave/valor acessíveis apenas do lado do serviço
  • Propriedades desejadas: atualizadas por um serviço e recebidas pelo dispositivo
  • Propriedades relatadas: atualizadas pelo dispositivo e recebidas pelo serviço.

Observe que, embora seja uma possibilidade, as propriedades desejadas e relatadas não precisam corresponder e que a lógica para sincronizar essas duas coleções, se necessário, é deixada para o usuário do SDK.

Para obter mais informações, consulte Noções básicas sobre gêmeos de dispositivo.

A maneira recomendada de obter um Twin para um dispositivo específico é usar o método getTwin(string, HttpResponseCallback<Twin>).

Construtores

Twin(string | DeviceIdentity, Registry)

Instancia um novo Twin. A maneira recomendada de obter um novo objeto Twin é usar o método getTwin(string, HttpResponseCallback<Twin>).

Propriedades

deviceId

Identificador exclusivo da identidade do dispositivo associada ao gêmeo, tal como existe no registro de identidade do dispositivo.
etag

Tag usada em simultaneidade otimista para evitar várias edições paralelas do dispositivo gêmeo.
modelId

ID do modelo da identidade do dispositivo associada ao gémeo, tal como existe no registo de identidade do dispositivo.
moduleId

Identificador de módulo para o módulo associado ao gêmeo, como existe no registro de identidade do dispositivo.
properties

Os dicionários de propriedades desejadas e relatadas (respectivamente em properties.desired e properties.reported).
tags

Coleção de pares chave/valor que está disponível apenas no lado do serviço e pode ser usada em consultas para localizar dispositivos específicos.

Métodos

get()
get(IncomingMessageCallback<Twin>)

Obtém a versão mais recente deste dispositivo gêmeo do serviço Hub IoT.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)

Atualize o dispositivo twin com o patch fornecido como argumento.

Detalhes do Construtor

Twin(string | DeviceIdentity, Registry)

Instancia um novo Twin. A maneira recomendada de obter um novo objeto Twin é usar o método getTwin(string, HttpResponseCallback<Twin>).

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

Parâmetros

device

string | DeviceIdentity

Uma cadeia de caracteres de identificador de dispositivo ou um objeto que descreve o dispositivo. Se um Object, ele deve conter uma propriedade deviceId.

registryClient
Registry

O cliente de registro HTTP usado para executar chamadas de API REST.

Detalhes de Propriedade

deviceId

Identificador exclusivo da identidade do dispositivo associada ao gêmeo, tal como existe no registro de identidade do dispositivo.

deviceId: string

Valor de Propriedade

string

etag

Tag usada em simultaneidade otimista para evitar várias edições paralelas do dispositivo gêmeo.

etag: string

Valor de Propriedade

string

modelId

ID do modelo da identidade do dispositivo associada ao gémeo, tal como existe no registo de identidade do dispositivo.

modelId?: string

Valor de Propriedade

string

moduleId

Identificador de módulo para o módulo associado ao gêmeo, como existe no registro de identidade do dispositivo.

moduleId?: string

Valor de Propriedade

string

properties

Os dicionários de propriedades desejadas e relatadas (respectivamente em properties.desired e properties.reported).

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

Valor de Propriedade

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

tags

Coleção de pares chave/valor que está disponível apenas no lado do serviço e pode ser usada em consultas para localizar dispositivos específicos.

tags: {[key: string]: string}

Valor de Propriedade

{[key: string]: string}

Detalhes de Método

get() 

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

Devoluções

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Obtém a versão mais recente deste dispositivo gêmeo do serviço Hub IoT.

function get(done?: IncomingMessageCallback<Twin>)

Parâmetros

done

IncomingMessageCallback<Twin>

A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto Twin que representa a identidade do dispositivo criado e um objeto de resposta específico de transporte útil para registro em log ou depuração.

toJSON() 

function toJSON(): object

Devoluções

object

update(any) 

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

Parâmetros

patch

any

Devoluções

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Atualize o dispositivo twin com o patch fornecido como argumento.

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

Parâmetros

patch

any

Objeto que contém os novos valores a serem aplicados a este dispositivo gêmeo.

done

IncomingMessageCallback<Twin>

A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto Twin que representa a identidade do dispositivo criado e um objeto de resposta específico de transporte útil para registro em log ou depuração.