README.md
1| Supported Targets | ESP32 |
2| ----------------- | ----- |
3
4# BLE Peripheral with ICMP Echo-Reply
5
6(See the README.md file in the upper level 'examples' directory for more information about examples.)
7
8This example aims to run `ping` network utility along with BLE GATT server simultaneously using NimBLE host stack. It is a combination of 2 examples in IDF: `bluetooth/nimble/bleprph` and `protocols/icmp_echo`. See the README.md files of these examples to know more about them.
9
10### BLE peripheral
11
12This example creates GATT server and then starts advertising, waiting to be connected to a GATT client.
13
14It uses ESP32's Bluetooth controller and NimBLE stack based BLE host.
15
16### ICMP Echo-Reply
17
18Ping is a useful network utility used to test if a remote host is reachable on the IP network. It measures the round-trip time for messages sent from the source host to a destination target that are echoed back to the source.
19
20Ping operates by sending Internet Control Message Protocol (ICMP) echo request packets to the target host and waiting for an ICMP echo reply.
21
22**Notes:** Currently this example only supports IPv4.
23
24## How to Use Example
25
26Before project configuration and build, be sure to set the correct chip target using:
27
28```bash
29idf.py set-target <chip_name>
30```
31
32### Configure the project
33
34Open the project configuration menu:
35
36```bash
37idf.py menuconfig
38```
39
40In the `Example Configuration` menu:
41
42* Enter SSID and password of known Wi-Fi AP with connectivity to internet.
43* Enter desired ping IP Address. Default is set to `93.184.216.34` ( This is the IP address of https://example.com ).
44
45* Enter other related parameters like count of ping and maximum numbers of retry.
46
47## Testing
48
49To test this demo, any BLE scanner app and a WiFi access point with internet connectivity can be used.
50
51### Build and Flash
52
53Run `idf.py -p PORT flash monitor` to build, flash and monitor the project.
54
55(To exit the serial monitor, type ``Ctrl-]``.)
56
57See the [Getting Started Guide](https://idf.espressif.com/) for full steps to configure and use ESP-IDF to build projects.
58
59## Troubleshooting
60
61For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
62
