Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

component/bt: Optimize iBeacon demo

Browse source 
- Add endian change for major and minor part
- Change measured power format
- Optimize comments in example
This commit is contained in:
island 2017-07-25 14:36:00 +08:00
parent eff95f3799
commit 2f9111c13f
2 changed files with 70 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
examples/bluetooth/ble_ibeacon/README.rst
View file

@ -1,5 +1,9 @@
ESP-IDF GATT CLIENT demo ESP-IDF iBeacon demo
======================== ========================
This example demonstrates iBeacon-compatible BLE advertising, and scanning of iBeacons.
- IBEACON_SENDER: demo to send iBeacon-compatible advertising data.
- IBEACON_RECEIVER: demo to receive and resolve iBeacon advertising data.
This is the demo for user to use ESP_APIs to create a GATT Client. iBeacon is a trademark of Apple Inc.
Before building devices which use iBeacon technology, visit https://developer.apple.com/ibeacon/ to obtain a license.

112
examples/bluetooth/ble_ibeacon/main/ibeacon_demo.c
View file

@ -1,4 +1,4 @@
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD // Copyright 2015-2017 Espressif Systems (Shanghai) PTE LTD
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -16,7 +16,11 @@
/**************************************************************************** /****************************************************************************
* *
* This file is for gatt client. It can scan ble device, connect one device, * This file is for iBeacon demo. It supports both iBeacon sender and receiver
* which is distinguished by macros IBEACON_SENDER and IBEACON_RECEIVER,
*
* iBeacon is a trademark of Apple Inc. Before building devices which use iBeacon technology,
* visit https://developer.apple.com/ibeacon/ to obtain a license.
* *
****************************************************************************/ ****************************************************************************/
@ -25,6 +29,7 @@
#include <stdbool.h> #include <stdbool.h>
#include <stdio.h> #include <stdio.h>
#include "controller.h" #include "controller.h"
#include "nvs_flash.h"
#include "bt.h" #include "bt.h"
#include "bt_trace.h" #include "bt_trace.h"
@ -37,15 +42,20 @@
#include "esp_gatt_defs.h" #include "esp_gatt_defs.h"
#include "esp_bt_main.h" #include "esp_bt_main.h"
#define IBEACON_TAG "IBEACON_DEMO"
/* Because current ESP IDF version doesn't support scan and adv simultaneously, /* Because current ESP IDF version doesn't support scan and adv simultaneously,
* so Ibeacon sender and receiver should not run simultaneously */ * so iBeacon sender and receiver should not run simultaneously */
#define IBEACON_SENDER 0 #define IBEACON_SENDER 0
#define IBEACON_RECEIVER 1 #define IBEACON_RECEIVER 1
//#define IBEACON_MODE IBEACON_SENDER //IBEACON_RECEIVER
#define IBEACON_MODE IBEACON_RECEIVER #define IBEACON_MODE IBEACON_RECEIVER
static const char* DEMO_TAG = "IBEACON_DEMO";
/* Major and Minor part are stored in big endian mode in iBeacon packet,
* need to use this macro to transfer while creating or processing
* iBeacon data */
#define ENDIAN_CHANGE_U16(x) ((((x)&0xFF00)>>8) + (((x)&0xFF)<<8))
///Declare static functions ///Declare static functions
static void esp_gap_cb(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param); static void esp_gap_cb(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param);
@ -82,7 +92,7 @@ typedef struct {
uint8_t proximity_uuid[16]; uint8_t proximity_uuid[16];
uint16_t major; uint16_t major;
uint16_t minor; uint16_t minor;
uint8_t tx_power; int8_t measured_power;
}__attribute__((packed)) esp_ble_ibeacon_vendor_t; }__attribute__((packed)) esp_ble_ibeacon_vendor_t;
@ -93,7 +103,8 @@ typedef struct {
const uint8_t uuid_zeros[ESP_UUID_LEN_128] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; const uint8_t uuid_zeros[ESP_UUID_LEN_128] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
/* For Ibeacon packet format, please refer to Apple "Proximity Beacon Specification" doc */ /* For iBeacon packet format, please refer to Apple "Proximity Beacon Specification" doc */
/* Constant part of iBeacon data */
const esp_ble_ibeacon_head_t ibeacon_common_head = { const esp_ble_ibeacon_head_t ibeacon_common_head = {
.flags = {0x02, 0x01, 0x06}, .flags = {0x02, 0x01, 0x06},
.length = 0x1A, .length = 0x1A,
@ -102,9 +113,18 @@ const esp_ble_ibeacon_head_t ibeacon_common_head = {
.beacon_type = 0x1502 .beacon_type = 0x1502
}; };
bool esp_ble_is_ibeacon_packet (uint8_t *adv_data, uint8_t adv_data_len){ /* Vendor part of iBeacon data*/
bool result = FALSE; esp_ble_ibeacon_vendor_t vendor_config = {
.proximity_uuid = {0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0XFF},
.major = ENDIAN_CHANGE_U16(0x0001), //Major=0x0001
.minor = ENDIAN_CHANGE_U16(0x0010), //Minor=0x0010
.measured_power = 0xC5
};
BOOLEAN esp_ble_is_ibeacon_packet (uint8_t *adv_data, uint8_t adv_data_len){
BOOLEAN result = FALSE;
false;
if ((adv_data != NULL) && (adv_data_len == 0x1E)){ if ((adv_data != NULL) && (adv_data_len == 0x1E)){
if (!memcmp(adv_data, (uint8_t*)&ibeacon_common_head, sizeof(ibeacon_common_head))){ if (!memcmp(adv_data, (uint8_t*)&ibeacon_common_head, sizeof(ibeacon_common_head))){
result = TRUE; result = TRUE;
@ -119,8 +139,8 @@ esp_err_t esp_ble_config_ibeacon_data (esp_ble_ibeacon_vendor_t *vendor_config,
return ESP_ERR_INVALID_ARG; return ESP_ERR_INVALID_ARG;
} }
memcpy(&(ibeacon_adv_data->ibeacon_head), (uint8_t*)&ibeacon_common_head, sizeof(ibeacon_common_head)); memcpy(&ibeacon_adv_data->ibeacon_head, &ibeacon_common_head, sizeof(esp_ble_ibeacon_head_t));
memcpy(&(ibeacon_adv_data->ibeacon_vendor), vendor_config, sizeof(esp_ble_ibeacon_vendor_t)); memcpy(&ibeacon_adv_data->ibeacon_vendor, vendor_config, sizeof(esp_ble_ibeacon_vendor_t));
return ESP_OK; return ESP_OK;
} }
@ -131,10 +151,10 @@ static void esp_gap_cb(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *par
switch (event) { switch (event) {
case ESP_GAP_BLE_ADV_DATA_RAW_SET_COMPLETE_EVT:{ case ESP_GAP_BLE_ADV_DATA_RAW_SET_COMPLETE_EVT:{
#if (IBEACON_MODE == IBEACON_SENDER) #if (IBEACON_MODE == IBEACON_SENDER)
esp_ble_gap_start_advertising(&ble_adv_params); esp_ble_gap_start_advertising(&ble_adv_params);
#endif #endif
break; break;
} }
case ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT: { case ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT: {
#if (IBEACON_MODE == IBEACON_RECEIVER) #if (IBEACON_MODE == IBEACON_RECEIVER)
//the unit of the duration is second, 0 means scan permanently //the unit of the duration is second, 0 means scan permanently
@ -146,29 +166,30 @@ static void esp_gap_cb(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *par
case ESP_GAP_BLE_SCAN_START_COMPLETE_EVT: case ESP_GAP_BLE_SCAN_START_COMPLETE_EVT:
//scan start complete event to indicate scan start successfully or failed //scan start complete event to indicate scan start successfully or failed
if (param->scan_start_cmpl.status != ESP_BT_STATUS_SUCCESS) { if (param->scan_start_cmpl.status != ESP_BT_STATUS_SUCCESS) {
ESP_LOGE(IBEACON_TAG, "Scan start failed"); ESP_LOGE(DEMO_TAG, "Scan start failed");
} }
break; break;
case ESP_GAP_BLE_ADV_START_COMPLETE_EVT: case ESP_GAP_BLE_ADV_START_COMPLETE_EVT:
//adv start complete event to indicate adv start successfully or failed //adv start complete event to indicate adv start successfully or failed
if (param->adv_start_cmpl.status != ESP_BT_STATUS_SUCCESS) { if (param->adv_start_cmpl.status != ESP_BT_STATUS_SUCCESS) {
ESP_LOGE(IBEACON_TAG, "Adv start failed"); ESP_LOGE(DEMO_TAG, "Adv start failed");
} }
break; break;
case ESP_GAP_BLE_SCAN_RESULT_EVT: { case ESP_GAP_BLE_SCAN_RESULT_EVT: {
esp_ble_gap_cb_param_t *scan_result = (esp_ble_gap_cb_param_t *)param; esp_ble_gap_cb_param_t *scan_result = (esp_ble_gap_cb_param_t *)param;
switch (scan_result->scan_rst.search_evt) { switch (scan_result->scan_rst.search_evt) {
case ESP_GAP_SEARCH_INQ_RES_EVT: case ESP_GAP_SEARCH_INQ_RES_EVT:
/* Search for BLE Ibeacon Packet */ /* Search for BLE iBeacon Packet */
if (esp_ble_is_ibeacon_packet(scan_result->scan_rst.ble_adv, scan_result->scan_rst.adv_data_len)){ if (esp_ble_is_ibeacon_packet(scan_result->scan_rst.ble_adv, scan_result->scan_rst.adv_data_len)){
esp_ble_ibeacon_t *ibeacon_data = (esp_ble_ibeacon_t*)(scan_result->scan_rst.ble_adv); esp_ble_ibeacon_t *ibeacon_data = (esp_ble_ibeacon_t*)(scan_result->scan_rst.ble_adv);
ESP_LOGI(IBEACON_TAG, "----------Ibeacon Found----------"); ESP_LOGI(DEMO_TAG, "----------iBeacon Found----------");
esp_log_buffer_hex("IBEACON_DEMO: Device address:", scan_result->scan_rst.bda, BD_ADDR_LEN ); esp_log_buffer_hex("IBEACON_DEMO: Device address:", scan_result->scan_rst.bda, BD_ADDR_LEN );
esp_log_buffer_hex("IBEACON_DEMO: Proximity UUID:", ibeacon_data->ibeacon_vendor.proximity_uuid, ESP_UUID_LEN_128); esp_log_buffer_hex("IBEACON_DEMO: Proximity UUID:", ibeacon_data->ibeacon_vendor.proximity_uuid, ESP_UUID_LEN_128);
ESP_LOGI(IBEACON_TAG, "Major: 0x%04x", ibeacon_data->ibeacon_vendor.major); ESP_LOGI(DEMO_TAG, "Major: 0x%04x", ENDIAN_CHANGE_U16(ibeacon_data->ibeacon_vendor.major));
ESP_LOGI(IBEACON_TAG, "Minor: 0x%04x", ibeacon_data->ibeacon_vendor.minor); ESP_LOGI(DEMO_TAG, "Minor: 0x%04x", ENDIAN_CHANGE_U16(ibeacon_data->ibeacon_vendor.minor));
ESP_LOGI(IBEACON_TAG, "Tx Power:0x%02x", ibeacon_data->ibeacon_vendor.tx_power); ESP_LOGI(DEMO_TAG, "Measured power (RSSI at a 1m distance):%d dbm", ibeacon_data->ibeacon_vendor.measured_power);
ESP_LOGI(DEMO_TAG, "RSSI of packet:%d dbm", scan_result->scan_rst.rssi);
} }
break; break;
default: default:
@ -179,19 +200,19 @@ static void esp_gap_cb(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *par
case ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT: case ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT:
if (param->scan_stop_cmpl.status != ESP_BT_STATUS_SUCCESS){ if (param->scan_stop_cmpl.status != ESP_BT_STATUS_SUCCESS){
ESP_LOGE(IBEACON_TAG, "Scan stop failed"); ESP_LOGE(DEMO_TAG, "Scan stop failed");
} }
else { else {
ESP_LOGI(IBEACON_TAG, "Stop scan successfully"); ESP_LOGI(DEMO_TAG, "Stop scan successfully");
} }
break; break;
case ESP_GAP_BLE_ADV_STOP_COMPLETE_EVT: case ESP_GAP_BLE_ADV_STOP_COMPLETE_EVT:
if (param->adv_stop_cmpl.status != ESP_BT_STATUS_SUCCESS){ if (param->adv_stop_cmpl.status != ESP_BT_STATUS_SUCCESS){
ESP_LOGE(IBEACON_TAG, "Adv stop failed"); ESP_LOGE(DEMO_TAG, "Adv stop failed");
} }
else { else {
ESP_LOGI(IBEACON_TAG, "Stop adv successfully"); ESP_LOGI(DEMO_TAG, "Stop adv successfully");
} }
break; break;
@ -201,54 +222,49 @@ static void esp_gap_cb(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *par
} }
void ble_client_appRegister(void) void ble_ibeacon_appRegister(void)
{ {
esp_err_t status; esp_err_t status;
ESP_LOGI(IBEACON_TAG, "register callback"); ESP_LOGI(DEMO_TAG, "register callback");
//register the scan callback function to the gap module //register the scan callback function to the gap module
if ((status = esp_ble_gap_register_callback(esp_gap_cb)) != ESP_OK) { if ((status = esp_ble_gap_register_callback(esp_gap_cb)) != ESP_OK) {
ESP_LOGE(IBEACON_TAG, "gap register error, error code = %x", status); ESP_LOGE(DEMO_TAG, "gap register error, error code = %x", status);
return; return;
} }
} }
void gattc_client_test(void) void ble_ibeacon_init(void)
{ {
esp_bluedroid_init(); esp_bluedroid_init();
esp_bluedroid_enable(); esp_bluedroid_enable();
ble_client_appRegister(); ble_ibeacon_appRegister();
} }
void app_main() void app_main()
{ {
ESP_ERROR_CHECK(nvs_flash_init());
esp_bt_controller_config_t bt_cfg = BT_CONTROLLER_INIT_CONFIG_DEFAULT(); esp_bt_controller_config_t bt_cfg = BT_CONTROLLER_INIT_CONFIG_DEFAULT();
esp_bt_controller_init(&bt_cfg); esp_bt_controller_init(&bt_cfg);
esp_bt_controller_enable(ESP_BT_MODE_BTDM); esp_bt_controller_enable(ESP_BT_MODE_BTDM);
gattc_client_test(); ble_ibeacon_init();
/* set scan parameters */ /* set scan parameters */
#if (IBEACON_MODE == IBEACON_RECEIVER) #if (IBEACON_MODE == IBEACON_RECEIVER)
esp_ble_gap_set_scan_params(&ble_scan_params); esp_ble_gap_set_scan_params(&ble_scan_params);
#elif (IBEACON_MODE == IBEACON_SENDER) #elif (IBEACON_MODE == IBEACON_SENDER)
esp_ble_ibeacon_t ibeacon_adv_data; esp_ble_ibeacon_t ibeacon_adv_data;
esp_ble_ibeacon_vendor_t vendor_config = {
.proximity_uuid = {0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0XFF},
.major = 0x0001,
.minor = 0x0010,
.tx_power = 0xC5
};
esp_err_t status = esp_ble_config_ibeacon_data (&vendor_config, &ibeacon_adv_data); esp_err_t status = esp_ble_config_ibeacon_data (&vendor_config, &ibeacon_adv_data);
if (status == ESP_OK){ if (status == ESP_OK){
esp_ble_gap_config_adv_data_raw((uint8_t*)&ibeacon_adv_data, sizeof(ibeacon_adv_data)); esp_ble_gap_config_adv_data_raw((uint8_t*)&ibeacon_adv_data, sizeof(ibeacon_adv_data));
} }
else { else {
ESP_LOGE(IBEACON_TAG, "Config Ibeacon data failed, status =0x%x\n", status); ESP_LOGE(DEMO_TAG, "Config iBeacon data failed, status =0x%x\n", status);
} }
#endif #endif
} }