esp-idf/examples/bluetooth/bluedroid/classic_bt/bt_discovery/README.md

| Supported Targets | ESP32 |
| ----------------- | ----- |

# ESP-IDF BT-INQUIRY demo

Demo of Classic Bluetooth Device and Service Discovery
This is the demo for user to use ESP_APIs to perform inquiry to search for a target device and then performs service search via SDP.

## How to use example

### Hardware Required

This example is designed to run on commonly available ESP32 development board, e.g. ESP32-DevKitC.

### 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
```

(Replace PORT with the name of the serial port to use.)

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

See the [Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) for full steps to configure and use ESP-IDF to build projects.

## Example Description

After the program started, the device will start inquiry to search for a device with Major device type "PHONE" in the Class of Device Field. Then it will cancel the inquiry and started to perform service discovering on this remote device.

## Trouble shooting

- Some old BT device doesn't place their device name in EIR, but new devices place their device name in EIR. Users can obtain the peer device name in `bt_app_gap_cb` `ESP_BT_GAP_DISC_RES_EVT` event handler or resolve it in EIR just like the function `get_name_from_eir` does.

- ESP32 places its device name in EIR by default.
Rewrite Bluedroid BT READMEs from .rst to .md 2020-07-06 22:26:08 -04:00			`\| Supported Targets \| ESP32 \|`
			`\| ----------------- \| ----- \|`
build_app: make multi target support readable 2020-04-09 04:40:57 -04:00
Update bt_discovery demo and README 1. Use bt_app_gap_init function 2. Add Security Simple Pair doc 3. Update README Update SPP demo 1. Add input module for bt_spp_initiator demo to show the security simple pair features 2. Update README of bt_spp_acceptor and bt_spp_initiator demo. Format comment in esp_a2dp_api.h Format comment in esp_avrc_api.h Format comment in esp_spp_api.h Fix bt_discovery build err Update HFP API guide error Remove BTA_AV_DEBUG Remove Trailing Whitespace & End of Files 2020-09-15 02:44:03 -04:00			`# ESP-IDF BT-INQUIRY demo`
component/bt: implement Classic Bluetooth GAP APIs for device and service discovery 2017-11-24 04:28:43 -05:00
			`Demo of Classic Bluetooth Device and Service Discovery`
			`This is the demo for user to use ESP_APIs to perform inquiry to search for a target device and then performs service search via SDP.`

Update bt_discovery demo and README 1. Use bt_app_gap_init function 2. Add Security Simple Pair doc 3. Update README Update SPP demo 1. Add input module for bt_spp_initiator demo to show the security simple pair features 2. Update README of bt_spp_acceptor and bt_spp_initiator demo. Format comment in esp_a2dp_api.h Format comment in esp_avrc_api.h Format comment in esp_spp_api.h Fix bt_discovery build err Update HFP API guide error Remove BTA_AV_DEBUG Remove Trailing Whitespace & End of Files 2020-09-15 02:44:03 -04:00			`## How to use example`

			`### Hardware Required`

			`This example is designed to run on commonly available ESP32 development board, e.g. ESP32-DevKitC.`

			`### 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`
			```

			`(Replace PORT with the name of the serial port to use.)`

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

			`See the [Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) for full steps to configure and use ESP-IDF to build projects.`

			`## Example Description`
component/bt: implement Classic Bluetooth GAP APIs for device and service discovery 2017-11-24 04:28:43 -05:00
			`After the program started, the device will start inquiry to search for a device with Major device type "PHONE" in the Class of Device Field. Then it will cancel the inquiry and started to perform service discovering on this remote device.`
Update bt_discovery demo and README 1. Use bt_app_gap_init function 2. Add Security Simple Pair doc 3. Update README Update SPP demo 1. Add input module for bt_spp_initiator demo to show the security simple pair features 2. Update README of bt_spp_acceptor and bt_spp_initiator demo. Format comment in esp_a2dp_api.h Format comment in esp_avrc_api.h Format comment in esp_spp_api.h Fix bt_discovery build err Update HFP API guide error Remove BTA_AV_DEBUG Remove Trailing Whitespace & End of Files 2020-09-15 02:44:03 -04:00
			`## Trouble shooting`

			- Some old BT device doesn't place their device name in EIR, but new devices place their device name in EIR. Users can obtain the peer device name in `bt_app_gap_cb` `ESP_BT_GAP_DISC_RES_EVT` event handler or resolve it in EIR just like the function `get_name_from_eir` does.

			`- ESP32 places its device name in EIR by default.`