esp idf
v5.3.1
中文版
ESP-IDF — это среда разработки для SoC Espressif, поддерживаемая в Windows, Linux и macOS.
Пожалуйста, прочтите политику поддержки и документацию для получения дополнительной информации о версиях ESP-IDF.
Дополнительную информацию о выпусках ESP-IDF с прекращенной поддержкой см. в разделе «Информация об окончании срока службы».
В следующей таблице показана поддержка ESP-IDF SoC Espressif, где и обозначают статус предварительной версии и поддержку соответственно. Поддержка предварительной версии обычно ограничена по времени и предназначена для бета-версий чипов. Используйте версию ESP-IDF, в которой уже поддерживается нужный SoC.
| Чип | v5.0 | v5.1 | v5.2 | v5.3 | v5.4 | |
|---|---|---|---|---|---|---|
| ЭСП32 | ||||||
| ЭСП32-С2 | ||||||
| ЭСП32-С3 | ||||||
| ЭСП32-С3 | Объявление | |||||
| ЭСП32-С2 | Объявление | |||||
| ЭСП32-С6 | Объявление | |||||
| ЭСП32-Х2 | Объявление | |||||
| ЭСП32-П4 | Объявление | |||||
| ЭСП32-С5 | Объявление | |||||
| ЭСП32-С61 | Объявление |
Есть варианты доработок серии чипов. См. «Совместимость между выпусками ESP-IDF и версиями SoC Espressif» для получения подробной информации о совместимости между ESP-IDF и версиями чипа.
Вместо этого процессоры Espressif, выпущенные до 2016 года (ESP8266 и ESP8285), поддерживаются RTOS SDK.
См. https://idf.espressif.com/ для получения ссылок на подробные инструкции по настройке ESP-IDF в зависимости от используемого вами чипа.
Примечание. Каждая серия SoC и каждая версия ESP-IDF имеют собственную документацию. Пожалуйста, обратитесь к разделу «Версии», чтобы узнать, как найти документацию и как получить конкретную версию ESP-IDF.
ESP-IDF использует относительные местоположения в качестве URL-адресов своих подмодулей (.gitmodules). Итак, они ссылаются на GitHub. Если ESP-IDF разветвлен на репозиторий Git, которого нет на GitHub, вам нужно будет запустить скрипт Tools/set-submodules-to-github.sh после клонирования git.
Скрипт устанавливает абсолютные URL-адреса для всех подмодулей, позволяя завершить git submodule update --init --recursive . При клонировании ESP-IDF из GitHub этот шаг не требуется.
Помимо проекта esp-idf-template, упомянутого в разделе «Начало работы», ESP-IDF включает в себя несколько примеров проектов в каталоге примеров.
Найдя проект, с которым хотите работать, перейдите в его каталог, и вы сможете его настроить и собрать.
Чтобы запустить собственный проект на основе примера, скопируйте каталог проекта примера за пределы каталога ESP-IDF.
См. ссылки на руководство по началу работы выше для получения подробного руководства по настройке. Это краткий справочник по общим командам при работе с проектами ESP-IDF:
(Полный список необходимых действий и более подробную информацию см. в руководстве по началу работы, указанном выше.)
Установите зависимости сборки хоста, упомянутые в руководстве по началу работы.
Запустите сценарий установки, чтобы настроить среду сборки. Доступные варианты включают install.bat или install.ps1 для Windows и install.sh или install.fish для оболочек Unix.
Запустите сценарий экспорта в Windows ( export.bat ) или установите его исходный код в Unix ( source export.sh ) в каждой среде оболочки перед использованием ESP-IDF.
idf.py set-target <chip_name> устанавливает целью проекта <chip_name> . Запустите idf.py set-target без каких-либо аргументов, чтобы увидеть список поддерживаемых целей.
idf.py menuconfig открывает текстовое меню конфигурации, в котором вы можете настроить проект.
idf.py build
... скомпилирует приложение, загрузчик и сгенерирует таблицу разделов на основе конфигурации.
Когда сборка завершится, она выведет командную строку для использования esptool.py для прошивки чипа. Однако вы также можете сделать это автоматически, запустив:
idf.py -p PORT flash
Замените PORT именем вашего последовательного порта (например, COM3 в Windows, /dev/ttyUSB0 в Linux или /dev/cu.usbserial-X в MacOS. Если опция -p не указана, idf.py flash попытается выполнить прошить первый доступный последовательный порт.
Это перенесет весь проект (приложение, загрузчик и таблицу разделов) на новый чип. Параметры прошивки последовательного порта можно настроить с помощью idf.py menuconfig .
Вам не нужно запускать idf.py build перед запуском idf.py flash , idf.py flash автоматически пересоберет все, что в этом нуждается.
Цель idf.py monitor использует инструмент esp-idf-monitor для отображения последовательного вывода из SoC Espressif. esp-idf-monitor также имеет ряд функций для декодирования вывода сбоя и взаимодействия с устройством. Подробную информацию можно найти на странице документации.
Выйдите из монитора, набрав Ctrl-].
Чтобы создать, прошить и контролировать выходные данные за один проход, вы можете запустить:
idf.py flash monitor
После первоначальной прошивки вы можете просто собрать и прошить только свое приложение, а не загрузчик и таблицу разделов:
idf.py app — создайте только приложение.
idf.py app-flash — прошить только приложение.
idf.py app-flash автоматически пересоберет приложение, если какие-либо исходные файлы изменились.
(При обычной разработке нет никаких недостатков в перепрошивке загрузчика и таблицы разделов каждый раз, если они не изменились.)
Цель idf.py flash не стирает все содержимое флэш-памяти. Однако иногда полезно вернуть устройство в полностью стертое состояние, особенно при внесении изменений в таблицу разделов или обновлениях приложений OTA. Чтобы стереть всю флэш-память, запустите idf.py erase-flash .
Это можно комбинировать с другими целями, например, idf.py -p PORT erase-flash flash сотрет все, а затем заново прошьет новое приложение, загрузчик и таблицу разделов.
Документация последней версии: https://docs.espressif.com/projects/esp-idf/. Эта документация собрана из каталога docs этого репозитория.
Руководство для начинающих по ключевым понятиям и ресурсам ESP-IDF
Форум esp32.com — это место, где можно задавать вопросы и находить ресурсы сообщества.
Если вы обнаружили ошибку или у вас есть запрос на добавление функции, проверьте раздел «Проблемы» на GitHub. Пожалуйста, проверьте существующие проблемы, прежде чем открывать новые.
Если вы хотите внести свой вклад в ESP-IDF, пожалуйста, ознакомьтесь с Руководством по вкладам.
