azure-iothub package

IoT Hub-tjänstklienten används för att kommunicera med enheter via en Azure IoT-hubb. Det låter SDK-användaren:

• skicka moln-till-enhet (kallas även kommandon) till enheter: kommandon placeras i kö på IoT Hub och levereras asynkront endast när enheten är ansluten. Endast 50 kommandon kan placeras i kö per enhet.
• anropa direkta metoder på enheter (som endast fungerar om enheten för närvarande är ansluten: det är ett synkront sätt att kommunicera med enheten)
• lyssna efter feedbackmeddelanden som skickats av enheter för tidigare kommandon.
• lyssna efter meddelanden om filuppladdning från enheter.

Användare bör skapa nya Client instanser genom att anropa någon av fabriksmetoderna, fromConnectionString eller frånSharedAccessSignatureför att skapa en IoT Hub-tjänstklient.

Skapar en representation av en enhet för användning med enhetsidentitetsregister API:er.

Den här klassen är inaktuell eftersom enhetsidentitetsregistret kan fungera direkt med JSON-objekt som innehåller en partiell beskrivning av enheten, inte nödvändigtvis det fullständiga objektet. Utöver det levererades den här klassen med ett skrivfel på symmetricKey egenskapsnamn (det var pascal-cased i stället för camel-cased). SDK:t håller den här klassen kvar för att inte bryta befintlig kod, men den tas bort i en framtida större versionsuppdatering och kunderna bör i stället använda vanliga JSON-objekt.

Innehåller metoder för att skapa, uppdatera, övervaka och avbryta långvariga jobb på en IoT Hub-instans samt köra frågor mot befintliga jobb. Med jobb-API:et i Azure IoT Hub kan du schemalägga direktmetodanrop och tvillinguppdateringar på flera enheter.

SDK-användare förväntas skapa JobClient instanser med hjälp av fabriksmetoderna fromConnectionString(string) och fromSharedAccessSignature(string).

Klassen Registry ger åtkomst till IoT Hub-enhetsidentitetstjänsten. Användare av SDK:t bör instansiera den här klassen med någon av fabriksmetoderna: fromConnectionString eller frånSharedAccessSignature.

Protokollet som används för enhetsidentitetsregisteråtgärder är HTTPS.

Transportklass som används av -tjänstklienten för att ansluta till Azure IoT Hub med hjälp av AMQP-protokollet via en säker socket (TLS). Den här klassen ska inte användas direkt och skickas i stället till någon av de Client fabriksmetoderna: frånConnectionString eller frånSharedAccessSignature.

Transportklass som används av -tjänstklienten för att ansluta till Azure IoT Hub med hjälp av AMQP-protokollet via säkra websockets. Den här klassen ska inte användas direkt och skickas i stället till någon av de Client fabriksmetoderna: frånConnectionString eller frånSharedAccessSignature.

Skapar signaturer för delad åtkomst baserat på anslutningssträngen som skickas till konstruktorn. Den här klassen används av protokollskiktet i SDK för att lägga till autentiseringshuvuden i varje begäran.

En enhetstvilling är ett dokument som beskriver tillståndet för en enhet som lagras av en Azure IoT-hubb och som är tillgänglig även om enheten är offline. Den är byggd i cirka 3 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: uppdateras av enheten och tas emot av tjänsten.

Observera att även om det är en möjlighet, 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 användaren av SDK.

Mer information finns i Understanding Device Twins.

Det rekommenderade sättet att hämta en Twin för en viss enhet är att använda metoden getTwin(string, HttpResponseCallback<Twin>).

Konfigurationsobjektet representerar konfigurationen av en enskild enhet, eller så kan det representera en distribution som kan tillämpas som en konfiguration på enheter baserat på targetCondition.

Beskriver de parametrar som är tillgängliga för användning med direkta metoder (kallas även enhetsmetoder)