منصوبے کے بارے میں

ESP-IDF (Espressif IoT Development Framework) ایسپریسف SoCs کے لیے سرکاری ڈیولپمنٹ فریم ورک ہے، جو Windows, Linux اور macOS پر معاون ہے۔ یہ ایسپریسف چپس کو نشانہ بناتا ہے؛ 2016 سے پہلے جاری ہونے والے SoCs (ESP8266 اور ESP8285) اس کے بجائے علیحدہ RTOS SDK کے ذریعے تعاون یافتہ ہیں۔ ریپوزٹری میں ریلیز سپورٹ شیڈولز، اینڈ-آف-لائف مشورے، اور ESP-IDF ریلیزز اور چپ ریویژنز کے درمیان مطابقت دستاویز کی گئی ہے۔ ہر SoC سیریز اور ہر ESP-IDF ریلیز کی اپنی دستاویزات ہیں، اور README آن لائن دستاویزات کے Versions سیکشن کی طرف اشارہ کرتا ہے تاکہ دستاویزات تلاش کی جا سکیں اور مخصوص ریلیز کو چیک آؤٹ کیا جا سکے۔ شروع کرنے میں ہوسٹ بلڈ ڈیپینڈنسیز انسٹال کرنا، ایک انسٹال اسکرپٹ چلانا (Windows پر install.bat یا install.ps1؛ Unix شیلز پر install.sh یا install.fish)، اور پھر ESP-IDF استعمال کرنے سے پہلے ہر شیل میں ماحول کو ایکسپورٹ کرنا شامل ہے (Windows پر export.bat، Unix پر source export.sh)۔ ایک ٹیمپلیٹ پروجیکٹ (esp-idf-template) اور examples ڈائریکٹری میں مثالوں کے پروجیکٹس کا ایک سیٹ فراہم کیا گیا ہے؛ مثال سے نیا پروجیکٹ شروع کرنے کے لیے، مثال کی ڈائریکٹری کو ESP-IDF ٹری سے باہر کاپی کیا جاتا ہے۔ بنیادی ورک فلو idf.py کمانڈ لائن ٹول استعمال کرتا ہے۔ `idf.py set-target chip_name` ہدف چپ منتخب کرتا ہے، اور `idf.py menuconfig` ایک ٹیکسٹ پر مبنی کنفیگریشن مینو کھولتا ہے۔ `idf.py build` ایپلیکیشن اور بوٹ لوڈر مرتب کرتا ہے اور کنفیگریشن سے پارٹیشن ٹیبل تیار کرتا ہے۔ فلیشنگ `idf.py -p PORT flash` کے ساتھ کی جاتی ہے، جو نئی چپ پر ایپ، بوٹ لوڈر اور پارٹیشن ٹیبل لکھتا ہے اور خود بخود کسی بھی چیز کو دوبارہ بناتا ہے جس کی ضرورت ہو؛ اگر پورٹ آپشن چھوڑ دیا جائے تو یہ پہلی دستیاب سیریل پورٹ آزماتا ہے۔ سیریل آؤٹ پٹ `idf.py monitor` کے ساتھ دیکھا جاتا ہے، جو esp-idf-monitor ٹول استعمال کرتا ہے اور کریش آؤٹ پٹ کو ڈی کوڈ کر سکتا ہے اور ڈیوائس کے ساتھ تعامل کر سکتا ہے؛ اسے Ctrl-] سے بند کیا جاتا ہے۔ `idf.py flash monitor` بلڈ، فلیش اور مانیٹر کو ایک ہی مرحلے میں یکجا کرتا ہے۔ تکراری کام کے لیے، `idf.py app` صرف ایپ بناتا ہے اور `idf.py app-flash` صرف ایپ فلیش کرتا ہے، جب ذرائع تبدیل ہوتے ہیں تو خود بخود دوبارہ تعمیر ہوتا ہے۔ `idf.py erase-flash` پوری فلیش مٹا دیتا ہے، جو پارٹیشن ٹیبل تبدیلیوں یا OTA اپڈیٹس کے لیے مفید ہے، اور اسے دیگر اہداف کے ساتھ ملایا جا سکتا ہے۔ غیر-GitHub فورکس کے لیے، README نوٹ کرتا ہے کہ سب ماڈیول URLs نسبتاً ہیں اور GitHub سے منسلک ہیں؛ اسکرپٹ tools/set-submodules-to-github.sh مطلق URLs سیٹ کرتا ہے تاکہ `git submodule update --init --recursive` مکمل ہو سکے۔ GitHub سے کلون کرتے وقت یہ مرحلہ ضروری نہیں ہے۔ وسائل میں docs ڈائریکٹری سے بنائی گئی آن لائن دستاویزات، ایک ابتدائی رہنما ویڈیو، سوالات اور کمیونٹی وسائل کے لیے esp32.com فورم، بگز اور فیچر کی درخواستوں کے لیے GitHub Issues سیکشن، اور ایک شراکت رہنما شامل ہیں۔