esp-idf/examples/bluetooth/nimble/ble_spp/spp_client

Supported Targets	ESP32	ESP32-C3	ESP32-S3

BLE SPP central example

In Bluetooth classic (BR/EDR) systems, a Serial Port Profile (SPP) is an adopted profile defined by the Bluetooth Special Interest Group (SIG) used to emulate a serial port connection over a Bluetooth wireless connection. For BLE systems, an adopted SPP profile over BLE is not defined, thus emulation of a serial port must be implemented as a vendor-specific custom profile.

This reference design consists of two Demos, the BLE SPP server and BLE SPP client that run on their respective endpoints. These devices connect and exchange data wirelessly with each other. This capability creates a virtual serial link over the air. Each byte input can be sent and received by both the server and client. The SPP server is implemented as the spp_server demo while the SPP client is implemented as the spp_client demo. Espressif designed the BLE SPP applications to use the UART transport layer but you could adapt this design to work with other serial protocols, such as SPI.

This vendor-specific custom profile is implemented in main.c and main.c.

Using Examples

Initialization

Both the server and client will first initialize the UART and BLE. The server demo will set up the serial port service with standard GATT and GAP services in the attribute server. The client demo will scan the BLE broadcast over the air to find the SPP server.

Event Processing

The spp server has two main event processing functions for BLE event:

  static int ble_spp_server_gap_event(struct ble_gap_event *event, void *arg);
  static int  ble_svc_gatt_handler(uint16_t conn_handle, uint16_t attr_handle,struct ble_gatt_access_ctxt *ctxt, void *arg);

The SPP client has one main event processing functions for BLE event:

  esp_gap_cb(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t * param);

These are some queues and tasks used by SPP application:

Queues:

• spp_uart_queue - Uart data messages received from the Uart

Tasks:

• ble_client_uart_task - process Uart

Packet Structure

After the Uart received data, the data will be posted to Uart task. Then, in the UART_DATA event, the raw data may be retrieved. The max length is 120 bytes every time. If you run the BLE SPP demo with two ESP32 chips, the MTU size will be exchanged after the BLE connection is established, so every packet can be send directly. If you only run the ble_spp_server demo, and it was connected by a phone, the MTU size may be less than 123 bytes. In such a case the data will be split into fragments and send in turn. In every packet, we add 4 bytes to indicate that this is a fragment packet. The first two bytes contain "##" if this is a fragment packet, the third byte is the total number of the packets, the fourth byte is the current number of this packet. The phone APP need to check the structure of the packet if it want to communicate with the ble_spp_server demo.

Sending Data Wirelessly

The client will be sending WriteNoRsp packets to the server. The server side sends data through notifications. When the Uart receives data, the Uart task places it in the buffer.

Receiving Data Wirelessly

The server will receive this data in the BLE_GATT_ACCESS_OP_WRITE_CHR event.

GATT Server Attribute Table

charactertistic	UUID	Permissions
SPP_DATA_RECV_CHAR	0xABF1	READ&WRITE_NR
SPP_DATA_NOTIFY_CHAR	0xABF2	READ&NOTIFY
SPP_COMMAND_CHAR	0xABF3	READ&WRITE_NR
SPP_STATUS_CHAR	0xABF4	READ & NOTIFY

This example creates GATT client and performs passive scan, it then connects to peripheral device if the device advertises connectability and the write characteristic.

It performs three GATT operations against the specified peer:

• Discover all services,characteristics and descriptors.

• After the discovery is completed, take UART input from user and write characteristic.

Note :

• Make sure to run python -m pip install --user -r $IDF_PATH/requirements.txt -r $IDF_PATH/tools/ble/requirements.txt to install the dependency packages needed.
• Currently this Python utility is only supported on Linux (BLE communication is via BLuez + DBus).

How to use example

Configure the project

idf.py menuconfig

Build and Flash

Build the project and flash it to the board, then run monitor tool to view serial output:

idf.py -p PORT flash monitor

(To exit the serial monitor, type Ctrl-].)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

Example Output

This is the console output on successful connection:

I (487) NimBLE_SPP_BLE_CENT: BLE Host Task Started
GAP procedure initiated: stop advertising.
GAP procedure initiated: discovery; own_addr_type=0 filter_policy=0 passive=1 limited=0 filter_duplicates=1 duration=forever
GAP procedure initiated: connect; peer_addr_type=0 peer_addr=7c:df:a1:40:3e:fa scan_itvl=16 scan_window=16 itvl_min=24 itvl_max=40 latency=0 supervision_timeout=256 min_ce_len=0 max_ce_len=0 own_addr_type=0
Connection established
GATT procedure initiated: discover all services
GATT procedure initiated: discover all characteristics; start_handle=1 end_handle=5
GATT procedure initiated: discover all characteristics; start_handle=6 end_handle=9
GATT procedure initiated: discover all characteristics; start_handle=10 end_handle=14
GATT procedure initiated: discover all characteristics; start_handle=15 end_handle=65535
GATT procedure initiated: discover all descriptors; chr_val_handle=8 end_handle=9
GATT procedure initiated: discover all descriptors; chr_val_handle=17 end_handle=18
GATT procedure initiated: discover all descriptors; chr_val_handle=20 end_handle=65535
Service discovery complete; status=0 conn_handle=1
I (9277) NimBLE_SPP_BLE_CENT: Data sent from client uart task =
1b5b41
GATT procedure initiated: write; att_handle=17 len=3
I (9277) NimBLE_SPP_BLE_CENT: Write in uart task success!
received notification; conn_handle=1 attr_handle=20 attr_len=1