Share via

azure-iot-device package

  • Referentie

Klassen

Message

Het Message object wordt gebruikt voor telemetrie (apparaat-naar-cloud) en opdrachten (cloud-naar-apparaat) asynchrone berichten tussen het apparaat en de IoT Hub-service. Het is transportagnostisch, wat betekent dat het op dezelfde manier werkt via AMQP, MQTT en HTTP.
Client

IoT Hub apparaatclient die wordt gebruikt om een apparaat te verbinden met een Azure IoT-hub.

Gebruikers van de SDK moeten een van de factorymethoden aanroepen, fromConnectionString of fromSharedAccessSignature om een IoT Hub-apparaatclient te maken.
DeviceMethodRequest

Vertegenwoordigt de gegevens die worden doorgegeven van de service aan het apparaat wanneer een apparaatmethode wordt aangeroepen vanuit de cloud. Een exemplaar van deze klasse wordt doorgegeven aan de callback die is geregistreerd via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

een DeviceMethodResponse -object wordt aan de gebruiker verstrekt met elke DeviceMethodRequest mogelijkheid om een goed opgemaakt antwoord te maken en terug te sturen naar de service voor elke apparaatmethodeaanroep. Een exemplaar van deze klasse wordt als de tweede parameter doorgegeven aan de callback die is geregistreerd via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

Biedt een AuthenticationProvider implementatie waarmee het genereren van tokens wordt gedelegeerd aan iotedged. Deze implementatie is bedoeld om te worden gebruikt bij het gebruik van de moduleclient met Azure IoT Edge.

Dit type neemt het over van SharedAccessKeyAuthenticationProvider en is functioneel identiek aan dat type, met uitzondering van het onderdeel voor het genereren van tokens dat wordt overschreven door de _sign methode te implementeren.
ModuleClient

IoT Hub apparaatclient die wordt gebruikt om een apparaat te verbinden met een Azure IoT-hub.

Gebruikers van de SDK moeten een van de factorymethoden aanroepen, fromConnectionString of fromSharedAccessSignature om een IoT Hub-apparaatclient te maken.
SharedAccessKeyAuthenticationProvider

Biedt een AuthenticationProvider object dat eenvoudig kan worden gemaakt met een connection string en vervolgens wordt gebruikt door de apparaatclient en transporteert voor verificatie met het Azure IoT Hub-exemplaar.

Het SharedAccessKeyAuthenticationProvider object zorgt ervoor dat shared access signature-tokens regelmatig worden gemaakt en de newTokenAvailable gebeurtenis voor de transporten wordt verzonden om hun referenties te vernieuwen met het Azure IoT Hub-exemplaar en verbonden te blijven.
SharedAccessSignatureAuthenticationProvider

Biedt een AuthenticationProvider object dat eenvoudig kan worden gemaakt met een shared access signature en vervolgens wordt gebruikt door de apparaatclient en transporteert voor verificatie met het Azure IoT Hub-exemplaar.

Het SharedAccessSignatureAuthenticationProvider object vernieuwt het shared access signature-token niet automatisch, dus de gebruiker moet niet-verlopen Shared Access Signature-tokens invoeren met behulp van de updateSharedAccessSignature methode . Voor elke aanroep van deze methode verzendt de SharedAccessSignatureAuthenticationProvider een newTokenAvailable gebeurtenis die transporten gebruiken om te verifiëren bij het Azure IoT Hub-exemplaar.
Twin

Een apparaatdubbel is een document waarin de status wordt beschreven 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.

Hoewel dit een mogelijkheid is, hoeven de gewenste en gerapporteerde eigenschappen niet overeen te komen en dat de logica voor het synchroniseren van deze twee verzamelingen, indien nodig, wordt overgelaten aan de gebruiker van de SDK.

Zie Understanding Device Twins (Apparaatdubbels begrijpen) voor meer informatie.
X509AuthenticationProvider

Biedt een AuthenticationProvider object dat eenvoudig kan worden gemaakt met een X509-certificaat en -sleutel en dat vervolgens wordt gebruikt door de apparaatclient en transporteert voor verificatie met het Azure IoT Hub-exemplaar.

In tegenstelling tot de SharedAccessSignatureAuthenticationProvider objecten en SharedAccessKeyAuthenticationProvider verzendt newTokenAvailable de X509AuthenticationProvider geen gebeurtenis omdat er geen token is betrokken bij X509-verificatie. De transporten krijgen de referenties op met behulp van de getDeviceCredentials methode .

Interfaces

AmqpTransportOptions

Opties die specifiek zijn voor het AMQP-transport.

Dit wordt doorgegeven aan setOptions als een eigenschap met de naam http in een DeviceClientOptions-object .

Raadpleeg
DeviceClientOptions

Opties voor het clientobject. Doorgegeven aan de functie setOptions .

Voorbeeld

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

De structuur van opties die wordt gebruikt om te configureren hoe vaak de HTTP-ontvanger berichten peilt. Elk van deze opties sluiten elkaar uit, met uitzondering van de drain booleaanse waarde. Er mag slechts één interval, atof cronmanualPolling aanwezig zijn in de structuur van de optie.

Dit wordt geconfigureerd door setOptions aan te roepen met deze eigenschap met de naam receivePolicy in een HttpTransportOptions-object dat zich in een DeviceClientOptions-object bevindt.

Raadpleeg
HttpTransportOptions

Optiesstructuur voor het doorgeven van optionele configuratieparameters aan http-transport.

Dit wordt doorgegeven aan setOptions als een eigenschap met de naam http in een DeviceClientOptions-object .

Raadpleeg
MqttTransportOptions

Opties die specifiek zijn voor het MQTT-transport

Dit wordt doorgegeven aan setOptions als een eigenschap met de naam mqtt in een DeviceClientOptions-object .
TwinProperties

Bevat de gewenste en gerapporteerde eigenschappen voor de dubbel.

Type-aliassen

BufferConvertible

Functies

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

Functiedetails

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Parameters

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Retouren

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

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

Parameters

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

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

Parameters

productInfo

string

Retouren

Promise<string>