MCPcopy Create free account
hub / github.com/JoaoLopesF/RemoteDebug / showHelp

Method showHelp

src/RemoteDebug.cpp:1267–1394  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

1265// Show help of commands
1266
1267void RemoteDebug::showHelp() {
1268
1269 // Show the initial message
1270
1271 String help = "";
1272
1273 // Password request ? - 04/03/18
1274
1275 if (_password != "" && !_passwordOk) {
1276
1277 help.concat("\r\n");
1278 help.concat("* Please enter with a password to access");
1279#ifdef REMOTEDEBUG_PWD_ATTEMPTS
1280 help.concat(" (attempt ");
1281 help.concat(_passwordAttempt);
1282 help.concat(" of ");
1283 help.concat(REMOTEDEBUG_PWD_ATTEMPTS);
1284 help.concat(")");
1285#endif
1286 help.concat(':');
1287 help.concat("\r\n");
1288
1289 debugPrint(help);
1290
1291 return;
1292}
1293
1294 // Show help
1295
1296#if defined(ESP8266)
1297 help.concat("*** Remote debug - over telnet - for ESP8266 (NodeMCU) - version ");
1298#elif defined(ESP32)
1299 help.concat("*** Remote debug - over telnet - for ESP32 - version ");
1300#endif
1301 help.concat(VERSION);
1302 help.concat("\r\n");
1303 help.concat("* Host name: ");
1304 help.concat(_hostName);
1305 help.concat(" IP:");
1306 help.concat(WiFi.localIP().toString());
1307 help.concat(" Mac address:");
1308 help.concat(WiFi.macAddress());
1309 help.concat("\r\n");
1310 help.concat("* Free Heap RAM: ");
1311 help.concat(ESP.getFreeHeap());
1312 help.concat("\r\n");
1313 help.concat("* ESP SDK version: ");
1314 help.concat(ESP.getSdkVersion());
1315 help.concat("\r\n");
1316 help.concat("******************************************************\r\n");
1317 help.concat("* Commands:\r\n");
1318 help.concat(" ? or help -> display these help of commands\r\n");
1319 help.concat(" q -> quit (close this connection)\r\n");
1320 help.concat(" m -> display memory available\r\n");
1321 help.concat(" v -> set debug level to verbose\r\n");
1322 help.concat(" d -> set debug level to debug\r\n");
1323 help.concat(" i -> set debug level to info\r\n");
1324 help.concat(" w -> set debug level to warning\r\n");

Callers

nothing calls this directly

Calls

no outgoing calls

Tested by

no test coverage detected