Share via

Device class

  • Referencia
Paquete:
azure-iothub

Advertencia

Esta API ya está en desuso.

Crea una representación de un dispositivo para su uso con las API del Registro de identidades de dispositivo .

Esta clase está en desuso porque el registro de identidad del dispositivo puede funcionar directamente con objetos JSON que contienen una descripción parcial del dispositivo, no necesariamente el objeto completo. Además de eso, inicialmente esta clase se envió con un error tipográfico en el nombre de la symmetricKey propiedad (era pascal-cased en lugar de camel-cased). El SDK mantiene esta clase para no interrumpir el código existente, pero esto se quitará en una futura actualización de la versión principal y los clientes deben usar en su lugar objetos JSON sin formato.

Constructores

Device(any)

Crea una instancia de un nuevo objeto Device.

Propiedades

authentication

Contiene las claves simétricas usadas para autenticar este dispositivo.
capabilities

Contiene las funcionalidades de este dispositivo.
cloudToDeviceMessageCount

Número de mensajes c2d a la espera de que se entreguen al dispositivo.
connectionState

Si el dispositivo está "conectado" o "desconectado". No se recomienda usar esta propiedad para determinar si el dispositivo está realmente conectado en este momento, ya que la conexión del dispositivo puede haber agotado el tiempo de espera y es posible que el centro de IoT no lo haya detectado o si el dispositivo usa HTTPS para conectarse. Si necesita supervisar las conexiones de dispositivo, la manera recomendada es usar la característica de supervisión de operaciones del centro.
connectionStateUpdatedTime

Marca de tiempo que representa la última vez connectionState que ha cambiado.
deviceId

Identificador de dispositivo único tal y como existe en el registro de dispositivos de Azure IoT Hub.
etag

Etiqueta de entidad débil asignada a esta descripción de identidad del dispositivo
generationId

Se usa para eliminar o volver a crear dispositivos que se han eliminado o vuelto a crear con el mismo deviceId
lastActivityTime

Marca de tiempo que representa la última vez que el dispositivo se autenticó, envió un mensaje o recibió un mensaje.
status

"habilitado" (el dispositivo autorizado para conectarse, puede enviar o recibir mensajes) o "deshabilitado".
statusReason

Cadena de 128 caracteres establecida cuando el dispositivo está deshabilitado.
statusUpdatedTime

Marca de tiempo que representa la última vez status que ha cambiado.

Detalles del constructor

Device(any)

Crea una instancia de un nuevo objeto Device.

new Device(jsonData?: any)

Parámetros

jsonData

any

Representación JSON opcional del dispositivo, que se asignará a las propiedades del objeto . Si no se proporciona ningún argumento, se asignarán valores predeterminados a las propiedades del dispositivo.

Detalles de las propiedades

authentication

Contiene las claves simétricas usadas para autenticar este dispositivo.

authentication?: Authentication

Valor de propiedad

Authentication

capabilities

Contiene las funcionalidades de este dispositivo.

capabilities?: Capabilities

Valor de propiedad

Capabilities

cloudToDeviceMessageCount

Número de mensajes c2d a la espera de que se entreguen al dispositivo.

cloudToDeviceMessageCount?: string

Valor de propiedad

string

connectionState

Si el dispositivo está "conectado" o "desconectado". No se recomienda usar esta propiedad para determinar si el dispositivo está realmente conectado en este momento, ya que la conexión del dispositivo puede haber agotado el tiempo de espera y es posible que el centro de IoT no lo haya detectado o si el dispositivo usa HTTPS para conectarse. Si necesita supervisar las conexiones de dispositivo, la manera recomendada es usar la característica de supervisión de operaciones del centro.

connectionState?: ConnectionState

Valor de propiedad

ConnectionState

connectionStateUpdatedTime

Marca de tiempo que representa la última vez connectionState que ha cambiado.

connectionStateUpdatedTime?: string

Valor de propiedad

string

deviceId

Identificador de dispositivo único tal y como existe en el registro de dispositivos de Azure IoT Hub.

deviceId: string

Valor de propiedad

string

etag

Etiqueta de entidad débil asignada a esta descripción de identidad del dispositivo

etag?: string

Valor de propiedad

string

generationId

Se usa para eliminar o volver a crear dispositivos que se han eliminado o vuelto a crear con el mismo deviceId

generationId?: string

Valor de propiedad

string

lastActivityTime

Marca de tiempo que representa la última vez que el dispositivo se autenticó, envió un mensaje o recibió un mensaje.

lastActivityTime?: string

Valor de propiedad

string

status

"habilitado" (el dispositivo autorizado para conectarse, puede enviar o recibir mensajes) o "deshabilitado".

status?: DeviceStatus

Valor de propiedad

DeviceStatus

statusReason

Cadena de 128 caracteres establecida cuando el dispositivo está deshabilitado.

statusReason?: string

Valor de propiedad

string

statusUpdatedTime

Marca de tiempo que representa la última vez status que ha cambiado.

statusUpdatedTime?: string

Valor de propiedad

string