]> granicus.if.org Git - esp-idf/commitdiff
Updated links to examples in new folders / categories in api documentation
authorKrzysztof Budzynski <krzysztof@espressif.com>
Mon, 16 Jan 2017 22:08:36 +0000 (23:08 +0100)
committerKrzysztof Budzynski <krzysztof@espressif.com>
Mon, 16 Jan 2017 22:08:36 +0000 (23:08 +0100)
24 files changed:
docs/api/bluetooth/controller_vhci.rst
docs/api/bluetooth/esp_blufi.rst
docs/api/bluetooth/esp_bt_defs.rst
docs/api/bluetooth/esp_bt_device.rst
docs/api/bluetooth/esp_bt_main.rst
docs/api/bluetooth/esp_gap_ble.rst
docs/api/bluetooth/esp_gatt_defs.rst
docs/api/bluetooth/esp_gattc.rst
docs/api/bluetooth/esp_gatts.rst
docs/api/ethernet/esp_eth.rst
docs/api/peripherals/gpio.rst
docs/api/peripherals/i2c.rst
docs/api/peripherals/ledc.rst
docs/api/peripherals/pcnt.rst
docs/api/peripherals/rmt.rst
docs/api/peripherals/timer.rst
docs/api/peripherals/uart.rst
docs/api/protocols/mdns.rst
docs/api/storage/sdmmc.rst
docs/api/wifi/esp_wifi.rst
docs/build_system.rst
examples/storage/nvs_rw_blob/README.md
examples/storage/nvs_rw_value/README.md
examples/system/ota/README.md

index a9c1a79289e127224d90e585b17a4109d62a0687..3868d9cec7bafcb0259012ec5635637f4788ff9f 100644 (file)
@@ -11,13 +11,13 @@ Application Example
 
 Check `/examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf/>`_ repository, that contains the following example:
 
-`05_ble_adv <https://github.com/espressif/esp-idf/blob/master/examples/05_ble_adv/main/app_bt.c>`_ 
+`bluetooth/ble_adv <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/ble_adv/main/app_bt.c>`_ 
 
   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
 -------------
index 13432dc1542fcb3f7542321497d3b26b844f2d2f..a281c3d3d61d07b71e4ec3844febf8137ccbcd91 100644 (file)
@@ -13,7 +13,7 @@ Application Example
 
 Check `/examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf/>`_ repository, that contains the following example:
 
-`12_blufi <https://github.com/espressif/esp-idf/blob/master/examples/12_blufi/main/>`_ 
+`bluetooth/blufi <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/blufi/main/>`_ 
 
 This is a BLUFI demo. This demo can set ESP32's wifi to softap/station/softap&station mode and config wifi connections.
 
index 801b13df7891ed771f853e56f707a4625a17f104..217dfb7620bf2dc4b5e102b27b0498b75b8bf598 100644 (file)
@@ -11,7 +11,7 @@ Application Example
 
 `Instructions`_
 
-.. _Instructions: template.html
+.. _Instructions: ../template.html
 
 
 API Reference
index c344a5e633fa64770c7e69302ab21461b677e821..79c2e9c9bfb7ff21684d34ef5c0dcac3c585ac54 100644 (file)
@@ -13,7 +13,7 @@ Application Example
 
 `Instructions`_
 
-.. _Instructions: template.html
+.. _Instructions: ../template.html
 
 
 API Reference
index 48bb0c9cc0e89624778c9d2a67ff16b5eb19950c..f44dc7eebcef89d35a397464a057c991025e0a38 100644 (file)
@@ -11,7 +11,7 @@ Application Example
 
 `Instructions`_
 
-.. _Instructions: template.html
+.. _Instructions: ../template.html
 
 
 API Reference
index 856ed273025cc7a5c6847332f80d3b3d34d27dd5..088ab27dbaed3cf23ddfd98f4c76c870e47e11b6 100644 (file)
@@ -11,14 +11,14 @@ Application Example
 
 Check `/examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf/>`_ repository, that contains the following example:
 
-`14_gatts_demo <https://github.com/espressif/esp-idf/blob/master/examples/14_gatt_server/main/gatts_demo.c>`_ 
-`15_gattc_demo <https://github.com/espressif/esp-idf/blob/master/examples/15_gatt_client/main/gattc_demo.c>`_ 
+`14_gatts_demo <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_server/main/gatts_demo.c>`_ 
+`15_gattc_demo <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_client/main/gattc_demo.c>`_ 
 
 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
index 70e808a5d7732b5ba2cf8094e4ce09b266313fc7..621c6d95e1248031c9e6453d151be2850cad3e5b 100644 (file)
@@ -11,7 +11,7 @@ Application Example
 
 `Instructions`_
 
-.. _Instructions: template.html
+.. _Instructions: ../template.html
 
 
 API Reference
index 7ff1e9de7e395317596330e7b3908baf90a12fe2..eada883fd7093d24e96b8b2442b776acb0648a57 100644 (file)
@@ -11,13 +11,13 @@ Application Example
 
 Check `/examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf/>`_ repository, that contains the following example:
 
-`15_gattc_demo <https://github.com/espressif/esp-idf/blob/master/examples/15_gatt_client/main/gattc_demo.c>`_ 
+`15_gattc_demo <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_client/main/gattc_demo.c>`_ 
 
 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
index 4278e6b33ea5975170ede071815ac107cd27fcb7..877840402c0df65c8fc44fea250f86befd04fb55 100644 (file)
@@ -11,13 +11,13 @@ Application Example
 
 Check `/examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf/>`_ repository, that contains the following example:
 
-`14_gatts_demo <https://github.com/espressif/esp-idf/blob/master/examples/14_gatt_server/main/gatts_demo.c>`_ 
+`14_gatts_demo <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_server/main/gatts_demo.c>`_ 
 
 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
index 371aa5b2333c3a7b4f194cd444cd0cb182997c61..5702389af81fba7896e5d0f18cc2dfe94213f9fd 100644 (file)
@@ -4,7 +4,7 @@ ETHERNET
 Application Example
 -------------------
 
-ethernet example: `examples/17_ethernet <https://github.com/espressif/esp-idf/tree/master/examples/17_ethernet>`_.
+ethernet example: `examples/ethernet/ethernet <https://github.com/espressif/esp-idf/tree/master/examples/ethernet/ethernet>`_.
 
 API Reference
 -------------
index f331b9d26516eedcbd3108835fd7cf751d0a85ee..643eac1f4db527bbb6b7a29276b7f6578a762f59 100644 (file)
@@ -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 <https://github.com/espressif/esp-idf/tree/master/examples/21_gpio>`_.
+GPIO output and input interrupt example: `examples/peripherals/gpio <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/gpio>`_.
 
 API Reference
 -------------
index 2f89681f1d66c8771b69ea5bf08437613f8a2526..93d863da6bda6698e00924395b6fcbc7dd82a6bc 100644 (file)
@@ -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 <https://github.com/espressif/esp-idf/tree/master/examples/18_i2c>`_.
+I2C master and slave example: `examples/peripherals/i2c <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/i2c>`_.
 
 API Reference
 -------------
index 12d7cd16d0827bf3e52c9a0d6ab0df5b080d2810..8c55e2413bc8e1b29a2f7b3ad68f45eb6f8b9e3c 100644 (file)
@@ -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 <https://github.com/espressif/esp-idf/tree/master/examples/29_ledc>`_.
+LEDC change duty cycle and fading control example: `examples/peripherals/ledc <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/ledc>`_.
 
 API Reference
 -------------
index 7fe73e6f47a2531075821b9190d123617430f1ef..bf4fcd04063d44af9db44f81bf78ae5582120322 100644 (file)
@@ -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 <https://github.com/espressif/esp-idf/tree/master/examples/16_pcnt>`_.
+Pulse counter with control signal and event interrupt example: `examples/peripherals/pcnt <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/pcnt>`_.
 
 API Reference
 -------------
index 9d834b1e28cf405b7782a94aa231af9de1b01b87..715bc46786e28df086edb929493fb9cad8204737 100644 (file)
@@ -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 <https://github.com/espressif/esp-idf/tree/master/examples/11_rmt_nec_tx_rx>`_.
+NEC remote control TX and RX example: `examples/peripherals/rmt_nec_tx_rx <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/rmt_nec_tx_rx>`_.
 
 API Reference
 -------------
index 0db0a12c234d3153ec471256f353896528d3fb49..203c6b0d30772bb55dd444d9116113f75aca17d5 100644 (file)
@@ -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 <https://github.com/espressif/esp-idf/tree/master/examples/13_timer_group>`_.
+64-bit hardware timer example: `examples/peripherals/timer_group <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/timer_group>`_.
 
 API Reference
 -------------
index fa83309e2a71ce17ca3caf961252bb86d8e1dde1..8684b2afa370d1e52972a7100140fc494cfe59b4 100644 (file)
@@ -16,7 +16,7 @@ API Reference
 
 `Instructions`_
 
-.. _Instructions: template.html
+.. _Instructions: ../template.html
 
 Header Files
 ^^^^^^^^^^^^
index 95789444f580fbd863c01f191c1ef2204d779eb4..d674e25a08b42800aafc7ec2b7af24e23bc8a211 100644 (file)
@@ -163,7 +163,7 @@ Example of using the methods above:
 Application Example
 -------------------
 
-mDNS server/scanner example: `examples/30_mdns_example <https://github.com/espressif/esp-idf/tree/master/examples/30_mdns_example>`_.
+mDNS server/scanner example: `examples/protocols/mdsn <https://github.com/espressif/esp-idf/tree/master/examples/protocols/mdsn>`_.
 
 API Reference
 -------------
index e751852f954e6c7cc38841111bd8208071421ceb..fe2e5c27f88473341c1979ed79adb521c6961309 100644 (file)
@@ -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
index c13d3d751a4524449b2c51763c357c72110993de..1fe832a2c5dbac07fbbb11b3d596c0896e427800 100644 (file)
@@ -16,7 +16,7 @@ API Reference
 
 `Instructions`_
 
-.. _Instructions: template.html
+.. _Instructions: ../template.html
 
 Header Files
 ^^^^^^^^^^^^
index 7a33a412560bb5dddd732bc9767ed2379a0f47e0..d4353287b941bd723aa399f7bbfafcd3ed336533 100644 (file)
@@ -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
index 81a0e36c7159b0c133178a19e1817420cb332991..94b8549b36062bbebcb86a6685280bda6573b325 100644 (file)
@@ -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).
 
index 09cd364e8d132c5c025632d3426df1ce7fa77764..797e8d422a128326fc14a40976bfb5f2707f7103 100644 (file)
@@ -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).
 
index 49a47d3799ddf7cb20682c9c3b2d37170c8161db..886dbf5fbbfb9de29040f2bc1ec0f45fc85f060a 100644 (file)
@@ -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