Arduino-esp32: Where documentation for "Arduino core for the ESP32" (arduino-esp32) is located?

[N0rbert]

Hardware:

Board: ESP32 Dev Module
Core Installation/update date: 2018-01-05
IDE name: Arduino IDE 1.8.5 & Platform.io 3.5.2rc1
Flash Frequency: 40Mhz
Upload Speed: 115200

Description:

I can't find comprehensive documentation for "Arduino core for the ESP32" (arduino-esp32).
But I can find it for ESP-IDF at ReadTheDocs.

I know about esp32.net and esp32.com, but their format does not suite my needs, because I need book format.

Where documentation for "Arduino core for the ESP32" (arduino-esp32) is located?
Is it available in Doxygen / reStructuredText / Markdown / PDF formats anywhere?
Is it similar to ESP-IDF? Or it is completely different API?

[lbernstone]

Arduino-esp32 is intended to provide an arduino compatible environment on the esp32 hardware. https://www.arduino.cc/reference/en/ has the basic arduino functional documentation.

[N0rbert]

Let me clarify what I need.
I say about documentation for esp32_-prefixed functions, not basic Arduino functions (not digitalRead()).
Examples: esp_deep_sleep_enable_ulp_wakeup, esp_deep_sleep_start, esp_vfs_spiffs_register, esp_wifi_scan_start, esp_ble_gap_start_advertising, esp_spiffs_mounted and so on.

Am I understand correctly that right way to use documentation is to read both Arduino Reference and ESP-IDF for ESP specific functions?

[copercini]

Examples: esp_deep_sleep_enable_ulp_wakeup, esp_deep_sleep_start, esp_vfs_spiffs_register, esp_wifi_scan_start, esp_ble_gap_start_advertising, esp_spiffs_mounted and so on.

These functions are from IDF: https://github.com/espressif/esp-idf http://esp-idf.readthedocs.io/en/latest/

---

Arduino for ESP32 is a compatibility layer that calls the IDF functions ( ESP-IDF docs )

This is good because you can use both APIs on both platforms, running Arduino code on IDF or calling IDF functions directly on your Arduino code

[N0rbert]

Thank you for clarification. I thought suddenly I lost something.