From 5ae9647667619e862fd9969f44edd1cefd52e3b6 Mon Sep 17 00:00:00 2001 From: krzychb Date: Tue, 17 Jan 2017 19:12:48 +0100 Subject: [PATCH] Added links to examples in API documentation --- docs/api/peripherals/spi_master.rst | 5 +++++ docs/api/peripherals/uart.rst | 8 +++----- docs/api/system/deep_sleep.rst | 5 +++++ docs/api/system/log.rst | 8 +++++--- docs/api/system/ota.rst | 5 +++++ docs/api/wifi/esp_wifi.rst | 8 +++----- 6 files changed, 26 insertions(+), 13 deletions(-) diff --git a/docs/api/peripherals/spi_master.rst b/docs/api/peripherals/spi_master.rst index 012d1832ce..9e5c0eb636 100644 --- a/docs/api/peripherals/spi_master.rst +++ b/docs/api/peripherals/spi_master.rst @@ -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 `_. + API Reference ------------- diff --git a/docs/api/peripherals/uart.rst b/docs/api/peripherals/uart.rst index 8684b2afa3..b00b4e0648 100644 --- a/docs/api/peripherals/uart.rst +++ b/docs/api/peripherals/uart.rst @@ -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 `_. API Reference ------------- -`Instructions`_ - -.. _Instructions: ../template.html - Header Files ^^^^^^^^^^^^ diff --git a/docs/api/system/deep_sleep.rst b/docs/api/system/deep_sleep.rst index 9e6642fd90..393d5f025e 100644 --- a/docs/api/system/deep_sleep.rst +++ b/docs/api/system/deep_sleep.rst @@ -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 `_ example, where ESP module is periodically waken up to retrive time from NTP server. + diff --git a/docs/api/system/log.rst b/docs/api/system/log.rst index d812740bb2..24d3bef80a 100644 --- a/docs/api/system/log.rst +++ b/docs/api/system/log.rst @@ -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 `_ folder of `espressif/esp-idf `_ repository, that among others, contains the following examples: + +* `system/ota `_ +* `storage/sd_card `_ +* `protocols/https_request `_ API Reference ------------- diff --git a/docs/api/system/ota.rst b/docs/api/system/ota.rst index a4984620f6..ce2fdba635 100644 --- a/docs/api/system/ota.rst +++ b/docs/api/system/ota.rst @@ -1,6 +1,11 @@ OTA === +Application Example +------------------- + +Demonstration of OTA (over the air) firmware update workflow: `examples/system/ota `_. + API Reference ------------- diff --git a/docs/api/wifi/esp_wifi.rst b/docs/api/wifi/esp_wifi.rst index 1fe832a2c5..247ddf7522 100644 --- a/docs/api/wifi/esp_wifi.rst +++ b/docs/api/wifi/esp_wifi.rst @@ -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 `_. API Reference ------------- -`Instructions`_ - -.. _Instructions: ../template.html - Header Files ^^^^^^^^^^^^