Skip to content

Commit 01d7ea7

Browse files
Bascyme-no-dev
Bascy
authored and
me-no-dev
committed
Refactored use of LOG_X(LOG_TAG, ...) to log_x(...) (#2672)
* Replaced ARDUINO_VARIANT with const char * Fixed missing return value * Added quotes around defined value in macro (Issue #2193) * Change logging from Error to Verbose when not found and default available * Move Enter and Exit logging to Verbose Level * Refactored LOG_X() into log_x()
1 parent af23d0b commit 01d7ea7

21 files changed

+399
-530
lines changed

Diff for: ‎libraries/BLE/src/BLEAdvertisedDevice.cpp

+11-17
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,7 @@
1616
#include <sstream>
1717
#include "BLEAdvertisedDevice.h"
1818
#include "BLEUtils.h"
19-
#if defined(ARDUINO_ARCH_ESP32) && defined(CONFIG_ARDUHAL_ESP_LOG)
2019
#include "esp32-hal-log.h"
21-
#define LOG_TAG ""
22-
#else
23-
#include "esp_log.h"
24-
static const char* LOG_TAG="BLEAdvertisedDevice";
25-
#endif
2620

2721
BLEAdvertisedDevice::BLEAdvertisedDevice() {
2822
m_adFlag = 0;
@@ -249,7 +243,7 @@ void BLEAdvertisedDevice::parseAdvertisement(uint8_t* payload, size_t total_len)
249243
length--;
250244

251245
char* pHex = BLEUtils::buildHexData(nullptr, payload, length);
252-
ESP_LOGD(LOG_TAG, "Type: 0x%.2x (%s), length: %d, data: %s",
246+
log_d("Type: 0x%.2x (%s), length: %d, data: %s",
253247
ad_type, BLEUtils::advTypeToString(ad_type), length, pHex);
254248
free(pHex);
255249

@@ -308,7 +302,7 @@ void BLEAdvertisedDevice::parseAdvertisement(uint8_t* payload, size_t total_len)
308302

309303
case ESP_BLE_AD_TYPE_SERVICE_DATA: { // Adv Data Type: 0x16 (Service Data) - 2 byte UUID
310304
if (length < 2) {
311-
ESP_LOGE(LOG_TAG, "Length too small for ESP_BLE_AD_TYPE_SERVICE_DATA");
305+
log_e("Length too small for ESP_BLE_AD_TYPE_SERVICE_DATA");
312306
break;
313307
}
314308
uint16_t uuid = *(uint16_t*)payload;
@@ -321,7 +315,7 @@ void BLEAdvertisedDevice::parseAdvertisement(uint8_t* payload, size_t total_len)
321315

322316
case ESP_BLE_AD_TYPE_32SERVICE_DATA: { // Adv Data Type: 0x20 (Service Data) - 4 byte UUID
323317
if (length < 4) {
324-
ESP_LOGE(LOG_TAG, "Length too small for ESP_BLE_AD_TYPE_32SERVICE_DATA");
318+
log_e("Length too small for ESP_BLE_AD_TYPE_32SERVICE_DATA");
325319
break;
326320
}
327321
uint32_t uuid = *(uint32_t*) payload;
@@ -334,7 +328,7 @@ void BLEAdvertisedDevice::parseAdvertisement(uint8_t* payload, size_t total_len)
334328

335329
case ESP_BLE_AD_TYPE_128SERVICE_DATA: { // Adv Data Type: 0x21 (Service Data) - 16 byte UUID
336330
if (length < 16) {
337-
ESP_LOGE(LOG_TAG, "Length too small for ESP_BLE_AD_TYPE_128SERVICE_DATA");
331+
log_e("Length too small for ESP_BLE_AD_TYPE_128SERVICE_DATA");
338332
break;
339333
}
340334

@@ -346,7 +340,7 @@ void BLEAdvertisedDevice::parseAdvertisement(uint8_t* payload, size_t total_len)
346340
} //ESP_BLE_AD_TYPE_32SERVICE_DATA
347341

348342
default: {
349-
ESP_LOGD(LOG_TAG, "Unhandled type: adType: %d - 0x%.2x", ad_type, ad_type);
343+
log_d("Unhandled type: adType: %d - 0x%.2x", ad_type, ad_type);
350344
break;
351345
}
352346
} // switch
@@ -386,7 +380,7 @@ void BLEAdvertisedDevice::setAdFlag(uint8_t adFlag) {
386380
void BLEAdvertisedDevice::setAppearance(uint16_t appearance) {
387381
m_appearance = appearance;
388382
m_haveAppearance = true;
389-
ESP_LOGD(LOG_TAG, "- appearance: %d", m_appearance);
383+
log_d("- appearance: %d", m_appearance);
390384
} // setAppearance
391385

392386

@@ -398,7 +392,7 @@ void BLEAdvertisedDevice::setManufacturerData(std::string manufacturerData) {
398392
m_manufacturerData = manufacturerData;
399393
m_haveManufacturerData = true;
400394
char* pHex = BLEUtils::buildHexData(nullptr, (uint8_t*) m_manufacturerData.data(), (uint8_t) m_manufacturerData.length());
401-
ESP_LOGD(LOG_TAG, "- manufacturer data: %s", pHex);
395+
log_d("- manufacturer data: %s", pHex);
402396
free(pHex);
403397
} // setManufacturerData
404398

@@ -410,7 +404,7 @@ void BLEAdvertisedDevice::setManufacturerData(std::string manufacturerData) {
410404
void BLEAdvertisedDevice::setName(std::string name) {
411405
m_name = name;
412406
m_haveName = true;
413-
ESP_LOGD(LOG_TAG, "- setName(): name: %s", m_name.c_str());
407+
log_d("- setName(): name: %s", m_name.c_str());
414408
} // setName
415409

416410

@@ -421,7 +415,7 @@ void BLEAdvertisedDevice::setName(std::string name) {
421415
void BLEAdvertisedDevice::setRSSI(int rssi) {
422416
m_rssi = rssi;
423417
m_haveRSSI = true;
424-
ESP_LOGD(LOG_TAG, "- setRSSI(): rssi: %d", m_rssi);
418+
log_d("- setRSSI(): rssi: %d", m_rssi);
425419
} // setRSSI
426420

427421

@@ -450,7 +444,7 @@ void BLEAdvertisedDevice::setServiceUUID(const char* serviceUUID) {
450444
void BLEAdvertisedDevice::setServiceUUID(BLEUUID serviceUUID) {
451445
m_serviceUUIDs.push_back(serviceUUID);
452446
m_haveServiceUUID = true;
453-
ESP_LOGD(LOG_TAG, "- addServiceUUID(): serviceUUID: %s", serviceUUID.toString().c_str());
447+
log_d("- addServiceUUID(): serviceUUID: %s", serviceUUID.toString().c_str());
454448
} // setServiceUUID
455449

456450

@@ -481,7 +475,7 @@ void BLEAdvertisedDevice::setServiceDataUUID(BLEUUID uuid) {
481475
void BLEAdvertisedDevice::setTXPower(int8_t txPower) {
482476
m_txPower = txPower;
483477
m_haveTXPower = true;
484-
ESP_LOGD(LOG_TAG, "- txPower: %d", m_txPower);
478+
log_d("- txPower: %d", m_txPower);
485479
} // setTXPower
486480

487481

Diff for: ‎libraries/BLE/src/BLEAdvertising.cpp

+29-38
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,7 @@
2222
#include <esp_err.h>
2323
#include "BLEUtils.h"
2424
#include "GeneralUtils.h"
25-
26-
#if defined(ARDUINO_ARCH_ESP32) && defined(CONFIG_ARDUHAL_ESP_LOG)
2725
#include "esp32-hal-log.h"
28-
#define LOG_TAG ""
29-
#else
30-
#include "esp_log.h"
31-
static const char* LOG_TAG = "BLEAdvertising";
32-
#endif
33-
34-
3526

3627
/**
3728
* @brief Construct a default advertising object.
@@ -120,25 +111,25 @@ void BLEAdvertising::setScanResponse(bool set) {
120111
* @param [in] connectWhitelistOnly If true, only allow connections from those on the white list.
121112
*/
122113
void BLEAdvertising::setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly) {
123-
ESP_LOGD(LOG_TAG, ">> setScanFilter: scanRequestWhitelistOnly: %d, connectWhitelistOnly: %d", scanRequestWhitelistOnly, connectWhitelistOnly);
114+
log_v(">> setScanFilter: scanRequestWhitelistOnly: %d, connectWhitelistOnly: %d", scanRequestWhitelistOnly, connectWhitelistOnly);
124115
if (!scanRequestWhitelistOnly && !connectWhitelistOnly) {
125116
m_advParams.adv_filter_policy = ADV_FILTER_ALLOW_SCAN_ANY_CON_ANY;
126-
ESP_LOGD(LOG_TAG, "<< setScanFilter");
117+
log_v("<< setScanFilter");
127118
return;
128119
}
129120
if (scanRequestWhitelistOnly && !connectWhitelistOnly) {
130121
m_advParams.adv_filter_policy = ADV_FILTER_ALLOW_SCAN_WLST_CON_ANY;
131-
ESP_LOGD(LOG_TAG, "<< setScanFilter");
122+
log_v("<< setScanFilter");
132123
return;
133124
}
134125
if (!scanRequestWhitelistOnly && connectWhitelistOnly) {
135126
m_advParams.adv_filter_policy = ADV_FILTER_ALLOW_SCAN_ANY_CON_WLST;
136-
ESP_LOGD(LOG_TAG, "<< setScanFilter");
127+
log_v("<< setScanFilter");
137128
return;
138129
}
139130
if (scanRequestWhitelistOnly && connectWhitelistOnly) {
140131
m_advParams.adv_filter_policy = ADV_FILTER_ALLOW_SCAN_WLST_CON_WLST;
141-
ESP_LOGD(LOG_TAG, "<< setScanFilter");
132+
log_v("<< setScanFilter");
142133
return;
143134
}
144135
} // setScanFilter
@@ -149,15 +140,15 @@ void BLEAdvertising::setScanFilter(bool scanRequestWhitelistOnly, bool connectWh
149140
* @param [in] advertisementData The data to be advertised.
150141
*/
151142
void BLEAdvertising::setAdvertisementData(BLEAdvertisementData& advertisementData) {
152-
ESP_LOGD(LOG_TAG, ">> setAdvertisementData");
143+
log_v(">> setAdvertisementData");
153144
esp_err_t errRc = ::esp_ble_gap_config_adv_data_raw(
154145
(uint8_t*)advertisementData.getPayload().data(),
155146
advertisementData.getPayload().length());
156147
if (errRc != ESP_OK) {
157-
ESP_LOGE(LOG_TAG, "esp_ble_gap_config_adv_data_raw: %d %s", errRc, GeneralUtils::errorToString(errRc));
148+
log_e("esp_ble_gap_config_adv_data_raw: %d %s", errRc, GeneralUtils::errorToString(errRc));
158149
}
159150
m_customAdvData = true; // Set the flag that indicates we are using custom advertising data.
160-
ESP_LOGD(LOG_TAG, "<< setAdvertisementData");
151+
log_v("<< setAdvertisementData");
161152
} // setAdvertisementData
162153

163154

@@ -166,15 +157,15 @@ void BLEAdvertising::setAdvertisementData(BLEAdvertisementData& advertisementDat
166157
* @param [in] advertisementData The data to be advertised.
167158
*/
168159
void BLEAdvertising::setScanResponseData(BLEAdvertisementData& advertisementData) {
169-
ESP_LOGD(LOG_TAG, ">> setScanResponseData");
160+
log_v(">> setScanResponseData");
170161
esp_err_t errRc = ::esp_ble_gap_config_scan_rsp_data_raw(
171162
(uint8_t*)advertisementData.getPayload().data(),
172163
advertisementData.getPayload().length());
173164
if (errRc != ESP_OK) {
174-
ESP_LOGE(LOG_TAG, "esp_ble_gap_config_scan_rsp_data_raw: %d %s", errRc, GeneralUtils::errorToString(errRc));
165+
log_e("esp_ble_gap_config_scan_rsp_data_raw: %d %s", errRc, GeneralUtils::errorToString(errRc));
175166
}
176167
m_customScanResponseData = true; // Set the flag that indicates we are using custom scan response data.
177-
ESP_LOGD(LOG_TAG, "<< setScanResponseData");
168+
log_v("<< setScanResponseData");
178169
} // setScanResponseData
179170

180171
/**
@@ -183,7 +174,7 @@ void BLEAdvertising::setScanResponseData(BLEAdvertisementData& advertisementData
183174
* @return N/A.
184175
*/
185176
void BLEAdvertising::start() {
186-
ESP_LOGD(LOG_TAG, ">> start: customAdvData: %d, customScanResponseData: %d", m_customAdvData, m_customScanResponseData);
177+
log_v(">> start: customAdvData: %d, customScanResponseData: %d", m_customAdvData, m_customScanResponseData);
187178

188179
// We have a vector of service UUIDs that we wish to advertise. In order to use the
189180
// ESP-IDF framework, these must be supplied in a contiguous array of their 128bit (16 byte)
@@ -195,14 +186,14 @@ void BLEAdvertising::start() {
195186
m_advData.p_service_uuid = new uint8_t[m_advData.service_uuid_len];
196187
uint8_t* p = m_advData.p_service_uuid;
197188
for (int i = 0; i < numServices; i++) {
198-
ESP_LOGD(LOG_TAG, "- advertising service: %s", m_serviceUUIDs[i].toString().c_str());
189+
log_d("- advertising service: %s", m_serviceUUIDs[i].toString().c_str());
199190
BLEUUID serviceUUID128 = m_serviceUUIDs[i].to128();
200191
memcpy(p, serviceUUID128.getNative()->uuid.uuid128, 16);
201192
p += 16;
202193
}
203194
} else {
204195
m_advData.service_uuid_len = 0;
205-
ESP_LOGD(LOG_TAG, "- no services advertised");
196+
log_d("- no services advertised");
206197
}
207198

208199
esp_err_t errRc;
@@ -214,7 +205,7 @@ void BLEAdvertising::start() {
214205
m_advData.include_txpower = !m_scanResp;
215206
errRc = ::esp_ble_gap_config_adv_data(&m_advData);
216207
if (errRc != ESP_OK) {
217-
ESP_LOGE(LOG_TAG, "<< esp_ble_gap_config_adv_data: rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
208+
log_e("<< esp_ble_gap_config_adv_data: rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
218209
return;
219210
}
220211
}
@@ -225,7 +216,7 @@ void BLEAdvertising::start() {
225216
m_advData.include_txpower = m_scanResp;
226217
errRc = ::esp_ble_gap_config_adv_data(&m_advData);
227218
if (errRc != ESP_OK) {
228-
ESP_LOGE(LOG_TAG, "<< esp_ble_gap_config_adv_data (Scan response): rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
219+
log_e("<< esp_ble_gap_config_adv_data (Scan response): rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
229220
return;
230221
}
231222
}
@@ -240,10 +231,10 @@ void BLEAdvertising::start() {
240231
// Start advertising.
241232
errRc = ::esp_ble_gap_start_advertising(&m_advParams);
242233
if (errRc != ESP_OK) {
243-
ESP_LOGE(LOG_TAG, "<< esp_ble_gap_start_advertising: rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
234+
log_e("<< esp_ble_gap_start_advertising: rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
244235
return;
245236
}
246-
ESP_LOGD(LOG_TAG, "<< start");
237+
log_v("<< start");
247238
} // start
248239

249240

@@ -253,13 +244,13 @@ void BLEAdvertising::start() {
253244
* @return N/A.
254245
*/
255246
void BLEAdvertising::stop() {
256-
ESP_LOGD(LOG_TAG, ">> stop");
247+
log_v(">> stop");
257248
esp_err_t errRc = ::esp_ble_gap_stop_advertising();
258249
if (errRc != ESP_OK) {
259-
ESP_LOGE(LOG_TAG, "esp_ble_gap_stop_advertising: rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
250+
log_e("esp_ble_gap_stop_advertising: rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
260251
return;
261252
}
262-
ESP_LOGD(LOG_TAG, "<< stop");
253+
log_v("<< stop");
263254
} // stop
264255

265256
/**
@@ -352,12 +343,12 @@ void BLEAdvertisementData::setFlags(uint8_t flag) {
352343
* @param [in] data Manufacturer data.
353344
*/
354345
void BLEAdvertisementData::setManufacturerData(std::string data) {
355-
ESP_LOGD("BLEAdvertisementData", ">> setManufacturerData");
346+
log_d("BLEAdvertisementData", ">> setManufacturerData");
356347
char cdata[2];
357348
cdata[0] = data.length() + 1;
358349
cdata[1] = ESP_BLE_AD_MANUFACTURER_SPECIFIC_TYPE; // 0xff
359350
addData(std::string(cdata, 2) + data);
360-
ESP_LOGD("BLEAdvertisementData", "<< setManufacturerData");
351+
log_d("BLEAdvertisementData", "<< setManufacturerData");
361352
} // setManufacturerData
362353

363354

@@ -366,12 +357,12 @@ void BLEAdvertisementData::setManufacturerData(std::string data) {
366357
* @param [in] The complete name of the device.
367358
*/
368359
void BLEAdvertisementData::setName(std::string name) {
369-
ESP_LOGD("BLEAdvertisementData", ">> setName: %s", name.c_str());
360+
log_d("BLEAdvertisementData", ">> setName: %s", name.c_str());
370361
char cdata[2];
371362
cdata[0] = name.length() + 1;
372363
cdata[1] = ESP_BLE_AD_TYPE_NAME_CMPL; // 0x09
373364
addData(std::string(cdata, 2) + name);
374-
ESP_LOGD("BLEAdvertisementData", "<< setName");
365+
log_d("BLEAdvertisementData", "<< setName");
375366
} // setName
376367

377368

@@ -455,12 +446,12 @@ void BLEAdvertisementData::setServiceData(BLEUUID uuid, std::string data) {
455446
* @param [in] The short name of the device.
456447
*/
457448
void BLEAdvertisementData::setShortName(std::string name) {
458-
ESP_LOGD("BLEAdvertisementData", ">> setShortName: %s", name.c_str());
449+
log_d("BLEAdvertisementData", ">> setShortName: %s", name.c_str());
459450
char cdata[2];
460451
cdata[0] = name.length() + 1;
461452
cdata[1] = ESP_BLE_AD_TYPE_NAME_SHORT; // 0x08
462453
addData(std::string(cdata, 2) + name);
463-
ESP_LOGD("BLEAdvertisementData", "<< setShortName");
454+
log_d("BLEAdvertisementData", "<< setShortName");
464455
} // setShortName
465456

466457

@@ -476,7 +467,7 @@ void BLEAdvertising::handleGAPEvent(
476467
esp_gap_ble_cb_event_t event,
477468
esp_ble_gap_cb_param_t* param) {
478469

479-
ESP_LOGD(LOG_TAG, "handleGAPEvent [event no: %d]", (int)event);
470+
log_d("handleGAPEvent [event no: %d]", (int)event);
480471

481472
switch(event) {
482473
case ESP_GAP_BLE_ADV_DATA_SET_COMPLETE_EVT: {
@@ -492,7 +483,7 @@ void BLEAdvertising::handleGAPEvent(
492483
break;
493484
}
494485
case ESP_GAP_BLE_ADV_STOP_COMPLETE_EVT: {
495-
ESP_LOGI(LOG_TAG, "STOP advertising");
486+
log_i("STOP advertising");
496487
start();
497488
break;
498489
}

Diff for: ‎libraries/BLE/src/BLEBeacon.cpp

+1-7
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,7 @@
88
#if defined(CONFIG_BT_ENABLED)
99
#include <string.h>
1010
#include "BLEBeacon.h"
11-
#if defined(ARDUINO_ARCH_ESP32) && defined(CONFIG_ARDUHAL_ESP_LOG)
1211
#include "esp32-hal-log.h"
13-
#define LOG_TAG ""
14-
#else
15-
#include "esp_log.h"
16-
static const char* LOG_TAG = "BLEBeacon";
17-
#endif
1812

1913
#define ENDIAN_CHANGE_U16(x) ((((x)&0xFF00)>>8) + (((x)&0xFF)<<8))
2014

@@ -58,7 +52,7 @@ int8_t BLEBeacon::getSignalPower() {
5852
*/
5953
void BLEBeacon::setData(std::string data) {
6054
if (data.length() != sizeof(m_beaconData)) {
61-
ESP_LOGE(LOG_TAG, "Unable to set the data ... length passed in was %d and expected %d", data.length(), sizeof(m_beaconData));
55+
log_e("Unable to set the data ... length passed in was %d and expected %d", data.length(), sizeof(m_beaconData));
6256
return;
6357
}
6458
memcpy(&m_beaconData, data.data(), sizeof(m_beaconData));

0 commit comments

Comments
 (0)