Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
OVMS3-idf/docs/en/api-reference/bluetooth/index.rst

33 lines
2 KiB
ReStructuredText
Raw Normal View History

Moved api documentation to new folders / categories
2017-01-16 22:08:35 +00:00
Bluetooth API
*************
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst
2016-10-26 19:08:36 +00:00
component/bt : doxygen can generate html correctly
2016-12-01 12:20:22 +00:00
.. toctree::
Moved api documentation to new folders / categories
2017-01-16 22:08:35 +00:00
:maxdepth: 2
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst
2016-10-26 19:08:36 +00:00
component/bt: modify bluetooth API 1. VHCI api and doxygen 2. Controller api and doxygen 3. bluedroid init/enable api and doxygen 4. cleanup demo codes
2017-01-03 07:53:06 +00:00
Bluetooth Controller && VHCI <controller_vhci>
component/bt : doxygen can generate html correctly
2016-12-01 12:20:22 +00:00
Bluetooth Common <bt_common>
Bluetooth LE <bt_le>
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
Bluetooth Classic <classic_bt>
NimBLE: Port NimBLE stack to IDF Release v3.3 (Backport v3.3) Includes all the latest NimBLE stack changes from idf-v4.0 with few idf-v3.3 specific modifications. - Addition of nimble component as submodule (`nimble-1.1.0-idf-v3.3`), contains IDF v3.3 specific minor changes. - Example applications are identical to idf-v4.0 - Modification in `bt/Kconfig` to accommodate NimBLE as a BT host.
2019-10-18 05:23:24 +00:00
NimBLE <nimble/index>
Moved api documentation to new folders / categories
2017-01-16 22:08:35 +00:00
Added links from api category TOC to example category folders Typo fix in bluetooth README.md
2017-01-18 20:04:11 +00:00
NimBLE: Port NimBLE stack to IDF Release v3.3 (Backport v3.3) Includes all the latest NimBLE stack changes from idf-v4.0 with few idf-v3.3 specific modifications. - Addition of nimble component as submodule (`nimble-1.1.0-idf-v3.3`), contains IDF v3.3 specific minor changes. - Example applications are identical to idf-v4.0 - Modification in `bt/Kconfig` to accommodate NimBLE as a BT host.
2019-10-18 05:23:24 +00:00
ESP-IDF currently supports two host stacks. The Bluedroid based stack (default) supports classic Bluetooth as well as BLE. On the other hand, Apache NimBLE based stack is BLE only. For users to make a
* For usecases involving classic Bluetooth as well as BLE, Bluedroid should be used.
* For BLE-only usecases, using NimBLE is recommended. It is less demanding in terms of code footprint and runtime memory, making it suitable for such scenarios.
component/bt: Update BLE examples tutorials and ReadMe files - Make docs compatible with GitHub Markdown - Add tutorials links in programming doc - Modify ReadMe files
2018-01-11 12:24:18 +00:00
To see the overview of the ESP32 Bluetooth stack architecture, follow links below:
* `ESP32 Bluetooth Architecture (PDF) [English] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
* `ESP32 Bluetooth Architecture (PDF) [中文] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_
docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests.
2017-01-19 08:16:06 +00:00
Example code for this API section is provided in :example:`bluetooth` directory of ESP-IDF examples.
component/bt: Update BLE examples tutorials and ReadMe files - Make docs compatible with GitHub Markdown - Add tutorials links in programming doc - Modify ReadMe files
2018-01-11 12:24:18 +00:00
Several examples contain detailed description. To see them please follow links below:
* :example_file:`GATT Client Example Walkthrough <bluetooth/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md>`
* :example_file:`GATT Server Service Table Example Walkthrough <bluetooth/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>`
* :example_file:`GATT Server Example Walkthrough <bluetooth/gatt_server/tutorial/Gatt_Server_Example_Walkthrough.md>`
* :example_file:`GATT Security Client Example Walkthrough <bluetooth/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
* :example_file:`GATT Security Server Example Walkthrough <bluetooth/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`
* :example_file:`GATT Client Multi-connection Example Walkthrough <bluetooth/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_Example_Walkthrough.md>`
Reference in a new issue Copy permalink