Bluetooth® API

[中文]

This section provides the API reference for Bluetooth components supported in ESP-IDF. ESP-IDF supports two host stacks: Bluedroid and NimBLE.

  • Bluedroid (the default stack): Supports both Bluetooth Classic and Bluetooth LE. Recommended for applications that require both technologies.

  • NimBLE: A lightweight stack for Bluetooth LE only. Ideal for resource-constrained applications due to smaller code size and memory usage.

Use the navigation links below to explore API documentation and application examples.


Controller Interface API

The low-level interface between the Bluetooth host stack and the controller.

Bluedroid Stack API

The default host stack in ESP-IDF, supporting both Bluetooth Classic and Bluetooth LE.

For architecture and feature overviews, refer to the following documents in API Guides:

Bluetooth® Architecture, Bluetooth® Low Energy

NimBLE Stack API

A lightweight host stack for Bluetooth LE.

For additional details and API reference from the upstream documentation, refer to Apache Mynewt NimBLE User Guide.

ESP-BLE-MESH API

Implements Bluetooth LE Mesh networking.


Examples and Tutorials

Explore examples and tutorials in the ESP-IDF examples directory:

Step-by-step tutorials for developing with the Bluedroid stack:

Step-by-step tutorials for developing with the NimBLE stack:


Was this page helpful?