New BLE examples

24_ble_scan_with_names/Makefile

@@ -0,0 +1,9 @@
+#
+# This is a project Makefile. It is assumed the directory this Makefile resides in is a
+# project subdirectory.
+#
+
+PROJECT_NAME := ble_scan_with_names
+
+include $(IDF_PATH)/make/project.mk
+

24_ble_scan_with_names/main/main.c

@@ -0,0 +1,151 @@
+#include <freertos/FreeRTOS.h>
+#include <freertos/task.h>
+
+#include "nvs_flash.h"
+#include "esp_err.h"
+#include "esp_log.h"
+
+#include "esp_bt.h"
+#include "esp_bt_main.h"
+#include "esp_gap_ble_api.h"
+
+
+// array of found devices
+#define MAX_DISCOVERED_DEVICES 50
+esp_bd_addr_t discovered_devices[MAX_DISCOVERED_DEVICES];
+int discovered_devices_num = 0;
+
+// scan parameters
+static esp_ble_scan_params_t ble_scan_params = {
+		.scan_type              = BLE_SCAN_TYPE_ACTIVE,
+		.own_addr_type          = BLE_ADDR_TYPE_PUBLIC,
+		.scan_filter_policy     = BLE_SCAN_FILTER_ALLOW_ALL,
+		.scan_interval          = 0x50,
+		.scan_window            = 0x30
+	};
+
+// check if the device was already discovered
+bool alreadyDiscovered(esp_bd_addr_t address) {
+
+	bool found = false;
+
+	for(int i = 0; i < discovered_devices_num; i++) {
+
+		for(int j = 0; j < ESP_BD_ADDR_LEN; j++)
+			found = (discovered_devices[i][j] == address[j]);
+
+		if(found) break;
+	}
+
+	return found;
+}
+
+// add a new device to the list
+void addDevice(esp_bd_addr_t address) {
+
+	discovered_devices_num++;
+	if(discovered_devices_num > MAX_DISCOVERED_DEVICES) return;
+
+	for(int i = 0; i < ESP_BD_ADDR_LEN; i++)
+		discovered_devices[discovered_devices_num - 1][i] = address[i];
+}
+
+// GAP callback
+static void esp_gap_cb(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)
+{
+    switch (event) {
+
+		case ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT: 
+
+			printf("ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT\n");
+			if(param->scan_param_cmpl.status == ESP_BT_STATUS_SUCCESS) {
+				printf("Scan parameters set, start scanning for 10 seconds\n\n");
+				esp_ble_gap_start_scanning(10);
+			}
+			else printf("Unable to set scan parameters, error code %d\n\n", param->scan_param_cmpl.status);
+			break;
+
+		case ESP_GAP_BLE_SCAN_START_COMPLETE_EVT:
+
+			printf("ESP_GAP_BLE_SCAN_START_COMPLETE_EVT\n");
+			if(param->scan_start_cmpl.status == ESP_BT_STATUS_SUCCESS) {
+				printf("Scan started\n\n");
+			}
+			else printf("Unable to start scan process, error code %d\n\n", param->scan_start_cmpl.status);
+			break;
+
+		case ESP_GAP_BLE_SCAN_RESULT_EVT:
+
+			if(param->scan_rst.search_evt == ESP_GAP_SEARCH_INQ_RES_EVT) {
+
+				if(!alreadyDiscovered(param->scan_rst.bda)) {
+
+					printf("ESP_GAP_BLE_SCAN_RESULT_EVT\n");
+					printf("Device found: ADDR=");
+					for(int i = 0; i < ESP_BD_ADDR_LEN; i++) {
+						printf("%02X", param->scan_rst.bda[i]);
+						if(i != ESP_BD_ADDR_LEN -1) printf(":");
+					}
+
+					// try to read the complete name
+					uint8_t *adv_name = NULL;
+					uint8_t adv_name_len = 0;
+					adv_name = esp_ble_resolve_adv_data(param->scan_rst.ble_adv, ESP_BLE_AD_TYPE_NAME_CMPL, &adv_name_len);
+					if(adv_name) {
+						printf("\nFULL NAME=");
+						for(int i = 0; i < adv_name_len; i++) printf("%c", adv_name[i]);
+					}
+
+					printf("\n\n");
+					addDevice(param->scan_rst.bda);
+				}
+
+			}
+			else if(param->scan_rst.search_evt == ESP_GAP_SEARCH_INQ_CMPL_EVT)
+				printf("Scan complete\n\n");
+			break;
+
+		default:
+
+			printf("Event %d unhandled\n\n", event);
+			break;
+	}
+}
+
+
+void app_main() {
+
+	printf("BT scan\n\n");
+
+	// set components to log only errors
+	esp_log_level_set("*", ESP_LOG_ERROR);
+
+	// initialize nvs
+	ESP_ERROR_CHECK(nvs_flash_init());
+	printf("- NVS init ok\n");
+
+	// release memory reserved for classic BT (not used)
+	ESP_ERROR_CHECK(esp_bt_controller_mem_release(ESP_BT_MODE_CLASSIC_BT));
+	printf("- Memory for classic BT released\n");
+
+	// initialize the BT controller with the default config
+	esp_bt_controller_config_t bt_cfg = BT_CONTROLLER_INIT_CONFIG_DEFAULT();
+    esp_bt_controller_init(&bt_cfg);
+	printf("- BT controller init ok\n");
+
+	// enable the BT controller in BLE mode
+    esp_bt_controller_enable(ESP_BT_MODE_BLE);
+	printf("- BT controller enabled in BLE mode\n");
+
+	// initialize Bluedroid library
+	esp_bluedroid_init();
+    esp_bluedroid_enable();
+	printf("- Bluedroid initialized and enabled\n");
+
+	// register GAP callback function
+	ESP_ERROR_CHECK(esp_ble_gap_register_callback(esp_gap_cb));
+	printf("- GAP callback registered\n\n");
+
+	// configure scan parameters
+	esp_ble_gap_set_scan_params(&ble_scan_params);
+}

25_ibeacon_finder/Makefile

@@ -0,0 +1,9 @@
+#
+# This is a project Makefile. It is assumed the directory this Makefile resides in is a
+# project subdirectory.
+#
+
+PROJECT_NAME := ibeacon_finder
+
+include $(IDF_PATH)/make/project.mk
+

25_ibeacon_finder/main/Kconfig.projbuild

@@ -0,0 +1,20 @@
+menu "iBeacon finder configuration"
+
+config IBEACON_UUID
+    string "iBeacon UUID"
+
+config MIN_RSSI
+    int "Min RSSI to consider the iBeacon found"
+	default -50	
+
+config TIMEOUT
+    int "Timeout (in milliseconds)"
+	default 10000
+
+config LED_PIN
+    int "PIN connected to the LED"
+	range 0 34
+	default 0
+
+endmenu
+

25_ibeacon_finder/main/main.c

@@ -0,0 +1,203 @@
+#include "string.h"
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "freertos/event_groups.h"
+
+#include "nvs_flash.h"
+#include "esp_err.h"
+#include "esp_log.h"
+
+#include "esp_bt.h"
+#include "esp_bt_main.h"
+#include "esp_gap_ble_api.h"
+
+#include "driver/gpio.h"
+
+
+// ---------- iBeacon packet structure ----------
+
+typedef struct {
+    uint8_t flags[3];
+    uint8_t length;
+    uint8_t type;
+    uint16_t company_id;
+    uint16_t beacon_type;
+}__attribute__((packed)) ibeacon_header_t;
+
+typedef struct {
+    uint8_t proximity_uuid[16];
+    uint16_t major;
+    uint16_t minor;
+    int8_t measured_power;
+}__attribute__((packed)) ibeacon_data_t;
+
+typedef struct {
+    ibeacon_header_t ibeacon_header;
+    ibeacon_data_t ibeacon_data;
+}__attribute__((packed)) ibeacon_packet_t;
+
+// ----------------------------------------------
+
+// iBeacon fixed header
+ibeacon_header_t ibeacon_fixed_header = {
+	.flags = {0x02, 0x01, 0x06},
+	.length = 0x1A,
+    .type = 0xFF,
+    .company_id = 0x004C,
+    .beacon_type = 0x1502
+};
+
+// scan parameters
+static esp_ble_scan_params_t ble_scan_params = {
+	.scan_type              = BLE_SCAN_TYPE_ACTIVE,
+	.own_addr_type          = BLE_ADDR_TYPE_PUBLIC,
+	.scan_filter_policy     = BLE_SCAN_FILTER_ALLOW_ALL,
+	.scan_interval          = 0x50,
+	.scan_window            = 0x30
+};
+
+// global variables
+bool led_on = false;
+static EventGroupHandle_t my_event_group;
+const int FOUND_BIT = BIT0;
+
+// timeout task
+void timeout_task(void *pvParameter) {
+
+	while(1) {
+
+		// wait the timeout period
+		EventBits_t uxBits;
+		uxBits = xEventGroupWaitBits(my_event_group, FOUND_BIT, true, true, CONFIG_TIMEOUT / portTICK_PERIOD_MS);
+
+		// if found bit was not set, the function returned after the timeout period
+		if((uxBits & FOUND_BIT) == 0) {
+
+			// turn the led off
+			if(led_on) {
+				gpio_set_level(CONFIG_LED_PIN, 0);
+				led_on = false;
+				printf("iBeacon not found for %d milliseconds, led off\n", CONFIG_TIMEOUT);
+			}
+		}
+	}
+}
+
+// GAP callback
+static void esp_gap_cb(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)
+{
+    switch (event) {
+
+		case ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT: 
+
+			printf("ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT\n");
+			if(param->scan_param_cmpl.status == ESP_BT_STATUS_SUCCESS) {
+				printf("Scan parameters set, start scan process\n\n");
+				esp_ble_gap_start_scanning(0);
+			}
+			else printf("Unable to set scan parameters, error code %d\n\n", param->scan_param_cmpl.status);
+			break;
+
+		case ESP_GAP_BLE_SCAN_START_COMPLETE_EVT:
+
+			printf("ESP_GAP_BLE_SCAN_START_COMPLETE_EVT\n");
+			if(param->scan_start_cmpl.status == ESP_BT_STATUS_SUCCESS) {
+				printf("Scan process started\n\n");
+
+				// start the timeout task
+				xTaskCreate(&timeout_task, "timeout_task", 2048, NULL, 5, NULL);
+				printf("Timeout task started\n\n");
+			}
+			else printf("Unable to start scan process, error code %d\n\n", param->scan_start_cmpl.status);
+			break;
+
+		case ESP_GAP_BLE_SCAN_RESULT_EVT:
+
+			if(param->scan_rst.search_evt == ESP_GAP_SEARCH_INQ_RES_EVT) {
+
+				// a device was found, check if it's an iBeacon
+
+				// first verify that data length is 30 bytes
+				if ((param->scan_rst.ble_adv != NULL) && (param->scan_rst.adv_data_len == 0x1E)) {
+
+					// now compare the header with the iBeacon fixed header
+					if (!memcmp(param->scan_rst.ble_adv, (uint8_t *)&ibeacon_fixed_header, sizeof(ibeacon_fixed_header))) {
+
+						// this is an iBeacon, parse the data and check if the UUID matches and the signal strength is ok
+						char ibeacon_uuid[32];
+						ibeacon_packet_t *ibeacon_packet = (ibeacon_packet_t *)(param->scan_rst.ble_adv);
+						for(int i = 0; i < 16; i++) sprintf(ibeacon_uuid + 2*i, "%02x", ibeacon_packet->ibeacon_data.proximity_uuid[i]);
+
+						if((strncmp(ibeacon_uuid, CONFIG_IBEACON_UUID, 32) == 0) && (param->scan_rst.rssi > CONFIG_MIN_RSSI)) {
+
+							// if it matches, notify the timeout task and turn the led on
+							xEventGroupSetBits(my_event_group, FOUND_BIT);
+
+							if(!led_on) {
+								gpio_set_level(CONFIG_LED_PIN, 1);
+								led_on = true;
+								printf("iBeacon found, led on\n");
+							}
+						}	
+					}
+				}	
+			}
+			else if(param->scan_rst.search_evt == ESP_GAP_SEARCH_INQ_CMPL_EVT)
+				printf("Scan complete\n\n");
+			break;
+
+		default:
+
+			printf("Event %d unhandled\n\n", event);
+			break;
+	}
+}
+
+
+void app_main() {
+
+	printf("iBeacon finder\n\n");
+
+	// set components to log only errors
+	esp_log_level_set("*", ESP_LOG_ERROR);
+
+	// initialize nvs
+	ESP_ERROR_CHECK(nvs_flash_init());
+	printf("- NVS init ok\n");
+
+	// configure led pin
+	gpio_pad_select_gpio(CONFIG_LED_PIN);
+    gpio_set_direction(CONFIG_LED_PIN, GPIO_MODE_OUTPUT);
+	gpio_set_level(CONFIG_LED_PIN, 0);
+	printf("- LED pin configurated\n");
+
+	// create the event group 
+	my_event_group = xEventGroupCreate();
+	printf("- Event group created\n");
+
+	// release memory reserved for classic BT (not used)
+	ESP_ERROR_CHECK(esp_bt_controller_mem_release(ESP_BT_MODE_CLASSIC_BT));
+	printf("- Memory for classic BT released\n");
+
+	// initialize the BT controller with the default config
+	esp_bt_controller_config_t bt_cfg = BT_CONTROLLER_INIT_CONFIG_DEFAULT();
+    esp_bt_controller_init(&bt_cfg);
+	printf("- BT controller init ok\n");
+
+	// enable the BT controller in BLE mode
+    esp_bt_controller_enable(ESP_BT_MODE_BLE);
+	printf("- BT controller enabled in BLE mode\n");
+
+	// initialize Bluedroid library
+	esp_bluedroid_init();
+    esp_bluedroid_enable();
+	printf("- Bluedroid initialized and enabled\n");
+
+	// register GAP callback function
+	ESP_ERROR_CHECK(esp_ble_gap_register_callback(esp_gap_cb));
+	printf("- GAP callback registered\n\n");
+
+	// configure scan parameters
+	esp_ble_gap_set_scan_params(&ble_scan_params);
+}