Skip to content

Commit 7812322

Browse files
committed
v3.0.4
- All public configurations (#defines) have moved to RemoteDebugCfg.h, to facilitate changes for anybody. - Changed examples with warnings on change any #define in project, with workarounds, if it not work. (thanks to @22MarioZ for added this issue)
1 parent dbf19dd commit 7812322

13 files changed

+1182
-140
lines changed

README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# RemoteDebug Library for ESP8266 and ESP32
1+
# RemoteDebug Library
22

3-
Library for Arduino to debug devices over WiFi, with Print commands like Serial haves
3+
A library for Arduino to debug projects over WiFi, with web app or telnet client,
4+
with Print commands like Serial Monitor.
45

56
![logo](extras/readme_media/logo.png)
67

@@ -71,6 +72,12 @@ and we will see if it is possible made the port for your board.
7172

7273
## How it looks
7374

75+
Image: RemoteDebugApp (web app)
76+
77+
![webapp](extras/readme_media/webapp_screenshot.png)
78+
79+
Image: telnet client
80+
7481
![remotedebug_v2](extras/readme_media/remotedebug_v2.png)
7582

7683
Youtube (RemoteDebug v2):
@@ -536,6 +543,12 @@ In advanced sample, I used WifiManager library, ArduinoOTA and mDNS, please see
536543
537544
## Releases
538545
546+
### 3.0.4 - 2019-03-19
547+
548+
- All public configurations (#defines) have moved to RemoteDebugCfg.h, to facilitate changes for anybody.
549+
- Changed examples, with warnings on change any #define in project,
550+
with workarounds if it not work. (thanks to @22MarioZ for added this issue)
551+
539552
### 3.0.3 - 2019-03-18
540553
541554
- Adjustments if web socket is disabled

examples/RemoteDebug_Advanced/RemoteDebug_Advanced.ino

+21-11
Original file line numberDiff line numberDiff line change
@@ -126,36 +126,46 @@ WebServer HTTPServer(80);
126126

127127
#endif // WEB_SERVER_ENABLED
128128

129-
// Remote debug over WiFi - not recommended for production/release, only for development
129+
///// Remote debug over WiFi - not recommended for production/release, only for development
130130

131-
// Disable all debug ?
131+
// Options for RemoteDebug of this project
132+
133+
// Attention: read this, before you change any option
132134
//
135+
// If yot changed it and not works, the compiler is using catching old compiled files
136+
// To workaround this:
137+
// - If have a clean project option in IDE (as Eclipse/Platformio), do it
138+
// - or force compiler to compiler all (changing any configuration of board)
139+
// - or to this change globally in RemoteDebugCfg.h (on library directory)
140+
// - And upload again
141+
//
142+
// thanks to @22MarioZ for added this issue
143+
144+
// Disable all debug ?
133145
// Important to compile for prodution/release
134146
// Disable all debug ? Good to release builds (production)
135147
// as nothing of RemoteDebug is compiled, zero overhead :-)
136-
// For it just uncomment the DEBUG_DISABLED
137-
// On change it, if in another IDE than Arduino IDE, like Eclipse or VSCODE,
138-
// please clean the project, before compile
139-
148+
// Uncomment the line below, to do it:
140149
//#define DEBUG_DISABLED true
141150

142151
// Disable te auto function feature of RemoteDebug
143-
// Note: uncomment to disable it, good if your code already have func name on debug messages
144-
152+
// Good if your code already have func name on debug messages
153+
// Uncomment the line below, to do it:
145154
//#define DEBUG_DISABLE_AUTO_FUNC true
146155

147156
// Disable Websocket? This is used with RemoteDebugApp connection
148-
// Uncomment this to disable it
149-
157+
// Uncomment the line below, to do it:
150158
//#define WEBSOCKET_DISABLED true
151159

152160
#ifndef WEBSOCKET_DISABLED // Only if Web socket enabled (RemoteDebugApp)
153161
// If enabled, you can change the port here (8232 is default)
162+
// Uncomment the line below, to do it:
154163
//#define WEBSOCKET_PORT 8232
155164

156165
// Internally, the RemoteDebug uses a local copy of the arduinoWebSockets library (https://github.com/Links2004/arduinoWebSockets)
157166
// Due it not in Arduino Library Manager
158-
// If your project already use this library, please uncomment the line above:
167+
// If your project already use this library,
168+
// Uncomment the line below, to do it:
159169
//#define USE_LIB_WEBSOCKET true
160170
#endif
161171

examples/RemoteDebug_Basic/RemoteDebug_Basic.ino

-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,6 @@ RemoteDebug Debug;
100100
const char* ssid = "........";
101101
const char* password = "........";
102102

103-
104103
// Time
105104

106105
uint32_t mLastTime = 0;

0 commit comments

Comments
 (0)