added command backlog

README.md

@@ -102,12 +102,18 @@ The esp_uMQTT_broker comes with a build-in scripting engine. A script enables th
 
 The script specific CLI commands are:
 
-- script [_portno_|delete]: opens port for upload of scripts or deletes the current script
+- script [_portno_|url|delete]: opens port for upload of scripts, downloads a script from an URL, or just deletes the current one
 - show script [_line_no_]: dumps the currently active script starting with the given line (dumpy only about 1 KB, repeat command for more lines)
 - set @[num] _value_: sets the flash variable "num" (for use in scripts) to the given inital value (must be shorter than 63 chars)
 - set pwm_period _period_: sets the PWM period in terms of 200ns slots (default: 5000, = 0.1ms ^= 1KHz)
 - show vars: dumps all variables of the current program incl. the persistent flash variables
+
+Debug commands:
 - set script_logging [0|1]: switches logging of script execution on or off (not permanently stored in the configuration)
+- set backlog _buffersize_: sets the size of the backlog buffer (0 = backlog off, default, not permanently stored in the configuration)
+- show backlog: dumps the backlog to the remote console
+
+The backlog buffer stores the most recent console outputs of the running script and the CLI. If you detect an error situation you can log into the remote console and dump the recent output with "show backlog".
 
 Scripts with size up to 4KB are uploaded to the esp_uMQTT_broker using a network interface. 
 

SCRIPTING.md

@@ -129,7 +129,7 @@ This event happens when the GPIO pin with the given number generates an interrup
 ```
 http_response
 ```
-This event happens when an HTTP-request has been sent with "http_get" and a response arrives. The actual body of the response can be accessed in the actions via the special variable _$this_http_body_, the HTTP return code via the special variable _$this_http_code_. These variables are only defined inside the "on http_response" clause.
+This event happens when an HTTP-request has been sent with "http_get" or "http_post" and a response arrives. The actual body of the response can be accessed in the actions via the special variable _$this_http_body_, the HTTP return code via the special variable _$this_http_code_. To identify responses from multiple requests the special variables _$this_http_host_ and _$this_http_path_ can be tested. They contain the host and the path of the request. All these variables are only defined inside the "on http_response" clause.
 
 ## Actions
 ```

firmware/sha1sums

@@ -1,2 +1,2 @@
-033d48114a262ca73b6b505079e92bb2870b934d  0x00000.bin
-efa7d3a70c006f6d7e4cd8115dfde375275324f8  0x10000.bin
+e3485af0d2789bc28327150b3106c84550f33f08  0x00000.bin
+90aacf464f6572c424438b96ea484051f66b5735  0x10000.bin

user/cli.c

@@ -337,6 +337,21 @@ void ICACHE_FLASH_ATTR console_handle_command(struct espconn *pespconn) {
 #endif
 	    goto command_handled_2;
 	}
+#ifdef BACKLOG
+	if (nTokens >= 2 && strcmp(tokens[1], "backlog") == 0) {
+	    uint16_t len;
+	    if (backlog_buffer == NULL)
+		goto command_handled_2;
+	    while (ringbuf_bytes_free(console_tx_buffer) && (len=ringbuf_bytes_used(backlog_buffer))) {
+		if (len > sizeof(response)-1)
+		    len = sizeof(response)-1;
+		ringbuf_memcpy_from(response, backlog_buffer, len);
+		to_console(response);
+	    }
+
+	    goto command_handled_2;
+	}
+#endif
 #ifdef SCRIPTED
 	if (nTokens >= 2 && strcmp(tokens[1], "script") == 0) {
 	    if (config.locked) {
@@ -880,15 +895,38 @@ void ICACHE_FLASH_ATTR console_handle_command(struct espconn *pespconn) {
 
 	    if (strcmp(tokens[1], "broker_access") == 0) {
 		config.mqtt_broker_access = atoi(tokens[2]) & (LOCAL_ACCESS | REMOTE_ACCESS);
-		os_sprintf(response, "Broker access set\r\n", config.config_port);
+		os_sprintf(response, "Broker access set\r\n");
 		goto command_handled;
 	    }
 
 	    if (strcmp(tokens[1], "broker_autoretain") == 0) {
 		config.auto_retained = atoi(tokens[2]) != 0;
-		os_sprintf(response, "Broker autoretain set\r\n", config.config_port);
+		os_sprintf(response, "Broker autoretain set\r\n");
 		goto command_handled;
 	    }
+#ifdef BACKLOG
+	    if (strcmp(tokens[1], "backlog") == 0) {
+		int backlog_size = atoi(tokens[2]);
+		if (backlog_size != 0) {
+		    if (backlog_buffer != NULL) {
+			os_sprintf(response, "Backlog already set\r\n");
+			goto command_handled;
+		    }
+		    backlog_buffer = ringbuf_new(backlog_size);
+		    if (backlog_buffer == NULL) {
+			os_sprintf(response, "No memory\r\n");
+			goto command_handled;
+		    }
+		    os_sprintf(response, "Backlog set to %d chars\r\n", backlog_size);
+		} else {
+		    if (backlog_buffer != NULL) {
+			ringbuf_free(&backlog_buffer);
+		    }
+		    os_sprintf(response, "Backlog off\r\n");
+		}
+		goto command_handled;
+	    }
+#endif
 #ifdef SCRIPTED
 	    if (strcmp(tokens[1], "script_logging") == 0) {
 		lang_logging = atoi(tokens[2]);

user/global.h

@@ -41,6 +41,10 @@ void http_script_cb(char *response_body, int http_status, char *response_headers
 void script_connected_cb(void *arg);
 #endif
 
+#ifdef BACKLOG
+ringbuf_t backlog_buffer;
+#endif
+
 void console_handle_command(struct espconn *pespconn);
 void to_console(char *str);
 void do_command(char *t1, char *t2, char *t3);

user/lang.c

@@ -4,6 +4,8 @@
 #include "lang.h"
 #include "global.h"
 
+#ifdef SCRIPTED
+
 #ifdef NTP
 #include "ntp.h"
 #endif
@@ -1950,3 +1952,5 @@ void ICACHE_FLASH_ATTR interpreter_http_reply(char *hostname, char *path, char *
 }
 #endif
 
+#endif /* SCRIPTED */
+

user/user_config.h

@@ -98,6 +98,11 @@
 #define REMOTE_CONFIG      1
 #define CONSOLE_SERVER_PORT  7777
 
+//
+// Define this to support console backlog
+//
+#define BACKLOG      1
+
 //
 // Size of the console buffers
 //

user/user_main.c

@@ -257,8 +257,8 @@ void ICACHE_FLASH_ATTR free_script(void) {
 #endif				/* SCRIPTED */
 
 void ICACHE_FLASH_ATTR console_send_response(struct espconn *pespconn, bool serial_force) {
-    char payload[MAX_CON_SEND_SIZE];
     uint16_t len = ringbuf_bytes_used(console_tx_buffer);
+    char payload[len];
 
     if (len == 0)
 	return;
@@ -270,8 +270,18 @@ void ICACHE_FLASH_ATTR console_send_response(struct espconn *pespconn, bool seri
 	    client_sent_pending = true;
 	}
     } else {
-	if (system_output >= SYSTEM_OUTPUT_CMD || serial_force)
+	if (system_output >= SYSTEM_OUTPUT_CMD || serial_force) {
 	    UART_Send(0, payload, len);
+	}
+#ifdef BACKLOG
+	if (backlog_buffer != NULL) {
+	    char outbuf[10];
+	    if (ringbuf_bytes_free(backlog_buffer) < len && !ringbuf_is_empty(backlog_buffer)) {
+		ringbuf_memcpy_from(outbuf, backlog_buffer, sizeof(outbuf));
+	    }
+	    ringbuf_memcpy_into(backlog_buffer, payload, len);
+	}
+#endif
     }
 }
 
@@ -506,7 +516,9 @@ static void ICACHE_FLASH_ATTR user_procTask(os_event_t * events) {
 		char data[bytes_count+1];
 		ringbuf_memcpy_from(data, console_rx_buffer, bytes_count);
 		data[bytes_count] = '\0';
+#ifdef SCRIPTED
 		interpreter_serial_input(data, bytes_count);
+#endif
 	    } else {
 		console_handle_command(pespconn);
 	    }
@@ -739,6 +751,9 @@ void  user_init() {
     do_ip_config = false;
     my_ip.addr = 0;
     t_old = 0;
+#ifdef BACKLOG
+    backlog_buffer = NULL;
+#endif
 
     console_rx_buffer = ringbuf_new(MAX_CON_CMD_SIZE);
     console_tx_buffer = ringbuf_new(MAX_CON_SEND_SIZE);