Použití sady Visual Studio 2022 k vývoji a ladění modulů pro Azure IoT Edge

1. V Průzkumník řešení klikněte pravým tlačítkem na název hlavního projektu a vyberte Nastavit verzi modulu runtime IoT Edge.

   

2. V rozevírací nabídce zvolte verzi modulu runtime, na které běží vaše zařízení IoT Edge, a pak výběrem ok uložte změny. Pokud nedošlo k žádné změně, vyberte Zrušit a ukončete ji.

   Rozšíření v současné době neobsahuje výběr nejnovějších verzí modulu runtime. Pokud chcete nastavit verzi modulu runtime vyšší než 1.2, otevřete soubor manifestu nasazení deployment.debug.template.json . Změňte verzi modulu runtime modulu system runtime image edgeAgent a edgeHub. Pokud například chcete použít modul runtime IoT Edge verze 1.5, změňte v souboru manifestu nasazení následující řádky:

   "systemModules": {
      "edgeAgent": {
       //...
         "image": "mcr.microsoft.com/azureiotedge-agent:1.5"
       //...
      "edgeHub": {
      //...
         "image": "mcr.microsoft.com/azureiotedge-hub:1.5",
      //...
   

3. Pokud jste změnili verzi, znovu vygenerujte manifest nasazení tak, že kliknete pravým tlačítkem na název projektu a vyberete Vygenerovat nasazení pro IoT Edge. Tím se vygeneruje manifest nasazení na základě šablony nasazení a zobrazí se v konfigurační složce projektu sady Visual Studio.

1. Otevřete soubor manifestu nasazení deployment.debug.template.json. Manifest nasazení je dokument JSON, který popisuje moduly, které se mají nakonfigurovat na cílovém zařízení IoT Edge.

2. Změňte verzi modulu runtime modulu system runtime image edgeAgent a edgeHub. Pokud například chcete použít modul runtime IoT Edge verze 1.5, změňte v souboru manifestu nasazení následující řádky:

   "systemModules": {
       "edgeAgent": {
       //...
           "image": "mcr.microsoft.com/azureiotedge-agent:1.5",
       //...
       "edgeHub": {
       //...
           "image": "mcr.microsoft.com/azureiotedge-hub:1.5",
       //...
   

Ladění pomocí simulátoru

Azure IoT EdgeHub Dev Tool poskytuje místní vývojové a ladicí prostředí. Tento nástroj pomáhá spouštět moduly IoT Edge bez modulu runtime IoT Edge, abyste mohli vytvářet, vyvíjet, testovat, spouštět a ladit moduly a řešení IoT Edge místně. Image nemusíte odesílat do registru kontejneru a nasazovat je do zařízení pro účely testování.

Další informace najdete v nástroji Azure IoT EdgeHub Dev Tool.

Inicializace nástroje v sadě Visual Studio:

1. Načtěte připojovací řetězec vašeho zařízení IoT Edge (nachází se ve službě IoT Hub) z webu Azure Portal nebo z Azure CLI.

   Pokud k načtení připojovací řetězec použijete rozhraní příkazového řádku, použijte tento příkaz a nahraďte [device_id] a [hub_name] vlastními hodnotami:

   az iot hub device-identity connection-string show --device-id [device_id] --hub-name [hub_name]
   

2. V nabídce Nástroje v sadě Visual Studio vyberte Azure IoT Edge Tools>Setup IoT Edge Simulator.

3. Vložte připojovací řetězec a vyberte OK.

Sestavení a ladění jednoho modulu

Obvykle chcete testovat a ladit každý modul před spuštěním v rámci celého řešení s více moduly. Nástroj simulátoru IoT Edge umožňuje spustit jeden modul izolovaně a odesílat zprávy přes port 53000.

1. V Průzkumník řešení vyberte a zvýrazněte složku projektu modulu (například IotEdgeModule1). Nastavte vlastní modul jako spouštěný projekt. V nabídce vyberte Project>Set as StartUp Project (Spustit projekt).

2. Stisknutím klávesy F5 nebo výběrem tlačítka pro spuštění panelu nástrojů spusťte simulátor IoT Edge pro jeden modul. Počáteční doba může trvat 10 až 20 sekund.

   

3. Pokud se modul úspěšně inicializoval, měl by se zobrazit okno konzolové aplikace .NET Core.

4. Nastavte zarážku pro kontrolu modulu.

   • Při vývoji v jazyce C# nastavte zarážku ve PipeMessage() funkci v ModuleBackgroundService.cs.
   • Pokud používáte jazyk C, nastavte zarážku ve InputQueue1Callback() funkci v main.c.

5. Otestujte modul odesláním zprávy. Při ladění jednoho modulu simulátor naslouchá na výchozím portu 53000 zpráv. Pokud chcete odeslat zprávu do modulu, spusťte následující příkaz curl z příkazového prostředí, jako je Git Bash nebo WSL Bash.

   curl --header "Content-Type: application/json" --request POST --data '{"inputName": "input1","data":"hello world"}' http://localhost:53000/api/v1/messages
   

   Pokud se v adrese URL zobrazí chyba bez chybějící složené složené závorky nebo závorky, zkuste místo toho použít následující příkaz:

   curl --header "Content-Type: application/json" --request POST --data "{\"inputName\": \"input1\", \"data\", \"hello world\"}"  http://localhost:53000/api/v1/messages
   

   

   Zarážka by se měla aktivovat. Proměnné můžete sledovat v okně Místní prostředí sady Visual Studio a zjistit, kdy je ladicí program spuštěný. Přejděte na Ladicí>místní prostředí Systému Windows.>

   V prostředí Bash nebo prostředí by se mělo zobrazit {"message":"accepted"} potvrzení.

   V konzole .NET byste měli vidět:

   IoT Hub module client initialized.
   Received message: 1, Body: [hello world]
   

6. Pokud chcete zastavit ladění, stiskněte Ctrl+F5 nebo stiskněte tlačítko zastavit.

Sestavení a ladění více modulů

Po dokončení vývoje jednoho modulu můžete chtít spustit a ladit celé řešení s více moduly. Nástroj simulátoru IoT Edge umožňuje spouštět všechny moduly definované v manifestu nasazení, včetně simulovaného hraničníhohubu pro směrování zpráv. V tomto příkladu spustíte dva vlastní moduly a modul simulovaného senzoru teploty. Zprávy z modulu simulovaného senzoru teploty se směrují do každého vlastního modulu.

1. V Průzkumník řešení přidejte do řešení druhý modul tak, že kliknete pravým tlačítkem myši na hlavní složku projektu. V nabídce vyberte Přidat>nový modul IoT Edge.

   

2. Add module V okně zadejte název nového modulu a nahraďte localhost:5000 část adresy URL úložiště přihlašovacím serverem služby Azure Container Registry, jako jste to udělali dříve.

3. Otevřete soubor deployment.debug.template.json , abyste viděli, že nový modul byl přidán v části moduly . Do oddílu EdgeHub trasy se také přidala nová trasa pro odesílání zpráv z nového modulu do IoT Hubu. Pokud chcete odesílat data ze simulovaného senzoru teploty do nového modulu, přidejte další trasu s následujícím řádkem JSON. Nahraďte <NewModuleName> (na dvou místech) vlastním názvem modulu.

   "sensorTo<NewModuleName>": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/<NewModuleName>/inputs/input1\")"
   

4. Klikněte pravým tlačítkem na hlavní projekt (například AzureIotEdgeApp1) a vyberte Nastavit jako počáteční projekt. Nastavením hlavního projektu jako spouštěcího projektu se spustí všechny moduly v řešení. To zahrnuje oba moduly, které jste přidali do řešení, modul simulovaného senzoru teploty a simulované centrum Edge.

5. Stisknutím klávesy F5 nebo výběrem tlačítka pro spuštění panelu nástrojů spusťte řešení. Zpočátku může trvat 10 až 20 sekund. Ujistěte se, že nemáte spuštěné další kontejnery Dockeru, které by mohly svázat port, který pro tento projekt potřebujete.

6. Pro každý modul by se měla zobrazit dvě okna konzolové aplikace .NET Core.

7. Nastavte zarážku pro kontrolu modulů.

   • Při vývoji v jazyce C# nastavte zarážku ve PipeMessage() funkci v ModuleBackgroundService.cs.
   • Pokud používáte jazyk C, nastavte zarážku ve InputQueue1Callback() funkci v main.c.

8. Vytvořte v každém modulu zarážky a stisknutím klávesy F5 spusťte a ladit více modulů současně. Měli byste vidět několik oken konzolové aplikace .NET Core, přičemž každé okno představuje jiný modul.

   

9. Pokud chcete zastavit ladění, stiskněte Ctrl+F5 nebo stiskněte tlačítko zastavit.

Vytváření a nabízení imagí do registru

Po vývoji a ladění modulu můžete sestavit a odeslat image modulu do služby Azure Container Registry. Pak můžete modul nasadit do zařízení IoT Edge.

1. Nastavte hlavní projekt IoT Edge jako počáteční projekt, ne jeden z jednotlivých modulů.

2. Jako konfiguraci pro sestavení imagí modulů vyberte ladění nebo vydání.

   Poznámka:

   Při výběru možnosti Ladit sada Visual Studio používá Dockerfile.(amd64|windows-amd64).debug k sestavení imagí Dockeru. To zahrnuje ladicí program příkazového řádku .NET Core VSDBG v imagi kontejneru při jeho vytváření. Pro moduly IoT Edge připravené pro produkční prostředí doporučujeme použít konfiguraci vydané verze , která se používá Dockerfile.(amd64|windows-amd64) bez VSDBG.

3. Pokud používáte privátní registr, jako je Azure Container Registry (ACR), přihlaste se k němu pomocí následujícího příkazu Dockeru. Uživatelské jméno a heslo můžete získat na stránce Přístupové klíče vašeho registru na webu Azure Portal.

   docker login <ACR login server>
   

4. Pojďme přidat přihlašovací údaje služby Azure Container Registry do nastavení modulu runtime nalezeného v souboru deployment.debug.template.json. Můžete to provést dvěma způsoby. Přihlašovací údaje registru můžete buď přidat do .env souboru (nejbezpečnější), nebo je přidat přímo do souboru deployment.debug.template.json .

   Přidejte do .env souboru přihlašovací údaje:

   V Průzkumník řešení vyberte tlačítko Zobrazit všechny soubory na panelu nástrojů. Zobrazí se .env soubor. Přidejte do .env souboru uživatelské jméno a heslo služby Azure Container Registry. Tyto přihlašovací údaje najdete na stránce Přístupové klíče služby Azure Container Registry na webu Azure Portal.

   

       DEFAULT_RT_IMAGE=1.2
       CONTAINER_REGISTRY_USERNAME_myregistry=<my-registry-name>
       CONTAINER_REGISTRY_PASSWORD_myregistry=<my-registry-password>
   

   Přímé přidání přihlašovacích údajů do deployment.debug.template.json

   Pokud byste raději přidali přihlašovací údaje přímo do šablony nasazení, nahraďte zástupné symboly uživatelským jménem správce ACR, heslem a názvem registru.

         "settings": {
           "minDockerVersion": "v1.25",
           "loggingOptions": "",
           "registryCredentials": {
             "registry1": {
               "username": "<username>",
               "password": "<password>",
               "address": "<registry name>.azurecr.io"
             }
           }
         }
   

   Poznámka:

   Tento článek používá přihlašovací údaje správce pro Azure Container Registry, které jsou vhodné pro scénáře vývoje a testování. Až budete připraveni na produkční scénáře, doporučujeme použít možnost ověřování s nejnižšími oprávněními, jako jsou instanční objekty. Další informace najdete v tématu Správa přístupu k registru kontejneru.

5. Pokud používáte místní registr, můžete spustit místní registr.

6. Nakonec v Průzkumník řešení klikněte pravým tlačítkem na hlavní složku projektu a vyberte Sestavit a odeslat moduly IoT Edge, aby se sestavil a nasdílel image Dockeru pro každý modul. Může to trvat minutu. Až se zobrazí Finished Build and Push IoT Edge Modules. v konzole Výstup v sadě Visual Studio, máte hotovo.

Nasazení řešení

Teď, když jste vytvořili a nasdíleli image modulů do služby Azure Container Registry, můžete řešení nasadit do zařízení IoT Edge. Už máte šablonu manifestu nasazení, kterou jste v průběhu tohoto kurzu pozorovali. Vygenerujme z toho manifest nasazení a pak pomocí příkazu Azure CLI nasadíte moduly do zařízení IoT Edge v Azure.

1. Klikněte pravým tlačítkem na hlavní projekt v sadě Visual Studio Průzkumník řešení a zvolte Generovat nasazení pro IoT Edge.

   

2. Přejděte do místní složky hlavního projektu sady Visual Studio a vyhledejte ji config . Cesta k souboru může vypadat takto: C:\Users\<YOUR-USER-NAME>\source\repos\<YOUR-IOT-EDGE-PROJECT-NAME>\config. Tady najdete vygenerovaný manifest nasazení, například deployment.amd64.debug.json.

3. Zkontrolujte soubor a ověřte deployment.amd64.debug.json , že je verze schématu edgeHub nastavená na 1.2.

    "$edgeHub": {
        "properties.desired": {
          "schemaVersion": "1.2",
          "routes": {
            "IotEdgeModule2022ToIoTHub": "FROM /messages/modules/IotEdgeModule2022/outputs/* INTO $upstream",
            "sensorToIotEdgeModule2022": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/IotEdgeModule2022/inputs/input1\")",
            "IotEdgeModule2022bToIoTHub": "FROM /messages/modules/IotEdgeModule2022b/outputs/* INTO $upstream"
          },
          "storeAndForwardConfiguration": {
            "timeToLiveSecs": 7200
          }
        }
      }
   

   Tip

   Šablona nasazení pro Visual Studio 2022 vyžaduje verzi schématu 1.2. Pokud ho potřebujete mít 1.1 nebo 1.0, počkejte, až se vygeneruje nasazení (neměňte ho).deployment.debug.template.json Při generování nasazení se ve výchozím nastavení vytvoří schéma 1.2. Před nasazením do Azure ale můžete ručně změnit deployment.amd64.debug.jsonvygenerovaný manifest.

   Důležité

   Po nasazení zařízení IoT Edge se v současné době na webu Azure Portal s verzí 1.2 schématu nezobrazí správně (verze 1.1 bude v pořádku). Jedná se o známou chybu, která bude brzy opravena. To ale nebude mít vliv na vaše zařízení, protože je stále připojený ve službě IoT Hub a dá se s ním kdykoli komunikovat pomocí Azure CLI.

   

4. Teď nasadíme manifest pomocí příkazu Azure CLI. Otevřete příkazový řádek pro vývojáře sady Visual Studio a přejděte do konfiguračního adresáře.

       cd config
   

5. Nasaďte manifest pro zařízení IoT Edge do IoT Hubu. Příkaz nakonfiguruje zařízení tak, aby používalo moduly vyvinuté ve vašem řešení. Manifest nasazení byl vytvořen v předchozím kroku a uložen ve složce konfigurace . Z konfigurační složky spusťte následující příkaz nasazení. Nahraďte hodnotu [device id]a [hub name][file path] nahraďte hodnotami. Pokud ID zařízení IoT Edge v IoT Hubu neexistuje, musí se vytvořit.

       az iot edge set-modules --device-id [device id] --hub-name [hub name] --content [file path]
   

   Váš příkaz může vypadat například takto:

   az iot edge set-modules --device-id my-device-name --hub-name my-iot-hub-name --content deployment.amd64.debug.json
   

6. Po spuštění příkazu se v JSON příkazovém řádku zobrazí potvrzení nasazení.

Image Dockeru pro sestavení modulu

Po vytvoření modulu můžete sestavit image modulu, která se uloží do registru kontejneru pro nasazení do zařízení IoT Edge.

Pomocí souboru Dockerfile modulu sestavte image Dockeru modulu.

docker build --rm -f "<DockerFilePath>" -t <ImageNameAndTag> "<ContextPath>" 

Předpokládejme například, že příkazové prostředí je v adresáři projektu a název vašeho modulu je IotEdgeModule1. Pokud chcete vytvořit image místního registru nebo registru kontejneru Azure, použijte následující příkazy:

# Build the image for the local registry

docker build --rm -f "./IotEdgeModule1/Dockerfile.amd64.debug" -t localhost:5000/iotedgemodule1:0.0.1-amd64 "./IotEdgeModule1"

# Or build the image for an Azure Container Registry

docker build --rm -f "./IotEdgeModule1/Dockerfile.amd64.debug" -t myacr.azurecr.io/iotedgemodule1:0.0.1-amd64 "./IotEdgeModule1"

Image Dockeru modulu push

Nasdílejte image modulu do místního registru nebo do registru kontejneru.

docker push <ImageName>

Příklad:

# Push the Docker image to the local registry

docker push localhost:5000/iotedgemodule1:0.0.1-amd64

# Or push the Docker image to an Azure Container Registry
az acr login --name myacr
docker push myacr.azurecr.io/iotedgemodule1:0.0.1-amd64

Nasaďte modul do zařízení IoT Edge.

V sadě Visual Studio otevřete v hlavním projektu soubor manifestu nasazení deployment.debug.template.json. Manifest nasazení je dokument JSON, který popisuje moduly, které se mají nakonfigurovat na cílovém zařízení IoT Edge. Před nasazením musíte aktualizovat přihlašovací údaje služby Azure Container Registry, image modulů a správné createOptions hodnoty. Další informace o hodnotách createOption najdete v tématu Konfigurace možností vytváření kontejnerů pro moduly IoT Edge.

1. Pokud k uložení image modulu používáte Službu Azure Container Registry, musíte do nastavení edgeAgent přidat přihlašovací údaje k deployment.debug.template.json. Příklad:

   "modulesContent": {
   "$edgeAgent": {
     "properties.desired": {
       "schemaVersion": "1.1",
       "runtime": {
         "type": "docker",
         "settings": {
           "minDockerVersion": "v1.25",
           "loggingOptions": "",
           "registryCredentials": {
             "myacr": {
               "username": "myacr",
               "password": "<your_acr_password>",
               "address": "myacr.azurecr.io"
             }
           }
         }
       },
   //...
   

2. Hodnotu vlastnosti image nahraďte názvem image modulu, který jste odeslali do registru. Pokud jste například odeslali image označenou myacr.azurecr.io/iotedgemodule1:0.0.1-amd64 pro vlastní modul IotEdgeModule1, nahraďte hodnotu vlastnosti image hodnotou značky.

3. Přidejte nebo nahraďte hodnotu createOptions řetězcovým obsahem pro každý systém a vlastní modul v šabloně nasazení.

   Například image IotEdgeModule1 a nastavení createOptions by se podobaly následujícímu:

   "IotEdgeModule1": {
   "version": "1.0.0",
   "type": "docker",
   "status": "running",
   "restartPolicy": "always",
   "settings": {
       "image": "myacr.azurecr.io/iotedgemodule1:0.0.1-amd64",
       "createOptions": "{\"HostConfig\":{\"PortBindings\":{\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}],\"443/tcp\":[{\"HostPort\":\"443\"}]}}}"
   }
   

K nasazení modulů do Azure IoT Hubu použijte příkaz set-modules Pro IoT Edge. Pokud chcete například nasadit moduly definované v souboru deployment.debug.amd64.json do ioT Hubu my-iot-hub pro zařízení IoT Edge my-device, použijte následující příkaz:

az iot edge set-modules --hub-name my-iot-hub --device-id my-device --content ./deployment.debug.template.json --login "HostName=my-iot-hub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=<SharedAccessKey>"