Compartilhar via

Device class

  • Referência
Pacote:
azure-iothub

Aviso

Essa API foi preterida.

Cria uma representação de um dispositivo para uso com as APIs do registro de identidade do dispositivo .

Essa classe foi preterida porque o registro de identidade do dispositivo pode funcionar diretamente com objetos JSON que contêm uma descrição parcial do dispositivo, não necessariamente o objeto completo. Além disso, inicialmente, essa classe foi enviada com um erro de digitação no nome da symmetricKey propriedade (foi maiúsculas e minúsculas em vez de camel-cased). O SDK está mantendo essa classe por perto para não interromper o código existente, mas isso será removido em uma atualização de versão principal futura e os clientes devem usar objetos JSON simples.

Construtores

Device(any)

Crie uma instância de um novo objeto Device.

Propriedades

authentication

Contém as chaves simétricas usadas para autenticar este dispositivo.
capabilities

Contém os recursos deste dispositivo.
cloudToDeviceMessageCount

Número de mensagens c2d aguardando por entregues ao dispositivo.
connectionState

Se o dispositivo está 'conectado' ou 'desconectado'. No entanto, não é recomendável usar essa propriedade para determinar se o dispositivo está realmente conectado no momento, pois a conexão do dispositivo pode ter esgotado e o Hub IoT pode não tê-lo detectado ou se o dispositivo está usando HTTPS para se conectar. Se você tiver a necessidade de monitorar conexões de dispositivo, a maneira recotada é usar o recurso de monitoramento de operações do hub.
connectionStateUpdatedTime

Carimbo de data/hora que representa a última alteração connectionState .
deviceId

Identificador de dispositivo exclusivo como ele existe no registro de dispositivos do Hub IoT do Azure.
etag

Marca de entidade fraca atribuída a esta descrição de identidade do dispositivo
generationId

Usado para desambiguar dispositivos que foram excluídos/recriados com o mesmo deviceId
lastActivityTime

Carimbo de data/hora que representa a última vez que o dispositivo foi autenticado, enviou uma mensagem ou recebeu uma mensagem.
status

'enabled' (dispositivo autorizado a se conectar, pode enviar/receber mensagens) ou 'desabilitado'.
statusReason

Cadeia de caracteres de 128 caracteres definida quando o dispositivo está desabilitado.
statusUpdatedTime

Carimbo de data/hora que representa a última alteração status .

Detalhes do construtor

Device(any)

Crie uma instância de um novo objeto Device.

new Device(jsonData?: any)

Parâmetros

jsonData

any

Uma representação JSON opcional do dispositivo, que será mapeada para propriedades no objeto . Se nenhum argumento for fornecido, as propriedades do dispositivo receberão valores padrão.

Detalhes da propriedade

authentication

Contém as chaves simétricas usadas para autenticar este dispositivo.

authentication?: Authentication

Valor da propriedade

Authentication

capabilities

Contém os recursos deste dispositivo.

capabilities?: Capabilities

Valor da propriedade

Capabilities

cloudToDeviceMessageCount

Número de mensagens c2d aguardando por entregues ao dispositivo.

cloudToDeviceMessageCount?: string

Valor da propriedade

string

connectionState

Se o dispositivo está 'conectado' ou 'desconectado'. No entanto, não é recomendável usar essa propriedade para determinar se o dispositivo está realmente conectado no momento, pois a conexão do dispositivo pode ter esgotado e o Hub IoT pode não tê-lo detectado ou se o dispositivo está usando HTTPS para se conectar. Se você tiver a necessidade de monitorar conexões de dispositivo, a maneira recotada é usar o recurso de monitoramento de operações do hub.

connectionState?: ConnectionState

Valor da propriedade

ConnectionState

connectionStateUpdatedTime

Carimbo de data/hora que representa a última alteração connectionState .

connectionStateUpdatedTime?: string

Valor da propriedade

string

deviceId

Identificador de dispositivo exclusivo como ele existe no registro de dispositivos do Hub IoT do Azure.

deviceId: string

Valor da propriedade

string

etag

Marca de entidade fraca atribuída a esta descrição de identidade do dispositivo

etag?: string

Valor da propriedade

string

generationId

Usado para desambiguar dispositivos que foram excluídos/recriados com o mesmo deviceId

generationId?: string

Valor da propriedade

string

lastActivityTime

Carimbo de data/hora que representa a última vez que o dispositivo foi autenticado, enviou uma mensagem ou recebeu uma mensagem.

lastActivityTime?: string

Valor da propriedade

string

status

'enabled' (dispositivo autorizado a se conectar, pode enviar/receber mensagens) ou 'desabilitado'.

status?: DeviceStatus

Valor da propriedade

DeviceStatus

statusReason

Cadeia de caracteres de 128 caracteres definida quando o dispositivo está desabilitado.

statusReason?: string

Valor da propriedade

string

statusUpdatedTime

Carimbo de data/hora que representa a última alteração status .

statusUpdatedTime?: string

Valor da propriedade

string