Delen via


azure-iothub package

Klassen

Client

De IoT Hub-serviceclient wordt gebruikt om te communiceren met apparaten via een Azure IoT-hub. Hiermee kan de SDK-gebruiker:

  • cloud-naar-apparaat verzenden (ook wel opdrachten genoemd) naar apparaten: opdrachten worden in de wachtrij geplaatst op IoT Hub en worden alleen asynchroon geleverd wanneer het apparaat is verbonden. Er kunnen per apparaat slechts 50 opdrachten in de wachtrij worden geplaatst.
  • directe methoden aanroepen op apparaten (die alleen werken als het apparaat momenteel is verbonden: het is een synchrone manier om met het apparaat te communiceren)
  • luisteren naar feedbackberichten die zijn verzonden door apparaten voor eerdere opdrachten.
  • luisteren naar meldingen voor het uploaden van bestanden vanaf apparaten.

Gebruikers moeten nieuwe Client-exemplaren maken door een van de factorymethoden aan te roepen, fromConnectionString of vanSharedAccessSignatureom een IoT Hub-serviceclient te maken.

Device

Hiermee maakt u een weergave van een apparaat voor gebruik met het apparaatidentiteitsregister API's.

Deze klasse is afgeschaft omdat het register apparaatidentiteits register rechtstreeks kan werken met JSON-objecten die een gedeeltelijke beschrijving van het apparaat bevatten, niet noodzakelijkerwijs het volledige object. Bovendien werd deze klasse geleverd met een typefout op de naam van de eigenschap symmetricKey (het was pascal-cased in plaats van kameel-cased). De SDK houdt deze klasse in de buurt om bestaande code niet te verbreken, maar dit wordt verwijderd in een toekomstige primaire versie-update en klanten moeten in plaats daarvan gewone JSON-objecten gebruiken.

JobClient

Biedt methoden voor het maken, bijwerken, bewaken en annuleren van langlopende taken op een IoT Hub-exemplaar, evenals het uitvoeren van query's op bestaande taken. Met de Taken-API in Azure IoT Hub kunt u directe methode-aanroepen en dubbele updates plannen op meerdere apparaten.

SDK-gebruikers maken naar verwachting JobClient exemplaren met behulp van de factory-methoden fromConnectionString(string) en fromSharedAccessSignature(string).

Registry

De registerklasse biedt toegang tot de IoT Hub-apparaatidentiteitsservice. Gebruikers van de SDK moeten deze klasse instantiëren met een van de factorymethoden: fromConnectionString of fromSharedAccessSignature.

Het protocol dat wordt gebruikt voor registerbewerkingen voor apparaatidentiteiten is HTTPS.

Amqp

Transportklasse die wordt gebruikt door de -serviceclient om verbinding te maken met de Azure IoT-hub met behulp van het AMQP-protocol via een beveiligde (TLS)-socket. Deze klasse mag niet rechtstreeks worden gebruikt en in plaats daarvan worden doorgegeven aan een van de Client factory-methoden: fromConnectionString of fromSharedAccessSignature.

AmqpWs

Transportklasse die wordt gebruikt door de -serviceclient om verbinding te maken met de Azure IoT-hub met behulp van het AMQP-protocol via beveiligde websockets. Deze klasse mag niet rechtstreeks worden gebruikt en in plaats daarvan worden doorgegeven aan een van de Client factory-methoden: fromConnectionString of fromSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Hiermee maakt u handtekeningen voor gedeelde toegang op basis van de verbindingsreeks die aan de constructor is doorgegeven. Deze klasse wordt gebruikt door de protocollaag van de SDK om verificatieheaders toe te voegen aan elke aanvraag.

Twin

Een apparaatdubbel is een document met een beschrijving van de status van een apparaat dat is opgeslagen door een Azure IoT-hub en beschikbaar is, zelfs als het apparaat offline is. Het is gebouwd rond 3 secties:

  • Tags: sleutel-waardeparen die alleen toegankelijk zijn vanaf de servicezijde
  • Gewenste eigenschappen: bijgewerkt door een service en ontvangen door het apparaat
  • Gerapporteerde eigenschappen: bijgewerkt door het apparaat en ontvangen door de service.

Houd er rekening mee dat hoewel het een mogelijkheid is dat gewenste en gerapporteerde eigenschappen niet overeenkomen en dat de logica voor het synchroniseren van deze twee verzamelingen, indien nodig, overblijft aan de gebruiker van de SDK.

Zie Understanding Device Twinsvoor meer informatie.

De aanbevolen manier om een Twin voor een specifiek apparaat te verkrijgen, is door de methode getTwin(string, HttpResponseCallback<Twin>) te gebruiken.

Interfaces

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

Het configuratieobject vertegenwoordigt de configuratie van één apparaat of het kan een implementatie vertegenwoordigen die kan worden toegepast als een configuratie op apparaten op basis van de targetCondition.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

Beschrijft de parameters die beschikbaar zijn voor gebruik met directe methoden (ook wel apparaatmethoden genoemd)

Module

Type-aliassen

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback