azure-iot-device package

  • Referencia

Clases

Message

El Message objeto se usa para la mensajería asincrónica de telemetría (dispositivo a nube) y comandos (nube a dispositivo) entre el dispositivo y el servicio IoT Hub. Es independiente del transporte, lo que significa que funciona de la misma manera a través de AMQP, MQTT y HTTP.
Client

IoT Hub cliente de dispositivo usado para conectar un dispositivo con una instancia de Azure IoT Hub.

Los usuarios del SDK deben llamar a uno de los métodos de fábrica, fromConnectionString o fromSharedAccessSignature para crear un cliente de dispositivo IoT Hub.
DeviceMethodRequest

Representa los datos pasados desde el servicio al dispositivo cuando se llama a un método de dispositivo desde la nube. Una instancia de esta clase se pasa a la devolución de llamada registrada a través de onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

Se proporciona un DeviceMethodResponse objeto al usuario con cada DeviceMethodRequest uno de los cuales permite al usuario construir y enviar una respuesta con formato correcto al servicio para cada llamada al método de dispositivo. Una instancia de esta clase se pasa como segundo parámetro a la devolución de llamada registrada mediante onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

Proporciona una AuthenticationProvider implementación que delega la generación de tokens en iotedged. Esta implementación está pensada para usarse al usar el cliente del módulo con Azure IoT Edge.

Este tipo hereda de SharedAccessKeyAuthenticationProvider y es funcionalmente idéntico a ese tipo, excepto la parte de generación de tokens que invalida mediante la implementación del _sign método .
ModuleClient

IoT Hub cliente de dispositivo usado para conectar un dispositivo con una instancia de Azure IoT Hub.

Los usuarios del SDK deben llamar a uno de los métodos de fábrica, fromConnectionString o fromSharedAccessSignature para crear un cliente de dispositivo IoT Hub.
SharedAccessKeyAuthenticationProvider

Proporciona un AuthenticationProvider objeto que se puede crear simplemente con una cadena de conexión y, a continuación, lo usa el cliente del dispositivo y los transportes para autenticarse con la instancia de Azure IoT Hub.

El SharedAccessKeyAuthenticationProvider objeto se encarga de crear tokens de firma de acceso compartido en una cadencia regular y emite el newTokenAvailable evento para que los transportes renueven sus credenciales con la instancia de Azure IoT Hub y permanezcan conectados.
SharedAccessSignatureAuthenticationProvider

Proporciona un AuthenticationProvider objeto que se puede crear simplemente con una firma de acceso compartido y, a continuación, lo usa el cliente del dispositivo y los transportes para autenticarse con la instancia de Azure IoT Hub.

El SharedAccessSignatureAuthenticationProvider objeto no renueva automáticamente el token de firma de acceso compartido, por lo que el usuario debe alimentar los tokens de firma de acceso compartido no expirados mediante el updateSharedAccessSignature método . Para cada llamada a este método, SharedAccessSignatureAuthenticationProvider emitirá un newTokenAvailable evento que se usará para autenticarse con la instancia de Azure IoT Hub.
Twin

Un dispositivo gemelo está documentando el estado de un dispositivo almacenado por una instancia de Azure IoT Hub y está disponible incluso si el dispositivo está sin conexión. Se construye alrededor de 3 secciones:

  • Etiquetas: pares clave-valor solo accesibles desde el lado del servicio
  • Propiedades deseadas: actualizadas por un servicio y recibidas por el dispositivo
  • Propiedades notificadas: actualizadas por el dispositivo y recibidas por el servicio.

Tenga en cuenta que, aunque es una posibilidad, las propiedades deseadas y notificadas no tienen que coincidir y que la lógica para sincronizar estas dos colecciones, si es necesario, se deja al usuario del SDK.

Para más información, consulte Descripción de los dispositivos gemelos.
X509AuthenticationProvider

Proporciona un AuthenticationProvider objeto que se puede crear simplemente con un certificado y una clave X509 y, a continuación, lo usa el cliente del dispositivo y los transportes para autenticarse con la instancia de Azure IoT Hub.

A diferencia de los SharedAccessSignatureAuthenticationProvider objetos y SharedAccessKeyAuthenticationProvider , el X509AuthenticationProvider no emite un newTokenAvailable evento, ya que no hay ningún token implicado en la autenticación X509. Los transportes obtendrán las credenciales mediante el getDeviceCredentials método .

Interfaces

AmqpTransportOptions

Opciones específicas del transporte AMQP.

Esto se pasa a setOptions como una propiedad denominada http dentro de un objeto DeviceClientOptions .

Vea
DeviceClientOptions

Opciones para el objeto Client. Se pasa a la función setOptions .

Ejemplo

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);
DeviceTransport
HttpReceiverOptions

Estructura de opciones usada para configurar la frecuencia con la que el receptor HTTP sondea los mensajes. Cada una de estas opciones es mutuamente excluyente, excepto el drain booleano. Solo un interval, atcron o manualPolling debe estar presente en la estructura de opciones.

Esto se configura mediante una llamada a setOptions con esta propiedad denominada receivePolicy dentro de un objeto HttpTransportOptions que está dentro de un objeto DeviceClientOptions .

Vea
HttpTransportOptions

Estructura de opciones para pasar parámetros de configuración opcionales al transporte Http.

Esto se pasa a setOptions como una propiedad denominada http dentro de un objeto DeviceClientOptions .

Vea
MqttTransportOptions

Opciones específicas del transporte MQTT

Esto se pasa a setOptions como una propiedad denominada mqtt dentro de un objeto DeviceClientOptions .
TwinProperties

Contiene las propiedades deseadas y notificadas para el gemelo.

Alias de tipos

BufferConvertible

Funciones

getUserAgentString(NoErrorCallback<string>)
getUserAgentString()
getUserAgentString(string, NoErrorCallback<string>)
getUserAgentString(string)

Detalles de la función

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Parámetros

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Devoluciones

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)

Parámetros

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

function getUserAgentString(productInfo: string): Promise<string>

Parámetros

productInfo

string

Devoluciones

Promise<string>