リモート ホストでの Secure Shell (SSH) での Visual Studio Code の使用
重要
これは Azure Sphere (レガシ) のドキュメントです。 Azure Sphere (レガシ) は 2027 年 9 月 27 日に 再提供されておりユーザーは現時点で Azure Sphere (統合) に移行する必要があります。 TOC の上にある Version セレクターを使用して、Azure Sphere (統合) のドキュメントを表示します。
Visual Studio Code を Azure Sphere SDK と共に使用して、Secure Shell (SSH) 経由でリモート ホスト上でコードをビルドおよびデバッグできます。 次の 2 つのシナリオがサポートされています。
リモート コンピューター上のコードとローカル コンピューター上のデバイス。
リモート コンピューター上のコードとデバイスの両方。
3 つ目のシナリオ (リモート コンピューター上のローカル コンピューターとデバイス上のコード) はサポートされていません。
ローカル コンピューターを設定する
Visual Studio Code 拡張機能パネルで Azure Sphere を検索し、 Install をクリックして、Azure Sphere 拡張機能をインストールします。
ヒント
2 つの
Azure Sphere
拡張機能があり、いずれか 1 つをインストールすると、UI コンポーネントの Azure Sphere UI とワークスペース コンポーネントの Azure Sphere の両方がインストールされます。Visual Studio Code 拡張機能パネルで Remote-SSH を検索し、 Install ボタンをクリックして、リモート SSH 拡張機能をインストールします。
リモート コンピューターを設定する
- キーベースの認証 リモート コンピューターを設定することを強くお勧めします。
- Windows または Linux 用の Azure Sphere SDK をインストールします。
リモート コンピューター上のコードとローカル コンピューター上のデバイス
- USB 経由でデバイスをローカル コンピューターに接続します。
- リモート コンピューターにまだプロジェクトがない場合は、 サンプル リポジトリを複製するか microsoft Samples Browser Microsoft Samples Browser から 1 つのプロジェクトを取得できます。
- Visual Studio Code をローカルで開きます。
- 初回のみ: View>Command Palette>Remote-SSH: Add new SSH host から Visual Studio Code を開き、プロンプトに従って SSH ホスト情報を入力します。 (既定では、config という名前のファイルがホーム ディレクトリの .ssh ディレクトリに書き込まれます。ローカル コンピューターが Windows の場合、アクセス許可の問題が発生することがあります。ファイルを別のディレクトリに移動し、 File>Preferences>Settings>Extensions>Remote - SSH: Config File で絶対パスを指定できます。
リモート コンピューターに接続する
Visual Studio Code コマンド View>Command Palette>Remote-SSH: Connect to host (
Shift+Ctrl+P
) を実行して、リモート コンピューターに接続します。Visual Studio Code 拡張機能パネルで Azure Sphere を検索し、SSH で Install: [remote name] ボタンをクリックして、リモート コンピューターに Azure Sphere 拡張機能をインストールします。 Visual Studio Code を再起動し、インストール後にリモート コンピューターに再接続することが必要になる場合があります。
ヒント
拡張機能がリモート コンピューターに正しくインストールされているかどうかを確認するには、拡張機能パネルの検索ボックスをオフにし、
Azure Sphere
拡張機能が SSH: [リモート名] - INSTALLED ビューに表示されていることを確認します。File>Open Folder または File>Open workspace を使用して、プロジェクト フォルダーまたはワークスペースを開きます。
ビルド、ローカル デバイスへのデプロイ、デバッグ
F5 キーを押してプロジェクトをビルドおよびデバッグします。 プロジェクトが以前にビルドされていない場合、またはファイルが変更され、再構築が必要な場合、Visual Studio Code はデバッグを開始する前にプロジェクトをビルドします。
Visual Studio Code がアプリケーションをビルドし、イメージ パッケージを作成してボードにデプロイし、デバッグ モードで起動するまで数秒待ちます。 途中で Output ペインに状態の更新が表示されます。
まず、CMake は、アプリケーションをビルドする必要があるかどうかを判断します。 その場合は、フォーカスが出力ウィンドウに移動し、CMake/Build からの出力が表示されます。
次に、 Output ペインに、イメージ パッケージがデバイスに展開されるときに結果が表示されます。 最後に、デバッグ コンソールがフォーカスを受け取り、デバッガーの出力を表示します。
Visual Studio Code デバッガーを使用してブレークポイントの設定、一時停止、ステップ オーバー、ステップ イン、再起動、またはアプリケーションの停止を行います。
リモート コンピューター上のコードとデバイス
- USB 経由でデバイスをリモート コンピューターに接続します。
- リモート コンピューターにまだプロジェクトがない場合は、 サンプル リポジトリを複製するか microsoft Samples Browser Microsoft Samples Browser から 1 つのプロジェクトを取得できます。
- Visual Studio Code をローカルで開きます。
- 初回のみ: View>Command Palette>Remote-SSH: Add new SSH host から Visual Studio Code を開き、プロンプトに従って SSH ホスト情報を入力します。 (既定では、config という名前のファイルがホーム ディレクトリの .ssh ディレクトリに書き込まれます。ローカル コンピューターが Windows の場合、アクセス許可の問題が発生することがあります。ファイルを別のディレクトリに移動し、 File>Preferences>Settings>Extensions>Remote - SSH: Config File で絶対パスを指定できます。
リモート コンピューターに接続し、リモート設定を構成する
VS Code コマンド View>Command Palette>Remote-SSH: connect to host (
Shift+Ctrl+P
) を実行してリモート コンピューターに接続します。VS Code コマンド View>Command Palette>Preferences: Open Remote Settings を実行してリモート設定を追加し、JSON オブジェクトに次のフィールドを追加します (空のファイルの場合は、これを
{}
でラップする必要があります)。"remote.extensionKind": { "ms-vscode.azure-sphere-tools-ui": [ "workspace" ] }
プロジェクトとチームの設定に応じて、代わりにこの設定をユーザー/ワークスペース設定に追加できます。
Visual Studio Code 拡張機能パネルで Azure Sphere を検索し、SSH で Install: [remote name] ボタンをクリックして、リモート コンピューターに Azure Sphere 拡張機能をインストールします。 Visual Studio Code を再起動し、インストール後にリモート コンピューターに再接続することが必要になる場合があります。
ヒント
拡張機能がリモート コンピューターに正しくインストールされているかどうかを確認するには、拡張機能パネルの検索ボックスをオフにし、
Azure Sphere
拡張機能が SSH: [リモート名] - INSTALLED ビューに表示されていることを確認します。File>Open Folder または File>Open workspace' を使用して、プロジェクト フォルダーまたはワークスペースを開きます。
ビルド、リモート デバイスへのデプロイ、デバッグ
F5 キーを押してプロジェクトをビルドおよびデバッグします。 プロジェクトが以前にビルドされていない場合、またはファイルが変更され、再構築が必要な場合、Visual Studio Code はデバッグを開始する前にプロジェクトをビルドします。
Visual Studio Code がアプリケーションをビルドし、イメージ パッケージを作成してボードにデプロイし、デバッグ モードで起動するまで数秒待ちます。 途中で Output ペインに状態の更新が表示されます。
まず、CMake は、アプリケーションをビルドする必要があるかどうかを判断します。 その場合は、フォーカスが出力ウィンドウに移動し、CMake/Build からの出力が表示されます。
次に、 Output ペインに、イメージ パッケージがデバイスに展開されるときに結果が表示されます。 最後に、デバッグ コンソールがフォーカスを受け取り、デバッガーの出力を表示します。
Visual Studio Code デバッガーを使用してブレークポイントの設定、一時停止、ステップ オーバー、ステップ イン、再起動、またはアプリケーションの停止を行います。
接続を閉じる
リモート デバッグ セッションを終了するには、 File>Close Remote Connection を選択します。