Megosztás a következőn keresztül:


azure-iothub package

Osztályok

Client

Az IoT Hub szolgáltatásügyfél használatával kommunikálhat az eszközökkel egy Azure IoT Hubon keresztül. Lehetővé teszi, hogy az SDK-felhasználó:

  • felhőből eszközre (más néven parancsok) küldése az eszközökre: a parancsok várólistára kerülnek az IoT Hubon, és aszinkron módon csak akkor lesznek kézbesítve, ha az eszköz csatlakoztatva van. Eszközönként csak 50 parancs állítható várólistára.
  • közvetlen metódusok meghívása az eszközökön (amelyek csak akkor működnek, ha az eszköz jelenleg csatlakoztatva van: szinkron módon kommunikál az eszközzel)
  • figyelheti az eszközök által a korábbi parancsokhoz küldött visszajelzési üzeneteket.
  • figyelheti az eszközökről érkező fájlfeltöltési értesítéseket.

A felhasználóknak új Client példányokat kell létrehozniuk az egyik gyári metódus meghívásával, aConnectionString vagy ASharedAccessSignaturehasználatával, hogy létrehozzák az IoT Hub szolgáltatásügyfélt.

Device

Egy eszköz ábrázolása az eszközidentitás-beállításjegyzék API-kkal való használatra.

Ez az osztály elavult, mert a eszközidentitás-beállításjegyzék közvetlenül az eszköz részleges leírását tartalmazó JSON-objektumokkal dolgozhat, nem feltétlenül a teljes objektummal. Ezen felül ezt az osztályt eredetileg egy elírással szállították a symmetricKey tulajdonságnévre (a teve-eset helyett pascal-case volt). Az SDK megtartja ezt az osztályt annak érdekében, hogy ne törje meg a meglévő kódot, de ez egy későbbi főverziófrissítésben törlődik, és az ügyfeleknek ehelyett egyszerű JSON-objektumokat kell használniuk.

JobClient

Metódusokat biztosít egy IoT Hub-példányon futó, hosszú ideig futó feladatok létrehozására, frissítésére, monitorozására és megszakítására, valamint a meglévő feladatok lekérdezésére. Az Azure IoT Hub Jobs API-ja lehetővé teszi közvetlen metódushívások és ikerfrissítések ütemezését több eszközön.

Az SDK-felhasználók várhatóan JobClient példányokat hoznak létre a gyári metódusokkal fromConnectionString(string) és fromSharedAccessSignature(string).

Registry

A Beállításjegyzék-osztály hozzáférést biztosít az IoT Hub eszközidentitási szolgáltatásához. Az SDK felhasználóinak az egyik gyári módszerrel kell példányosítaniuk ezt az osztályt: aConnectionString vagy a SharedAccessSignature.

Az eszközidentitás-beállításjegyzék műveleteihez használt protokoll a HTTPS.

Amqp

A szolgáltatásügyfél által használt átviteli osztály csatlakozni az Azure IoT Hubhoz az AMQP protokoll használatával egy biztonságos (TLS) szoftvercsatornán keresztül. Ezt az osztályt nem szabad közvetlenül használni, hanem át kell adni az egyik Client gyári metódusnak: aConnectionString vagy fromSharedAccessSignature.

AmqpWs

A szolgáltatásügyfél által használt átviteli osztály csatlakozni az Azure IoT Hubhoz az AMQP protokoll használatával biztonságos websocketeken keresztül. Ezt az osztályt nem szabad közvetlenül használni, hanem át kell adni az egyik Client gyári metódusnak: aConnectionString vagy fromSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Közös hozzáférésű jogosultságkódokat hoz létre a konstruktornak átadott kapcsolati sztring alapján. Ezt az osztályt az SDK protokollrétege használja a hitelesítési fejlécek minden kéréshez való hozzáadásához.

Twin

Az ikereszköz egy Azure IoT Hub által tárolt eszköz állapotát leíró dokumentum, amely akkor is elérhető, ha az eszköz offline állapotban van. 3 részből áll:

  • Címkék: kulcs/érték párok csak a szolgáltatásoldalról érhetők el
  • Kívánt tulajdonságok: egy szolgáltatás által frissített és az eszköz által fogadott tulajdonságok
  • Jelentett tulajdonságok: az eszköz frissítette és a szolgáltatás fogadta.

Vegye figyelembe, hogy bár lehetséges, a kívánt és a jelentett tulajdonságoknak nem kell egyezniük, és hogy a két gyűjtemény szinkronizálásának logikája, ha szükséges, az SDK felhasználójára marad.

További információ: Device Twinsismertetése.

A Twin egy adott eszközhöz való beszerzésének ajánlott módja a getTwin(string, HttpResponseCallback<Twin>) módszer használata.

Interfészek

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

A Konfiguráció objektum egyetlen eszköz konfigurációját jelöli, vagy egy olyan üzembe helyezést, amely konfigurációként alkalmazható az eszközökre a targetCondition alapján.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

A közvetlen metódusokkal (más néven eszközmetódusokkal) használható paraméterek ismertetése

Module

Típusaliasok

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback