Compartir a través de


azure-iothub package

Clases

Client

El cliente del servicio IoT Hub se usa para comunicarse con dispositivos a través de una instancia de Azure IoT Hub. Permite al usuario del SDK:

  • enviar la nube al dispositivo (también conocido como comandos) a los dispositivos: los comandos se ponen en cola en IoT Hub y se entregan de forma asincrónica solo cuando el dispositivo está conectado. Solo se pueden poner en cola 50 comandos por dispositivo.
  • invocar métodos directos en dispositivos (que solo funcionarán si el dispositivo está conectado actualmente: es una forma sincrónica de comunicarse con el dispositivo).
  • escuche los mensajes de comentarios enviados por los dispositivos para los comandos anteriores.
  • escuche las notificaciones de carga de archivos de los dispositivos.

Los usuarios deben crear nuevas instancias de Client llamando a uno de los métodos de fábrica, fromConnectionString o fromSharedAccessSignature, para crear un cliente de servicio de IoT Hub.

Device

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

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

JobClient

Proporciona métodos para crear, actualizar, supervisar y cancelar trabajos de ejecución prolongada en una instancia de IoT Hub, así como consultar trabajos existentes. La API de trabajos de Azure IoT Hub permite programar llamadas directas a métodos y actualizaciones gemelas en varios dispositivos.

Se espera que los usuarios del SDK creen instancias de JobClient mediante los métodos de fábrica fromConnectionString(string) y fromSharedAccessSignature(string).

Registry

La clase Registry proporciona acceso al servicio de identidad de dispositivo de IoT Hub. Los usuarios del SDK deben crear instancias de esta clase con uno de los métodos de fábrica: fromConnectionString o fromSharedAccessSignature.

El protocolo que se usa para las operaciones del Registro de identidades de dispositivo es HTTPS.

Amqp

Clase de transporte usada por el cliente de servicio para conectarse al centro de IoT de Azure mediante el protocolo AMQP a través de un socket seguro (TLS). Esta clase no se debe usar directamente y, en su lugar, se debe pasar a uno de los métodos de fábrica de Client: fromConnectionString o fromSharedAccessSignature.

AmqpWs

Clase de transporte que usa el cliente de servicio para conectarse al centro de IoT de Azure mediante el protocolo AMQP a través de websockets seguros. Esta clase no se debe usar directamente y, en su lugar, se debe pasar a uno de los métodos de fábrica de Client: fromConnectionString o fromSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Crea firmas de acceso compartido basadas en la cadena de conexión que se pasa al constructor. Esta clase la usa la capa de protocolo del SDK para agregar encabezados de autenticación a cada solicitud.

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 obtener más información, consulte Understanding Device Twins.

La manera recomendada de obtener un Twin para un dispositivo específico es usar el método getTwin(string, HttpResponseCallback<Twin>).

Interfaces

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration

El objeto Configuration representa la configuración de un único dispositivo o puede representar una implementación que se puede aplicar como una configuración a los dispositivos basados en targetCondition.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

Describe los parámetros que están disponibles para su uso con métodos directos (también denominados métodos de dispositivo).

Module

Alias de tipos

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback