1| Supported Targets | ESP32 | ESP32-C3 | 2| ----------------- | ----- | -------- | 3 4# ESP-IDF Gatt Security Client Example 5 6This example shows how to use the ESP BLE security APIs to secure connect to and encrypt with peer devices. 7 8## How to Use Example 9 10Before project configuration and build, be sure to set the correct chip target using: 11 12```bash 13idf.py set-target <chip_name> 14``` 15 16To test this demo, you can run the [gatt_security_server_demo](../gatt_security_server), which starts advertising and can be connected to this demo automatically. 17 18There are some important points for this demo: 191. `esp_ble_gap_set_security_param` should be used to set the security parameters in the initial stage; 202. `esp_ble_set_encryption` should be used to start encryption with peer device. If the peer device initiates the encryption, `esp_ble_gap_security_rsp` should be used to send security response to the peer device when `ESP_GAP_BLE_SEC_REQ_EVT` is received. 213. The `gatt_security_client_demo` will receive a `ESP_GAP_BLE_AUTH_CMPL_EVT` once the encryption procedure has completed. 22 23Please, check this [tutorial](tutorial/Gatt_Security_Client_Example_Walkthrough.md) for more information about this example. 24 25### Hardware Required 26 27* A development board with ESP32/ESP32-C3 SoC (e.g., ESP32-DevKitC, ESP-WROVER-KIT, etc.) 28* A USB cable for Power supply and programming 29 30See [Development Boards](https://www.espressif.com/en/products/devkits) for more information about it. 31 32### Build and Flash 33 34Run `idf.py -p PORT flash monitor` to build, flash and monitor the project. 35 36(To exit the serial monitor, type ``Ctrl-]``.) 37 38See the [Getting Started Guide](https://idf.espressif.com/) for full steps to configure and use ESP-IDF to build projects. 39 40## Example Output 41 42``` 43I (0) cpu_start: Starting scheduler on APP CPU. 44I (572) BTDM_INIT: BT controller compile version [1342a48] 45I (572) system_api: Base MAC address is not set 46I (572) system_api: read default base MAC address from EFUSE 47I (582) phy_init: phy_version 4670,719f9f6,Feb 18 2021,17:07:07 48I (1002) SEC_GATTC_DEMO: EVT 0, gattc if 1 49I (1002) SEC_GATTC_DEMO: REG_EVT 50I (1032) SEC_GATTC_DEMO: Scan start success 51I (1242) SEC_GATTC_DEMO: 38 68 a4 69 bb 7c 52I (1242) SEC_GATTC_DEMO: Searched Adv Data Len 31, Scan Response Len 14 53I (1242) SEC_GATTC_DEMO: Searched Device Name Len 0 54I (1242) SEC_GATTC_DEMO: 55 56I (1262) SEC_GATTC_DEMO: 38 68 a4 69 bb 7c 57I (1262) SEC_GATTC_DEMO: Searched Adv Data Len 31, Scan Response Len 14 58I (1262) SEC_GATTC_DEMO: Searched Device Name Len 0 59I (1272) SEC_GATTC_DEMO: 60 61I (1592) SEC_GATTC_DEMO: 38 68 a4 69 bb 7c 62I (1592) SEC_GATTC_DEMO: Searched Adv Data Len 31, Scan Response Len 14 63I (1592) SEC_GATTC_DEMO: Searched Device Name Len 0 64I (1602) SEC_GATTC_DEMO: 65 66I (1912) SEC_GATTC_DEMO: 38 68 a4 69 bb 7c 67I (1912) SEC_GATTC_DEMO: Searched Adv Data Len 31, Scan Response Len 14 68I (1912) SEC_GATTC_DEMO: Searched Device Name Len 0 69I (1922) SEC_GATTC_DEMO: 70 71``` 72 73## Troubleshooting 74 75For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon. 76
