azure-iothub package

Osztályok

Client

A 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 IoT Hub várólistára kerülnek, és aszinkron módon csak akkor lesznek kézbesítve, ha az eszköz csatlakoztatva van. Eszközönként csak 50 parancs lehet várólistára helyezve.
  • közvetlen metódusok meghívása az eszközökön (ez csak akkor működik, 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 egy IoT Hub szolgáltatásügyfél létrehozásához a factory metódusok egyikének meghívásával aConnectionStringből vagy a SharedAccessSignature-ból.

Device

Létrehoz egy eszköz reprezentációját az eszközidentitás-beállításjegyzék API-ival való használatra.

Ez az osztály elavult, mert az eszközidentitás-beállításjegyzék közvetlenül működhet az eszköz részleges leírását tartalmazó JSON-objektumokkal, 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éven (ez pascal-cased volt a camel-cased helyett). Az SDK megtartja ezt az osztályt, hogy ne törje meg a meglévő kódot, de ezt egy későbbi főverzió-frissítés eltávolítja, és az ügyfeleknek ehelyett egyszerű JSON-objektumokat kell használniuk.

JobClient

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

Az SDK-felhasználóktól elvárjuk, hogy példányokat hozzanak létre JobClient a gyári metódusok fromConnectionString(string) és fromSharedAccessSignature(string)a használatával.

Registry

A Beállításjegyzék osztály hozzáférést biztosít az IoT Hub eszközidentitás-szolgáltatáshoz. Az SDK felhasználóinak a következő gyári módszerekkel kell példányosítaniuk ezt az osztályt: fromConnectionString vagy fromSharedAccessSignature.

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 biztonságos (TLS) szoftvercsatornán keresztül csatlakozik az Azure IoT Hubhoz az AMQP protokoll használatával. Ezt az osztályt nem szabad közvetlenül használni, hanem át kell adni az Client egyik gyári módszernek: fromConnectionString vagy fromSharedAccessSignature.

AmqpWs

A szolgáltatásügyfél által használt átviteli osztály az AMQP protokollal csatlakozik az Azure IoT Hubhoz biztonságos websocketeken keresztül. Ezt az osztályt nem szabad közvetlenül használni, hanem át kell adni az Client egyik gyári módszernek: fromConnectionString 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 hitelesítési fejlécek hozzáadásához az egyes kérésekhez.

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 frissíti, és az eszköz fogadja
  • 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 szükség esetén az SDK felhasználójára marad.

További információ: Az ikereszközök ismertetése.

Egy adott eszközhöz Twin az ajánlott módszer a getTwin(string, HttpResponseCallback<Twin>) metódus használata.

Interfészek

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

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

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