diff --git a/docs/api/bluetooth/controller_vhci.rst b/docs/api/bluetooth/controller_vhci.rst index a9c1a79289..3868d9cec7 100644 --- a/docs/api/bluetooth/controller_vhci.rst +++ b/docs/api/bluetooth/controller_vhci.rst @@ -11,13 +11,13 @@ Application Example Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`05_ble_adv `_ +`bluetooth/ble_adv `_ This is a BLE advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for BLE advertising. `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference ------------- diff --git a/docs/api/bluetooth/esp_blufi.rst b/docs/api/bluetooth/esp_blufi.rst index 13432dc154..a281c3d3d6 100644 --- a/docs/api/bluetooth/esp_blufi.rst +++ b/docs/api/bluetooth/esp_blufi.rst @@ -13,7 +13,7 @@ Application Example Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`12_blufi `_ +`bluetooth/blufi `_ This is a BLUFI demo. This demo can set ESP32's wifi to softap/station/softap&station mode and config wifi connections. diff --git a/docs/api/bluetooth/esp_bt_defs.rst b/docs/api/bluetooth/esp_bt_defs.rst index 801b13df78..217dfb7620 100644 --- a/docs/api/bluetooth/esp_bt_defs.rst +++ b/docs/api/bluetooth/esp_bt_defs.rst @@ -11,7 +11,7 @@ Application Example `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_bt_device.rst b/docs/api/bluetooth/esp_bt_device.rst index c344a5e633..79c2e9c9bf 100644 --- a/docs/api/bluetooth/esp_bt_device.rst +++ b/docs/api/bluetooth/esp_bt_device.rst @@ -13,7 +13,7 @@ Application Example `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_bt_main.rst b/docs/api/bluetooth/esp_bt_main.rst index 48bb0c9cc0..f44dc7eebc 100644 --- a/docs/api/bluetooth/esp_bt_main.rst +++ b/docs/api/bluetooth/esp_bt_main.rst @@ -11,7 +11,7 @@ Application Example `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_gap_ble.rst b/docs/api/bluetooth/esp_gap_ble.rst index 856ed27302..088ab27dba 100644 --- a/docs/api/bluetooth/esp_gap_ble.rst +++ b/docs/api/bluetooth/esp_gap_ble.rst @@ -11,14 +11,14 @@ Application Example Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`14_gatts_demo `_ -`15_gattc_demo `_ +`14_gatts_demo `_ +`15_gattc_demo `_ The two demos use different gap api, such like advertising, scan, set device name and others. `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_gatt_defs.rst b/docs/api/bluetooth/esp_gatt_defs.rst index 70e808a5d7..621c6d95e1 100644 --- a/docs/api/bluetooth/esp_gatt_defs.rst +++ b/docs/api/bluetooth/esp_gatt_defs.rst @@ -11,7 +11,7 @@ Application Example `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_gattc.rst b/docs/api/bluetooth/esp_gattc.rst index 7ff1e9de7e..eada883fd7 100644 --- a/docs/api/bluetooth/esp_gattc.rst +++ b/docs/api/bluetooth/esp_gattc.rst @@ -11,13 +11,13 @@ Application Example Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`15_gattc_demo `_ +`15_gattc_demo `_ This is a gatt client demo. This demo can scan devices, connect to the gatt server and discover the service. `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_gatts.rst b/docs/api/bluetooth/esp_gatts.rst index 4278e6b33e..877840402c 100644 --- a/docs/api/bluetooth/esp_gatts.rst +++ b/docs/api/bluetooth/esp_gatts.rst @@ -11,13 +11,13 @@ Application Example Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`14_gatts_demo `_ +`14_gatts_demo `_ This is a gatt server demo. Use gatt api to create a gatt server with send advertising. This gatt server can be connected and the service can be discovery. `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/ethernet/esp_eth.rst b/docs/api/ethernet/esp_eth.rst index 371aa5b233..5702389af8 100644 --- a/docs/api/ethernet/esp_eth.rst +++ b/docs/api/ethernet/esp_eth.rst @@ -4,7 +4,7 @@ ETHERNET Application Example ------------------- -ethernet example: `examples/17_ethernet `_. +ethernet example: `examples/ethernet/ethernet `_. API Reference ------------- diff --git a/docs/api/peripherals/gpio.rst b/docs/api/peripherals/gpio.rst index f331b9d265..643eac1f4d 100644 --- a/docs/api/peripherals/gpio.rst +++ b/docs/api/peripherals/gpio.rst @@ -10,7 +10,7 @@ Note that GPIO6-11 are usually used for SPI flash. GPIO34-39 can only be set as Application Example ------------------- -GPIO output and input interrupt example: `examples/21_gpio `_. +GPIO output and input interrupt example: `examples/peripherals/gpio `_. API Reference ------------- diff --git a/docs/api/peripherals/i2c.rst b/docs/api/peripherals/i2c.rst index 2f89681f1d..93d863da6b 100644 --- a/docs/api/peripherals/i2c.rst +++ b/docs/api/peripherals/i2c.rst @@ -9,7 +9,7 @@ ESP32 has two I2C controllers which can be set as master mode or slave mode. Application Example ------------------- -I2C master and slave example: `examples/18_i2c `_. +I2C master and slave example: `examples/peripherals/i2c `_. API Reference ------------- diff --git a/docs/api/peripherals/ledc.rst b/docs/api/peripherals/ledc.rst index 12d7cd16d0..8c55e2413b 100644 --- a/docs/api/peripherals/ledc.rst +++ b/docs/api/peripherals/ledc.rst @@ -12,7 +12,7 @@ decrease the duty cycle gradually, allowing for fades without any processor inte Application Example ------------------- -LEDC change duty cycle and fading control example: `examples/29_ledc `_. +LEDC change duty cycle and fading control example: `examples/peripherals/ledc `_. API Reference ------------- diff --git a/docs/api/peripherals/pcnt.rst b/docs/api/peripherals/pcnt.rst index 7fe73e6f47..bf4fcd0406 100644 --- a/docs/api/peripherals/pcnt.rst +++ b/docs/api/peripherals/pcnt.rst @@ -9,7 +9,7 @@ The PCNT (Pulse Counter) module is designed to count the number of rising and/or Application Example ------------------- -Pulse counter with control signal and event interrupt example: `examples/16_pcnt `_. +Pulse counter with control signal and event interrupt example: `examples/peripherals/pcnt `_. API Reference ------------- diff --git a/docs/api/peripherals/rmt.rst b/docs/api/peripherals/rmt.rst index 9d834b1e28..715bc46786 100644 --- a/docs/api/peripherals/rmt.rst +++ b/docs/api/peripherals/rmt.rst @@ -9,7 +9,7 @@ The RMT (Remote Control) module driver can be used to send and receive infrared Application Example ------------------- -NEC remote control TX and RX example: `examples/11_rmt_nec_tx_rx `_. +NEC remote control TX and RX example: `examples/peripherals/rmt_nec_tx_rx `_. API Reference ------------- diff --git a/docs/api/peripherals/timer.rst b/docs/api/peripherals/timer.rst index 0db0a12c23..203c6b0d30 100644 --- a/docs/api/peripherals/timer.rst +++ b/docs/api/peripherals/timer.rst @@ -12,7 +12,7 @@ They are all 64-bit generic timers based on 16-bit prescalers and 64-bit auto-re Application Example ------------------- -64-bit hardware timer example: `examples/13_timer_group `_. +64-bit hardware timer example: `examples/peripherals/timer_group `_. API Reference ------------- diff --git a/docs/api/peripherals/uart.rst b/docs/api/peripherals/uart.rst index fa83309e2a..8684b2afa3 100644 --- a/docs/api/peripherals/uart.rst +++ b/docs/api/peripherals/uart.rst @@ -16,7 +16,7 @@ API Reference `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html Header Files ^^^^^^^^^^^^ diff --git a/docs/api/protocols/mdns.rst b/docs/api/protocols/mdns.rst index 95789444f5..d674e25a08 100644 --- a/docs/api/protocols/mdns.rst +++ b/docs/api/protocols/mdns.rst @@ -163,7 +163,7 @@ Example of using the methods above: Application Example ------------------- -mDNS server/scanner example: `examples/30_mdns_example `_. +mDNS server/scanner example: `examples/protocols/mdsn `_. API Reference ------------- diff --git a/docs/api/storage/sdmmc.rst b/docs/api/storage/sdmmc.rst index e751852f95..fe2e5c27f8 100644 --- a/docs/api/storage/sdmmc.rst +++ b/docs/api/storage/sdmmc.rst @@ -15,7 +15,7 @@ Protocol layer works with the host via ``sdmmc_host_t`` structure. This structur Application Example ------------------- -An example which combines SDMMC driver with FATFS library is provided in ``examples/27_sd_card`` directory. This example initializes the card, writes and reads data from it using POSIX and C library APIs. See README.md file in the example directory for more information. +An example which combines SDMMC driver with FATFS library is provided in ``examples/storage/sd_card`` directory. This example initializes the card, writes and reads data from it using POSIX and C library APIs. See README.md file in the example directory for more information. Protocol layer APIs diff --git a/docs/api/wifi/esp_wifi.rst b/docs/api/wifi/esp_wifi.rst index c13d3d751a..1fe832a2c5 100644 --- a/docs/api/wifi/esp_wifi.rst +++ b/docs/api/wifi/esp_wifi.rst @@ -16,7 +16,7 @@ API Reference `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html Header Files ^^^^^^^^^^^^ diff --git a/docs/build_system.rst b/docs/build_system.rst index 7a33a41256..d4353287b9 100644 --- a/docs/build_system.rst +++ b/docs/build_system.rst @@ -464,7 +464,7 @@ The file's contents will be added to the .rodata section in flash, and are avail The names are generated from the full name of the file, as given in COMPONENT_EMBED_FILES. Characters /, ., etc. are replaced with underscores. The _binary prefix in the symbol name is added by objcopy and is the same for both text and binary files. -For an example of using this technique, see examples/04_https_request - the certificate file contents are loaded from the text .pem file at compile time. +For an example of using this technique, see examples/protocols/https_request - the certificate file contents are loaded from the text .pem file at compile time. Fully Overriding The Component Makefile diff --git a/examples/storage/nvs_rw_blob/README.md b/examples/storage/nvs_rw_blob/README.md index 81a0e36c71..94b8549b36 100644 --- a/examples/storage/nvs_rw_blob/README.md +++ b/examples/storage/nvs_rw_blob/README.md @@ -7,7 +7,7 @@ Demonstrates how to read and write a single integer value and a blob (binary lar Example also shows how to implement diagnostics if read / write operation was successful. -If not done already, consider checking simpler example *07_nvs_rw_value*, that has been used as a starting point for preparing this one. +If not done already, consider checking simpler example *storage/nvs_rw_value*, that has been used as a starting point for preparing this one. Detailed functional description of NVS and API is provided in [documentation](http://esp-idf.readthedocs.io/en/latest/api/nvs_flash.html). diff --git a/examples/storage/nvs_rw_value/README.md b/examples/storage/nvs_rw_value/README.md index 09cd364e8d..797e8d422a 100644 --- a/examples/storage/nvs_rw_value/README.md +++ b/examples/storage/nvs_rw_value/README.md @@ -6,7 +6,7 @@ The value holds the number of ESP32 module restarts. Since it is written to NVS, Example also shows how to check if read / write operation was successful, or certain value is not initialized in NVS. Diagnostic is provided in plain text to help track program flow and capture any issues on the way. -Check another example *08_nvs_rw_blob*, that shows how to read and write variable length binary data (blob). +Check another example *storage/nvs_rw_blob*, that shows how to read and write variable length binary data (blob). Detailed functional description of NVS and API is provided in [documentation](http://esp-idf.readthedocs.io/en/latest/api/nvs_flash.html). diff --git a/examples/system/ota/README.md b/examples/system/ota/README.md index 49a47d3799..886dbf5fbb 100644 --- a/examples/system/ota/README.md +++ b/examples/system/ota/README.md @@ -30,12 +30,12 @@ Connect your host PC to the same AP that you will use for the ESP32. Python has a built-in HTTP server that can be used for example purposes. -For our upgrade example OTA file, we're going to use the `01_hello_world` example. +For our upgrade example OTA file, we're going to use the `get-started/hello_world` example. Open a new terminal to run the HTTP server, then run these commands to build the example and start the server: ``` -cd $IDF_PATH/examples/01_hello_world +cd $IDF_PATH/examples/get-started/hello_world make cd build python -m SimpleHTTPServer 8070