Merge pull request #262 from schneemaier/patch-1

Update flash.sh

front-end

@@ -1 +1 @@
-Subproject commit e25523de11484d306a8cc5cb7b9d3c5839edd916
+Subproject commit 9aae724df2ce60a144eb9f170bb09bdbd02297df

rel-tpl/flash.sh

@@ -18,8 +18,8 @@ if [ -z ${ESPTOOL} ]; then
 	fi
 fi
 
-[ -z ESPPORT ] && ESPPORT=/dev/ttyUSB0
+[ -z ${ESPPORT} ] && ESPPORT=/dev/ttyUSB0
-[ -z ESPBAUD ] && ESPBAUD=460800
+[ -z ${ESPBAUD} ] && ESPBAUD=460800
 
 set -x
 ${ESPTOOL} --port ${ESPPORT} --baud ${ESPBAUD} \

user/api.h

@@ -11,5 +11,6 @@
 #define API_REBOOT  "/api/v1/reboot"
 #define API_PING    "/api/v1/ping"
 #define API_CLEAR   "/api/v1/clear"
+#define API_GPIO    "/api/v1/gpio"
 
 #endif //ESPTERM_API_H

user/cgi_d2d.c

@@ -178,7 +178,7 @@ d2d_parse_command(char *msg)
 	else if (strstarts(msg, "H;")) {
 		if (request_pending) return false;
 
-		// Send a esp-esp message
+		// Send a HTTP request
 		msg += 2;
 		const char *method = NULL;
 		const char *params = NULL;

user/cgi_system.c

@@ -10,7 +10,8 @@
 #include "cgi_logging.h"
 
 #define SET_REDIR_SUC "/cfg/system"
-#define SET_REDIR_ERR SET_REDIR_SUC"?err="
+
+void buildInputsJson(char *buff);
 
 static ETSTimer tmr;
 
@@ -82,7 +83,18 @@ cgiSystemCfgSetParams(HttpdConnData *connData)
 	char redir_url_buf[100];
 
 	char *redir_url = redir_url_buf;
-	redir_url += sprintf(redir_url, SET_REDIR_ERR);
+
+	if (GET_ARG("redir")) {
+		strncpy(redir_url, buff, 40);
+		u32 len = strlen(buff);
+		if (len > 40) len = 40;
+		redir_url += len;
+	} else {
+		redir_url += sprintf(redir_url, SET_REDIR_SUC);
+	}
+	char *end_of_redir_url = redir_url;
+	redir_url += sprintf(redir_url, "?err=");
+	char *end_of_failed_redir_url = redir_url;
 	// we'll test if anything was printed by looking for \0 in failed_keys_buf
 
 	if (connData->conn == NULL) {
@@ -174,14 +186,16 @@ cgiSystemCfgSetParams(HttpdConnData *connData)
 	(void)redir_url;
 	(void)uart_changed; // unused
 
-	if (redir_url_buf[strlen(SET_REDIR_ERR)] == 0) {
+	if (*end_of_failed_redir_url == '\0') {
 		// All was OK
 		cgi_info("Set system params - success, saving...");
 
 		sysconf_apply_settings();
 		persist_store();
 
-		httpdRedirect(connData, SET_REDIR_SUC "?msg=Settings%20saved%20and%20applied.");
+		strcpy(end_of_redir_url, "?msg=Settings%20saved%20and%20applied.");
+
+		httpdRedirect(connData, redir_url_buf);
 	} else {
 		cgi_warn("Some settings did not validate, asking for correction");
 
@@ -198,6 +212,40 @@ cgiSystemCfgSetParams(HttpdConnData *connData)
 	return HTTPD_CGI_DONE;
 }
 
+static void tplSystemCfgFill(char *token, char *buff)
+{
+    buff[0] = '\0';
+
+    const bool admin = false;
+    const bool tpl=true;
+
+#define XSTRUCT sysconf
+#define X XGET_CGI_FUNC_RETURN
+    XTABLE_SYSCONF
+#undef X
+#undef XSTRUCT
+
+    if (streq(token, "def_access_name")) {
+        sprintf(buff, "%s", DEF_ACCESS_NAME);
+        return;
+    }
+
+    if (streq(token, "def_access_pw")) {
+        sprintf(buff, "%s", DEF_ACCESS_PW);
+        return;
+    }
+
+    if (streq(token, "def_admin_pw")) {
+        sprintf(buff, "%s", DEFAULT_ADMIN_PW);
+        return;
+    }
+
+    if (streq(token, "gpio_initial")) {
+        buildInputsJson(buff);
+        return;
+    }
+}
+
 
 httpd_cgi_state ICACHE_FLASH_ATTR
 tplSystemCfg(HttpdConnData *connData, char *token, void **arg)
@@ -210,27 +258,132 @@ tplSystemCfg(HttpdConnData *connData, char *token, void **arg)
 		return HTTPD_CGI_DONE;
 	}
 
-	strcpy(buff, ""); // fallback
+    tplSystemCfgFill(token, buff);
+
+	tplSend(connData, buff, -1);
+	return HTTPD_CGI_DONE;
+}
+
 
-	const bool admin = false;
+static ETSTimer tmrPulse;
-	const bool tpl=true;
 
-#define XSTRUCT sysconf
+static void ICACHE_FLASH_ATTR tmrPulseCb(void *arg)
-#define X XGET_CGI_FUNC
+{
-	XTABLE_SYSCONF
+	u32 mask = sysconf->gpio2_conf==GPIOCONF_OFF ? 0x30 : 0x34;
-#undef X
+	u32 argu = (u32) arg;
-#undef XSTRUCT
+	u32 set_on = argu & mask;
+	u32 set_off = (argu >> 16) & mask;
+	gpio_output_set(set_off, set_on, 0, 0); // the args are swapped here to achieve the opposite
+}
+
+
+void ICACHE_FLASH_ATTR
+buildInputsJson(char *buff)
+{
+    u32 inputs = gpio_input_get();
+
+    sprintf(buff, "{\"io2\":%d,\"io4\":%d,\"io5\":%d}",
+            ((inputs&(1<<2)) != 0),
+            ((inputs&(1<<4)) != 0),
+            ((inputs&(1<<5)) != 0)
+    );
+}
+
+/**
+ * API to set GPIOs
+ *
+ * @param connData
+ * @return
+ */
+httpd_cgi_state ICACHE_FLASH_ATTR cgiGPIO(HttpdConnData *connData)
+{
+	char buff[32];
+
+	if (connData->conn==NULL) {
+		//Connection aborted. Clean up.
+		return HTTPD_CGI_DONE;
+	}
+
+	bool set = 0;
+	u32 inputs = gpio_input_get();
+
+	// args are do2, do4, do5, pulse. Values: 0 - off, 1 - on, t - toggle. pulse is in ms
 
-	if (streq(token, "def_access_name")) {
+	s8 set_d2 = -1, set_d4 = -1, set_d5 = -1;
-		sprintf(buff, "%s", DEF_ACCESS_NAME);
+
+	if (sysconf->gpio2_conf == GPIOCONF_OUT_START_0 || sysconf->gpio2_conf == GPIOCONF_OUT_START_1) {
+		if (GET_ARG("do2")) {
+			if (buff[0] == 't') {
+				set = ((inputs & (1<<2)) == 0);
+			} else {
+				set = buff[0] == '1';
+			}
+			set_d2 = set;
+			gpio_output_set((uint32) (set << 2), (uint32) ((!set) << 2), 0, 0);
+		}
 	}
-	else if (streq(token, "def_access_pw")) {
+
-		sprintf(buff, "%s", DEF_ACCESS_PW);
+	if (sysconf->gpio4_conf == GPIOCONF_OUT_START_0 || sysconf->gpio4_conf == GPIOCONF_OUT_START_1) {
+		if (GET_ARG("do4")) {
+			if (buff[0] == 't') {
+				set = ((inputs & (1<<4)) == 0);
+			} else {
+				set = buff[0] == '1';
+			}
+			set_d4 = set;
+			gpio_output_set((uint32) (set << 4), (uint32) ((!set) << 4), 0, 0);
+		}
 	}
-	else if (streq(token, "def_admin_pw")) {
+
-		sprintf(buff, "%s", DEFAULT_ADMIN_PW);
+	if (sysconf->gpio5_conf == GPIOCONF_OUT_START_0 || sysconf->gpio5_conf == GPIOCONF_OUT_START_1) {
+		if (GET_ARG("do5")) {
+			if (buff[0] == 't') {
+				set = ((inputs & (1<<5)) == 0);
+			} else {
+				set = buff[0] == '1';
+			}
+			set_d5 = set;
+			gpio_output_set((uint32) (set << 5), (uint32) ((!set) << 5), 0, 0);
+		}
 	}
 
-	tplSend(connData, buff, -1);
+	if (GET_ARG("pulse")) {
+		int duration = atoi(buff);
+
+		if (duration > 0) {
+			u32 cmd = 0;
+			if (set_d2 != -1) {
+				if (set_d2) { cmd |= 1<<2; } else { cmd |= 1<<(16+2); }
+			}
+
+			if (set_d4 != -1) {
+				if (set_d4) { cmd |= 1<<4; } else { cmd |= 1<<(16+4); }
+			}
+
+			if (set_d5 != -1) {
+				if (set_d5) { cmd |= 1<<5; } else { cmd |= 1<<(16+5); }
+			}
+
+			os_timer_disarm(&tmrPulse);
+			os_timer_setfn(&tmrPulse, tmrPulseCb, (void*) cmd);
+			os_timer_arm(&tmrPulse, duration, false);
+		}
+	}
+
+	httpdStartResponse(connData, 200);
+	httpdHeader(connData, "Content-Type", "application/json");
+	httpdEndHeaders(connData);
+
+	// refresh inputs
+	buildInputsJson(buff);
+	httpdSend(connData, buff, -1);
+
 	return HTTPD_CGI_DONE;
 }
+
+/** "GPIO" page */
+httpd_cgi_state ICACHE_FLASH_ATTR
+tplGpio(HttpdConnData *connData, char *token, void **arg)
+{
+	return tplSystemCfg(connData, token, arg);
+}

user/cgi_system.h

@@ -9,5 +9,7 @@ httpd_cgi_state cgiResetDevice(HttpdConnData *connData);
 httpd_cgi_state cgiSystemCfgSetParams(HttpdConnData *connData);
 httpd_cgi_state tplSystemCfg(HttpdConnData *connData, char *token, void **arg);
 httpd_cgi_state cgiResetScreen(HttpdConnData *connData);
+httpd_cgi_state cgiGPIO(HttpdConnData *connData);
+httpd_cgi_state tplGpio(HttpdConnData *connData, char *token, void **arg);
 
 #endif // CGI_PING_H

user/config_xmacros.h

@@ -88,6 +88,9 @@ enum xset_result xset_ustring(const char *name, u8 *field, const char *buff, con
 #define XGET_CGI_FUNC(type, name, suffix, deref, xget, xset, xsarg, xnotify, allow) \
 	if ((allow) && streq(token, #name)) xget(buff, deref XSTRUCT->name);
 
+#define XGET_CGI_FUNC_RETURN(type, name, suffix, deref, xget, xset, xsarg, xnotify, allow) \
+	if ((allow) && streq(token, #name)) { xget(buff, deref XSTRUCT->name); return; }
+
 #define XSTRUCT_FIELD(type, name, suffix, deref, xget, xset, xsarg, xnotify, allow) \
 	type name suffix;
 

user/io.c

@@ -98,7 +98,10 @@ static void ICACHE_FLASH_ATTR resetBtnTimerCb(void *arg) {
 	} else {
 		// 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 (sysconf->gpio2_conf == GPIOCONF_OFF) {
+            // only if uart is enabled
+            PIN_FUNC_SELECT(PERIPHS_IO_MUX_GPIO2_U, FUNC_U1TXD_BK);
+        }
 
 		if (resetCnt>=12) { //6 secs pressed - FR (timer is at 500 ms)
 			info("Restoring to default settings via BOOT button!");
@@ -140,3 +143,61 @@ void ICACHE_FLASH_ATTR ioInit() {
 	}
 }
 
+struct pinmapping {
+	bool set;
+	bool reset;
+	bool enable;
+	bool disable;
+	bool input;
+	bool pullup;
+};
+
+void ICACHE_FLASH_ATTR userGpioInit(void)
+{
+	const struct pinmapping pin_mappings[5] = {
+	//   S  R  E  D  I  P
+		{0, 1, 0, 1, 0, 0}, // OFF
+		{0, 1, 1, 0, 0, 0}, // OUT 0
+		{1, 0, 1, 0, 0, 0}, // OUT 1
+		{0, 0, 0, 1, 1, 1}, // IN PULL
+		{0, 0, 0, 1, 1, 0}, // IN NOPULL
+	};
+
+	u8 num;
+	const struct pinmapping *pm;
+
+	// GPIO2
+	num = 2;
+	pm = &pin_mappings[sysconf->gpio2_conf];
+	gpio_output_set((uint32) (pm->set << num), (uint32) (pm->reset << num), (uint32) (pm->enable << num), (uint32) (pm->disable << num));
+	if (pm->pullup) {
+		PIN_PULLUP_EN(PERIPHS_IO_MUX_GPIO2_U);
+	} else {
+		PIN_PULLUP_DIS(PERIPHS_IO_MUX_GPIO2_U);
+	}
+	if (sysconf->gpio2_conf == GPIOCONF_OFF) {
+        PIN_FUNC_SELECT(PERIPHS_IO_MUX_GPIO2_U, FUNC_U1TXD_BK);
+    } else {
+        PIN_FUNC_SELECT(PERIPHS_IO_MUX_GPIO2_U, FUNC_GPIO2);
+    }
+
+	// GPIO4
+	num = 4;
+	pm = &pin_mappings[sysconf->gpio4_conf];
+	gpio_output_set((uint32) (pm->set << num), (uint32) (pm->reset << num), (uint32) (pm->enable << num), (uint32) (pm->disable << num));
+	if (pm->pullup) {
+		PIN_PULLUP_EN(PERIPHS_IO_MUX_GPIO4_U);
+	} else {
+		PIN_PULLUP_DIS(PERIPHS_IO_MUX_GPIO4_U);
+	}
+
+	// GPIO5
+	num = 5;
+	pm = &pin_mappings[sysconf->gpio5_conf];
+	gpio_output_set((uint32) (pm->set << num), (uint32) (pm->reset << num), (uint32) (pm->enable << num), (uint32) (pm->disable << num));
+	if (pm->pullup) {
+		PIN_PULLUP_EN(PERIPHS_IO_MUX_GPIO5_U);
+	} else {
+		PIN_PULLUP_DIS(PERIPHS_IO_MUX_GPIO5_U);
+	}
+}

user/io.h

@@ -2,5 +2,6 @@
 #define IO_H
 
 void ioInit(void);
+void userGpioInit(void);
 
 #endif

user/routes.c

@@ -103,6 +103,7 @@ const HttpdBuiltInUrl routes[] ESP_CONST_DATA = {
 	ROUTE_TPL_FILE("/", tplScreen, "/term.tpl"),
 	ROUTE_TPL_FILE("/about/?", tplAbout, "/about.tpl"),
 	ROUTE_FILE("/help/?", "/help.html"),
+	ROUTE_TPL_FILE("/cfg/gpio/?", tplGpio, "/cfg_gpio.tpl"),
 
 	// --- Sockets ---
 	ROUTE_WS(URL_WS_UPDATE, updateSockConnect),
@@ -114,6 +115,7 @@ const HttpdBuiltInUrl routes[] ESP_CONST_DATA = {
 	ROUTE_CGI(API_PING"/?", cgiPing),
 	ROUTE_CGI(API_CLEAR"/?", cgiResetScreen),
 	ROUTE_CGI(API_D2D_MSG"/?", cgiD2DMessage),
+	ROUTE_CGI(API_GPIO"/?", cgiGPIO),
 
 	ROUTE_REDIRECT("/cfg/?", "/cfg/wifi"),
 

user/serial.c

@@ -11,10 +11,12 @@ static ETSTimer flushLogTimer;
 
 static void buf_putc(char c)
 {
-	if (lb_ls != lb_nw) {
+    if (sysconf->gpio2_conf == GPIOCONF_OFF) {
-		logbuf[lb_nw++] = c;
+        if (lb_ls != lb_nw) {
-		if (lb_nw >= DEBUG_LOGBUF_SIZE) lb_nw = 0;
+            logbuf[lb_nw++] = c;
-	}
+            if (lb_nw >= DEBUG_LOGBUF_SIZE) lb_nw = 0;
+        }
+    }
 }
 
 static void ICACHE_FLASH_ATTR
@@ -42,7 +44,9 @@ buf_pop(void *unused)
 
 LOCAL void my_putc(char c)
 {
-	UART_WriteCharCRLF(UART1, (u8) c, 200);
+	if (sysconf->gpio2_conf == GPIOCONF_OFF) {
+		UART_WriteCharCRLF(UART1, (u8) c, 200);
+	}
 }
 
 /**
@@ -79,6 +83,14 @@ void ICACHE_FLASH_ATTR serialInit(void)
 	UART_SetStopBits(UART0, (UartStopBitsNum) sysconf->uart_stopbits);
 	UART_SetBaudrate(UART0, sysconf->uart_baudrate);
 
+	// GPIO2 may be used as a remotely controlled GPIO
+	if (sysconf->gpio2_conf == GPIOCONF_OFF) {
+		PIN_FUNC_SELECT(PERIPHS_IO_MUX_GPIO2_U, FUNC_U1TXD_BK);
+	} else {
+		PIN_FUNC_SELECT(PERIPHS_IO_MUX_GPIO2_U, FUNC_GPIO2);
+		// further config of the GPIO will be done in persist.c after calling this func
+	}
+
 	info("COM SERIAL: %d baud, %s parity, %s stopbit(s)",
 		 sysconf->uart_baudrate,
 		 (sysconf->uart_parity == PARITY_NONE ? "NONE" : (sysconf->uart_parity == PARITY_ODD ? "ODD" : "EVEN")),

user/syscfg.c

@@ -7,6 +7,7 @@
 #include "uart_driver.h"
 #include "serial.h"
 #include "cgi_logging.h"
+#include "io.h"
 
 SystemConfigBundle * const sysconf = &persist.current.sysconf;
 
@@ -119,6 +120,14 @@ sysconf_apply_settings(void)
 		changed = true;
 	}
 
+	if (sysconf->config_version < 2) {
+		dbg("Upgrading syscfg to v 2");
+		sysconf->gpio2_conf = GPIOCONF_OFF;
+        sysconf->gpio4_conf = GPIOCONF_OUT_START_0;
+        sysconf->gpio5_conf = GPIOCONF_OUT_START_0;
+		changed = true;
+	}
+
 	sysconf->config_version = SYSCONF_VERSION;
 
 	if (changed) {
@@ -128,6 +137,9 @@ sysconf_apply_settings(void)
 	// uart settings live here, but the CGI handler + form has been moved to the Terminal config page
 	serialInit();
 
+	// initialize user GPIOs
+	userGpioInit();
+
 	system_update_cpu_freq((uint8) (sysconf->overclock ? 160 : 80));
 }
 
@@ -143,4 +155,7 @@ sysconf_restore_defaults(void)
 	strcpy((char *)sysconf->access_pw, DEF_ACCESS_PW);
 	strcpy((char *)sysconf->access_name, DEF_ACCESS_NAME);
 	sysconf->overclock = false;
+	sysconf->gpio2_conf = GPIOCONF_OFF; // means 'use debug uart'
+	sysconf->gpio4_conf = GPIOCONF_OUT_START_0;
+	sysconf->gpio5_conf = GPIOCONF_OUT_START_0;
 }

user/syscfg.h

@@ -11,7 +11,7 @@
 // Size designed for the wifi config structure
 // Must be constant to avoid corrupting user config after upgrade
 #define SYSCONF_SIZE 300
-#define SYSCONF_VERSION 1
+#define SYSCONF_VERSION 2
 
 #define DEF_ACCESS_PW "1234"
 #define DEF_ACCESS_NAME "espterm"
@@ -25,6 +25,14 @@ enum pwlock {
 	PWLOCK_MAX = 5,
 };
 
+enum gpioconf {
+	GPIOCONF_OFF = 0,
+	GPIOCONF_OUT_START_0 = 1,
+	GPIOCONF_OUT_START_1 = 2,
+	GPIOCONF_IN_PULL = 3,
+	GPIOCONF_IN_NOPULL = 4,
+};
+
 //....Type................Name..Suffix...............Deref..XGET............XSET.........................NOTIFY....Allow
 // Deref is used to pass the field to xget. Cast is used to convert the &'d field to what xset wants (needed for static arrays)
 #define XTABLE_SYSCONF \
@@ -39,7 +47,9 @@ enum pwlock {
 	X(uchar,           access_name, [32],             /**/, xget_ustring,  xset_ustring, NULL,        /**/, admin|tpl) \
 	\
 	X(bool,            overclock, /**/,               /**/, xget_bool,     xset_bool, NULL,           /**/, 1) \
-
+	X(u8,              gpio2_conf, /**/,              /**/, xget_dec,      xset_u8, NULL,             /**/, 1) \
+	X(u8,              gpio4_conf, /**/,              /**/, xget_dec,      xset_u8, NULL,             /**/, 1) \
+	X(u8,              gpio5_conf, /**/,              /**/, xget_dec,      xset_u8, NULL,             /**/, 1)
 
 typedef struct {
 #define X XSTRUCT_FIELD
@@ -54,6 +64,7 @@ typedef struct {
 //	char access_pw[64]; // access password
 //	char access_name[32]; // access name
 //	bool overclock;
+//	bool debug_uart;
 } SystemConfigBundle;
 
 extern SystemConfigBundle * const sysconf;

user/uart_handler.c

@@ -56,6 +56,7 @@ void ICACHE_FLASH_ATTR UART_Init(void)
 
 	// U1TXD (GPIO2)
 	PIN_FUNC_SELECT(PERIPHS_IO_MUX_GPIO2_U, FUNC_U1TXD_BK);
+	PIN_PULLUP_DIS(PERIPHS_IO_MUX_GPIO2_U);
 
 	// Configure the UART peripherals
 	UART_SetWordLength(UART0, EIGHT_BITS); // main

user/user_main.c

@@ -96,6 +96,8 @@ static ETSTimer prHeapTimer;
 //Main routine. Initialize stdout, the I/O, filesystem and the webserver and we're done.
 void ICACHE_FLASH_ATTR user_init(void)
 {
+	sysconf->gpio2_conf = GPIOCONF_OFF; // enable debug UART for the start-up (sysconf is not loaded yet)
+
 	ansi_parser_inhibit = true;
 	serialInitBase();
 
@@ -110,7 +112,7 @@ void ICACHE_FLASH_ATTR user_init(void)
 	banner_gap();
 	banner("================ ESPTerm ================");
 	banner_info();
-	banner_info("Project by Ondrej Hruska, 2017");
+	banner_info("Project by Ondrej Hruska, 2017-2018");
 	banner_info();
 	banner_info(TERMINAL_GITHUB_REPO_NOPROTO);
 	banner_info();

user/version.h

@@ -9,10 +9,10 @@
 #define STR(x) STR_HELPER(x)
 
 #define FW_V_MAJOR 2
-#define FW_V_MINOR 3
+#define FW_V_MINOR 4
-#define FW_V_PATCH 1
+#define FW_V_PATCH 0
-#define FW_V_SUFFIX ""
+#define FW_V_SUFFIX "-pre2"
-#define FW_CODENAME "Cricket" // 2.3
+#define FW_CODENAME "Damselfly"
 #define FW_CODENAME_QUOTED "\""FW_CODENAME"\""
 
 #define FW_VERSION STR(FW_V_MAJOR) "." STR(FW_V_MINOR) "." STR(FW_V_PATCH) FW_V_SUFFIX