mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Updated links to examples in new folders / categories in api documentation
This commit is contained in:
parent
47a0b88f6e
commit
ad25997349
@ -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:
|
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.
|
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`_
|
||||||
|
|
||||||
.. _Instructions: template.html
|
.. _Instructions: ../template.html
|
||||||
|
|
||||||
API Reference
|
API Reference
|
||||||
-------------
|
-------------
|
||||||
|
@ -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:
|
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.
|
This is a BLUFI demo. This demo can set ESP32's wifi to softap/station/softap&station mode and config wifi connections.
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ Application Example
|
|||||||
|
|
||||||
`Instructions`_
|
`Instructions`_
|
||||||
|
|
||||||
.. _Instructions: template.html
|
.. _Instructions: ../template.html
|
||||||
|
|
||||||
|
|
||||||
API Reference
|
API Reference
|
||||||
|
@ -13,7 +13,7 @@ Application Example
|
|||||||
|
|
||||||
`Instructions`_
|
`Instructions`_
|
||||||
|
|
||||||
.. _Instructions: template.html
|
.. _Instructions: ../template.html
|
||||||
|
|
||||||
|
|
||||||
API Reference
|
API Reference
|
||||||
|
@ -11,7 +11,7 @@ Application Example
|
|||||||
|
|
||||||
`Instructions`_
|
`Instructions`_
|
||||||
|
|
||||||
.. _Instructions: template.html
|
.. _Instructions: ../template.html
|
||||||
|
|
||||||
|
|
||||||
API Reference
|
API Reference
|
||||||
|
@ -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:
|
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>`_
|
||||||
`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>`_
|
||||||
|
|
||||||
The two demos use different gap api, such like advertising, scan, set device name and others.
|
The two demos use different gap api, such like advertising, scan, set device name and others.
|
||||||
|
|
||||||
`Instructions`_
|
`Instructions`_
|
||||||
|
|
||||||
.. _Instructions: template.html
|
.. _Instructions: ../template.html
|
||||||
|
|
||||||
|
|
||||||
API Reference
|
API Reference
|
||||||
|
@ -11,7 +11,7 @@ Application Example
|
|||||||
|
|
||||||
`Instructions`_
|
`Instructions`_
|
||||||
|
|
||||||
.. _Instructions: template.html
|
.. _Instructions: ../template.html
|
||||||
|
|
||||||
|
|
||||||
API Reference
|
API Reference
|
||||||
|
@ -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:
|
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.
|
This is a gatt client demo. This demo can scan devices, connect to the gatt server and discover the service.
|
||||||
|
|
||||||
`Instructions`_
|
`Instructions`_
|
||||||
|
|
||||||
.. _Instructions: template.html
|
.. _Instructions: ../template.html
|
||||||
|
|
||||||
|
|
||||||
API Reference
|
API Reference
|
||||||
|
@ -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:
|
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.
|
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`_
|
||||||
|
|
||||||
.. _Instructions: template.html
|
.. _Instructions: ../template.html
|
||||||
|
|
||||||
|
|
||||||
API Reference
|
API Reference
|
||||||
|
@ -4,7 +4,7 @@ ETHERNET
|
|||||||
Application Example
|
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
|
API Reference
|
||||||
-------------
|
-------------
|
||||||
|
@ -10,7 +10,7 @@ Note that GPIO6-11 are usually used for SPI flash. GPIO34-39 can only be set as
|
|||||||
Application Example
|
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
|
API Reference
|
||||||
-------------
|
-------------
|
||||||
|
@ -9,7 +9,7 @@ ESP32 has two I2C controllers which can be set as master mode or slave mode.
|
|||||||
Application Example
|
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
|
API Reference
|
||||||
-------------
|
-------------
|
||||||
|
@ -12,7 +12,7 @@ decrease the duty cycle gradually, allowing for fades without any processor inte
|
|||||||
Application Example
|
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
|
API Reference
|
||||||
-------------
|
-------------
|
||||||
|
@ -9,7 +9,7 @@ The PCNT (Pulse Counter) module is designed to count the number of rising and/or
|
|||||||
Application Example
|
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
|
API Reference
|
||||||
-------------
|
-------------
|
||||||
|
@ -9,7 +9,7 @@ The RMT (Remote Control) module driver can be used to send and receive infrared
|
|||||||
Application Example
|
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
|
API Reference
|
||||||
-------------
|
-------------
|
||||||
|
@ -12,7 +12,7 @@ They are all 64-bit generic timers based on 16-bit prescalers and 64-bit auto-re
|
|||||||
Application Example
|
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
|
API Reference
|
||||||
-------------
|
-------------
|
||||||
|
@ -16,7 +16,7 @@ API Reference
|
|||||||
|
|
||||||
`Instructions`_
|
`Instructions`_
|
||||||
|
|
||||||
.. _Instructions: template.html
|
.. _Instructions: ../template.html
|
||||||
|
|
||||||
Header Files
|
Header Files
|
||||||
^^^^^^^^^^^^
|
^^^^^^^^^^^^
|
||||||
|
@ -163,7 +163,7 @@ Example of using the methods above:
|
|||||||
Application Example
|
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
|
API Reference
|
||||||
-------------
|
-------------
|
||||||
|
@ -15,7 +15,7 @@ Protocol layer works with the host via ``sdmmc_host_t`` structure. This structur
|
|||||||
Application Example
|
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
|
Protocol layer APIs
|
||||||
|
@ -16,7 +16,7 @@ API Reference
|
|||||||
|
|
||||||
`Instructions`_
|
`Instructions`_
|
||||||
|
|
||||||
.. _Instructions: template.html
|
.. _Instructions: ../template.html
|
||||||
|
|
||||||
Header Files
|
Header Files
|
||||||
^^^^^^^^^^^^
|
^^^^^^^^^^^^
|
||||||
|
@ -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.
|
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
|
Fully Overriding The Component Makefile
|
||||||
|
@ -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.
|
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).
|
Detailed functional description of NVS and API is provided in [documentation](http://esp-idf.readthedocs.io/en/latest/api/nvs_flash.html).
|
||||||
|
|
||||||
|
@ -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.
|
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).
|
Detailed functional description of NVS and API is provided in [documentation](http://esp-idf.readthedocs.io/en/latest/api/nvs_flash.html).
|
||||||
|
|
||||||
|
@ -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.
|
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:
|
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
|
make
|
||||||
cd build
|
cd build
|
||||||
python -m SimpleHTTPServer 8070
|
python -m SimpleHTTPServer 8070
|
||||||
|
Loading…
Reference in New Issue
Block a user