v5.6 - ESP-01S compatibility (blue LED at GPIO2, not GPIO1)

html_orig/css/app.css

@@ -748,7 +748,7 @@ input[type="number"], input[type="password"], input[type="text"], textarea, sele
 .ansiref.w100 {
   width: 100%; }
   .ansiref.w100 td:nth-child(1) {
-    width: 7em; }
+    width: 9em; }
   .ansiref.w100 td:nth-child(2) {
     width: 8em; }
 

html_orig/help.html

@@ -18,9 +18,12 @@
 	<ul>
 		<li>Communication UART on pins <b>Rx, Tx</b> at 115200-8-1-N</li>
 		<li>Debug log on pin <b>GPIO2</b> at 115200-8-1-N</li>
-		<li>Use 3.3V logic, or 5V with protection resistors (10k)</li>
+		<li>Use 3.3V logic, or 5V with protection resistors (470R or more)</li>
+		<li>If the "LVD" LED on the ESP Term board lights up, the module doesn't get enough power. Check your connections.</li>
 		<li>Connect Rx and Tx with a piece of wire to test the terminal alone, you should see what you type in the browser.
-			NOTE: This won't work if your ESP8266 board has a built-in USB-serial.</li>
+			NOTE: This won't work if your ESP8266 board has a built-in USB-serial (like NodeMCU).</li>
+		<li>For best performance, use the module in the Client mode. In AP mode, check that the channel used is clear;
+			interference may cause lag in the terminal.</li>
 	</ul>
 </div>
 
@@ -29,9 +32,10 @@
 
 	<ul>
 		<li>Most ANSI escape sequences are supported.</li>
-		<li>The max screen size is 2000 characters (eg. <b>25x80</b>), default is <b>10x26</b>. Set using <code>\e]W?;?\a</code> with rows;cols.</li>
+		<li>The max screen size is 2000 characters (eg. <b>25x80</b>), default is <b>10x26</b>. Set using <code>\e]W&lt;rows&gt;;&lt;cols&gt;\a</code>.</li>
 		<li>The screen will automatically scroll, can be used for log output.</li>
 		<li>Display update is sent <b>after 20 ms of inactivity</b>.</li>
+		<li>At most 4 clients can be connected at the same time.</li>
 		<li>The browser display needs WebSockets for the real-time updating. It may not work on really old phones / browsers.</li>
 	</ul>
 </div>
@@ -39,7 +43,7 @@
 <div class="Box">
 	<h2>Color Reference</h2>
 
-	<p>Color is set using <code>\e[?m</code> or <code>\e[?;?m</code> where "?" are numbers from the following tables:</p>
+	<p>Color is set using <code>\e[&lt;c&gt;m</code> or <code>\e[&lt;c&gt;;&lt;c&gt;m</code> where "&lt;c&gt;" are numbers from the following tables:</p>
 
 	<b>Foreground</b>
 
@@ -103,8 +107,7 @@
 	<p>The buttons under the screen send ASCII codes 1, 2, 3, 4, 5.</p>
 
 	<p>
-		<b>Mouse input</b> (click/tap) is sent as <code>\e?;?M</code> with row;column. You can use this for on-screen buttons, menu navigation etc.
-		<i>Please note this is a custom sequence, not supported by PuTTY or other terminals.</i>
+		<b>Mouse input</b> (click/tap) is sent as <code>\e[&lt;y&gt;;&lt;x&gt;M</code>. You can use this for on-screen buttons, menu navigation etc.
 	</p>
 </div>
 
@@ -167,42 +170,42 @@
 		</thead>
 		<tbody>
 		<tr>
-			<td>\e[?A</td>
+			<td>\e[&lt;n&gt;A</td>
 			<td>[count]</td>
 			<td>Move cursor up</td>
 		</tr>
 		<tr>
-			<td>\e[?B</td>
+			<td>\e[&lt;n&gt;B</td>
 			<td>[count]</td>
 			<td>Move cursor down</td>
 		</tr>
 		<tr>
-			<td>\e[?C</td>
+			<td>\e[&lt;n&gt;C</td>
 			<td>[count]</td>
 			<td>Move cursor forward (right)</td>
 		</tr>
 		<tr>
-			<td>\e[?D</td>
+			<td>\e[&lt;n&gt;D</td>
 			<td>[count]</td>
 			<td>Move cursor backward (left)</td>
 		</tr>
 		<tr>
-			<td>\e[?E</td>
+			<td>\e[&lt;n&gt;E</td>
 			<td>[count]</td>
 			<td>Go N line down, start of line</td>
 		</tr>
 		<tr>
-			<td>\e[?F</td>
+			<td>\e[&lt;n&gt;F</td>
 			<td>[count]</td>
 			<td>Go N lines up, start of line</td>
 		</tr>
 		<tr>
-			<td>\e[?G</td>
+			<td>\e[&lt;n&gt;G</td>
 			<td>column</td>
 			<td>Go to column</td>
 		</tr>
 		<tr>
-			<td>\e[?;?G</td>
+			<td>\e[&lt;y&gt;;&lt;x&gt;G</td>
 			<td>[row=1];[col=1]</td>
 			<td>Go to row and column</td>
 		</tr>
@@ -234,12 +237,22 @@
 		<tr>
 			<td>\e[?25l</td>
 			<td>--</td>
-			<td>Hide cursor (literal question mark, lowercase L!)</td>
+			<td>Hide cursor</td>
 		</tr>
 		<tr>
 			<td>\e[?25h</td>
 			<td>--</td>
-			<td>Show cursor (literal question mark!)</td>
+			<td>Show cursor</td>
+		</tr>
+		<tr>
+			<td>\e[?7l</td>
+			<td>--</td>
+			<td>Disable cursor auto-wrap & auto-scroll at end of screen</td>
+		</tr>
+		<tr>
+			<td>\e[?7h</td>
+			<td>--</td>
+			<td>Enable cursor auto-wrap & auto-scroll at end of screen</td>
 		</tr>
 		</tbody>
 	</table>
@@ -256,27 +269,27 @@
 		</thead>
 		<tbody>
 		<tr>
-			<td>\e[?J</td>
+			<td>\e[&lt;m&gt;J</td>
 			<td>[mode=0]</td>
 			<td>Clear screen. Mode: 0 - from cursor, 1 - to cursor, 2 - all</td>
 		</tr>
 		<tr>
-			<td>\e[?K</td>
+			<td>\e[&lt;m&gt;K</td>
 			<td>[mode=0]</td>
 			<td>Erase line. Mode: 0 - from cursor, 1 - to cursor, 2 - all</td>
 		</tr>
 		<tr>
-			<td>\e[?S</td>
+			<td>\e[&lt;n&gt;S</td>
 			<td>[lines]</td>
 			<td>Scroll screen content up, add empty line at the bottom</td>
 		</tr>
 		<tr>
-			<td>\e[?T</td>
+			<td>\e[&lt;n&gt;T</td>
 			<td>[lines]</td>
 			<td>Scroll screen content down, add empty line at the top</td>
 		</tr>
 		<tr>
-			<td>\e]W?;?\a</td>
+			<td>\e]W&lt;r&gt;;&lt;c&gt;\a</td>
 			<td>rows;cols</td>
 			<td>Set screen size, maximum 25x80 (resp. total 2000 characters). This also clears the screen.</td>
 		</tr>

html_orig/js/app.js

@@ -896,7 +896,8 @@ $._loader = function(vis) {
 		var screen = [];
 		var blinkIval;
 
-		/** Clear screen */
+/*
+		/!** Clear screen *!/
 		function cls() {
 			screen.forEach(function(cell, i) {
 				cell.t = ' ';
@@ -905,6 +906,7 @@ $._loader = function(vis) {
 				blit(cell);
 			});
 		}
+*/
 
 		/** Set text and color at XY */
 		function cellAt(y, x) {
@@ -916,14 +918,15 @@ $._loader = function(vis) {
 			return cellAt(cursor.y, cursor.x);
 		}
 
-		/** Enable or disable cursor visibility */
+/*
+		/!** Enable or disable cursor visibility *!/
 		function cursorEnable(enable) {
 			cursor.hidden = !enable;
 			cursor.a &= enable;
 			blit(cursorCell(), cursor.a);
 		}
 
-		/** Safely move cursor */
+		/!** Safely move cursor *!/
 		function cursorSet(y, x) {
 			// Hide and prevent from showing up during the move
 			cursor.suppress = true;
@@ -936,6 +939,7 @@ $._loader = function(vis) {
 			cursor.suppress = false;
 			blit(cursorCell(), cursor.a);
 		}
+*/
 
 		/** Update cell on display. inv = invert (for cursor) */
 		function blit(cell, inv) {
@@ -1081,7 +1085,10 @@ $._loader = function(vis) {
 		}
 
 		function onClose(evt) {
-			console.error("SOCKET CLOSED");
+			console.warn("SOCKET CLOSED, code "+evt.code+". Reconnecting...");
+			setTimeout(function() {
+				init();
+			}, 2000);
 		}
 
 		function onMessage(evt) {
@@ -1094,10 +1101,6 @@ $._loader = function(vis) {
 			}
 		}
 
-		function onError(evt) {
-			console.error(evt.data);
-		}
-
 		function doSend(message) {
 			console.log("TX: ", message);
 			if (ws.readyState != 1) {
@@ -1115,7 +1118,6 @@ $._loader = function(vis) {
 			ws.onopen = onOpen;
 			ws.onclose = onClose;
 			ws.onmessage = onMessage;
-			ws.onerror = onError;
 
 			console.log("Opening socket.");
 		}

html_orig/jssrc/term.js

@@ -197,7 +197,10 @@
 		}
 
 		function onClose(evt) {
-			console.error("SOCKET CLOSED");
+			console.warn("SOCKET CLOSED, code "+evt.code+". Reconnecting...");
+			setTimeout(function() {
+				init();
+			}, 1000);
 		}
 
 		function onMessage(evt) {
@@ -210,10 +213,6 @@
 			}
 		}
 
-		function onError(evt) {
-			console.error(evt.data);
-		}
-
 		function doSend(message) {
 			console.log("TX: ", message);
 			if (ws.readyState != 1) {
@@ -231,7 +230,6 @@
 			ws.onopen = onOpen;
 			ws.onclose = onClose;
 			ws.onmessage = onMessage;
-			ws.onerror = onError;
 
 			console.log("Opening socket.");
 		}

html_orig/packjs.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+echo "Packing js..."
+
 cat jssrc/chibi.js \
 	jssrc/utils.js \
 	jssrc/modal.js \

html_orig/sass/pages/_about.scss

@@ -53,7 +53,7 @@
 		width: 100%;
 
 		td:nth-child(1) {
-			width: 7em;
+			width: 9em;
 		}
 
 		td:nth-child(2) {

html_orig/term.html

@@ -5,6 +5,15 @@
 	<title>ESP8266 Remote Terminal</title>
 	<meta name="viewport" content="width=device-width,shrink-to-fit=no,user-scalable=no,initial-scale=1.0,maximum-scale=1.0,minimum-scale=1.0">
 
+	<script>
+		// Workaround for badly loaded page
+		setTimeout(function() {
+			if (typeof termInit == 'undefined' || typeof $ == 'undefined') {
+				location.reload(true);
+			}
+		}, 2000);
+	</script>
+
 	<link rel="stylesheet" href="/css/app.css">
 	<script src="/js/app.js"></script>
 </head>
@@ -31,8 +40,13 @@
 </nav>
 
 <script>
+	try {
 		_root = window.location.host;
 		termInit(%screenData%);
+	} catch(e) {
+		console.error("Fail, reloading...");
+		location.reload(true);
+	}
 </script>
 
 </body>

html_orig/wifi.html

@@ -50,8 +50,8 @@
 		<tr><td colspan=2 style="white-space: normal;">
 			<p>Some changes require a reboot, dropping connection. It can take a while to re-connect.</p>
 			<p>
-				<b>If you lose access</b>, connect GPIO0 to GND for	5 seconds to enter Client+AP mode.
-				If that fails, try the UART factory reset command "<code>\e]FR\a</code>".
+				<b>If you lose access</b>, hold the BOOT button for 2 seconds (the Tx LED starts blinking) to re-enable AP mode.
+				If that fails, hold the BOOT button for over 5 seconds (rapid Tx LED flashing) to perform a factory reset.
 			<p>
 		</td></tr>
 	</table>

user/ansi_parser_callbacks.c

@@ -138,7 +138,6 @@ apars_handle_CSI(char leadchar, int *params, char keychar)
 				screen_clear_line(CLEAR_FROM_CURSOR);
 			} else {
 				screen_clear_line(CLEAR_ALL);
-				screen_cursor_set_x(0);
 			}
 			break;
 
@@ -157,20 +156,29 @@ apars_handle_CSI(char leadchar, int *params, char keychar)
 			}
 			else if (n1 == 5) {
 				// Query device status - reply "Device is OK"
-				UART_WriteString(UART0, "\0330n", UART_TIMEOUT_US);
+				UART_WriteString(UART0, "\033[0n", UART_TIMEOUT_US);
 			}
 			break;
 
-			// DECTCEM cursor show hide
-		case 'l':
-			if (leadchar == '?' && n1 == 25) {
-				screen_cursor_enable(1);
-			}
-			break;
+			// DECTCEM feature enable / disable
 
 		case 'h':
-			if (leadchar == '?' && n1 == 25) {
+			if (leadchar == '?') {
+				if (n1 == 25) {
+					screen_cursor_enable(1);
+				} else if (n1 == 7) {
+					screen_wrap_enable(1);
+				}
+			}
+			break;
+
+		case 'l':
+			if (leadchar == '?') {
+				if (n1 == 25) {
 					screen_cursor_enable(0);
+				} else if (n1 == 7) {
+					screen_wrap_enable(0);
+				}
 			}
 			break;
 
@@ -224,7 +232,9 @@ apars_handle_RESET_cmd(void)
 void ICACHE_FLASH_ATTR
 apars_handle_OSC_FactoryReset(void)
 {
-	info("OSC: Factory reset");
+	warn("-------- Factory reset --------");
+
+	dbg("Switching to Client+AP mode");
 
 	// Send acknowledgement message to UART0
 	// User is performing this manually, so we can just print it as string
@@ -240,10 +250,12 @@ apars_handle_OSC_FactoryReset(void)
 	wifi_set_opmode(STATIONAP_MODE);
 
 	// --- AP config ---
+	dbg("AP WiFi channel: 6");
+
 	struct softap_config apconf;
 	wifi_softap_get_config(&apconf);
 	apconf.authmode=AUTH_OPEN; // Disable access protection
-	apconf.channel=1; // Reset channel; user may have set bad channel in the UI
+	apconf.channel=6; // Reset channel; user may have set bad channel in the UI
 
 	// generate unique AP name
 	u8 mac[6];
@@ -251,7 +263,11 @@ apars_handle_OSC_FactoryReset(void)
 	sprintf((char*)apconf.ssid, "TERM-%02X%02X%02X", mac[3], mac[4], mac[5]);
 	apconf.ssid_len = (u8)strlen((char*)apconf.ssid);
 
+	info("New AP name: %s", (char*)apconf.ssid);
+
 	// --- Station ---
+	dbg("Erasing stored WiFi credentials...");
+
 	struct station_config staconf;
 	wifi_station_get_config(&staconf);
 
@@ -260,12 +276,16 @@ apars_handle_OSC_FactoryReset(void)
 	staconf.bssid_set=0;
 	staconf.password[0]=0;
 
+	dbg("Commiting changes...");
 	wifi_softap_set_config(&apconf);
 	wifi_station_set_config(&staconf);
 
 	UART_WriteString(UART0, "Factory Reset complete, device reset.\r\n\r\n", UART_TIMEOUT_US);
 
-	// Reboot to clean STA+AP mode with Channel 1 & reset AP SSID.
+	info("*** FACTORY RESET COMPLETE ***");
+	dbg("Device reset...");
+
+	// Reboot to clean STA+AP mode with Channel X & reset AP SSID.
 	system_restart();
 }
 

user/io.c

@@ -10,6 +10,7 @@
 
 
 #include <esp8266.h>
+#include "ansi_parser_callbacks.h"
 
 #define BTNGPIO 0
 
@@ -17,16 +18,71 @@
 static bool enable_ap_button = false;
 
 static ETSTimer resetBtntimer;
+static ETSTimer blinkyTimer;
+
+// Holding BOOT pin triggers AP reset, then Factory Reset.
+// Indicate that by blinking the on-board LED.
+// -> ESP-01 has at at GPIO1, ESP-01S at GPIO2. We have to use both for compatibility.
+
+static void ICACHE_FLASH_ATTR bootHoldIndicatorTimerCb(void *arg) {
+	static bool state = true;
+
+	if (GPIO_INPUT_GET(BTNGPIO)) {
+		// if user released, shut up
+		state = 1;
+	}
+
+	if (state) {
+		GPIO_OUTPUT_SET(1, 1);
+		GPIO_OUTPUT_SET(2, 1);
+	} else {
+		GPIO_OUTPUT_SET(1, 0);
+		GPIO_OUTPUT_SET(2, 0);
+	}
+
+	state = !state;
+}
 
 static void ICACHE_FLASH_ATTR resetBtnTimerCb(void *arg) {
 	static int resetCnt=0;
 	if (enable_ap_button && !GPIO_INPUT_GET(BTNGPIO)) {
 		resetCnt++;
+
+		// indicating AP reset
+		if (resetCnt == 2) {
+			// LED pin as output (Normally UART output)
+			PIN_FUNC_SELECT(PERIPHS_IO_MUX_U0TXD_U, FUNC_GPIO1);
+			PIN_FUNC_SELECT(PERIPHS_IO_MUX_GPIO2_U, FUNC_GPIO2);
+
+			// LED on
+			GPIO_OUTPUT_SET(1, 0);
+			GPIO_OUTPUT_SET(2, 0);
+
+			os_timer_disarm(&blinkyTimer);
+			os_timer_setfn(&blinkyTimer, bootHoldIndicatorTimerCb, NULL);
+			os_timer_arm(&blinkyTimer, 500, 1);
+		}
+
+		// indicating we'll perform a factory reset
+		if (resetCnt == 10) {
+			os_timer_disarm(&blinkyTimer);
+			os_timer_setfn(&blinkyTimer, bootHoldIndicatorTimerCb, NULL);
+			os_timer_arm(&blinkyTimer, 100, 1);
+		}
 	} else {
-		if (resetCnt>=6) { //3 sec pressed
+		// Switch LED pins back to UART mode
+		PIN_FUNC_SELECT(PERIPHS_IO_MUX_U0TXD_U, FUNC_U0TXD);
+		PIN_FUNC_SELECT(PERIPHS_IO_MUX_GPIO2_U, FUNC_U1TXD_BK);
+
+		if (resetCnt>=10) { //5 secs pressed - FR
+			info("BOOT-button triggered FACTORY RESET!");
+			apars_handle_OSC_FactoryReset();
+		}
+		else if (resetCnt>=2) { //1 sec pressed
 			wifi_station_disconnect();
 			wifi_set_opmode(STATIONAP_MODE); //reset to AP+STA mode
-			info("Reset to AP mode from GPIO0, Restarting system...");
+			info("BOOT-button triggered reset to AP mode, restarting...");
+
 			system_restart();
 		}
 		resetCnt=0;

user/screen.c

@@ -31,6 +31,7 @@ static struct {
 	int y;    //!< Y coordinate
 	bool visible;    //!< Visible
 	bool inverse;    //!< Inverse colors
+	bool autowrap;    //!< Wrapping when EOL
 	Color fg;        //!< Foreground color for writing
 	Color bg;        //!< Background color for writing
 } cursor;
@@ -102,6 +103,7 @@ cursor_reset(void)
 	cursor.bg = SCREEN_DEF_BG;
 	cursor.visible = 1;
 	cursor.inverse = 0;
+	cursor.autowrap = 1;
 }
 
 //endregion
@@ -397,6 +399,17 @@ screen_cursor_enable(bool enable)
 	NOTIFY_DONE();
 }
 
+/**
+ * Enable autowrap
+ */
+void ICACHE_FLASH_ATTR
+screen_wrap_enable(bool enable)
+{
+	NOTIFY_LOCK();
+	cursor.autowrap = enable;
+	NOTIFY_DONE();
+}
+
 //endregion
 
 //region Colors
@@ -492,7 +505,7 @@ screen_putchar(char ch)
 				cursor.x--;
 			} else {
 				// wrap around start of line
-				if (cursor.y>0) {
+				if (cursor.autowrap && cursor.y>0) {
 					cursor.x=W-1;
 					cursor.y--;
 				}
@@ -532,6 +545,7 @@ screen_putchar(char ch)
 	cursor.x++;
 	// X wrap
 	if (cursor.x >= W) {
+		if (cursor.autowrap) {
 			cursor.x = 0;
 			cursor.y++;
 			// Y wrap
@@ -540,6 +554,9 @@ screen_putchar(char ch)
 				screen_scroll_up(1);
 				cursor.y = H - 1;
 			}
+		} else {
+			cursor.x = W - 1;
+		}
 	}
 
 done:

user/screen.h

@@ -109,6 +109,9 @@ void screen_cursor_restore(bool withAttrs);
 /** Enable cursor display */
 void screen_cursor_enable(bool enable);
 
+/** Enable auto wrap */
+void screen_wrap_enable(bool enable);
+
 // --- Colors ---
 
 /** Set cursor foreground color */

user/user_main.c

@@ -24,6 +24,8 @@
 #include "screen.h"
 #include "routes.h"
 #include "user_main.h"
+#include "uart_driver.h"
+#include "ansi_parser_callbacks.h"
 
 #ifdef ESPFS_POS
 CgiUploadFlashDef uploadParams={
@@ -92,6 +94,15 @@ void ICACHE_FLASH_ATTR user_init(void)
 
 	ioInit();
 
+	// Change AP name if AI-THINKER found (means un-initialized device)
+	struct softap_config apconf;
+	wifi_softap_get_config(&apconf);
+	if (strstarts((char*)apconf.ssid, "AI-THINKER")) {
+		warn("Un-initialized device, performing factory reset.");
+		apars_handle_OSC_FactoryReset();
+		return;
+	}
+
 	// 0x40200000 is the base address for spi flash memory mapping, ESPFS_POS is the position
 	// where image is written in flash that is defined in Makefile.
 #ifdef ESPFS_POS
@@ -114,6 +125,10 @@ void ICACHE_FLASH_ATTR user_init(void)
 	// The terminal screen
 	screen_init();
 
+	// Print the CANCEL character to indicate the module has restarted
+	// Critically important for client application if any kind of screen persistence / content re-use is needed
+	UART_WriteChar(UART0, 24, UART_TIMEOUT_US); // 0x18 - 24 - CAN
+
 	info("Listening on UART0, 115200-8-N-1!");
 }
 

user/user_main.h

@@ -1,7 +1,7 @@
 #ifndef USER_MAIN_H_H
 #define USER_MAIN_H_H
 
-#define FIRMWARE_VERSION "0.5"
+#define FIRMWARE_VERSION "0.5.6"
 #define TERMINAL_GITHUB_REPO "https://github.com/MightyPork/esp-vt100-firmware"
 
 #endif //USER_MAIN_H_H