esp idf
v5.3.1
中文版
ESP-IDF est le framework de développement pour les SoC Espressif pris en charge sur Windows, Linux et macOS.
Veuillez lire la politique de support et la documentation pour plus d'informations sur les versions ESP-IDF.
Veuillez consulter les avis de fin de vie pour plus d'informations sur les versions ESP-IDF dont le support n'est plus disponible.
Le tableau suivant montre la prise en charge ESP-IDF des SoC Espressif, où et désignent respectivement l'état d'aperçu et la prise en charge. Le support en avant-première est généralement limité dans le temps et destiné aux versions bêta des puces. Veuillez utiliser une version ESP-IDF où le SoC souhaité est déjà pris en charge.
| Ébrécher | v5.0 | v5.1 | v5.2 | v5.3 | v5.4 | |
|---|---|---|---|---|---|---|
| ESP32 | ||||||
| ESP32-S2 | ||||||
| ESP32-C3 | ||||||
| ESP32-S3 | Annonce | |||||
| ESP32-C2 | Annonce | |||||
| ESP32-C6 | Annonce | |||||
| ESP32-H2 | Annonce | |||||
| ESP32-P4 | Annonce | |||||
| ESP32-C5 | Annonce | |||||
| ESP32-C61 | Annonce |
Il existe des variantes de révisions pour une série de puces. Voir Compatibilité entre les versions ESP-IDF et les révisions des SoC Espressif pour plus de détails sur la compatibilité entre ESP-IDF et les révisions de puces.
Les SoC Espressif publiés avant 2016 (ESP8266 et ESP8285) sont plutôt pris en charge par le SDK RTOS.
Voir https://idf.espressif.com/ pour des liens vers des instructions détaillées sur la façon de configurer l'ESP-IDF en fonction de la puce que vous utilisez.
Remarque : Chaque série de SoC et chaque version ESP-IDF possède sa propre documentation. Veuillez consulter la section Versions pour savoir comment trouver de la documentation et comment commander une version spécifique d'ESP-IDF.
ESP-IDF utilise des emplacements relatifs comme URL de sous-modules (.gitmodules). Ils sont donc liés à GitHub. Si ESP-IDF est transféré vers un référentiel Git qui n'est pas sur GitHub, vous devrez exécuter le script tools/set-submodules-to-github.sh après le clonage de git.
Le script définit des URL absolues pour tous les sous-modules, permettant git submodule update --init --recursive de se terminer. Si vous clonez ESP-IDF depuis GitHub, cette étape n'est pas nécessaire.
En plus du projet esp-idf-template mentionné dans Mise en route, ESP-IDF est livré avec quelques exemples de projets dans le répertoire des exemples.
Une fois que vous avez trouvé le projet avec lequel vous souhaitez travailler, accédez à son répertoire et vous pourrez le configurer et le construire.
Pour démarrer votre propre projet basé sur un exemple, copiez le répertoire du projet exemple en dehors du répertoire ESP-IDF.
Consultez les liens du guide de démarrage ci-dessus pour un guide de configuration détaillé. Ceci est une référence rapide pour les commandes courantes lorsque vous travaillez avec des projets ESP-IDF :
(Voir le guide de démarrage répertorié ci-dessus pour une liste complète des étapes requises avec plus de détails.)
Installez les dépendances de build d'hôte mentionnées dans le guide de démarrage.
Exécutez le script d'installation pour configurer l'environnement de génération. Les options incluent install.bat ou install.ps1 pour Windows et install.sh ou install.fish pour les shells Unix.
Exécutez le script d'exportation sous Windows ( export.bat ) ou sourcez-le sous Unix ( source export.sh ) dans chaque environnement shell avant d'utiliser ESP-IDF.
idf.py set-target <chip_name> définit la cible du projet sur <chip_name> . Exécutez idf.py set-target sans aucun argument pour voir une liste des cibles prises en charge.
idf.py menuconfig ouvre un menu de configuration textuel dans lequel vous pouvez configurer le projet.
idf.py build
... compilera l'application, le chargeur de démarrage et générera une table de partition basée sur la configuration.
Une fois la construction terminée, une ligne de commande sera affichée pour utiliser esptool.py pour flasher la puce. Cependant, vous pouvez également le faire automatiquement en exécutant :
idf.py -p PORT flash
Remplacez PORT par le nom de votre port série (comme COM3 sous Windows, /dev/ttyUSB0 sous Linux ou /dev/cu.usbserial-X sous MacOS. Si l'option -p est omise, idf.py flash essaiera de flasher le premier port série disponible.
Cela flashera l'intégralité du projet (application, chargeur de démarrage et table de partition) sur une nouvelle puce. Les paramètres de clignotement du port série peuvent être configurés avec idf.py menuconfig .
Vous n'avez pas besoin d'exécuter idf.py build avant d'exécuter idf.py flash , idf.py flash reconstruira automatiquement tout ce qui en a besoin.
La cible idf.py monitor utilise l'outil esp-idf-monitor pour afficher la sortie série des SoC Espressif. esp-idf-monitor dispose également d'une gamme de fonctionnalités pour décoder la sortie de crash et interagir avec l'appareil. Consultez la page de documentation pour plus de détails.
Quittez le moniteur en tapant Ctrl-].
Pour créer, flasher et surveiller la sortie en un seul passage, vous pouvez exécuter :
idf.py flash monitor
Après le flash initial, vous souhaiterez peut-être simplement créer et flasher uniquement votre application, pas le chargeur de démarrage et la table de partition :
idf.py app - créez uniquement l'application.
idf.py app-flash - flashez uniquement l'application.
idf.py app-flash reconstruira automatiquement l'application si des fichiers source ont été modifiés.
(Dans un développement normal, il n'y a aucun inconvénient à reflasher le chargeur de démarrage et la table de partition à chaque fois, s'ils n'ont pas changé.)
La cible idf.py flash n'efface pas l'intégralité du contenu du flash. Cependant, il est parfois utile de remettre l'appareil dans un état totalement effacé, notamment lors de modifications de la table de partition ou de mises à jour de l'application OTA. Pour effacer l'intégralité du flash, exécutez idf.py erase-flash .
Cela peut être combiné avec d'autres cibles, c'est-à-dire que idf.py -p PORT erase-flash flash effacera tout, puis reflashera la nouvelle application, le chargeur de démarrage et la table de partition.
Documentation pour la dernière version : https://docs.espressif.com/projects/esp-idf/. Cette documentation est construite à partir du répertoire docs de ce référentiel.
Guide du débutant sur les concepts et ressources clés de l'ESP-IDF
Le forum esp32.com est un endroit pour poser des questions et trouver des ressources communautaires.
Consultez la section Problèmes sur github si vous trouvez un bug ou si vous avez une demande de fonctionnalité. Veuillez vérifier les problèmes existants avant d'en ouvrir un nouveau.
Si vous souhaitez contribuer à l'ESP-IDF, veuillez consulter le Guide des contributions.
