Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated links to point directly to example folder, fixed names

Browse source
This commit is contained in:
krzychb 2017-01-17 20:03:26 +01:00
parent 5ae9647667
commit 03c14809f9
6 changed files with 26 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/api/bluetooth/controller_vhci.rst
View file

@ -6,19 +6,17 @@ Overview
`Instructions`_ `Instructions`_
.. _Instructions: ../template.html
Application Example 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/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf/>`_ repository, that contains the following example:
`bluetooth/ble_adv <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/ble_adv/main/app_bt.c>`_ `ble_adv <https://github.com/espressif/esp-idf/blob/master/examples/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. 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
API Reference API Reference
------------- -------------

6
docs/api/bluetooth/esp_blufi.rst
View file

@ -11,11 +11,11 @@ Use should concern these things:
Application Example 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/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that contains the following example:
`bluetooth/blufi <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/blufi/main/>`_ `blufi <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/blufi>`_
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.
API Reference API Reference

16
docs/api/bluetooth/esp_gap_ble.rst
View file

@ -1,25 +1,21 @@
GAP API GAP API
======== =======
Overview Overview
-------- --------
`Instructions`_ `Instructions`_
.. _Instructions: ../template.html
Application Example 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/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that contains the following examples:
`14_gatts_demo <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_server/main/gatts_demo.c>`_ `gatt_server <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_server>`_, `gatt_client <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_client>`_
`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
The two demos use different gap api, such like advertising, scan, set device name and others.
API Reference API Reference
------------- -------------

12
docs/api/bluetooth/esp_gattc.rst
View file

@ -6,18 +6,16 @@ Overview
`Instructions`_ `Instructions`_
.. _Instructions: ../template.html
Application Example 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/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ 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/bluetooth/gatt_client/main/gattc_demo.c>`_ `gatt_client <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_client>`_
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: ../template.html
API Reference API Reference

13
docs/api/bluetooth/esp_gatts.rst
View file

@ -6,19 +6,16 @@ Overview
`Instructions`_ `Instructions`_
.. _Instructions: ../template.html
Application Example 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/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ 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/bluetooth/gatt_server/main/gatts_demo.c>`_ `gatt_server <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_server>`_
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
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.
API Reference API Reference
------------- -------------

6
docs/api/storage/nvs_flash.rst
View file

@ -3,9 +3,9 @@
Application Example Application Example
------------------- -------------------
Two examples are provided in ESP-IDF examples directory: Two examples are provided in ESP-IDF `examples/storage <https://github.com/espressif/esp-idf/tree/master/examples/storage>`_ directory:
`storage/nvs_rw_value <https://github.com/espressif/esp-idf/blob/master/examples/storage/nvs_rw_value/main/nvs_rw_value.c>`_ `nvs_rw_value <https://github.com/espressif/esp-idf/blob/master/examples/storage/nvs_rw_value>`_
Demonstrates how to read and write a single integer value using NVS. Demonstrates how to read and write a single integer value using NVS.
@ -13,7 +13,7 @@ Two examples are provided in ESP-IDF examples directory:
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.
`storage/nvs_rw_blob <https://github.com/espressif/esp-idf/blob/master/examples/storage/nvs_rw_blob/main/nvs_rw_blob.c>`_ `nvs_rw_blob <https://github.com/espressif/esp-idf/blob/master/examples/storage/nvs_rw_blob>`_
Demonstrates how to read and write a single integer value and a blob (binary large object) using NVS to preserve them between ESP32 module restarts. Demonstrates how to read and write a single integer value and a blob (binary large object) using NVS to preserve them between ESP32 module restarts.