Использование Visual Studio 2022 для разработки и отладки модулей для Azure IoT Edge

1. В обозревателе решений щелкните правой кнопкой мыши имя основного проекта, а затем выберите "Задать версию среды выполнения IoT Edge".

   

2. Используйте раскрывающееся меню, чтобы выбрать версию среды выполнения, под управлением которой работают ваши устройства IoT Edge, а затем нажмите кнопку OK, чтобы сохранить изменения. Если изменения не были сделаны, нажмите кнопку "Отмена ", чтобы выйти.

   Расширение не включает выбор для последних версий среды выполнения. Чтобы задать версию среды выполнения выше 1.2, откройте файл манифеста развертывания deployment.debug.template.json . Измените версию среды выполнения для образов модулей среды выполнения системы edgeAgent и edgeHub. Например, чтобы использовать среду выполнения IoT Edge версии 1.5, измените следующие строки в файле манифеста развертывания:

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

3. Если вы изменили версию, повторно создайте манифест развертывания, щелкнув правой кнопкой мыши имя проекта, а затем выберите "Создать развертывание для IoT Edge". Это создает манифест развертывания на основе шаблона развертывания и помещает его в папку конфигурации проекта Visual Studio.

1. Откройте файл манифеста развертывания deployment.debug.template.json . Манифест развертывания — это документ JSON, описывающий модули для настройки на целевом устройстве IoT Edge.

2. Измените версию среды выполнения для образов модулей среды выполнения системы edgeAgent и edgeHub. Например, чтобы использовать среду выполнения IoT Edge версии 1.5, измените следующие строки в файле манифеста развертывания:

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

Отладка с помощью симулятора

Средство разработки Azure IoT EdgeHub предоставляет локальную разработку и отладку. Средство позволяет запускать модули IoT Edge без среды выполнения IoT Edge для локального создания, разработки, тестирования, запуска и отладки модулей IoT Edge и решений. Нет необходимости отправлять образы в реестр контейнеров и развертывать их на устройстве для тестирования.

Подробнее см. в статье Средство разработки Azure IoT EdgeHub.

Чтобы инициализировать средство в Visual Studio, выполните следующие действия.

1. Получите строка подключения устройства IoT Edge (найденного в Центр Интернета вещей) из портал Azure или из Azure CLI.

   При использовании интерфейса командной строки для получения строка подключения используйте эту команду, заменив "[device_id]" и "[hub_name]" собственными значениями:

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

2. В меню "Сервис" в Visual Studio выберите Azure IoT Edge Tools>Setup IoT Edge Simulator.

3. Вставьте строка подключения и нажмите кнопку "ОК".

Создание и отладка одного модуля

Как правило, необходимо протестировать и отладить каждый модуль перед запуском в целом решении с несколькими модулями. Средство симулятора IoT Edge позволяет запускать один модуль в изоляции отправки сообщений через порт 53000.

1. В Обозреватель решений выберите и выделите папку проекта модуля (например, IotEdgeModule1). Задайте пользовательский модуль в качестве запускаемого проекта. Выберите "Набор проектов" в качестве начального проекта> в меню.

2. Нажмите клавишу F5 или нажмите кнопку запуска панели инструментов, чтобы запустить симулятор IoT Edge для одного модуля. Изначально может потребоваться от 10 до 20 секунд.

   

3. Появится окно консольного приложения .NET Core, если модуль успешно инициализирован.

4. Задайте точку останова для проверки модуля.

   • При разработке в C#задайте точку останова PipeMessage() в функции в ModuleBackgroundService.cs.
   • Если для разработки используется C, задайте точку остановка в функции InputQueue1Callback() в файле main.c.

5. Проверьте модуль, отправив сообщение. При отладке одного модуля симулятор прослушивает порт 53000 по умолчанию для сообщений. Чтобы отправить сообщение в модуль, выполните следующую команду curl из командной оболочки, например Git Bash или WSL Bash.

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

   Если вы получаете ошибку , не совпадающую с закрывающей скобкой или скобкой в URL-адресе, попробуйте выполнить следующую команду:

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

   

   Точка останова должна быть активирована. Переменные можно просмотреть в окне "Локальные параметры Visual Studio " при запуске отладчика. Перейдите к разделу Отладка>локальных параметров Windows.>

   В оболочке или Bash появится {"message":"accepted"} подтверждение.

   В консоли .NET вы увидите следующее:

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

6. Нажмите клавиши CTRL+F5 или выберите кнопку "Остановить", чтобы остановить отладку.

Создание и отладка нескольких модулей

После разработки единого модуля далее вы можете запустить и отладить все решение с несколькими модулями. Средство симулятора IoT Edge позволяет запускать все модули, определенные в манифесте развертывания, включая имитированный edgeHub для маршрутизации сообщений. В этом примере выполняется два пользовательских модуля и имитированный модуль датчика температуры. Сообщения из модуля имитированного датчика температуры направляются в каждый пользовательский модуль.

1. В Обозреватель решений добавьте второй модуль в решение, щелкнув правой кнопкой мыши папку основного проекта. В меню выберите Добавить>Новый модуль IoT Edge.

   

2. Add module В окне присвойте новому модулю имя и замените localhost:5000 часть URL-адреса репозитория вашим Реестр контейнеров Azure сервером входа, как и раньше.

3. Откройте файл deployment.debug.template.json , чтобы увидеть, что новый модуль добавлен в раздел модулей . Новый маршрут также был добавлен в раздел маршрутов для EdgeHub отправки сообщений из нового модуля в Центр Интернета вещей. Чтобы отправить данные из имитированного датчика температуры в новый модуль, добавьте другой маршрут со следующей строкой JSON. Замените <NewModuleName> (в двух местах) собственным именем модуля.

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

4. Щелкните правой кнопкой мыши основной проект (например, AzureIotEdgeApp1) и выберите "Задать в качестве проекта запуска". Задав основной проект в качестве запускаемого проекта, все модули в запуске решения. Сюда входят оба модуля, добавленные в решение, модуль имитированного датчика температуры и имитированный концентратор Edge.

5. Нажмите клавишу F5 или нажмите кнопку "Запустить панель инструментов", чтобы запустить решение. Изначально может потребоваться от 10 до 20 секунд. Убедитесь, что у вас нет других контейнеров Docker, которые могут привязать порт, необходимый для этого проекта.

6. Для каждого модуля должно появиться два окна консольного приложения .NET Core.

7. Установите точку останова для проверки модулей.

   • При разработке в C#задайте точку останова PipeMessage() в функции в ModuleBackgroundService.cs.
   • Если для разработки используется C, задайте точку остановка в функции InputQueue1Callback() в файле main.c.

8. Создайте точки останова в каждом модуле, а затем нажмите клавишу F5 для одновременного запуска и отладки нескольких модулей. Вы увидите несколько окон консольного приложения .NET Core с каждым окном, представляющим другой модуль.

   

9. Нажмите клавиши CTRL+F5 или выберите кнопку "Остановить", чтобы остановить отладку.

Создание и отправка образов в реестр

После разработки и отладки модуля создайте и отправьте образ модуля в реестр контейнеров Azure. Затем разверните модуль на устройстве IoT Edge.

1. Задайте основной проект IoT Edge в качестве начального проекта, а не одного из отдельных модулей.

2. Выберите конфигурацию Отладка или Выпуск, которая будет применяться для образов модуля.

   Примечание.

   При выборе Отладка Visual Studio использует Dockerfile.(amd64|windows-amd64).debug для создания образов Docker. В образе контейнера включен отладчик командной строки .NET Core VSDBG. Для модулей IoT Edge, готовых к эксплуатации, используйте конфигурацию выпуска, которая использует Dockerfile.(amd64|windows-amd64) без VSDBG.

3. Если вы используете частный реестр, например Реестр контейнеров Azure (ACR), используйте следующую команду Docker для входа. Получите имя пользователя и пароль на странице ключей доступа реестра на портале Azure.

   docker login <ACR login server>
   

4. Добавьте сведения о входе в реестр контейнеров Azure в параметры среды выполнения в deployment.debug.template.json файле. Вы можете добавить учетные данные реестра в .env файл (наиболее безопасный) или добавить их непосредственно в deployment.debug.template.json файл.

   Добавьте учетные данные в .env файл:

   В Обозреватель решений нажмите кнопку "Показать все файлы". Появится .env файл. Добавьте в файл Реестр контейнеров Azure имя пользователя и пароль.env. Найдите эти учетные данные на странице "Ключи доступа " реестра контейнеров Azure на портале Azure.

   

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

   Добавление учетных данных непосредственно в deployment.debug.template.json

   Если вы хотите добавить учетные данные непосредственно в шаблон развертывания, замените заполнители именем администратора ACR, паролем и именем реестра.

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

   Примечание.

   При работе с этой статьей используются учетные данные администратора для Реестра контейнеров Azure, что удобно для сценариев разработки и тестирования. Но после перехода в рабочую среду рекомендуется использовать для проверки подлинности вариант с минимальными правами, например субъект-службу. Дополнительные сведения см. в разделе Управление доступом к реестру контейнеров.

5. Если вы используете локальный реестр, запустите локальный реестр.

6. Наконец, в Обозреватель решений щелкните правой кнопкой мыши главную папку проекта и выберите "Сборка и отправка модулей IoT Edge", чтобы создать и отправить образ Docker для каждого модуля. Это может занять минуту. Когда вы увидите Finished Build and Push IoT Edge Modules. в консоли вывода Visual Studio, все готово.

Развертывание решения

Теперь, когда вы создали и направили образы модулей в реестр контейнеров Azure, разверните решение на устройстве IoT Edge. В этом руководстве уже есть шаблон манифеста развертывания. Создайте манифест развертывания из него, а затем используйте команду Azure CLI для развертывания модулей на устройстве IoT Edge в Azure.

1. Щелкните правой кнопкой мыши основной проект в Visual Studio Обозреватель решений и выберите "Создать развертывание для IoT Edge".

   

2. Перейдите в локальную папку основного проекта Visual Studio и просмотрите config ее. Путь к файлу может выглядеть следующим образом: C:\Users\<YOUR-USER-NAME>\source\repos\<YOUR-IOT-EDGE-PROJECT-NAME>\config Здесь вы найдете созданный манифест развертывания, например deployment.amd64.debug.json.

3. deployment.amd64.debug.json Откройте файл и убедитесь, edgeHub что версия схемы установлена на 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
          }
        }
      }
   

   Совет

   Шаблон развертывания для Visual Studio 2022 требует версии схемы 1.2. Если вам нужно, чтобы оно было 1.1 или 1.0, дождитесь, пока развертывание не будет создано (не изменяйте его в deployment.debug.template.json). Создание развертывания по умолчанию создает схему 1.2. Однако вы можете вручную изменить deployment.amd64.debug.jsonсозданный манифест перед развертыванием в Azure.

   Внимание

   После развертывания устройства IoT Edge он в настоящее время не отображается на портале Azure с схемой 1.2 (версия 1.1 является нормальной). Однако это не повлияет на устройство, так как оно по-прежнему подключено в Центре Интернета вещей и может взаимодействовать с ним в любое время с помощью Azure CLI.

   

4. Теперь давайте развернем наш манифест с помощью команды Azure CLI. Откройте командную строку разработчика Visual Studio и перейдите в каталог конфигурации.

       cd config
   

5. Разверните манифест для устройства IoT Edge, чтобы Центр Интернета вещей. Команда настраивает устройство для использования модулей, разработанных в решении. Манифест развертывания был создан на предыдущем шаге и сохранен в папке конфигурации . В папке конфигурации выполните следующую команду развертывания. Замените [device id]значения , [hub name]а также [file path] значениями. Если идентификатор устройства IoT Edge не существует в Центр Интернета вещей, его необходимо создать.

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

   Например, команда может выглядеть следующим образом:

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

6. После выполнения команды в командной строке появится подтверждение развертывания, напечатанного в ФОРМАТЕ JSON.

Образ Docker модуля сборки

После разработки модуля создайте образ модуля для хранения в реестре контейнеров для развертывания на устройстве IoT Edge.

Используйте Dockerfile модуля для создания образа Docker модуля.

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

Например, если командная оболочка находится в каталоге проекта, а имя модуля — IotEdgeModule1, используйте следующие команды, чтобы создать образ для локального реестра или реестра контейнеров Azure:

# 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"

Образ Docker модуля push

Отправьте образ модуля в локальный реестр или реестр контейнеров.

docker push <ImageName>

Например:

# 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

Разверните модуль на устройстве IoT Edge.

В Visual Studio откройте файл манифеста развертывания deployment.debug.template.json в основном проекте. Манифест развертывания — это документ JSON, описывающий модули для настройки на целевом устройстве IoT Edge. Перед развертыванием необходимо обновить учетные данные Реестр контейнеров Azure, образы модулей и соответствующие createOptions значения. Дополнительные сведения о значениях createOption см. в разделе "Настройка параметров создания контейнера для модулей IoT Edge".

1. Если вы используете Реестр контейнеров Azure для хранения образа модуля, необходимо добавить учетные данные в deployment.debug.template.json в параметры edgeAgent. Например,

   "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. Замените значение свойства изображения именем образа модуля, отправленного в реестр. Например, если вы принудили изображение, помеченное myacr.azurecr.io/iotedgemodule1:0.0.1-amd64 для пользовательского модуля IotEdgeModule1, замените значение свойства изображения значением тега.

3. Добавьте или замените значение createOptions строковым содержимым для каждого системного и пользовательского модуля в шаблоне развертывания.

   Например, образ IotEdgeModule1 и параметры createOptions будут похожи на следующие:

   "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\"}]}}}"
   }
   

Используйте команду набора модулей Azure CLI IoT Edge для развертывания модулей в Центре Интернета вещей Azure. Например, чтобы развернуть модули, определенные в файлеdeployment.debug.amd64.json, в IoT Hub my-iot-hub для устройства IoT Edge my-device, выполните следующую команду:

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>"