Skip to content

Commit

Permalink
Merge branch 'feature/add_mesh_support_macro' into 'master'
Browse files Browse the repository at this point in the history
ble_mesh: docs: Remove BLE Mesh related reference for C2

Closes IDF-4215

See merge request espressif/esp-idf!19513
  • Loading branch information
jack0c committed Sep 20, 2022
2 parents 09f7589 + 6e79d05 commit 9d8d118
Show file tree
Hide file tree
Showing 16 changed files with 37 additions and 12 deletions.
4 changes: 4 additions & 0 deletions components/soc/esp32/include/soc/Kconfig.soc_caps.in
Original file line number Diff line number Diff line change
Expand Up @@ -743,6 +743,10 @@ config SOC_BLE_SUPPORTED
bool
default y

config SOC_BLE_MESH_SUPPORTED
bool
default y

config SOC_BT_CLASSIC_SUPPORTED
bool
default y
1 change: 1 addition & 0 deletions components/soc/esp32/include/soc/soc_caps.h
Original file line number Diff line number Diff line change
Expand Up @@ -393,4 +393,5 @@

/*---------------------------------- Bluetooth CAPS ----------------------------------*/
#define SOC_BLE_SUPPORTED (1) /*!< Support Bluetooth Low Energy hardware */
#define SOC_BLE_MESH_SUPPORTED (1) /*!< Support BLE MESH */
#define SOC_BT_CLASSIC_SUPPORTED (1) /*!< Support Bluetooth Classic hardware */
4 changes: 4 additions & 0 deletions components/soc/esp32c2/include/soc/Kconfig.soc_caps.in
Original file line number Diff line number Diff line change
Expand Up @@ -591,6 +591,10 @@ config SOC_BLE_SUPPORTED
bool
default y

config SOC_BLE_MESH_SUPPORTED
bool
default n

config SOC_ESP_NIMBLE_CONTROLLER
bool
default y
1 change: 1 addition & 0 deletions components/soc/esp32c2/include/soc/soc_caps.h
Original file line number Diff line number Diff line change
Expand Up @@ -280,4 +280,5 @@

/*---------------------------------- Bluetooth CAPS ----------------------------------*/
#define SOC_BLE_SUPPORTED (1) /*!< Support Bluetooth Low Energy hardware */
#define SOC_BLE_MESH_SUPPORTED (0) /*!< Support BLE MESH */
#define SOC_ESP_NIMBLE_CONTROLLER (1) /*!< Support BLE EMBEDDED controller V1 */
4 changes: 4 additions & 0 deletions components/soc/esp32c3/include/soc/Kconfig.soc_caps.in
Original file line number Diff line number Diff line change
Expand Up @@ -834,3 +834,7 @@ config SOC_WIFI_MESH_SUPPORT
config SOC_BLE_SUPPORTED
bool
default y

config SOC_BLE_MESH_SUPPORTED
bool
default y
1 change: 1 addition & 0 deletions components/soc/esp32c3/include/soc/soc_caps.h
Original file line number Diff line number Diff line change
Expand Up @@ -382,3 +382,4 @@

/*---------------------------------- Bluetooth CAPS ----------------------------------*/
#define SOC_BLE_SUPPORTED (1) /*!< Support Bluetooth Low Energy hardware */
#define SOC_BLE_MESH_SUPPORTED (1) /*!< Support BLE MESH */
4 changes: 4 additions & 0 deletions components/soc/esp32h2/include/soc/Kconfig.soc_caps.in
Original file line number Diff line number Diff line change
Expand Up @@ -755,6 +755,10 @@ config SOC_BLE_SUPPORTED
bool
default y

config SOC_BLE_MESH_SUPPORTED
bool
default y

config SOC_ESP_NIMBLE_CONTROLLER
bool
default y
1 change: 1 addition & 0 deletions components/soc/esp32h2/include/soc/soc_caps.h
Original file line number Diff line number Diff line change
Expand Up @@ -364,4 +364,5 @@

/*---------------------------------- Bluetooth CAPS ----------------------------------*/
#define SOC_BLE_SUPPORTED (1) /*!< Support Bluetooth Low Energy hardware */
#define SOC_BLE_MESH_SUPPORTED (1) /*!< Support BLE MESH */
#define SOC_ESP_NIMBLE_CONTROLLER (1) /*!< Support BLE EMBEDDED controller V1 */
4 changes: 4 additions & 0 deletions components/soc/esp32s3/include/soc/Kconfig.soc_caps.in
Original file line number Diff line number Diff line change
Expand Up @@ -1063,6 +1063,10 @@ config SOC_BLE_SUPPORTED
bool
default y

config SOC_BLE_MESH_SUPPORTED
bool
default y

config SOC_TWAI_BRP_MIN
int
default 2
Expand Down
1 change: 1 addition & 0 deletions components/soc/esp32s3/include/soc/soc_caps.h
Original file line number Diff line number Diff line change
Expand Up @@ -454,3 +454,4 @@

/*---------------------------------- Bluetooth CAPS ----------------------------------*/
#define SOC_BLE_SUPPORTED (1) /*!< Support Bluetooth Low Energy hardware */
#define SOC_BLE_MESH_SUPPORTED (1) /*!< Support BLE MESH */
10 changes: 8 additions & 2 deletions docs/conf_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
raise RuntimeError('IDF_PATH should be set, run export.sh before building docs')

BT_DOCS = ['api-guides/blufi.rst',
'api-guides/esp-ble-mesh/**',
'api-reference/bluetooth/bt_le.rst',
'api-reference/bluetooth/esp_bt_defs.rst',
'api-reference/bluetooth/esp_bt_device.rst',
Expand All @@ -32,11 +31,17 @@
'api-reference/bluetooth/esp_gatts.rst',
'api-reference/bluetooth/esp_gattc.rst',
'api-reference/bluetooth/esp_blufi.rst',
'api-reference/bluetooth/esp-ble-mesh.rst',
'api-reference/bluetooth/index.rst',
'api-reference/bluetooth/nimble/index.rst',
'migration-guides/release-5.x/bluetooth-low-energy.rst']

BLE_MESH_DOCS = ['api-guides/esp-ble-mesh/ble-mesh-index.rst',
'api-guides/esp-ble-mesh/ble-mesh-feature-list.rst',
'api-guides/esp-ble-mesh/ble-mesh-terminology.rst',
'api-guides/esp-ble-mesh/ble-mesh-architecture.rst',
'api-guides/esp-ble-mesh/ble-mesh-faq.rst',
'api-reference/bluetooth/esp-ble-mesh.rst']

CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst',
'api-reference/bluetooth/esp_a2dp.rst',
'api-reference/bluetooth/esp_avrc.rst',
Expand Down Expand Up @@ -144,6 +149,7 @@

# format: {tag needed to include: documents to included}, tags are parsed from sdkconfig and peripheral_caps.h headers
conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS,
'SOC_BLE_MESH_SUPPORTED':BLE_MESH_DOCS,
'SOC_WIFI_SUPPORTED':WIFI_DOCS,
'SOC_BT_CLASSIC_SUPPORTED':CLASSIC_BT_DOCS,
'SOC_SUPPORT_COEXISTENCE':COEXISTENCE_DOCS,
Expand Down
6 changes: 0 additions & 6 deletions docs/docs_not_updated/esp32c2.txt
Original file line number Diff line number Diff line change
@@ -1,6 +0,0 @@
api-guides/esp-ble-mesh/ble-mesh-index
api-guides/esp-ble-mesh/ble-mesh-feature-list
api-guides/esp-ble-mesh/ble-mesh-terminology
api-guides/esp-ble-mesh/ble-mesh-architecture
api-guides/esp-ble-mesh/ble-mesh-faq
api-reference/bluetooth/esp-ble-mesh
2 changes: 1 addition & 1 deletion docs/en/api-guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ API Guides
:SOC_RTC_MEM_SUPPORTED: deep-sleep-stub
:SOC_USB_OTG_SUPPORTED: dfu
error-handling
:SOC_BT_SUPPORTED: esp-ble-mesh/ble-mesh-index
:SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index
freertos-smp
:SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh
event-handling
Expand Down
2 changes: 1 addition & 1 deletion docs/en/api-reference/bluetooth/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Bluetooth API
bt_le
:SOC_BT_CLASSIC_SUPPORTED: classic_bt
controller_vhci
esp-ble-mesh
:SOC_BLE_MESH_SUPPORTED: esp-ble-mesh
nimble/index

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 choice:
Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/api-guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ API 指南
:SOC_RTC_MEM_SUPPORTED: deep-sleep-stub
:SOC_USB_OTG_SUPPORTED: dfu
error-handling
:SOC_BT_SUPPORTED: esp-ble-mesh/ble-mesh-index
:SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index
freertos-smp
:SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh
event-handling
Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/api-reference/bluetooth/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
bt_le
:SOC_BT_CLASSIC_SUPPORTED: classic_bt
controller_vhci
esp-ble-mesh
:SOC_BLE_MESH_SUPPORTED: esp-ble-mesh
nimble/index

ESP-IDF 目前支持两个主机堆栈。基于 Bluedroid 的堆栈(默认)支持传统蓝牙和 BLE,而基于 Apache NimBLE 的堆栈仅支持 BLE。用户可参考如下信息进行选择:
Expand Down

0 comments on commit 9d8d118

Please sign in to comment.