Usare le proprietà desiderate per configurare i dispositivi

Introduzione

In Introduzione ai dispositivi gemelli dell'hub IoT è stato illustrato come impostare i metadati dei dispositivi dal back-end della soluzione usando tag, come segnalare le condizioni dei dispositivi da un'app per dispositivo con le proprietà segnalate e come eseguire query su tali informazioni con un linguaggio simile a SQL.

In questa esercitazione verrà illustrato come usare le proprietà desiderate del dispositivo gemello con le proprietà segnalate per configurare in remoto le app per dispositivi. In particolare, questa esercitazione descrive come le proprietà segnalate e desiderate di un dispositivo gemello supportano la configurazione in più passaggi di un'applicazione per dispositivi e come ottenere nel back-end della soluzione la visibilità dello stato di tale operazione in tutti i dispositivi. Per altre informazioni sul ruolo delle configurazioni del dispositivo, vedere Panoramica della gestione dei dispositivi con l'hub IoT.

In genere, l'uso di dispositivi gemelli abilita il back-end della soluzione per specificare la configurazione voluta per i dispositivi gestiti, invece di inviare comandi specifici. Il dispositivo ha quindi la responsabilità di configurare il modo migliore per aggiornare la propria configurazione (importante negli scenari IoT in cui le condizioni specifiche del dispositivo influiscono sulla possibilità di eseguire immediatamente determinati comandi) segnalando continuamente al back-end della soluzione lo stato corrente e le potenziali condizioni di errore del processo di aggiornamento. Questo modello è determinante per gestire grandi set di dispositivi, perché offre al back-end della soluzione la visibilità completa dello stato del processo di configurazione in tutti i dispositivi.

Nota

Negli scenari in cui i dispositivi sono controllati in modo più interattivo (come nel caso dell'attivazione di una ventola da un'app controllata dall'utente), può essere opportuno usare metodi diretti.

In questa esercitazione, il back-end della soluzione modifica la configurazione della telemetria di un dispositivo di destinazione e di conseguenza l'app per dispositivi segue un processo in più passaggi per applicare un aggiornamento della configurazione (che richiede ad esempio un riavvio del modulo software che nell'esercitazione viene simulato con un semplice ritardo).

Il back-end della soluzione archivia la configurazione nelle proprietà desiderate del dispositivo gemello nel modo seguente:

    {
        ...
        "properties": {
            ...
            "desired": {
                "telemetryConfig": {
                    "configId": "{id of the configuration}",
                    "sendFrequency": "{config}"
                }
            }
            ...
        }
        ...
    }

Nota

Dato che le configurazioni possono essere oggetti complessi, per semplificarne il confronto vengono assegnati ID univoci (hash o GUID).

L'app per dispositivi segnala la propria configurazione corrente eseguendo il mirroring della proprietà desiderata telemetryConfig nelle proprietà segnalate:

    {
        "properties": {
            ...
            "reported": {
                "telemetryConfig": {
                    "changeId": "{id of the current configuration}",
                    "sendFrequency": "{current configuration}",
                    "status": "Success",
                }
            }
            ...
        }
    }

Si noti che la proprietà segnalata telemetryConfig ha una proprietà status aggiuntiva usata per segnalare lo stato del processo di aggiornamento della configurazione.

Quando viene ricevuta una nuova configurazione desiderata, l'app per dispositivi segnala una configurazione in sospeso modificando le informazioni:

    {
        "properties": {
            ...
            "reported": {
                "telemetryConfig": {
                    "changeId": "{id of the current configuration}",
                    "sendFrequency": "{current configuration}",
                    "status": "Pending",
                    "pendingConfig": {
                        "changeId": "{id of the pending configuration}",
                        "sendFrequency": "{pending configuration}"
                    }
                }
            }
            ...
        }
    }

In un secondo momento l'app per dispositivi segnala l'esito positivo o negativo dell'operazione aggiornando la proprietà sopra indicata. Si noti che il back-end della soluzione può eseguire in qualsiasi momento query sullo stato del processo di configurazione in tutti i dispositivi.

Questa esercitazione illustra come:

  • Creare un'app per dispositivo simulato che riceve aggiornamenti di configurazione dal back-end della soluzione e segnala più aggiornamenti come proprietà segnalate nel processo di aggiornamento della configurazione.
  • Creare un'app back-end che aggiorna la configurazione desiderata di un dispositivo e quindi esegue query sul processo di aggiornamento della configurazione.

Al termine di questa esercitazione si avranno due app console:

  • SimulateDeviceConfiguration.js, un'app per dispositivo simulata che attende un aggiornamento della configurazione desiderata e segnala lo stato di un processo di aggiornamento della configurazione simulata.
  • SetDesiredConfigurationAndQuery.js, un'app back-end di .NET, che imposta la configurazione desiderata in un dispositivo ed esegue query sul processo di aggiornamento della configurazione.

Nota

L'articolo Azure IoT SDK contiene informazioni sui componenti Azure IoT SDK che consentono di compilare le app back-end e per dispositivi.

Per completare l'esercitazione, sono necessari gli elementi seguenti:

  • Visual Studio 2015 o Visual Studio 2017.
  • Node.js 4.0.x o versione successiva.
  • Un account Azure attivo. Se non si ha un account, è possibile crearne uno gratuito in pochi minuti.

Se è stata seguita l'esercitazione Introduzione ai dispositivi gemelli sono già disponibili un hub IoT e un'identità del dispositivo denominata myDeviceId. È quindi possibile ignorare la sezione Creare l'app per dispositivo simulata.

Creare un hub IoT

Creare un hub IoT per connettere l'app per dispositivo simulato. La procedura seguente illustra come completare questa attività usando il portale di Azure.

  1. Accedere al portale di Azure.
  2. Nell'indice fare clic su Nuovo > Internet delle cose > Hub IoT.

    Indice del portale di Azure

  3. Nella finestra Hub IoT scegliere la configurazione per l'hub IoT.

    Finestra Hub IoT

    1. Nella casella Nome immettere un nome per l'hub IoT. Se il Nome è valido e disponibile, appare un segno di spunta verde nella casella Nome.

      Importante

      L'hub IoT sarà individuabile pubblicamente come endpoint DNS, quindi evitare di indicare informazioni riservate nell'assegnazione del nome.

    2. Selezionare un piano tariffario e un livello di scalabilità. Per questa esercitazione non è necessario un livello specifico. Per questa esercitazione, usare il livello F1 gratuito.

    3. In Gruppo di risorse creare un gruppo di risorse o selezionarne uno esistente. Per altre informazioni, vedere Using resource groups to manage your Azure resources (Uso di Gruppi di risorse per gestire le risorse di Azure).
    4. In Percorsoselezionare il percorso per ospitare l'hub IoT. Per questa esercitazione, scegliere la località più vicina.
  4. Dopo aver scelto le opzioni di configurazione dell'hub IoT, fare clic su Crea. La creazione dell'hub IoT da parte di Azure può richiedere alcuni minuti. Per verificare lo stato, è possibile monitorare l'avanzamento nella Schermata iniziale o nel pannello Notifiche.

  5. Dopo avere creato l'hub IoT, fare clic sul nuovo riquadro dell'hub IoT nel portale di Azure per aprire la finestra delle proprietà. Annotare il Nome host, quindi fare clic su Criteri di accesso condiviso.

    Finestra del nuovo hub IoT

  6. In Criteri di accesso condivisi fare clic sul criterio iothubowner, quindi copiare e annotare la stringa di connessione dell'hub IoT nella finestra iothubowner. Per altre informazioni, vedere Controllo di accesso nella "Guida per gli sviluppatori dell'hub IoT".

    Criteri di accesso condivisi

Creare un'identità del dispositivo

In questa sezione si usa uno strumento di Node.js denominato iothub-explorer per creare un'identità del dispositivo per questa esercitazione. Gli ID dispositivo fanno distinzione tra maiuscole e minuscole.

  1. Eseguire il codice seguente nell'ambiente della riga di comando:

    npm install -g iothub-explorer@latest

  2. Eseguire quindi il comando indicato di seguito per accedere all'hub. Sostituire {iot hub connection string} con la stringa di connessione all'hub IoT copiata prima:

    iothub-explorer login "{iot hub connection string}"

  3. Creare infine una nuova identità del dispositivo denominata myDeviceId con il comando:

    iothub-explorer create myDeviceId --connection-string

    Importante

    L'ID dispositivo può essere visibile nei log raccolti per il supporto tecnico e la risoluzione dei problemi, quindi evitare di indicare informazioni riservate nell'assegnazione del nome.

Annotare la stringa di connessione del dispositivo visualizzata nei risultati. Questa stringa di connessione del dispositivo viene usata dall'app del dispositivo per la connessione all'hub IoT come dispositivo.

Per creare identità del dispositivo a livello di codice, vedere Introduzione all'hub IoT.

Creare l'app per dispositivo simulata

In questa sezione si crea un'app console Node.js che si connette all'hub come myDeviceId, attende un aggiornamento della configurazione desiderata e quindi segnala gli aggiornamenti nel processo di aggiornamento della configurazione simulata.

  1. Creare una nuova cartella vuota denominata simulatedeviceconfiguration. Nella cartella simulatedeviceconfiguration creare un nuovo file package.json immettendo il comando seguente al prompt dei comandi. Accettare tutte le impostazioni predefinite.

    npm init
    
  2. Al prompt dei comandi nella cartella simulatedeviceconfiguration digitare il comando seguente per installare i pacchetti azure-iot-device e azure-iot-device-mqtt:

    npm install azure-iot-device azure-iot-device-mqtt --save
    
  3. Usando un editor di testo, creare un nuovo file SimulateDeviceConfiguration.js nella cartella simulatedeviceconfiguration.
  4. Aggiungere il codice seguente al file SimulateDeviceConfiguration.js e sostituire il segnaposto {device connection string} con la stringa di connessione copiata quando si è creata l'identità del dispositivo myDeviceId:

     'use strict';
     var Client = require('azure-iot-device').Client;
     var Protocol = require('azure-iot-device-mqtt').Mqtt;
    
     var connectionString = '{device connection string}';
     var client = Client.fromConnectionString(connectionString, Protocol);
    
     client.open(function(err) {
         if (err) {
             console.error('could not open IotHub client');
         } else {
             client.getTwin(function(err, twin) {
                 if (err) {
                     console.error('could not get twin');
                 } else {
                     console.log('retrieved device twin');
                     twin.properties.reported.telemetryConfig = {
                         configId: "0",
                         sendFrequency: "24h"
                     }
                     twin.on('properties.desired', function(desiredChange) {
                         console.log("received change: "+JSON.stringify(desiredChange));
                         var currentTelemetryConfig = twin.properties.reported.telemetryConfig;
                         if (desiredChange.telemetryConfig &&desiredChange.telemetryConfig.configId !== currentTelemetryConfig.configId) {
                             initConfigChange(twin);
                         }
                     });
                 }
             });
         }
     });
    

    L'oggetto Client espone tutti i metodi necessari per interagire con i dispositivi gemelli dal dispositivo. Questo codice inizializza l'oggetto Client, recupera il dispositivo gemello per myDeviceId e quindi collega un gestore per l'aggiornamento nelle proprietà desiderate. Il gestore verifica che esista una richiesta di modifica della configurazione effettiva confrontando gli elementi configId, quindi richiama un metodo che avvia la modifica della configurazione.

    Per motivi di semplicità, questo codice usa un valore predefinito hardcoded per la configurazione iniziale. Una vera app probabilmente caricherebbe tale configurazione da una risorsa di archiviazione locale.

    Importante

    Gli eventi di modifica delle proprietà desiderate vengono inviati sempre una volta sola alla connessione al dispositivo. Assicurarsi di verificare che vi sia un'effettiva modifica nelle proprietà desiderate prima di eseguire qualsiasi azione.

  5. Aggiungere i metodi seguenti prima della chiamata a client.open():

     var initConfigChange = function(twin) {
         var currentTelemetryConfig = twin.properties.reported.telemetryConfig;
         currentTelemetryConfig.pendingConfig = twin.properties.desired.telemetryConfig;
         currentTelemetryConfig.status = "Pending";
    
         var patch = {
         telemetryConfig: currentTelemetryConfig
         };
         twin.properties.reported.update(patch, function(err) {
             if (err) {
                 console.log('Could not report properties');
             } else {
                 console.log('Reported pending config change: ' + JSON.stringify(patch));
                 setTimeout(function() {completeConfigChange(twin);}, 60000);
             }
         });
     }
    
     var completeConfigChange =  function(twin) {
         var currentTelemetryConfig = twin.properties.reported.telemetryConfig;
         currentTelemetryConfig.configId = currentTelemetryConfig.pendingConfig.configId;
         currentTelemetryConfig.sendFrequency = currentTelemetryConfig.pendingConfig.sendFrequency;
         currentTelemetryConfig.status = "Success";
         delete currentTelemetryConfig.pendingConfig;
    
         var patch = {
             telemetryConfig: currentTelemetryConfig
         };
         patch.telemetryConfig.pendingConfig = null;
    
         twin.properties.reported.update(patch, function(err) {
             if (err) {
                 console.error('Error reporting properties: ' + err);
             } else {
                 console.log('Reported completed config change: ' + JSON.stringify(patch));
             }
         });
     };
    

    Il metodo initConfigChange aggiorna le proprietà segnalate nell'oggetto dispositivo gemello locale con la richiesta di aggiornamento della configurazione e imposta lo stato su Pending (Sospeso), quindi aggiorna il dispositivo gemello nel servizio. Dopo l'aggiornamento del dispositivo gemello, simula un processo a esecuzione prolungata che termina con l'esecuzione di completeConfigChange. Questo metodo aggiorna le proprietà segnalate locali impostando lo stato su Success e rimuovendo l'oggetto pendingConfig, quindi aggiorna il dispositivo gemello nel servizio.

    Si noti che, per risparmiare larghezza di banda, le proprietà segnalate vengono aggiornate specificando solo le proprietà da modificare (denominate patch nel codice precedente), invece di sostituire l'intero documento.

    Nota

    Questa esercitazione non simula alcun comportamento per gli aggiornamenti della configurazione simultanei. Alcuni processi di aggiornamento della configurazione potrebbero consentire modifiche della configurazione di destinazione mentre l'aggiornamento è in esecuzione, altre potrebbero doverle accodare e altri ancora rifiutarle con una condizione di errore. È importante tenere in considerazione il comportamento desiderato per il processo di configurazione specifico e aggiungere la logica appropriata prima di iniziare la modifica della configurazione.

  6. Eseguire l'app per dispositivo:

     node SimulateDeviceConfiguration.js
    

    Dovrebbe essere visualizzato il messaggio retrieved device twin. Mantenere l'app in esecuzione.

Creare l'app di servizio

In questa sezione si creerà un'app console .NET che aggiorna le proprietà desiderate nel dispositivo gemello associato a myDeviceId con un nuovo oggetto di configurazione di telemetria. Viene quindi effettuata una query dei dispositivi gemelli archiviati nell'hub IoT e viene visualizzata la differenza tra la configurazione desiderata e quella segnalata del dispositivo.

  1. In Visual Studio aggiungere un progetto desktop di Windows classico in Visual C# usando il modello di progetto Applicazione console . Assegnare al progetto il nome SetDesiredConfigurationAndQuery.

    Nuovo progetto desktop di Windows classico in Visual C#

  2. In Esplora soluzioni fare clic con il pulsante destro del mouse sul progetto SetDesiredConfigurationAndQuery e quindi fare clic su Gestisci pacchetti NuGet.
  3. Nella finestra Gestione pacchetti NuGet selezionare Esplora, cercare microsoft.azure.devices, selezionare Installa per installare il pacchetto Microsoft.Azure.Devices e accettare le condizioni per l'uso. Questa procedura scarica, installa e aggiunge un riferimento al pacchetto NuGet Azure IoT - SDK per dispositivi e alle relative dipendenze.

    Finestra Gestione pacchetti NuGet

  4. Aggiungere le istruzione using seguenti all'inizio del file Program.cs :

     using Microsoft.Azure.Devices;
     using System.Threading;
     using Newtonsoft.Json;
    
  5. Aggiungere i campi seguenti alla classe Program . Sostituire il valore del segnaposto con la stringa di connessione dell'hub IoT creato nella sezione precedente.

     static RegistryManager registryManager;
     static string connectionString = "{iot hub connection string}";
    
  6. Aggiungere il metodo seguente alla classe Program :

     static private async Task SetDesiredConfigurationAndQuery()
     {
         var twin = await registryManager.GetTwinAsync("myDeviceId");
         var patch = new {
                 properties = new {
                     desired = new {
                         telemetryConfig = new {
                             configId = Guid.NewGuid().ToString(),
                             sendFrequency = "5m"
                         }
                     }
                 }
             };
    
         await registryManager.UpdateTwinAsync(twin.DeviceId, JsonConvert.SerializeObject(patch), twin.ETag);
         Console.WriteLine("Updated desired configuration");
    
         try
         {
             while (true)
             {
                 var query = registryManager.CreateQuery("SELECT * FROM devices WHERE deviceId = 'myDeviceId'");
                 var results = await query.GetNextAsTwinAsync();
                 foreach (var result in results)
                 {
                     Console.WriteLine("Config report for: {0}", result.DeviceId);
                     Console.WriteLine("Desired telemetryConfig: {0}", JsonConvert.SerializeObject(result.Properties.Desired["telemetryConfig"], Formatting.Indented));
                     Console.WriteLine("Reported telemetryConfig: {0}", JsonConvert.SerializeObject(result.Properties.Reported["telemetryConfig"], Formatting.Indented));
                     Console.WriteLine();
                 }
                 Thread.Sleep(10000);
             }
         }
         catch (Exception ex)
         {
             Console.WriteLine($"Exception: {ex.Message}");
         }
     }
    

    L'oggetto Registry espone tutti i metodi necessari per interagire con i dispositivi gemelli dal servizio. Questo codice inizializza l'oggetto Registry, recupera il dispositivo gemello per myDeviceId e ne aggiorna le proprietà desiderate con un nuovo oggetto di configurazione dei dati di telemetria. Ogni 10 secondi esegue una query dei dispositivi gemelli archiviati nell'hub IoT e stampa le configurazioni dei dati di telemetria desiderate e segnalate. Vedere il linguaggio di query dell'hub IoT per informazioni su come generare report avanzati in tutti i dispositivi.

    Importante

    Questa applicazione effettua una query dell'hub IoT ogni 10 secondi a scopo illustrativo. Usare le query per generare i report destinati all'utente in più dispositivi e non per rilevare le modifiche. Se la soluzione richiede notifiche in tempo reale degli eventi del dispositivo, usare le notifiche relative al dispositivo gemello.

  7. Aggiungere infine le righe seguenti al metodo Main :

     registryManager = RegistryManager.CreateFromConnectionString(connectionString);
     SetDesiredConfigurationAndQuery().Wait();
     Console.WriteLine("Press any key to quit.");
     Console.ReadLine();
    
  8. In Esplora soluzioni aprire Imposta progetti di avvio e assicurarsi che Azione per il progetto SetDesiredConfigurationAndQuery sia impostata su Avvio. Compilare la soluzione.
  9. Mentre SimulateDeviceConfiguration.js è in esecuzione, eseguire l'applicazione .NET da Visual Studio tramite F5: si potrà notare che la configurazione segnalata passa da Operazione riuscita a In sospeso e di nuovo a Operazione riuscita con la nuova frequenza di invio attiva di cinque minuti e non più di 24 ore.

    Dispositivo configurato correttamente

    Importante

    Tra l'operazione relativa al report del dispositivo e il risultato della query si verifica un ritardo fino a un minuto, che consente all'infrastruttura della query di funzionare su una scala molto ampia. Per recuperare visualizzazioni coerenti di un solo dispositivo gemello, usare il metodo getDeviceTwin nella classe Registry.

Passaggi successivi

In questa esercitazione è stata impostata una configurazione desiderata come proprietà desiderate da un back-end della soluzione ed è stata scritta un'app per dispositivo per rilevare tale modifica e simulare un processo di aggiornamento in più fasi che segnala lo stato tramite le proprietà segnalate.

Per altre informazioni, vedere le risorse seguenti:

  • Per inviare dati di telemetria dai dispositivi, vedere l'esercitazione Introduzione all'hub IoT.
  • Per pianificare o eseguire operazioni su grandi set di dispositivi, vedere l'esercitazione Pianificare e trasmettere processi.
  • Per controllare i dispositivi in modo interattivo, ad esempio per attivare un ventilatore da un'app controllata dall'utente, vedere l'esercitazione Use direct methods (Usare metodi diretti).