azure-iot-device package

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 transportneutraal, wat betekent dat het op dezelfde manier werkt via AMQP, MQTT en HTTP.

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

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

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

een DeviceMethodResponse-object wordt aan de gebruiker verstrekt met elke DeviceMethodRequest waarmee de gebruiker een goed opgemaakt antwoord naar de service kan maken en verzenden voor elke aanroep van de apparaatmethode. Een exemplaar van deze klasse wordt doorgegeven als de tweede parameter aan de callback geregistreerd via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Biedt een AuthenticationProvider-implementatie waarmee tokengeneratie 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 over van SharedAccessKeyAuthenticationProvider en is functioneel identiek aan dat type, met uitzondering van het generatiegedeelte van het token dat wordt overschreven door de _sign methode te implementeren.

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

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

Biedt een AuthenticationProvider-object dat eenvoudig kan worden gemaakt met een verbindingsreeks en vervolgens wordt gebruikt door de apparaatclient en transporten 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.

Biedt een AuthenticationProvider-object dat eenvoudig kan worden gemaakt met een handtekening voor gedeelde toegang en die vervolgens wordt gebruikt door de apparaatclient en transporteert om te verifiëren met het Azure IoT Hub-exemplaar.

Het SharedAccessSignatureAuthenticationProvider-object vernieuwt het shared access signature-token niet automatisch, zodat de gebruiker niet-verlopen shared access Signature-tokens moet invoeren met behulp van de methode updateSharedAccessSignature. Voor elke aanroep van deze methode verzendt de SharedAccessSignatureAuthenticationProvider een newTokenAvailable gebeurtenis die wordt gebruikt voor verificatie bij het Azure IoT Hub-exemplaar.

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.

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

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

Opties die specifiek zijn voor het AMQP-transport.

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

Zien

Opties voor het clientobject. Doorgegeven aan de functie setOptions.

voorbeeld van

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

Optiesstructuur die wordt gebruikt om te configureren hoe vaak de HTTP-ontvanger pollt voor berichten. Elk van deze opties is wederzijds exclusief, met uitzondering van de drain booleaanse waarde. Slechts één interval, at, cron of manualPolling moet aanwezig zijn in de optiesstructuur.

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

Zien

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.

Zien

Opties die specifiek zijn voor het MQTT-transport

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

Bevat de gewenste en gerapporteerde eigenschappen voor de tweeling.