ESP-IDF adalah kerangka pengembangan untuk SoC Espressif yang didukung di Windows, Linux, dan macOS.
Tabel berikut menunjukkan dukungan ESP-IDF pada SoC Espressif yang masing-masing menunjukkan status pratinjau dan dukungan. Dukungan pratinjau biasanya terbatas waktunya dan ditujukan untuk chip versi beta. Silakan gunakan rilis ESP-IDF yang SoC yang diinginkan sudah didukung.
Kepingan | v5.0 | v5.1 | v5.2 | v5.3 | v5.4 | |
---|---|---|---|---|---|---|
ESP32 | ||||||
ESP32-S2 | ||||||
ESP32-C3 | ||||||
ESP32-S3 | Pengumuman | |||||
ESP32-C2 | Pengumuman | |||||
ESP32-C6 | Pengumuman | |||||
ESP32-H2 | Pengumuman | |||||
ESP32-P4 | Pengumuman | |||||
ESP32-C5 | Pengumuman | |||||
ESP32-C61 | Pengumuman |
Terdapat varian revisi untuk rangkaian chip tersebut. Lihat Kompatibilitas Antara Rilis ESP-IDF dan Revisi SoC Espressif untuk detail kompatibilitas antara ESP-IDF dan revisi chip.
SoC Espressif yang dirilis sebelum 2016 (ESP8266 dan ESP8285) didukung oleh RTOS SDK.
Lihat https://idf.espressif.com/ untuk link ke petunjuk rinci tentang cara mengatur ESP-IDF tergantung pada chip yang Anda gunakan.
Catatan: Setiap seri SoC dan setiap rilis ESP-IDF memiliki dokumentasinya sendiri. Silakan lihat Bagian Versi tentang cara menemukan dokumentasi dan cara memeriksa rilis spesifik ESP-IDF.
ESP-IDF menggunakan lokasi relatif sebagai URL submodulnya (.gitmodules). Jadi mereka terhubung ke GitHub. Jika ESP-IDF bercabang ke repositori Git yang tidak ada di GitHub, Anda perlu menjalankan skrip tools/set-submodules-to-github.sh setelah git clone.
Skrip menetapkan URL absolut untuk semua submodul, sehingga git submodule update --init --recursive
dapat diselesaikan. Jika mengkloning ESP-IDF dari GitHub, langkah ini tidak diperlukan.
Selain proyek esp-idf-template yang disebutkan dalam Memulai, ESP-IDF hadir dengan beberapa contoh proyek di direktori contoh.
Setelah Anda menemukan proyek yang ingin Anda kerjakan, ubah ke direktorinya dan Anda dapat mengonfigurasi dan membangunnya.
Untuk memulai proyek Anda sendiri berdasarkan contoh, salin direktori proyek contoh di luar direktori ESP-IDF.
Lihat tautan panduan Memulai di atas untuk panduan pengaturan terperinci. Ini adalah referensi singkat untuk perintah umum saat bekerja dengan proyek ESP-IDF:
(Lihat panduan Memulai yang tercantum di atas untuk daftar lengkap langkah-langkah yang diperlukan dengan rincian lebih lanjut.)
install.bat
atau install.ps1
untuk Windows, dan install.sh
atau install.fish
untuk shell Unix.export.bat
) atau sumbernya di Unix ( source export.sh
) di setiap lingkungan shell sebelum menggunakan ESP-IDF. idf.py set-target
menetapkan target proyek menjadi
. Jalankan idf.py set-target
tanpa argumen apa pun untuk melihat daftar target yang didukung.idf.py menuconfig
membuka menu konfigurasi berbasis teks tempat Anda dapat mengonfigurasi proyek. idf.py build
... akan mengkompilasi aplikasi, bootloader dan menghasilkan tabel partisi berdasarkan konfigurasi.
Ketika pembangunan selesai, ia akan mencetak baris perintah untuk menggunakan esptool.py untuk mem-flash chip. Namun Anda juga dapat melakukan ini secara otomatis dengan menjalankan:
idf.py -p PORT flash
Ganti PORT dengan nama port serial Anda (seperti COM3
di Windows, /dev/ttyUSB0
di Linux, atau /dev/cu.usbserial-X
di MacOS. Jika opsi -p
dihilangkan, idf.py flash
akan mencoba flash port serial pertama yang tersedia.
Ini akan mem-flash seluruh proyek (aplikasi, bootloader, dan tabel partisi) ke chip baru. Pengaturan untuk flashing port serial dapat dikonfigurasi dengan idf.py menuconfig
.
Anda tidak perlu menjalankan idf.py build
sebelum menjalankan idf.py flash
, idf.py flash
akan secara otomatis membangun kembali apa pun yang memerlukannya.
Target idf.py monitor
menggunakan alat esp-idf-monitor untuk menampilkan output serial dari SoC Espressif. esp-idf-monitor juga memiliki serangkaian fitur untuk memecahkan kode keluaran kerusakan dan berinteraksi dengan perangkat. Periksa halaman dokumentasi untuk detailnya.
Keluar dari monitor dengan mengetik Ctrl-].
Untuk membangun, mem-flash, dan memantau keluaran dalam satu kali jalan, Anda dapat menjalankan:
idf.py flash monitor
Setelah flash awal, Anda mungkin hanya ingin membuat dan mem-flash aplikasi Anda saja, bukan bootloader dan tabel partisi:
idf.py app
- buat aplikasinya saja.idf.py app-flash
- flash aplikasinya saja. idf.py app-flash
akan secara otomatis membangun kembali aplikasi jika ada file sumber yang berubah.
(Dalam perkembangan normal, tidak ada ruginya untuk mem-reflash bootloader dan tabel partisi setiap kali, jika tidak berubah.)
Target idf.py flash
tidak menghapus seluruh konten flash. Namun terkadang berguna untuk mengembalikan perangkat ke keadaan terhapus total, terutama saat melakukan perubahan tabel partisi atau pembaruan aplikasi OTA. Untuk menghapus seluruh flash, jalankan idf.py erase-flash
.
Ini dapat digabungkan dengan target lain, yaitu idf.py -p PORT erase-flash flash
akan menghapus semuanya dan kemudian mem-flash ulang aplikasi, bootloader, dan tabel partisi baru.
Dokumentasi untuk versi terbaru: https://docs.espressif.com/projects/esp-idf/. Dokumentasi ini dibuat dari direktori docs repositori ini.
Panduan Pemula tentang Konsep Utama dan Sumber Daya ESP-IDF
Forum esp32.com adalah tempat untuk bertanya dan mencari sumber daya komunitas.
Periksa bagian Masalah di github jika Anda menemukan bug atau memiliki permintaan fitur. Silakan periksa Masalah yang ada sebelum membuka yang baru.
Jika Anda tertarik untuk berkontribusi pada ESP-IDF, silakan periksa Panduan Kontribusi.