在远程主机上将 Visual Studio Code 与 Secure Shell 配合使用 (SSH)

Visual Studio Code可与 Azure Sphere SDK 配合使用,通过安全外壳 (SSH) 在远程主机上生成和调试代码。 支持两种方案:

  • 远程计算机上的代码和本地计算机上的设备上的设备。

  • 远程计算机上的代码和设备。

第三种方案(本地计算机上的代码和远程计算机上的设备上的设备)不受支持。

设置本地计算机

  1. 下载并安装 Visual Studio Code

  2. 安装 适用于 WindowsLinux 的 Azure Sphere SDK。

  3. 通过在“Visual Studio Code扩展”面板中搜索“Azure Sphere”并单击“安装”来安装 Azure Sphere 扩展。

    提示

    有两个 Azure Sphere 扩展,安装其中任一扩展将同时安装: 用于 UI 组件的 Azure Sphere UI 和用于工作区组件的 Azure Sphere

  4. 通过在“Visual Studio Code扩展”面板中搜索 Remote-SSH,然后单击“安装”按钮来安装 Remote-SSH 扩展。

设置远程计算机

  1. 强烈建议将 远程计算机设置为基于密钥的身份验证
  2. 安装 适用于 WindowsLinux 的 Azure Sphere SDK。

远程计算机上的代码和本地计算机上的设备上的代码

  1. 通过 USB 将设备连接到本地计算机。
  2. 如果远程计算机上还没有项目,则可以克隆 示例存储库 或从 Microsoft 示例浏览器获取单个项目。
  3. 在本地打开Visual Studio Code。
  4. 仅限第一次:从视图>命令面板>打开Visual Studio CodeRemote-SSH:添加新 SSH 主机,并按提示输入 SSH 主机信息。 (默认情况下,名为 config 的文件将写入主目录中的 .ssh 目录。如果本地计算机是 Windows,这有时会导致权限问题。你可能想要将文件移动到另一个目录,并在“文件>首选项>设置扩展>>远程 - SSH:配置文件”中指定绝对路径 )

连接到远程计算机

  1. 通过执行 Visual Studio Code 命令视图>命令面板>Remote-SSH:连接到主机 (Shift+Ctrl+P) 连接到远程计算机。

  2. 通过在“Visual Studio Code扩展”面板中搜索 Azure Sphere,然后单击“在 SSH 中安装:[远程名称]”按钮,将 Azure Sphere 扩展安装到远程计算机。 安装后,可能需要重启Visual Studio Code并重新连接到远程计算机。

    提示

    若要检查扩展是否已在远程计算机上正确安装,请清除扩展面板中的搜索框,并确保Azure Sphere扩展显示在 SSH:[远程名称] - 已安装视图中。

  3. 使用“文件打开文件夹”或“文件>>打开”工作区打开项目文件夹或工作区。

生成、部署到本地设备和调试

  1. 按 F5 生成和调试项目。 如果之前尚未生成项目,或者文件已更改且需要重新生成,Visual Studio Code将在调试开始之前生成项目。

  2. 等待几秒钟,让Visual Studio Code生成应用程序、创建映像包、将其部署到开发板,并在调试模式下启动它。 在此过程中,你将在“ 输出 ”窗格中看到状态更新。

    首先,CMake 确定是否需要生成应用程序。 如果是这样,焦点将转移到输出窗口,该窗口显示来自 CMake/Build 的输出。

    接下来,“ 输出 ”窗格会在映像包部署到设备时显示结果。 最后,调试控制台接收焦点并显示调试器输出。

使用 Visual Studio Code 调试器设置断点、暂停、单步执行、单步执行、重启或停止应用程序。

远程计算机上的代码和设备

  1. 通过 USB 将设备连接到远程计算机。
  2. 如果远程计算机上还没有项目,则可以克隆 示例存储库 或从 Microsoft 示例浏览器获取单个项目。
  3. 在本地打开Visual Studio Code。
  4. 仅限第一次:从视图>命令面板>打开Visual Studio CodeRemote-SSH:添加新 SSH 主机,并按提示输入 SSH 主机信息。 (默认情况下,名为 config 的文件将写入主目录中的 .ssh 目录。如果本地计算机是 Windows,这有时会导致权限问题。你可能想要将文件移动到另一个目录,并在“文件>首选项>设置扩展>>远程 - SSH:配置文件”中指定绝对路径 )

连接到远程计算机并配置远程设置

  1. 通过执行 VS Code 命令查看>命令面板>连接到远程计算机Remote-SSH:连接到主机 (Shift+Ctrl+P) 。

  2. 通过执行 VS Code 命令“查看>命令面板>首选项”添加远程设置:打开“远程设置”,并将以下字段添加到 JSON 对象 (如果它是空文件,则需要将其包装在) 中{}

        "remote.extensionKind": {
            "ms-vscode.azure-sphere-tools-ui": [
                "workspace"
            ]
        }
    

    可以改为将此设置添加到用户/工作区设置,具体取决于项目和团队的设置。

  3. 通过在“Visual Studio Code扩展”面板中搜索 Azure Sphere,然后单击“在 SSH 中安装:[远程名称]”按钮,将 Azure Sphere 扩展安装到远程计算机。 安装后,可能需要重启Visual Studio Code并重新连接到远程计算机。

    提示

    若要检查扩展是否已在远程计算机上正确安装,请清除扩展面板中的搜索框,并确保Azure Sphere扩展显示在 SSH:[远程名称] - 已安装视图中。

  4. 使用“文件打开文件夹”或“文件>打开工作区>打开项目文件夹工作区

生成、部署到远程设备和调试

  1. 按 F5 生成和调试项目。 如果之前尚未生成项目,或者文件已更改且需要重新生成,Visual Studio Code将在调试开始之前生成项目。

  2. 等待几秒钟,让Visual Studio Code生成应用程序、创建映像包、将其部署到开发板,并在调试模式下启动它。 在此过程中,你将在“ 输出 ”窗格中看到状态更新。

    首先,CMake 确定是否需要生成应用程序。 如果是这样,焦点将转移到输出窗口,该窗口显示来自 CMake/Build 的输出。

    接下来,“ 输出 ”窗格会在映像包部署到设备时显示结果。 最后,调试控制台接收焦点并显示调试器输出。

使用 Visual Studio Code 调试器设置断点、暂停、单步执行、单步执行、重启或停止应用程序。

关闭连接

若要结束远程调试会话,请选择“ 文件>关闭远程连接”。