azure-iothub package

Classi

Client

Il client del servizio hub IoT viene usato per comunicare con i dispositivi tramite un hub IoT di Azure. Consente all'utente dell'SDK di:

  • inviare il cloud a dispositivo (noto anche come comandi) ai dispositivi: i comandi vengono accodati in hub IoT e recapitati in modo asincrono solo quando il dispositivo è connesso. Solo 50 comandi possono essere accodati per dispositivo.
  • richiamare metodi diretti nei dispositivi (che funzioneranno solo se il dispositivo è attualmente connesso: è un modo sincrono di comunicare con il dispositivo)
  • ascoltare i messaggi di feedback inviati dai dispositivi per i comandi precedenti.
  • ascoltare le notifiche di caricamento dei file dai dispositivi.

Gli utenti devono creare nuove Client istanze chiamando uno dei metodi factory, daConnectionString o daSharedAccessSignature, per creare un client del servizio hub IoT.

Device

Crea una rappresentazione di un dispositivo da usare con le API del Registro identità del dispositivo .

Questa classe è deprecata perché il Registro identità del dispositivo può funzionare direttamente con oggetti JSON contenenti una descrizione parziale del dispositivo, non necessariamente l'oggetto completo. In cima a quella classe inizialmente questa classe è stata inviata con un errore di digitazione sul nome della symmetricKey proprietà (era pascal-cased anziché camel-cased). L'SDK mantiene questa classe in giro per non interrompere il codice esistente, ma questa operazione verrà rimossa in un futuro aggiornamento della versione principale e i clienti devono invece usare oggetti JSON semplici.

JobClient

Fornisce metodi per creare, aggiornare, monitorare e annullare processi a esecuzione prolungata in un'istanza di hub IoT, nonché eseguire query sui processi esistenti. L'API Processi in hub IoT di Azure consente di pianificare chiamate di metodo diretto e aggiornamenti gemelli in più dispositivi.

Gli utenti dell'SDK devono creare JobClient istanze usando i metodi fromConnectionString(string) di factory e fromSharedAccessSignature(string).

Registry

La classe Registro di sistema fornisce l'accesso al servizio di identità del dispositivo hub IoT. Gli utenti dell'SDK devono creare un'istanza di questa classe con uno dei metodi factory: fromConnectionString o fromSharedAccessSignature.

Il protocollo usato per le operazioni del Registro di sistema delle identità del dispositivo è HTTPS.

Amqp

Classe di trasporto usata dal client del servizio per connettersi all'hub IoT di Azure usando il protocollo AMQP tramite un socket TLS sicuro. Questa classe non deve essere usata direttamente e deve essere passata a uno dei Client metodi factory: fromConnectionString o fromSharedAccessSignature.

AmqpWs

Classe di trasporto usata dal client del servizio per connettersi all'hub IoT di Azure usando il protocollo AMQP tramite websocket sicuri. Questa classe non deve essere usata direttamente e deve essere passata a uno dei Client metodi factory: fromConnectionString o fromSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Crea firme di accesso condiviso in base alla stringa di connessione passata al costruttore. Questa classe viene usata dal livello del protocollo dell'SDK per aggiungere intestazioni di autenticazione a ogni richiesta.

Twin

Un dispositivo gemello è un documento che descrive lo stato di un dispositivo archiviato da un hub IoT di Azure ed è disponibile anche se il dispositivo è offline. Si basa su 3 sezioni:

  • Tag: coppie chiave/valore accessibili solo dal lato servizio
  • Proprietà desiderate: aggiornata da un servizio e ricevuta dal dispositivo
  • Proprietà segnalate: aggiornate dal dispositivo e ricevute dal servizio.

Si noti che, anche se è una possibilità, le proprietà desiderate e segnalate non devono corrispondere e che la logica per sincronizzare queste due raccolte, se necessario, viene lasciata all'utente dell'SDK.

Per altre informazioni, vedere Informazioni sui dispositivi gemelli.

Il modo consigliato per ottenere un Twin oggetto per un dispositivo specifico consiste nell'usare il getTwin(string, HttpResponseCallback<Twin>) metodo .

Interfacce

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

L'oggetto Configuration rappresenta la configurazione di un singolo dispositivo oppure può rappresentare una distribuzione che può essere applicata come configurazione ai dispositivi in base alla destinazioneCondition.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

Descrive i parametri disponibili per l'uso con metodi diretti (chiamati anche metodi del dispositivo)

Module

Alias tipo

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback