Merge branch 'docs/add_ble_get_started_docs' into 'master'

[BT-3811] Added BLE Get Started See merge request espressif/esp-idf!32195
espressif · Aug 27, 2024 · a11aa9c · a11aa9c
2 parents c9df77e + f62f21d
commit a11aa9c
Show file tree

Hide file tree

Showing 31 changed files with 2,399 additions and 0 deletions.
diff --git a/docs/_static/ble/ble-4.2-adv-packet-structure.png b/docs/_static/ble/ble-4.2-adv-packet-structure.png
diff --git a/docs/_static/ble/ble-adv-packet-raw-data.jpg b/docs/_static/ble/ble-adv-packet-raw-data.jpg
diff --git a/docs/_static/ble/ble-advertise-and-scan-sequence.png b/docs/_static/ble/ble-advertise-and-scan-sequence.png
diff --git a/docs/_static/ble/ble-advertiser-rx-connection-request.png b/docs/_static/ble/ble-advertiser-rx-connection-request.png
diff --git a/docs/_static/ble/ble-advertiser-rx-scan-request.png b/docs/_static/ble/ble-advertiser-rx-scan-request.png
diff --git a/docs/_static/ble/ble-architecture.png b/docs/_static/ble/ble-architecture.png
diff --git a/docs/_static/ble/ble-connection-connected.jpg b/docs/_static/ble/ble-connection-connected.jpg
diff --git a/docs/_static/ble/ble-connection-device-list.jpg b/docs/_static/ble/ble-connection-device-list.jpg
diff --git a/docs/_static/ble/ble-connection-event-and-connection-interval.png b/docs/_static/ble/ble-connection-event-and-connection-interval.png
diff --git a/docs/_static/ble/ble-gap-state-diagram.png b/docs/_static/ble/ble-gap-state-diagram.png
diff --git a/docs/_static/ble/ble-gatt-architecture.png b/docs/_static/ble/ble-gatt-architecture.png
diff --git a/docs/_static/ble/ble-get-started-automation-io-service-details.jpg b/docs/_static/ble/ble-get-started-automation-io-service-details.jpg
diff --git a/docs/_static/ble/ble-get-started-connect-brief.jpg b/docs/_static/ble/ble-get-started-connect-brief.jpg
diff --git a/docs/_static/ble/ble-get-started-connect-details.jpg b/docs/_static/ble/ble-get-started-connect-details.jpg
diff --git a/docs/_static/ble/ble-get-started-gatt-services-list.jpg b/docs/_static/ble/ble-get-started-gatt-services-list.jpg
diff --git a/docs/_static/ble/ble-get-started-heart-rate-indicate.jpg b/docs/_static/ble/ble-get-started-heart-rate-indicate.jpg
diff --git a/docs/_static/ble/ble-get-started-heart-rate-read.jpg b/docs/_static/ble/ble-get-started-heart-rate-read.jpg
diff --git a/docs/_static/ble/ble-get-started-heart-rate-service-details.jpg b/docs/_static/ble/ble-get-started-heart-rate-service-details.jpg
diff --git a/docs/_static/ble/ble-get-started-led-write.jpg b/docs/_static/ble/ble-get-started-led-write.jpg
diff --git a/docs/_static/ble/ble-scan-list-nimble-beacon.jpg b/docs/_static/ble/ble-scan-list-nimble-beacon.jpg
diff --git a/docs/conf_common.py b/docs/conf_common.py
@@ -28,6 +28,10 @@
             'api-guides/ble/ble-feature-support-status.rst',
             'api-guides/ble/host-feature-support-status.rst',
             'api-reference/bluetooth/bt_le.rst',
+            'api-guides/ble/get-started/ble-introduction.rst',
+            'api-guides/ble/get-started/ble-device-discovery.rst',
+            'api-guides/ble/get-started/ble-connection.rst',
+            'api-guides/ble/get-started/ble-data-exchange.rst',
             'api-reference/bluetooth/esp_gap_ble.rst',
             'api-reference/bluetooth/esp_gatt_defs.rst',
             'api-reference/bluetooth/esp_gatts.rst',

diff --git a/docs/en/api-guides/ble/get-started/ble-connection.rst b/docs/en/api-guides/ble/get-started/ble-connection.rst
@@ -0,0 +1 @@
+.. include:: ../../../../zh_CN/api-guides/ble/get-started/ble-connection.rst
diff --git a/docs/en/api-guides/ble/get-started/ble-data-exchange.rst b/docs/en/api-guides/ble/get-started/ble-data-exchange.rst
@@ -0,0 +1 @@
+.. include:: ../../../../zh_CN/api-guides/ble/get-started/ble-data-exchange.rst
diff --git a/docs/en/api-guides/ble/get-started/ble-device-discovery.rst b/docs/en/api-guides/ble/get-started/ble-device-discovery.rst
@@ -0,0 +1 @@
+.. include:: ../../../../zh_CN/api-guides/ble/get-started/ble-device-discovery.rst
diff --git a/docs/en/api-guides/ble/get-started/ble-introduction.rst b/docs/en/api-guides/ble/get-started/ble-introduction.rst
@@ -0,0 +1 @@
+.. include:: ../../../../zh_CN/api-guides/ble/get-started/ble-introduction.rst
diff --git a/docs/en/api-guides/ble/index.rst b/docs/en/api-guides/ble/index.rst
@@ -13,6 +13,18 @@ Overview
    overview
    ble-feature-support-status
 
+***************
+Get Started
+***************
+
+.. toctree::
+   :maxdepth: 1
+
+   get-started/ble-introduction
+   get-started/ble-device-discovery
+   get-started/ble-connection
+   get-started/ble-data-exchange
+
 **********
 Profile
 **********

diff --git a/docs/zh_CN/api-guides/ble/get-started/ble-connection.rst b/docs/zh_CN/api-guides/ble/get-started/ble-connection.rst
diff --git a/docs/zh_CN/api-guides/ble/get-started/ble-data-exchange.rst b/docs/zh_CN/api-guides/ble/get-started/ble-data-exchange.rst
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		.. include:: ../../../../zh_CN/api-guides/ble/get-started/ble-connection.rst