]> granicus.if.org Git - esp-idf/commitdiff
Added links to examples in API documentation
authorkrzychb <krzychb@gazeta.pl>
Tue, 17 Jan 2017 18:12:48 +0000 (19:12 +0100)
committerkrzychb <krzychb@gazeta.pl>
Tue, 17 Jan 2017 18:12:48 +0000 (19:12 +0100)
docs/api/peripherals/spi_master.rst
docs/api/peripherals/uart.rst
docs/api/system/deep_sleep.rst
docs/api/system/log.rst
docs/api/system/ota.rst
docs/api/wifi/esp_wifi.rst

index 012d1832ce5729f82f15e0a0967eb1cc6bd9a26f..9e5c0eb6369f575ef36d5b9ce41c00f7c434627f 100644 (file)
@@ -105,6 +105,11 @@ on the transmission. For received data, use ``rx_data`` and set ``SPI_USE_RXDATA
 not touch the ``tx_buffer`` or ``rx_buffer`` members, because they use the same memory locations
 as ``tx_data`` and ``rx_data``.
 
+Application Example
+-------------------
+Display graphics on the ILI9341-based 320x240 LCD: `examples/peripherals/spi_master <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/spi_master>`_.
+
 API Reference
 -------------
 
index 8684b2afa370d1e52972a7100140fc494cfe59b4..b00b4e064865ed2721676e5741eeffc0a63efcb2 100644 (file)
@@ -6,18 +6,16 @@ Overview
 
 `Instructions`_
 
+.. _Instructions: ../template.html
+
 Application Example
 -------------------
 
-`Instructions`_
+Configure uart settings and install uart driver to read/write using UART0 and UART1 interfaces: `examples/peripherals/uart <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/uart>`_.
 
 API Reference
 -------------
 
-`Instructions`_
-
-.. _Instructions: ../template.html
-
 Header Files
 ^^^^^^^^^^^^
 
index 9e6642fd907c7f7bc8187dbd6f0c35fd5be3195b..393d5f025ed6b0e27c8c1231d9ca70ee75285182 100644 (file)
@@ -87,3 +87,8 @@ The following function can be used to enter deep sleep once wakeup sources are c
 
 .. doxygenfunction:: esp_deep_sleep_start
 
+Application Example
+-------------------
+Implementation of basic functionality of deep sleep is shown in `protocols/sntp <https://github.com/espressif/esp-idf/tree/master/examples/protocols/sntp>`_ example, where ESP module is periodically waken up to retrive time from NTP server.
+
index d812740bb2e260e8b12ba4f92fd7d1327e05f0fb..24d3bef80a08a5d9939a0de521bfc6ad99a41f62 100644 (file)
@@ -3,9 +3,11 @@
 Application Example
 -------------------
 
-`Instructions`_
-
-.. _Instructions: ../template.html
+Log library is commonly used by most of esp-idf components and examples. For demonstration of log functionality check `examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that among others, contains the following examples:
+* `system/ota <https://github.com/espressif/esp-idf/tree/master/examples/system/ota>`_ 
+* `storage/sd_card <https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card>`_ 
+* `protocols/https_request <https://github.com/espressif/esp-idf/tree/master/examples/protocols/https_request>`_ 
 
 API Reference
 -------------
index a4984620f6e5883ada2da0c1b8d9bb22b44d5775..ce2fdba63555ba5464f86b60461283cd909938ca 100644 (file)
@@ -1,6 +1,11 @@
 OTA
 ===
 
+Application Example
+-------------------
+Demonstration of OTA (over the air) firmware update workflow: `examples/system/ota <https://github.com/espressif/esp-idf/tree/master/examples/system/ota>`_.
+
 API Reference
 -------------
 
index 1fe832a2c5dbac07fbbb11b3d596c0896e427800..247ddf7522a9f6f8c3067862ba3a000324e9f1ac 100644 (file)
@@ -6,18 +6,16 @@ Overview
 
 `Instructions`_
 
+.. _Instructions: ../template.html
+
 Application Example
 -------------------
 
-`Instructions`_
+Simple code showing how to connect ESP32 module to an Access Point: `esp-idf-template <https://github.com/espressif/esp-idf-template>`_.
 
 API Reference
 -------------
 
-`Instructions`_
-
-.. _Instructions: ../template.html
-
 Header Files
 ^^^^^^^^^^^^