update doc

summivox · summivox · commit b935ff9d0522 · 2021-01-10T20:19:37.000-08:00
diff --git a/README.md b/README.md
@@ -1,5 +1,18 @@
+# Fork Notes
+
+This is a fork of https://github.com/espressif/arduino-esp32/tree/idf-release/v4.2 that actually builds successfully when added as a component to a boilerplate project targeting https://github.com/espressif/esp-idf/tree/release/v4.2 .
+
+## Background
+
+`arduino-esp32` can be added as a component to your `esp-idf`-based project. These two libraries are tightly coupled and will not compile unless both are on the same release. However, upstream has several other issues preventing a success build, even in a blank project. This fork fixes this, at the cost of removing `LITTLEFS` and `NetBIOS` libraries.
+
+## Usage
+
+See <docs/esp-idf_component.md> (also updated).
+
+----------------------------------------
+
 # Arduino core for the ESP32
-[![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32) ![](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg)
 
 ### Need help or have a question? Join the chat at [![https://gitter.im/espressif/arduino-esp32](https://badges.gitter.im/espressif/arduino-esp32.svg)](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
diff --git a/docs/esp-idf_component.md b/docs/esp-idf_component.md
@@ -1,26 +1,27 @@
 To use as a component of ESP-IDF
 =================================================
 
-## esp32-arduino-lib-builder
-
-For a simplified method, see [lib-builder](lib_builder.md)
-
 ## Installation
 
-- Download and install [esp-idf](https://github.com/espressif/esp-idf)
+- Download and install [esp-idf v4.2 release](https://github.com/espressif/esp-idf)
 - Create blank idf project (from one of the examples)
 - in the project folder, create a folder called components and clone this repository inside
 
     ```bash
     mkdir -p components && \
     cd components && \
-    git clone https://github.com/espressif/arduino-esp32.git arduino && \
+    git clone -single-branch --branch mod-idf-v4.2 https://github.com/summivox/arduino-esp32.git arduino && \
     cd arduino && \
     git submodule update --init --recursive && \
     cd ../.. && \
     make menuconfig
   ```
+
 - ```make menuconfig``` has some Arduino options
+    - **important: you MUST enable these to build**
+        - mbedTLS: Enable pre-shared-key ciphersuites
+        - bluetooth: At least enable BLE and Bluedroid
+        
     - "Autostart Arduino setup and loop on boot"
         - If you enable this options, your main.cpp should be formated like any other sketch
 
@@ -77,6 +78,10 @@ If you are writing code that does not require Arduino to compile and you want yo
 You might notice that Arduino-esp32's `delay()` function will only work in multiples of 10ms. That is because, by default, esp-idf handles task events 100 times per second.
 To fix that behavior you need to set FreeRTOS tick rate to 1000Hz in `make menuconfig` -> `Component config` -> `FreeRTOS` -> `Tick rate`.
 
+## FreeRTOS task watchdog time out
+
+In `menuconfig`, disable "Watch CPU1 Idle Task".
+
 ## Compilation Errors
 
 As commits are made to esp-idf and submodules, the codebases can develop incompatibilities which cause compilation errors.  If you have problems compiling, follow the instructions in [Issue #1142](https://github.com/espressif/arduino-esp32/issues/1142) to roll esp-idf back to a known good version.
