Condividi tramite

azure-iot-device package

  • Riferimento

Classi

Message

L'oggetto Message viene usato per la telemetria (da dispositivo a cloud) e per i comandi (da cloud a dispositivo) per la messaggistica asincrona tra il dispositivo e il servizio hub IoT. È indipendente dal trasporto, ovvero funziona allo stesso modo su AMQP, MQTT e HTTP.
Client

Client del dispositivo dell'hub IoT usato per connettere un dispositivo con un hub IoT di Azure.

Gli utenti dell'SDK devono chiamare uno dei metodi factory, daConnectionString o daSharedAccessSignature per creare un client del dispositivo dell'hub IoT.
DeviceMethodRequest

Rappresenta i dati passati dal servizio al dispositivo quando viene chiamato un metodo del dispositivo dal cloud. Un'istanza di questa classe viene passata al callback registrato tramite onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

All'utente viene fornito un oggetto DeviceMethodResponse con ogni DeviceMethodRequest che consente all'utente di costruire e inviare una risposta ben formattata al servizio per ogni chiamata al metodo del dispositivo. Un'istanza di questa classe viene passata come secondo parametro al callback registrato tramite onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

Fornisce un'implementazione AuthenticationProvider che delega la generazione di token a iotedged. Questa implementazione deve essere usata quando si usa il client del modulo con Azure IoT Edge.

Questo tipo eredita da SharedAccessKeyAuthenticationProvider ed è funzionalmente identico a quel tipo, ad eccezione della parte di generazione del token di cui esegue l'override implementando il metodo _sign.
ModuleClient

Client del dispositivo dell'hub IoT usato per connettere un dispositivo con un hub IoT di Azure.

Gli utenti dell'SDK devono chiamare uno dei metodi factory, daConnectionString o daSharedAccessSignature per creare un client del dispositivo dell'hub IoT.
SharedAccessKeyAuthenticationProvider

Fornisce un oggetto AuthenticationProvider che può essere creato semplicemente con una stringa di connessione e viene quindi usato dal client del dispositivo e dai trasporti per l'autenticazione con l'istanza dell'hub IoT di Azure.

L'oggetto SharedAccessKeyAuthenticationProvider si occupa della creazione di token di firma di accesso condiviso a cadenza regolare e genera l'evento newTokenAvailable per i trasporti per rinnovare le proprie credenziali con l'istanza dell'hub IoT di Azure e rimanere connessi.
SharedAccessSignatureAuthenticationProvider

Fornisce un oggetto AuthenticationProvider che può essere creato semplicemente con una firma di accesso condiviso e viene quindi usato dal client del dispositivo e dai trasporti per l'autenticazione con l'istanza dell'hub IoT di Azure.

L'oggetto SharedAccessSignatureAuthenticationProvider non rinnova automaticamente il token di firma di accesso condiviso, pertanto l'utente deve inserire i token di firma di accesso condiviso non scaduti usando il metodo updateSharedAccessSignature. Per ogni chiamata a questo metodo, il SharedAccessSignatureAuthenticationProvider genererà un evento newTokenAvailable che i trasporti useranno per l'autenticazione con l'istanza dell'hub IoT di Azure.
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: aggiornate da un servizio e ricevute 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 Understanding Device Twins.
X509AuthenticationProvider

Fornisce un oggetto AuthenticationProvider che può essere creato semplicemente con un certificato e una chiave X509 e viene quindi usato dal client e dai trasporti del dispositivo per l'autenticazione con l'istanza dell'hub IoT di Azure.

A differenza degli oggetti SharedAccessSignatureAuthenticationProvider e SharedAccessKeyAuthenticationProvider, il X509AuthenticationProvider non genera un evento newTokenAvailable poiché non sono presenti token coinvolti nell'autenticazione X509. I trasporti otterranno le credenziali usando il metodo getDeviceCredentials.

Interfacce

AmqpTransportOptions

Opzioni specifiche del trasporto AMQP.

Viene passato a setOptions come proprietà denominata http all'interno di un oggetto DeviceClientOptions.

Vedere
DeviceClientOptions

Opzioni per l'oggetto Client. Passato alla funzione setOptions.

esempio di

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

Struttura delle opzioni usata per configurare la frequenza con cui il ricevitore HTTP esegue il polling dei messaggi. Ognuna di queste opzioni si escludono a vicenda, ad eccezione del valore booleano drain. Nella struttura delle opzioni deve essere presente una sola interval, at, cron o manualPolling.

Questa operazione viene configurata chiamando setOptions con questa proprietà denominata receivePolicy all'interno di un oggetto HttpTransportOptions che si trova all'interno di un oggetto DeviceClientOptions.

Vedere
HttpTransportOptions

Struttura delle opzioni per il passaggio di parametri di configurazione facoltativi nel trasporto HTTP.

Viene passato a setOptions come proprietà denominata http all'interno di un oggetto DeviceClientOptions.

Vedere
MqttTransportOptions

Opzioni specifiche del trasporto MQTT

Viene passato a setOptions come proprietà denominata mqtt all'interno di un oggetto DeviceClientOptions.
TwinProperties

Contiene le proprietà desiderate e segnalate per il dispositivo gemello.

Alias tipo

BufferConvertible

Funzioni

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

Dettagli funzione

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Parametri

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Restituisce

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

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

Parametri

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

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

Parametri

productInfo

string

Restituisce

Promise<string>