Verwenden von Visual Studio Code mit Secure Shell (SSH) auf einem Remotehost

Artikel
08/09/2023

Visual Studio Code kann mit dem Azure Sphere SDK verwendet werden, um Code auf einem Remotehost über Secure Shell (SSH) zu erstellen und zu debuggen. Zwei Szenarien werden unterstützt:

Code auf Remotecomputer und Gerät auf dem lokalen Computer.
Sowohl Code als auch Gerät auf dem Remotecomputer.

Ein drittes Szenario – Code auf dem lokalen Computer und gerät auf dem Remotecomputer – wird nicht unterstützt.

Einrichten des lokalen Computers

Laden Sie Visual Studio Code herunter, und installieren Sie es.
Installieren Sie das Azure Sphere SDK für Windows oder Linux.
Installieren Sie die Azure Sphere-Erweiterung, indem Sie im Bereich der Visual Studio Code-Erweiterung nach Azure Sphere suchen und auf Installieren klicken.

Tipp

Es gibt zwei Azure Sphere Erweiterungen, und bei der Installation einer dieser Erweiterungen werden beide installiert: Die Azure Sphere-Benutzeroberfläche für die Ui-Komponente und Azure Sphere für die Arbeitsbereichskomponente.
Installieren Sie die Remote-SSH-Erweiterung, indem Sie im Bereich der Visual Studio Code-Erweiterung nach Remote-SSH suchen und auf die Schaltfläche Installieren klicken.

Einrichten des Remotecomputers

Es wird dringend empfohlen, dass Sie Ihren Remotecomputer für die schlüsselbasierte Authentifizierung einrichten.
Installieren Sie das Azure Sphere SDK für Windows oder Linux.

Code auf dem Remotecomputer und gerät auf dem lokalen Computer

Verbinden Sie das Gerät über USB mit dem lokalen Computer.
Wenn auf dem Remotecomputer noch kein Projekt vorhanden ist, können Sie entweder das Beispielrepository klonen oder ein einzelnes Projekt aus dem Microsoft-Beispielbrowser abrufen.
Öffnen Sie Visual Studio Code lokal.
Nur zum ersten Mal: Öffnen Sie Visual Studio Code über Ansicht>Befehlspalette>Remote-SSH: Neuen SSH-Host hinzufügen, und geben Sie ssh-Hostinformationen ein, wenn Sie dazu aufgefordert werden. (Standardmäßig wird eine Datei mit dem Namen config in das SSH-Verzeichnis in Ihrem Basisverzeichnis geschrieben. Dies führt manchmal zu Berechtigungsproblemen, wenn Ihr lokaler Computer Windows ist. Möglicherweise möchten Sie die Datei in ein anderes Verzeichnis verschieben und den absoluten Pfad unter Dateieinstellungen>>Einstellungen>Erweiterungen>Remote - SSH: Konfigurationsdatei angeben.)

Herstellen einer Verbindung mit dem Remotecomputer

Stellen Sie eine Verbindung mit dem Remotecomputer her, indem Sie den Visual Studio Code-Befehl View>Command Palette>Remote-SSH: Connect to host (Shift+Ctrl+P) ausführen.
Installieren Sie die Azure Sphere-Erweiterungen auf dem Remotecomputer, indem Sie im Bereich der Visual Studio Code-Erweiterung nach Azure Sphere suchen und auf die Schaltfläche In SSH installieren: [Remotename] klicken. Möglicherweise müssen Sie Visual Studio Code neu starten und nach der Installation erneut eine Verbindung mit dem Remotecomputer herstellen.

Tipp

Um zu überprüfen, ob die Erweiterung auf dem Remotecomputer ordnungsgemäß installiert ist, deaktivieren Sie das Suchfeld im Erweiterungsbereich, und stellen Sie sicher, dass Azure Sphere Erweiterungen in der Ssh-Ansicht [Remotename] – INSTALLIERT angezeigt werden.
Öffnen Sie den Projektordner oder Arbeitsbereich mithilfe von Datei>Ordner öffnen oder Datei>öffnen Arbeitsbereich.

Erstellen, Bereitstellen auf lokalem Gerät und Debuggen

Drücken Sie F5, um das Projekt zu erstellen und zu debuggen. Wenn das Projekt noch nicht erstellt wurde oder dateien geändert wurden und eine Neuerstellung erforderlich ist, erstellt Visual Studio Code das Projekt, bevor das Debuggen gestartet wird.
Warten Sie einige Sekunden, bis Visual Studio Code die Anwendung erstellt, ein Imagepaket erstellt, auf dem Board bereitgestellt und im Debugmodus gestartet wird. Auf dem Weg werden status Updates im Bereich Ausgabe angezeigt.

Zunächst bestimmt CMake, ob die Anwendung erstellt werden muss. Wenn ja, verschiebt sich der Fokus auf das Ausgabefenster, in dem die Ausgabe von CMake/Build angezeigt wird.

Als Nächstes wird im Bereich Ausgabe das Ergebnis angezeigt, wenn das Imagepaket auf dem Gerät bereitgestellt wird. Schließlich erhält die Debugkonsole den Fokus und zeigt die Debuggerausgabe an.

Verwenden Sie den Visual Studio Code-Debugger , um Haltepunkte festzulegen, die Anwendung anzuhalten, zu überspringen, neu zu starten oder zu beenden.

Code und Gerät auf dem Remotecomputer

Verbinden Sie das Gerät über USB mit dem Remotecomputer.
Wenn auf dem Remotecomputer noch kein Projekt vorhanden ist, können Sie entweder das Beispielrepository klonen oder ein einzelnes Projekt aus dem Microsoft-Beispielbrowser abrufen.
Öffnen Sie Visual Studio Code lokal.
Nur zum ersten Mal: Öffnen Sie Visual Studio Code über Ansicht>Befehlspalette>Remote-SSH: Neuen SSH-Host hinzufügen, und geben Sie ssh-Hostinformationen ein, wenn Sie dazu aufgefordert werden. (Standardmäßig wird eine Datei mit dem Namen config in das SSH-Verzeichnis in Ihrem Basisverzeichnis geschrieben. Dies führt manchmal zu Berechtigungsproblemen, wenn Ihr lokaler Computer Windows ist. Möglicherweise möchten Sie die Datei in ein anderes Verzeichnis verschieben und den absoluten Pfad unter Dateieinstellungen>>Einstellungen>Erweiterungen>Remote - SSH: Konfigurationsdatei angeben.)

Herstellen einer Verbindung mit dem Remotecomputer und Konfigurieren von Remoteeinstellungen

Stellen Sie eine Verbindung mit dem Remotecomputer her, indem Sie den VS Code-Befehl View>Command Palette>Remote-SSH: Connect to host (Shift+Ctrl+P) ausführen.
Fügen Sie Remoteeinstellungen hinzu, indem Sie den VS Code-Befehl Ansicht>Befehlspaletteneinstellungen>: Remoteeinstellungen öffnen ausführen und dem JSON-Objekt das folgende Feld hinzufügen (wenn es sich um eine leere Datei handelt, müssen Sie dies in {}umschließen):
```
    "remote.extensionKind": {
        "ms-vscode.azure-sphere-tools-ui": [
            "workspace"
        ]
    }
```
Sie können diese Einstellung stattdessen den Benutzer-/Arbeitsbereichseinstellungen hinzufügen, abhängig von der Einrichtung Ihrer Projekte und Ihres Teams.
Installieren Sie die Azure Sphere-Erweiterungen auf dem Remotecomputer, indem Sie im Bereich der Visual Studio Code-Erweiterung nach Azure Sphere suchen und auf die Schaltfläche In SSH installieren: [Remotename] klicken. Möglicherweise müssen Sie Visual Studio Code neu starten und nach der Installation erneut eine Verbindung mit dem Remotecomputer herstellen.

Tipp

Um zu überprüfen, ob die Erweiterung auf dem Remotecomputer ordnungsgemäß installiert ist, deaktivieren Sie das Suchfeld im Erweiterungsbereich, und stellen Sie sicher, dass Azure Sphere Erweiterungen in der Ssh-Ansicht [Remotename] – INSTALLIERT angezeigt werden.
Öffnen Sie den Projektordner oder Arbeitsbereich mithilfe von Datei>Ordner öffnen oder Datei>öffnen Arbeitsbereich.

Erstellen, Bereitstellen auf Einem Remotegerät und Debuggen

Drücken Sie F5, um das Projekt zu erstellen und zu debuggen. Wenn das Projekt noch nicht erstellt wurde oder dateien geändert wurden und eine Neuerstellung erforderlich ist, erstellt Visual Studio Code das Projekt, bevor das Debuggen gestartet wird.
Warten Sie einige Sekunden, bis Visual Studio Code die Anwendung erstellt, ein Imagepaket erstellt, auf dem Board bereitgestellt und im Debugmodus gestartet wird. Auf dem Weg werden status Updates im Bereich Ausgabe angezeigt.

Zunächst bestimmt CMake, ob die Anwendung erstellt werden muss. Wenn ja, verschiebt sich der Fokus auf das Ausgabefenster, in dem die Ausgabe von CMake/Build angezeigt wird.

Als Nächstes wird im Bereich Ausgabe das Ergebnis angezeigt, wenn das Imagepaket auf dem Gerät bereitgestellt wird. Schließlich erhält die Debugkonsole den Fokus und zeigt die Debuggerausgabe an.