Utilisation de Visual Studio Code avec Secure Shell (SSH) sur un hôte distant

2023-08-09

Visual Studio Code peut être utilisé avec le Kit de développement logiciel (SDK) Azure Sphere pour générer et déboguer du code sur un hôte distant via Secure Shell (SSH). Deux scénarios sont pris en charge :

Code sur l’ordinateur distant et appareil sur l’ordinateur local.
Code et appareil sur l’ordinateur distant.

Un troisième scénario , le code sur l’ordinateur local et l’appareil sur l’ordinateur distant, n’est pas pris en charge.

Configurer l’ordinateur local

Téléchargez et installez Visual Studio Code.
Installez le Kit de développement logiciel (SDK) Azure Sphere pour Windows ou Linux.
Installez l’extension Azure Sphere en recherchant Azure Sphere dans le panneau de l’extension Visual Studio Code et en cliquant sur Installer.

Pointe

Il existe deux Azure Sphere extensions, et l’installation de l’une d’entre elles installera les deux : l’interface utilisateur Azure Sphere pour le composant d’interface utilisateur et Azure Sphere pour le composant d’espace de travail.
Installez l’extension Remote-SSH en recherchant Remote-SSH dans le panneau de l’extension Visual Studio Code et en cliquant sur le bouton Installer .

Configurer l’ordinateur distant

Nous vous recommandons vivement de configurer votre machine distante pour l’authentification par clé.
Installez le Kit de développement logiciel (SDK) Azure Sphere pour Windows ou Linux.

Code sur l’ordinateur distant et l’appareil sur l’ordinateur local

Connectez l’appareil à l’ordinateur local et, si l’ordinateur local exécute Linux, exécutez le script azsphere_connect.sh.
S’il n’existe pas encore de projet sur l’ordinateur distant, vous pouvez cloner le référentiel d’exemples ou obtenir un seul projet à partir du Navigateur d’exemples Microsoft.
Ouvrez Visual Studio Code localement.
Première fois uniquement : Ouvrez Visual Studio Code à partir de La palette > decommandesAfficher>remote-SSH : ajoutez un nouvel hôte SSH et entrez les informations sur l’hôte SSH comme vous y êtes invité. (Par défaut, un fichier nommé config est écrit dans le répertoire .ssh de votre répertoire de base. Cela entraîne parfois des problèmes d’autorisations si votre ordinateur local est Windows. Vous souhaiterez peut-être déplacer le fichier vers un autre répertoire et spécifier le chemin absolu dansPréférences> de fichier>Paramètres>Extensions>distantes - SSH : Fichier de configuration.)

Se connecter à l’ordinateur distant

Connectez-vous à l’ordinateur distant en exécutant la commande Visual Studio Code Afficher> lapalette de commandes>Remote-SSH : Se connecter à l’hôte (Shift+Ctrl+P).
Installez les extensions Azure Sphere sur la machine distante en recherchant Azure Sphere dans le panneau de l’extension Visual Studio Code et en cliquant sur le bouton Installer dans SSH : [nom distant]. Vous devrez peut-être redémarrer Visual Studio Code et vous reconnecter à l’ordinateur distant après l’installation.

Pointe

Pour case activée si l’extension est installée correctement sur l’ordinateur distant, désactivez la zone de recherche dans le panneau d’extension et assurez-vous que Azure Sphere les extensions apparaissent dans la vue SSH : [nom distant] - INSTALLÉ.
Ouvrez le dossier ou l’espace de travail du projet à l’aide de l’espace> de travailOuvrir un dossier ou Ouvrir un fichier>.

Générer, déployer sur un appareil local et déboguer

Appuyez sur F5 pour générer et déboguer le projet. Si le projet n’a pas été généré précédemment, ou si les fichiers ont changé et qu’une reconstruction est nécessaire, Visual Studio Code génère le projet avant le démarrage du débogage.
Attendez plusieurs secondes que Visual Studio Code génère l’application, crée un package d’image, le déploie sur la carte et le démarre en mode débogage. Vous verrez status mises à jour dans le volet Sortie en cours de route.

Tout d’abord, CMake détermine si l’application doit être générée. Si c’est le cas, le focus se déplace sur la fenêtre de sortie, qui affiche la sortie de CMake/Build.

Ensuite, le volet Sortie affiche le résultat à mesure que le package d’image est déployé sur l’appareil. Enfin, la console de débogage reçoit le focus et affiche la sortie du débogueur.

Utilisez le débogueur Visual Studio Code pour définir des points d’arrêt, suspendre, effectuer un pas à pas, effectuer un pas à pas détaillé, redémarrer ou arrêter l’application.

Code et appareil sur l’ordinateur distant

Connectez l’appareil via USB à l’ordinateur distant et, si l’ordinateur distant exécute Linux, exécutez le script azsphere_connect.sh.
S’il n’existe pas encore de projet sur l’ordinateur distant, vous pouvez cloner le référentiel d’exemples ou obtenir un seul projet à partir du Navigateur d’exemples Microsoft.
Ouvrez Visual Studio Code localement.
Première fois uniquement : Ouvrez Visual Studio Code à partir de La palette > decommandesAfficher>remote-SSH : ajoutez un nouvel hôte SSH et entrez les informations sur l’hôte SSH comme vous y êtes invité. (Par défaut, un fichier nommé config est écrit dans le répertoire .ssh de votre répertoire de base. Cela entraîne parfois des problèmes d’autorisations si votre ordinateur local est Windows. Vous souhaiterez peut-être déplacer le fichier vers un autre répertoire et spécifier le chemin absolu dansPréférences> de fichier>Paramètres>Extensions>distantes - SSH : Fichier de configuration.)

Se connecter à l’ordinateur distant et configurer les paramètres distants

Connectez-vous à l’ordinateur distant en exécutant la commande VS Code Afficher>la palette> decommandes Remote-SSH : Se connecter à l’hôte (Shift+Ctrl+P).
Ajoutez des paramètres distants en exécutant la commande VS Code Afficher> les préférences depalette> decommandes : Ouvrez les paramètres distants et ajoutez le champ suivant à l’objet JSON (s’il s’agit d’un fichier vide, vous devez l’inclure dans {}un wrapper) :
```
    "remote.extensionKind": {
        "ms-vscode.azure-sphere-tools-ui": [
            "workspace"
        ]
    }
```
Vous pouvez ajouter ce paramètre aux paramètres utilisateur/espace de travail à la place, en fonction de la configuration de vos projets et de votre équipe.
Installez les extensions Azure Sphere sur la machine distante en recherchant Azure Sphere dans le panneau de l’extension Visual Studio Code et en cliquant sur le bouton Installer dans SSH : [nom distant]. Vous devrez peut-être redémarrer Visual Studio Code et vous reconnecter à l’ordinateur distant après l’installation.

Pointe

Pour case activée si l’extension est installée correctement sur l’ordinateur distant, désactivez la zone de recherche dans le panneau d’extension et assurez-vous que Azure Sphere les extensions apparaissent dans la vue SSH : [nom distant] - INSTALLÉ.
Ouvrez le dossier du projet ou l’espace de travail à l’aide de l’espace> de travailOuvrir un dossier ouOuvrir un fichier>.

Générer, déployer sur un appareil distant et déboguer

Appuyez sur F5 pour générer et déboguer le projet. Si le projet n’a pas été généré précédemment, ou si les fichiers ont changé et qu’une reconstruction est nécessaire, Visual Studio Code génère le projet avant le démarrage du débogage.
Attendez plusieurs secondes que Visual Studio Code génère l’application, crée un package d’image, le déploie sur la carte et le démarre en mode débogage. Vous verrez status mises à jour dans le volet Sortie en cours de route.

Tout d’abord, CMake détermine si l’application doit être générée. Si c’est le cas, le focus se déplace sur la fenêtre de sortie, qui affiche la sortie de CMake/Build.

Ensuite, le volet Sortie affiche le résultat à mesure que le package d’image est déployé sur l’appareil. Enfin, la console de débogage reçoit le focus et affiche la sortie du débogueur.

Utilisez le débogueur Visual Studio Code pour définir des points d’arrêt, suspendre, effectuer un pas à pas, effectuer un pas à pas détaillé, redémarrer ou arrêter l’application.

Fermer la connexion

Pour mettre fin à une session de débogage à distance, sélectionnez Fichier>Fermer la connexion à distance.