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

Article
11/05/2024

Important

Il s’agit de la documentation Azure Sphere (héritée). Azure Sphere (hérité) prend sa retraite le 27 septembre 2027 et les utilisateurs doivent migrer vers Azure Sphere (intégré) pour l’instant. Utilisez le sélecteur de version situé au-dessus du TOC pour afficher la documentation Azure Sphere (intégrée).

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 l’appareil sur l’ordinateur local.
Code et appareil sur l’ordinateur distant.

Un troisième scénario ( 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 d’extension Visual Studio Code, puis en cliquant sur Installer.

Conseil

Il existe deux Azure Sphere extensions et l’une d’entre elles installe 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 d’extension Visual Studio Code, puis en cliquant sur le bouton Installer .

Configurer l’ordinateur distant

Nous vous recommandons vivement de configurer votre ordinateur distant pour l’authentification basée sur des clés.
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 via USB à l’ordinateur local.
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 de Microsoft Samples Browser.
Ouvrez Visual Studio Code localement.
Première fois uniquement : Ouvrez Visual Studio Code à partir de la palette>de commandes View>Remote-SSH : Ajoutez un nouvel hôte SSH et entrez les informations de l’hôte SSH comme indiqué. (Par défaut, un fichier nommé config est écrit dans le répertoire .ssh dans votre répertoire de base. Cela provoque parfois des problèmes d’autorisations si votre ordinateur local est Windows. Vous pouvez déplacer le fichier vers un autre répertoire et spécifier le chemin absolu dans les extensions>de paramètres de préférences>>de fichier>à distance - SSH : Fichier config.)

Se connecter à l’ordinateur distant

Connectez-vous à l’ordinateur distant en exécutant la palette>de commandes d’affichage>de commandes Visual Studio Code 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 d’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.

Conseil

Pour vérifier si l’extension est installée correctement sur l’ordinateur distant, désactivez la zone de recherche dans le panneau d’extension et vérifiez que les Azure Sphere extensions apparaissent dans la vue SSH : [nom distant] - Vue INSTALLÉE .
Ouvrez le dossier ou l’espace de travail du projet à l’aide >d’un dossier ouvert de fichiers ou d’un espace de travail 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é créé précédemment ou si les fichiers ont changé et regénéré sont requis, Visual Studio Code génère le projet avant le démarrage du débogage.
Attendez plusieurs secondes pour que Visual Studio Code génère l’application, créez un package d’images, déployez-le sur la carte et démarrez-le en mode débogage. Vous verrez les mises à jour d’état dans le volet Sortie le long du chemin.

Tout d’abord, CMake détermine si l’application doit être générée. Si c’est le cas, le focus passe à 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, redémarrer ou arrêter l’application.

Code et appareil sur l’ordinateur distant

Connectez l’appareil via USB à l’ordinateur distant.
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 de Microsoft Samples Browser.
Ouvrez Visual Studio Code localement.
Première fois uniquement : Ouvrez Visual Studio Code à partir de la palette>de commandes View>Remote-SSH : Ajoutez un nouvel hôte SSH et entrez les informations de l’hôte SSH comme indiqué. (Par défaut, un fichier nommé config est écrit dans le répertoire .ssh dans votre répertoire de base. Cela provoque parfois des problèmes d’autorisations si votre ordinateur local est Windows. Vous pouvez déplacer le fichier vers un autre répertoire et spécifier le chemin absolu dans les extensions>de paramètres de préférences>>de fichier>à distance - SSH : Fichier config.)

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

Connectez-vous à l’ordinateur distant en exécutant vs Code command View>Command Palette>Remote-SSH : Se connecter à l’hôte ().Shift+Ctrl+P
Ajoutez des paramètres distants en exécutant les préférences de palette de commandes>de vue>de commande VS Code : Ouvrez les paramètres distants et ajoutez le champ suivant à l’objet JSON (s’il s’agit d’un fichier vide, vous devez encapsuler ceci{}) :
```
    "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 d’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.

Conseil

Pour vérifier si l’extension est installée correctement sur l’ordinateur distant, désactivez la zone de recherche dans le panneau d’extension et vérifiez que les Azure Sphere extensions apparaissent dans la vue SSH : [nom distant] - Vue INSTALLÉE .
Ouvrez le dossier ou l’espace de travail du projet à l’aide >d’un dossier ouvert de fichiers ou d’un espace de travail Ouvrir 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é créé précédemment ou si les fichiers ont changé et regénéré sont requis, Visual Studio Code génère le projet avant le démarrage du débogage.
Attendez plusieurs secondes pour que Visual Studio Code génère l’application, créez un package d’images, déployez-le sur la carte et démarrez-le en mode débogage. Vous verrez les mises à jour d’état dans le volet Sortie le long du chemin.

Tout d’abord, CMake détermine si l’application doit être générée. Si c’est le cas, le focus passe à 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, redémarrer ou arrêter l’application.

Fermer la connexion

Pour mettre fin à une session de débogage à distance, sélectionnez >Fermeture de fichier à distance.

Partager via