Kom igång med enhetshantering (Node.js)

Artikel
10/01/2024

Serverdelsappar kan använda Azure IoT Hub-primitiver, till exempel enhetstvillingar och direktmetoder, för att fjärrstarta och övervaka enhetshanteringsåtgärder på enheter. Den här artikeln visar hur en serverdelsapp och en enhetsapp kan arbeta tillsammans för att initiera och övervaka en omstart av fjärrenheter med hjälp av IoT Hub.

Kommentar

De funktioner som beskrivs i den här artikeln är endast tillgängliga på standardnivån för IoT Hub. Mer information om de grundläggande och standard-/kostnadsfria IoT Hub-nivåerna finns i Välj rätt IoT Hub-nivå för din lösning.

Använd en direktmetod för att initiera åtgärder för enhetshantering (till exempel omstart, fabriksåterställning och uppdatering av inbyggd programvara) från en serverdelsapp i molnet. Enheten ansvarar för:

Hantera metodbegäran som skickas från IoT Hub.
Initiera motsvarande enhetsspecifika åtgärd på enheten.
Tillhandahålla statusuppdateringar via rapporterade egenskaper till IoT Hub.

Du kan använda en serverdelsapp i molnet för att köra frågor för enhetstvillingar för att rapportera om förloppet för dina enhetshanteringsåtgärder.

Den här artikeln visar hur du skapar:

dmpatterns_getstarted_device.js: en simulerad enhetsapp med en direktmetod som startar om enheten och rapporterar den senaste omstartstiden. Direktmetoder anropas från molnet.
dmpatterns_getstarted_service.js: en .NET-konsolapp som anropar direktmetoden i den simulerade enhetsappen via din IoT-hubb. Den visar svaret och uppdaterade rapporterade egenskaper.

Förutsättningar

En IoT-hubb i din Azure-prenumeration. Om du inte har någon hubb ännu kan du följa stegen i Skapa en IoT-hubb.
En enhet som är registrerad i din IoT-hubb. Om du inte har en enhet i din IoT-hubb följer du stegen i Registrera en enhet.
Node.js version 10.0.x eller senare. Förbered utvecklingsmiljön beskriver hur du installerar Node.js för den här artikeln i Antingen Windows eller Linux.
Kontrollera att port 8883 är öppen i brandväggen. Enhetsexemplet i den här artikeln använder MQTT-protokollet, som kommunicerar via port 8883. Den här porten kan blockeras i vissa företags- och utbildningsnätverksmiljöer. Mer information och sätt att kringgå det här problemet finns i Ansluta till IoT Hub (MQTT).

Skapa en enhetsapp med en direktmetod

I det här avsnittet får du:

Skapa en Node.js konsolapp som svarar på en direktmetod som anropas av molnet.
Utlös en omstart av simulerad enhet.
Använd de rapporterade egenskaperna för att aktivera enhetstvillingfrågor för att identifiera enheter och när de senast startades om.

Viktigt!

Den här artikeln innehåller steg för att ansluta en enhet med en signatur för delad åtkomst, även kallad symmetrisk nyckelautentisering. Den här autentiseringsmetoden är praktisk för testning och utvärdering, men att autentisera en enhet med X.509-certifikat är en säkrare metod. Mer information finns i Metodtips > för säkerhet Anslutningssäkerhet.

Skapa en tom mapp med namnet managed-device. I mappen managed-device skapar du en package.json fil med hjälp av följande kommando i kommandotolken. Acceptera alla standardvärden:
```
npm init
```
Kör följande kommando i kommandotolken i mappen managed-device för att installera SDK-paketet azure-iot-device och azure-iot-device-mqtt-paketet :
```
npm install azure-iot-device azure-iot-device-mqtt --save
```
Skapa en dmpatterns_getstarted_device.js fil i mappen managed-device med hjälp av en textredigerare.

Lägg till följande "kräv"-instruktioner i början av filen dmpatterns_getstarted_device.js :

'use strict';

var Client = require('azure-iot-device').Client;
var Protocol = require('azure-iot-device-mqtt').Mqtt;

Lägg till en connectionString-variabel och använd den för att skapa en klientinstans. {yourdeviceconnectionstring} Ersätt platshållarvärdet med den enhet anslutningssträng du såg när du registrerade en enhet i IoT Hub:
```
var connectionString = '{yourdeviceconnectionstring}';
var client = Client.fromConnectionString(connectionString, Protocol);
```

Lägg till följande funktion för att implementera direktmetoden på enheten

var onReboot = function(request, response) {

    // Respond the cloud app for the direct method
    response.send(200, 'Reboot started', function(err) {
        if (err) {
            console.error('An error occurred when sending a method response:\n' + err.toString());
        } else {
            console.log('Response to method \'' + request.methodName + '\' sent successfully.');
        }
    });

    // Report the reboot before the physical restart
    var date = new Date();
    var patch = {
        iothubDM : {
            reboot : {
                lastReboot : date.toISOString(),
            }
        }
    };

    // Get device Twin
    client.getTwin(function(err, twin) {
        if (err) {
            console.error('could not get twin');
        } else {
            console.log('twin acquired');
            twin.properties.reported.update(patch, function(err) {
                if (err) throw err;
                console.log('Device reboot twin state reported')
            });  
        }
    });

    // Add your device's reboot API for physical restart.
    console.log('Rebooting!');
};

Öppna anslutningen till din IoT-hubb och starta direktmetodlyssnaren:

client.open(function(err) {
    if (err) {
        console.error('Could not open IotHub client');
    }  else {
        console.log('Client opened.  Waiting for reboot method.');
        client.onDeviceMethod('reboot', onReboot);
    }
});

Spara och stäng filen dmpatterns_getstarted_device.js .

Kommentar

För att hålla det enkelt implementerar den här artikeln inte en återförsöksprincip. I produktionskoden bör du implementera återförsöksprinciper (till exempel en exponentiell backoff), enligt vad som föreslås i artikeln Tillfälliga felhantering.

Hämta IoT Hub-anslutningssträng

I den här artikeln skapar du en serverdelstjänst som anropar en direktmetod på en enhet. Om du vill anropa en direktmetod på en enhet via IoT Hub behöver din tjänst behörighet för tjänstanslutning . Som standard skapas varje IoT Hub med en princip för delad åtkomst med namnet service som ger den här behörigheten.

Följ dessa steg för att hämta IoT Hub-anslutningssträng för tjänstprincipen:

I Azure Portal väljer du Resursgrupper. Välj den resursgrupp där hubben finns och välj sedan din hubb i listan över resurser.
Välj Principer för delad åtkomst i den vänstra rutan i din IoT-hubb.
I listan över principer väljer du tjänstprincipen.
Kopiera den primära anslutningssträng och spara värdet.

Mer information om principer och behörigheter för delad åtkomst i IoT Hub finns i Åtkomstkontroll och behörigheter.

Skapa en tjänstapp för att utlösa en omstart

I det här avsnittet skapar du en Node.js-konsolapp som initierar en fjärromstart på en enhet med hjälp av en direktmetod. Appen använder enhetstvillingfrågor för att identifiera den senaste omstartstiden för den enheten.

Viktigt!

Den här artikeln innehåller steg för att ansluta till en tjänst med hjälp av en signatur för delad åtkomst. Den här autentiseringsmetoden är praktisk för testning och utvärdering, men autentisering till en tjänst med Microsoft Entra-ID eller hanterade identiteter är en säkrare metod. Mer information finns i Metodtips för > säkerhet Molnsäkerhet.

Skapa en tom mapp med namnet trigger-reboot-on-device. I mappen trigger-reboot-on-device skapar du en package.json fil med hjälp av följande kommando i kommandotolken. Acceptera alla standardvärden:
```
npm init
```
I kommandotolken i mappen trigger-reboot-on-device kör du följande kommando för att installera azure-iothub Device SDK-paketet och azure-iot-device-mqtt-paketet :
```
npm install azure-iothub --save
```
Skapa en dmpatterns_getstarted_service.js fil i mappen trigger-reboot-on-device med hjälp av en textredigerare.

Lägg till följande "kräv"-instruktioner i början av filen dmpatterns_getstarted_service.js :

'use strict';

var Registry = require('azure-iothub').Registry;
var Client = require('azure-iothub').Client;

Lägg till följande variabeldeklarationer och ersätt {iothubconnectionstring} platshållarvärdet med IoT Hub-anslutningssträng du kopierade tidigare i Hämta IoT Hub-anslutningssträng:

var connectionString = '{iothubconnectionstring}';
var registry = Registry.fromConnectionString(connectionString);
var client = Client.fromConnectionString(connectionString);
var deviceToReboot = 'myDeviceId';

Lägg till följande funktion för att anropa enhetsmetoden för att starta om målenheten:

var startRebootDevice = function(twin) {

    var methodName = "reboot";

    var methodParams = {
        methodName: methodName,
        payload: null,
        timeoutInSeconds: 30
    };

    client.invokeDeviceMethod(deviceToReboot, methodParams, function(err, result) {
        if (err) {
            console.error("Direct method error: "+err.message);
        } else {
            console.log("Successfully invoked the device to reboot.");  
        }
    });
};

Lägg till följande funktion för att fråga efter enheten och få den senaste omstartstiden:

var queryTwinLastReboot = function() {

    registry.getTwin(deviceToReboot, function(err, twin){

        if (twin.properties.reported.iothubDM != null)
        {
            if (err) {
                console.error('Could not query twins: ' + err.constructor.name + ': ' + err.message);
            } else {
                var lastRebootTime = twin.properties.reported.iothubDM.reboot.lastReboot;
                console.log('Last reboot time: ' + JSON.stringify(lastRebootTime, null, 2));
            }
        } else 
            console.log('Waiting for device to report last reboot time.');
    });
};

Lägg till följande kod för att anropa de funktioner som utlöser direktmetoden för omstart och fråga efter den senaste omstartstiden:
```
startRebootDevice();
setInterval(queryTwinLastReboot, 2000);
```
Spara och stäng filen dmpatterns_getstarted_service.js .

Köra apparna

Nu är du redo att köra apparna.

I kommandotolken i mappen managed-device kör du följande kommando för att börja lyssna efter direktmetoden för omstart.
```
node dmpatterns_getstarted_device.js
```
I kommandotolken i mappen trigger-reboot-on-device kör du följande kommando för att utlösa fjärromstarten och fråga efter enhetstvillingen för att hitta den senaste omstartstiden.
```
node dmpatterns_getstarted_service.js
```
Du ser enhetens svar på direktmetoden för omstart och omstartsstatusen i konsolen.

Följande visar enhetssvaret på den omstartsdirigeringsmetod som skickas av tjänsten:

Följande visar tjänsten som utlöser omstarten och avsöker enhetstvillingen för den senaste omstartstiden:

Anpassa och utöka enhetshanteringsåtgärderna

Dina IoT-lösningar kan utöka den definierade uppsättningen med enhetshanteringsmönster eller aktivera anpassade mönster med hjälp av enhetstvillingen och primitiverna för moln-till-enhet-metoden. Andra exempel på åtgärder för enhetshantering är fabriksåterställning, uppdatering av inbyggd programvara, programuppdatering, energisparfunktioner, nätverks- och anslutningshantering samt datakryptering.

Fönster för enhetsunderhåll

Vanligtvis konfigurerar du enheter för att utföra åtgärder i taget som minimerar avbrott och stilleståndstid. Fönster för enhetsunderhåll är ett vanligt mönster för att definiera den tid då en enhet ska uppdatera sin konfiguration. Serverdelslösningarna kan använda önskade egenskaper för enhetstvillingen för att definiera och aktivera en princip på enheten som aktiverar ett underhållsperiod. När en enhet tar emot principen för underhållsperiod kan den använda den rapporterade egenskapen för enhetstvillingen för att rapportera status för principen. Serverdelsappen kan sedan använda enhetstvillingfrågor för att intyga efterlevnad av enheter och varje princip.

Nästa steg

I den här artikeln använde du en direktmetod för att utlösa en fjärromstart på en enhet. Du använde de rapporterade egenskaperna för att rapportera den senaste omstartstiden från enheten och frågade enhetstvillingen om att identifiera enhetens senaste omstartstid från molnet.

För att fortsätta komma igång med IoT Hub- och enhetshanteringsmönster, till exempel avbildningsbaserad uppdatering från slutpunkt till slutpunkt i artikeln Enhetsuppdatering för Azure IoT Hub med hjälp av raspberry Pi 3 B+-referensbilden.

Information om hur du utökar IoT-lösnings- och schemametodanrop på flera enheter finns i Schemalägga och sända jobb.

Dela via