Dela via

azure-iot-device package

  • Referens

Klasser

Message

Objektet Message används för telemetri (enhet till moln) och kommandon (moln-till-enhet) asynkrona meddelanden mellan enheten och IoT Hub-tjänsten. Det är transportagnostiskt, vilket innebär att det fungerar på samma sätt över AMQP, MQTT och HTTP.
Client

IoT Hub enhetsklient som används för att ansluta en enhet till en Azure IoT-hubb.

SDK-användare bör anropa någon av fabriksmetoderna, frånConnectionString eller fromSharedAccessSignature för att skapa en IoT Hub enhetsklient.
DeviceMethodRequest

Representerar de data som skickas från tjänsten till enheten när en enhetsmetod anropas från molnet. En instans av den här klassen skickas till motringningen som registrerats via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

ett DeviceMethodResponse objekt tillhandahålls till användaren med var DeviceMethodRequest och en så att användaren kan skapa och skicka ett välformaterat svar tillbaka till tjänsten för varje anrop till enhetsmetoden. En instans av den här klassen skickas som den andra parametern till motringningen som registrerats via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

Tillhandahåller en AuthenticationProvider implementering som delegerar tokengenerering till iotedged. Den här implementeringen är avsedd att användas när du använder modulklienten med Azure IoT Edge.

Den här typen ärver från SharedAccessKeyAuthenticationProvider och är funktionellt identisk med den typen förutom den tokengenereringsdel som den åsidosätter genom att implementera _sign metoden .
ModuleClient

IoT Hub enhetsklient som används för att ansluta en enhet till en Azure IoT-hubb.

SDK-användare bör anropa någon av fabriksmetoderna, frånConnectionString eller fromSharedAccessSignature för att skapa en IoT Hub enhetsklient.
SharedAccessKeyAuthenticationProvider

Tillhandahåller ett AuthenticationProvider objekt som kan skapas helt enkelt med en anslutningssträng och sedan används av enhetsklienten och transporterna för att autentisera med Azure IoT Hub-instansen.

Objektet SharedAccessKeyAuthenticationProvider tar hand om att skapa signaturtoken för delad åtkomst regelbundet och genererar newTokenAvailable händelsen för transporterna för att förnya sina autentiseringsuppgifter med Azure IoT Hub-instansen och förbli ansluten.
SharedAccessSignatureAuthenticationProvider

Tillhandahåller ett AuthenticationProvider objekt som kan skapas helt enkelt med en signatur för delad åtkomst och som sedan används av enhetsklienten och transporterna för att autentisera med Azure IoT Hub-instansen.

Objektet SharedAccessSignatureAuthenticationProvider förnyar inte signaturtoken för delad åtkomst automatiskt, så användaren måste mata in signaturtoken för icke-utgången updateSharedAccessSignature delad åtkomst till det med hjälp av metoden . För varje anrop till den här metoden SharedAccessSignatureAuthenticationProvider genererar en newTokenAvailable händelse som transporterna använder för att autentisera med Azure IoT Hub-instansen.
Twin

En enhetstvilling är ett dokument som beskriver tillståndet för en enhet som lagras av en Azure IoT-hubb och är tillgänglig även om enheten är offline. Den är byggd i tre avsnitt:

  • Taggar: nyckel/värde-par som endast är tillgängliga från tjänstsidan
  • Önskade egenskaper: uppdateras av en tjänst och tas emot av enheten
  • Rapporterade egenskaper: uppdaterades av enheten och togs emot av tjänsten.

Observera att även om det är möjligt behöver önskade och rapporterade egenskaper inte matcha och att logiken för att synkronisera dessa två samlingar, om det behövs, lämnas till SDK-användaren.

Mer information finns i Förstå enhetstvillingar.
X509AuthenticationProvider

Tillhandahåller ett AuthenticationProvider objekt som kan skapas helt enkelt med ett X509-certifikat och en nyckel och som sedan används av enhetsklienten och transporterna för att autentisera med Azure IoT Hub-instansen.

Till skillnad från objekten SharedAccessSignatureAuthenticationProviderX509AuthenticationProvider och SharedAccessKeyAuthenticationProvider genererar inte en newTokenAvailable händelse eftersom det inte finns någon token som ingår i X509-autentisering. Transporterna hämtar autentiseringsuppgifterna med hjälp av getDeviceCredentials metoden .

Gränssnitt

AmqpTransportOptions

Alternativ som är specifika för AMQP-transporten.

Detta skickas till setOptions som en egenskap med namnet http inuti ett DeviceClientOptions-objekt .

Se
DeviceClientOptions

Alternativ för klientobjektet. Skickades till funktionen setOptions .

Exempel

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

Alternativstruktur som används för att konfigurera hur ofta HTTP-mottagaren avsöker efter meddelanden. Vart och ett av dessa alternativ är ömsesidigt uteslutande, förutom det drain booleska. Endast en interval, at, cron eller manualPolling ska finnas i alternativstrukturen.

Detta konfigureras genom att anropa setOptions med detta som en egenskap med namnet receivePolicy inuti ett HttpTransportOptions-objekt som finns i ett DeviceClientOptions-objekt .

Se
HttpTransportOptions

Alternativstruktur för att skicka valfria konfigurationsparametrar till Http-transporten.

Detta skickas till setOptions som en egenskap med namnet http inuti ett DeviceClientOptions-objekt .

Se
MqttTransportOptions

Alternativ som är specifika för MQTT-transporten

Detta skickas till setOptions som en egenskap med namnet mqtt inuti ett DeviceClientOptions-objekt .
TwinProperties

Innehåller önskade och rapporterade egenskaper för tvillingen.

Typalias

BufferConvertible

Funktioner

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

Funktionsinformation

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Parametrar

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Returer

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

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

Parametrar

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

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

Parametrar

productInfo

string

Returer

Promise<string>