Skip to content

Commit 119f2cd

Browse files
Links2004Links2004
committed
Merge pull request esp8266#1350 from Links2004/debug
allow control of enabling debug and debug level from IDE
2 parents bcfa5c8 + 137c507 commit 119f2cd

File tree

12 files changed

+126
-49
lines changed

12 files changed

+126
-49
lines changed

‎boards.txt

+40
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ menu.FlashFreq=Flash Frequency
66
menu.UploadTool=Upload Using
77
menu.ResetMethod=Reset Method
88
menu.ESPModule=Module
9+
menu.Debug=Debug port
10+
menu.DebugLevel=Debug Level
911

1012
##############################################################
1113
generic.name=Generic ESP8266 Module
@@ -26,6 +28,8 @@ generic.build.core=esp8266
2628
generic.build.variant=generic
2729
generic.build.flash_mode=qio
2830
generic.build.spiffs_pagesize=256
31+
generic.build.debug_port=
32+
generic.build.debug_level=
2933

3034
generic.menu.UploadTool.esptool=Serial
3135
generic.menu.UploadTool.esptool.upload.tool=esptool
@@ -166,6 +170,42 @@ generic.menu.ResetMethod.ck.upload.resetmethod=ck
166170
generic.menu.ResetMethod.nodemcu=nodemcu
167171
generic.menu.ResetMethod.nodemcu.upload.resetmethod=nodemcu
168172

173+
generic.menu.Debug.Disabled=Disabled
174+
generic.menu.Debug.Disabled.build.debug_port=
175+
generic.menu.Debug.Serial=Serial
176+
generic.menu.Debug.Serial.build.debug_port=-DDEBUG_ESP_PORT=Serial
177+
generic.menu.Debug.Serial1=Serial1
178+
generic.menu.Debug.Serial1.build.debug_port=-DDEBUG_ESP_PORT=Serial1
179+
180+
generic.menu.DebugLevel.None=None
181+
generic.menu.DebugLevel.None.build.debug_level=
182+
generic.menu.DebugLevel.Core=Core
183+
generic.menu.DebugLevel.Core.build.debug_level=-DDEBUG_ESP_CORE
184+
generic.menu.DebugLevel.SSL=Core + SSL
185+
generic.menu.DebugLevel.SSL.build.debug_level=-DDEBUG_ESP_CORE -DDEBUG_ESP_SSL
186+
generic.menu.DebugLevel.WiFic=Core + WiFi
187+
generic.menu.DebugLevel.WiFic.build.debug_level=-DDEBUG_ESP_CORE -DDEBUG_ESP_WIFI
188+
generic.menu.DebugLevel.WiFi=WiFi
189+
generic.menu.DebugLevel.WiFi.build.debug_level=-DDEBUG_ESP_WIFI
190+
generic.menu.DebugLevel.HTTPClient=HTTPClient
191+
generic.menu.DebugLevel.HTTPClient.build.debug_level=-DDEBUG_ESP_HTTP_CLIENT
192+
generic.menu.DebugLevel.HTTPUpdate=HTTPUpdate
193+
generic.menu.DebugLevel.HTTPUpdate.build.debug_level=-DDEBUG_ESP_HTTP_UPDATE
194+
generic.menu.DebugLevel.HTTPUpdate2=HTTPClient + HTTPUpdate
195+
generic.menu.DebugLevel.HTTPUpdate2.build.debug_level=-DDEBUG_ESP_HTTP_UPDATE -DDEBUG_ESP_HTTP_UPDATE
196+
generic.menu.DebugLevel.HTTPUpdate3=HTTPClient + HTTPUpdate + Updater
197+
generic.menu.DebugLevel.HTTPUpdate3.build.debug_level=-DDEBUG_ESP_HTTP_UPDATE -DDEBUG_ESP_HTTP_UPDATE -DDEBUG_ESP_UPDATER
198+
generic.menu.DebugLevel.HTTPServer=HTTPServer
199+
generic.menu.DebugLevel.HTTPServer.build.debug_level=-DDEBUG_ESP_HTTP_SERVER
200+
generic.menu.DebugLevel.UPDATER=Updater
201+
generic.menu.DebugLevel.UPDATER.build.debug_level=-DDEBUG_ESP_UPDATER
202+
generic.menu.DebugLevel.OTA=OTA
203+
generic.menu.DebugLevel.OTA.build.debug_level=-DDEBUG_ESP_OTA
204+
generic.menu.DebugLevel.OTA2=OTA + Updater
205+
generic.menu.DebugLevel.OTA2.build.debug_level=-DDEBUG_ESP_OTA -DDEBUG_ESP_UPDATER
206+
generic.menu.DebugLevel.all=All
207+
generic.menu.DebugLevel.all.build.debug_level=-DDEBUG_ESP_CORE -DDEBUG_ESP_SSL -DDEBUG_ESP_WIFI -DDEBUG_ESP_HTTP_CLIENT -DDEBUG_ESP_HTTP_UPDATE -DDEBUG_ESP_HTTP_SERVER -DDEBUG_ESP_UPDATER -DDEBUG_ESP_OTA
208+
169209
# disabled because espressif's bootloader refuses to write above 4M
170210
# generic.menu.FlashSize.8M=8M (7M SPIFFS)
171211
# generic.menu.FlashSize.8M.build.flash_size=1M

‎cores/esp8266/Updater.h

+5-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@
2222
#define U_SPIFFS 100
2323
#define U_AUTH 200
2424

25-
//#define DEBUG_UPDATER Serial
25+
#ifdef DEBUG_ESP_UPDATER
26+
#ifdef DEBUG_ESP_PORT
27+
#define DEBUG_UPDATER DEBUG_ESP_PORT
28+
#endif
29+
#endif
2630

2731
class UpdaterClass {
2832
public:

‎cores/esp8266/core_esp8266_main.cpp

+3
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,9 @@ static void loop_wrapper() {
101101
preloop_update_frequency();
102102
if(!setup_done) {
103103
setup();
104+
#ifdef DEBUG_ESP_PORT
105+
DEBUG_ESP_PORT.setDebugOutput(true);
106+
#endif
104107
setup_done = true;
105108
}
106109
loop();

‎cores/esp8266/debug.h

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
#include <stddef.h>
55
#include <stdint.h>
66

7-
//#define DEBUGV(...) ets_printf(__VA_ARGS__)
7+
#ifdef DEBUG_ESP_CORE
8+
#define DEBUGV(...) ets_printf(__VA_ARGS__)
9+
#endif
810

911
#ifndef DEBUGV
1012
#define DEBUGV(...)

‎libraries/ArduinoOTA/ArduinoOTA.cpp

+18-13
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,12 @@ extern "C" {
1818
#include "include/UdpContext.h"
1919
#include <ESP8266mDNS.h>
2020

21-
//#define OTA_DEBUG 1
21+
22+
#ifdef DEBUG_ESP_OTA
23+
#ifdef DEBUG_ESP_PORT
24+
#define OTA_DEBUG DEBUG_ESP_PORT
25+
#endif
26+
#endif
2227

2328
ArduinoOTAClass::ArduinoOTAClass()
2429
: _port(0)
@@ -109,8 +114,8 @@ void ArduinoOTAClass::begin() {
109114
}
110115
_initialized = true;
111116
_state = OTA_IDLE;
112-
#if OTA_DEBUG
113-
Serial.printf("OTA server at: %s.local:%u\n", _hostname.c_str(), _port);
117+
#ifdef OTA_DEBUG
118+
OTA_DEBUG.printf("OTA server at: %s.local:%u\n", _hostname.c_str(), _port);
114119
#endif
115120
}
116121

@@ -226,8 +231,8 @@ void ArduinoOTAClass::_onRx(){
226231

227232
void ArduinoOTAClass::_runUpdate() {
228233
if (!Update.begin(_size, _cmd)) {
229-
#if OTA_DEBUG
230-
Serial.println("Update Begin Error");
234+
#ifdef OTA_DEBUG
235+
OTA_DEBUG.println("Update Begin Error");
231236
#endif
232237
if (_error_callback) {
233238
_error_callback(OTA_BEGIN_ERROR);
@@ -249,8 +254,8 @@ void ArduinoOTAClass::_runUpdate() {
249254

250255
WiFiClient client;
251256
if (!client.connect(_ota_ip, _ota_port)) {
252-
#if OTA_DEBUG
253-
Serial.printf("Connect Failed\n");
257+
#ifdef OTA_DEBUG
258+
OTA_DEBUG.printf("Connect Failed\n");
254259
#endif
255260
_udp_ota->listen(*IP_ADDR_ANY, _port);
256261
if (_error_callback) {
@@ -265,8 +270,8 @@ void ArduinoOTAClass::_runUpdate() {
265270
while (!client.available() && waited--)
266271
delay(1);
267272
if (!waited){
268-
#if OTA_DEBUG
269-
Serial.printf("Receive Failed\n");
273+
#ifdef OTA_DEBUG
274+
OTA_DEBUG.printf("Receive Failed\n");
270275
#endif
271276
_udp_ota->listen(*IP_ADDR_ANY, _port);
272277
if (_error_callback) {
@@ -288,8 +293,8 @@ void ArduinoOTAClass::_runUpdate() {
288293
client.print("OK");
289294
client.stop();
290295
delay(10);
291-
#if OTA_DEBUG
292-
Serial.printf("Update Success\nRebooting...\n");
296+
#ifdef OTA_DEBUG
297+
OTA_DEBUG.printf("Update Success\nRebooting...\n");
293298
#endif
294299
if (_end_callback) {
295300
_end_callback();
@@ -301,8 +306,8 @@ void ArduinoOTAClass::_runUpdate() {
301306
_error_callback(OTA_END_ERROR);
302307
}
303308
Update.printError(client);
304-
#if OTA_DEBUG
305-
Update.printError(Serial);
309+
#ifdef OTA_DEBUG
310+
Update.printError(OTA_DEBUG);
306311
#endif
307312
_state = OTA_IDLE;
308313
}

‎libraries/ESP8266HTTPClient/src/ESP8266HTTPClient.h

+5-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@
2525
#ifndef ESP8266HTTPClient_H_
2626
#define ESP8266HTTPClient_H_
2727

28-
//#define DEBUG_HTTPCLIENT(...) Serial1.printf( __VA_ARGS__ )
28+
#ifdef DEBUG_ESP_HTTP_CLIENT
29+
#ifdef DEBUG_ESP_PORT
30+
#define DEBUG_HTTPCLIENT(...) DEBUG_ESP_PORT.printf( __VA_ARGS__ )
31+
#endif
32+
#endif
2933

3034
#ifndef DEBUG_HTTPCLIENT
3135
#define DEBUG_HTTPCLIENT(...)

‎libraries/ESP8266WebServer/src/ESP8266WebServer.cpp

+9-4
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,13 @@
2828
#include "ESP8266WebServer.h"
2929
#include "FS.h"
3030
#include "detail/RequestHandlersImpl.h"
31-
// #define DEBUG
31+
32+
//#define DEBUG_ESP_HTTP_SERVER
33+
#ifdef DEBUG_ESP_PORT
34+
#define DEBUG_OUTPUT DEBUG_ESP_PORT
35+
#else
3236
#define DEBUG_OUTPUT Serial
37+
#endif
3338

3439
const char * AUTHORIZATION_HEADER = "Authorization";
3540

@@ -155,7 +160,7 @@ void ESP8266WebServer::handleClient() {
155160
return;
156161
}
157162

158-
#ifdef DEBUG
163+
#ifdef DEBUG_ESP_HTTP_SERVER
159164
DEBUG_OUTPUT.println("New client");
160165
#endif
161166

@@ -416,13 +421,13 @@ void ESP8266WebServer::onNotFound(THandlerFunction fn) {
416421
void ESP8266WebServer::_handleRequest() {
417422
bool handled = false;
418423
if (!_currentHandler){
419-
#ifdef DEBUG
424+
#ifdef DEBUG_ESP_HTTP_SERVER
420425
DEBUG_OUTPUT.println("request handler not found");
421426
#endif
422427
}
423428
else {
424429
handled = _currentHandler->handle(*this, _currentMethod, _currentUri);
425-
#ifdef DEBUG
430+
#ifdef DEBUG_ESP_HTTP_SERVER
426431
if (!handled) {
427432
DEBUG_OUTPUT.println("request handler failed to handle request");
428433
}

0 commit comments

Comments
 (0)