Configurez PlatformIO dans VS Code pour compiler et téléverser le micrologiciel OSSM de manière fiable
OSSM est développé avec PlatformIO dans VS Code. Si vous venez de l'IDE Arduino, la transition peut sembler peu familière au premier abord, mais vous obtiendrez des compilations plus rapides, une meilleure gestion des dépendances et une configuration cohérente pour tous les contributeurs.
PlatformIO gère les bibliothèques, les chaînes d'outils et les environnements de compilation pour vous. Les versions antérieures d'OSSM pouvaient être adaptées à Arduino, mais le projet a dépassé cette approche. Apprendre à utiliser PlatformIO prend moins de temps que de réadapter OSSM pour Arduino à chaque version.
Pourquoi PlatformIO ?
- Plus de temps pour les fonctionnalités – moins de temps à gérer les dépendances
- Collaboration plus facile : environnement de développement cohérent pour chaque contributeur
- Résolution automatique des dépendances : bibliothèques récupérées et épinglées pour des compilations reproductibles
- Intelligence du code : saisie semi-automatique, linting et détection d'erreurs en ligne
Conditions préalables
- VS Code installé
- Câble de données USB pour votre carte (les câbles réservés à la charge ne permettent pas le téléversement)
- Pilotes de carte installés si votre système d'exploitation l'exige (par exemple, CP210x ou CH340)
La carte OSSM de référence utilise un module de développement Espressif ESP32 Dev Module intégré.
Installation
Installer VS Code et PlatformIO
Installez VS Code, puis ajoutez l'extension "PlatformIO IDE" à partir de VS Code Marketplace. Après l'installation, redémarrez VS Code pour activer PlatformIO.
Vous devriez voir l'icône PlatformIO à tête extraterrestre dans l'Activity Bar à gauche.
Ouvrir PlatformIO Home
Cliquez sur l'icône PlatformIO pour ouvrir PlatformIO Home.
Ouvrez le projet OSSM
Depuis PlatformIO Home, sélectionnez "Open Project" et choisissez le dossier OSSM qui contient platformio.ini (minuscules).
L'Explorer doit afficher platformio.ini, un dossier src/ et un dossier lib/.
Sélectionnez le bon environnement (le cas échéant)
Si le projet définit plusieurs environnements dans platformio.ini (par exemple, différentes cartes ou options de compilation), utilisez le sélecteur d'environnement dans la VS Code Status Bar (généralement étiqueté avec l'environnement actif) pour choisir celui qui correspond à votre carte.
S'il n'y a qu'un seul environnement, PlatformIO le sélectionne automatiquement.
Ouvrez le point d'entrée du micrologiciel
Ouvrez src/main.cpp pour vérifier la source du micrologiciel.
Compiler et téléverser le micrologiciel
Utilisez l'icône ✓ (Build) pour compiler et l'icône → (Upload) pour flasher la carte. Ces contrôles se trouvent dans la Status Bar en bas de VS Code.
- Effectuez d'abord une compilation pour détecter les erreurs localement, ou téléversez directement pour compiler et flasher en une seule étape.
- Assurez-vous que votre carte est connectée et que le port série correct est sélectionné.
Une compilation réussie se termine par SUCCESS dans le terminal. Un téléversement réussi affiche Hash of data verified ou une confirmation similaire de l'outil de téléversement ESP32.
Tâches courantes
- Sélectionner le port série : PlatformIO → Quick Access → "Select Serial Port".
- Surveiller la sortie série : cliquez sur l'icône de prise (Monitor) dans la Status Bar ou exécutez
PlatformIO: Monitorà partir de la Command Palette. - Nettoyer la compilation : exécutez
PlatformIO: Cleanpour supprimer les artefacts compilés avant de reconstruire.
Dépannage
Les causes les plus courantes sont une configuration incorrecte du port série ou de la carte.
Vérifiez votre port série
Sous Windows, la carte apparaît sous la forme COMx. Sous macOS/Linux, elle apparaît sous /dev/tty.* ou /dev/cu.*.
Définissez le port dans PlatformIO :
Si vous ne voyez pas de port, essayez un autre câble USB, un autre port USB ou installez le pilote USB vers UART approprié pour votre carte.
Pour la carte OSSM de référence, la cible de carte est Espressif ESP32 Dev Module. Assurez-vous que votre environnement platformio.ini utilise le paramètre board correct pour ESP32.
Une mise à jour d'une plate-forme ou d'une bibliothèque peut introduire des modifications incompatibles. Épinglez les versions dans platformio.ini pour restaurer une configuration éprouvée.
; Example: pin the Espressif32 platform
platform = espressif32@3.5.0Vérifiez toujours les notes de version du projet pour connaître les versions de plate-forme et de bibliothèque recommandées.
Cela indique généralement une inadéquation du débit en bauds.
- Vérifiez
monitor_speeddansplatformio.ini(par exemple,115200) - Assurez-vous que le micrologiciel et le moniteur série utilisent le même débit en bauds
- Maintenez ou appuyez sur les boutons BOOT/EN de la carte comme requis par votre module ESP32
- Appuyez sur reset une fois le téléversement terminé si la carte ne redémarre pas automatiquement
- Déconnectez les autres applications susceptibles d'utiliser le même port série
Si vous rencontrez des problèmes non abordés ici, capturez le journal complet de compilation/téléversement de PlatformIO à partir du VS Code Terminal et incluez-le lorsque vous demandez de l'aide. Le journal contient l'environnement sélectionné, les versions de la plateforme et les messages d'erreur exacts.