Variable TCP Telnet ports via web interface

.travis.yml

@@ -1,31 +1,28 @@
-# Travis-CI file for Esp-Link
-
 language: c
-
 before_install:
-  - curl -Ls http://s3.voneicken.com/xtensa-lx106-elf-20160330.tgx | tar Jxf -
-  - curl -Ls http://s3.voneicken.com/esp_iot_sdk_v2.0.0.p1.tgx | tar -C .. -Jxf -
-
-after_script:
- # upload to an S3 bucket, requires S3_BUCKET, AWS_ACCESS_KEY_ID and AWS_SECRET_KEY to be set
- # in environment using travis' repository settings
-  - "if [[ -n \"$S3_BUCKET\" && -n \"$AWS_ACCESS_KEY_ID\" ]]; then
-     echo Uploading *.tgz to $S3_BUCKET;
-     curl -Ls https://github.com/rlmcpherson/s3gof3r/releases/download/v0.5.0/gof3r_0.5.0_linux_amd64.tar.gz | tar zxf - gof3r_0.5.0_linux_amd64/gof3r;
-     mv gof3r*/gof3r .;
-     ls *.tgz | xargs -I {} ./gof3r put -b $S3_BUCKET -k esp-link/{} --acl public-read -p {};
-     ls *.tgz | xargs -I {} echo \"URL: http://$S3_BUCKET/esp-link/{}\";
-     fi"
-
-compiler: gcc
-
-env:
-
+- curl -Ls http://s3.voneicken.com/xtensa-lx106-elf-20160330.tgx | tar Jxf -
+- curl -Ls http://s3.voneicken.com/esp_iot_sdk_v2.0.0.p1.tgx | tar -C .. -Jxf -
 script:
-  - export XTENSA_TOOLS_ROOT=$PWD/xtensa-lx106-elf/bin/
-  - export BRANCH=$TRAVIS_BRANCH
-    #- export SDK_BASE=$PWD/esp_iot_sdk_v2.0.0.p1
-  - make release
-
+- printenv
+- export XTENSA_TOOLS_ROOT=$PWD/xtensa-lx106-elf/bin/
+- export BRANCH=$TRAVIS_BRANCH
+- echo "Travis Branch is $TRAVIS_BRANCH"
+- echo "Travis Tag is    $TRAVIS_TAG"
+- echo "Travis COMMIT is $TRAVIS_COMMIT"
+- echo "Travis COMMIT is $TRAVIS_COMMIT_RANGE"
+- echo "Dont forget to set VARIABLES for S3 to function. SEE gof3r README"
+- make release
 notifications:
   email: false
+deploy:
+  overwrite: true
+  skip_cleanup: true
+  provider: releases
+  api_key:
+    secure: unYyTCLpk1ixcNOyoUwroBqqx0yBhii56IXm57kjo5kl3umf1GRb3FUIE6la+B0njsNwAUNR/uLn6wF4FqYTUJzNQZskJDJfZjb53vwuoHaoa5j4K/bWB9zRlQ1XZBTkV48cxz8Ef2KyNduK2IciOHwsw3LQS0em3dpK7oG/20VzELt23Gx8uhBYa+OUzlr3Y+PYPynkwM30YwVQXpCy/GMgEbrcKheGbLTAIp7tms0KDAvbb98U0BI3tWBckE5GzAYYAmrXgyDXtEsU/poCMqUj/lpPl1s/5uxGVevTO7XuL4AYtF//AixsM20bPKtIZDHZS9b7JHtVhU655bY2aAfpMgf7xzkKbJkRzeAzT9HucFDjLY48yW4vztdJxBgkAL9d064gTHhThtn4hylZAYpHnqUiM0j4DKil5A0VG2F8EVEqZ7Q2tNzy6aqq37wzTuYXsYpz3mglpazaXXp/LoSurDHy1gz6aB/mdaeBoL3MX1q09LBE8lFGYBILQ8KUkrLyJathxAVvDBnl7nXFv2NWoZ2i7CfXdpCwmOVUN2WhudNfgbbaMung+voTFB+yLq9PBQP5gdP0MKU3zDTB/msmZo1pp/SbnNETCrKAdRtxNI+bxTQ98njAIkxI+7ZiVV8SMNEPyNcWq/6ViYDcIHJMR4Gq0DZunre1voEs1F4=
+  file_glob: true
+  file: esp-link-master-*.t*gz
+  on:
+    branch: master
+    repo: fuzzball03/esp-link
+    condition: "$TRAVIS_BRANCH = master"

Makefile

@@ -52,12 +52,15 @@ ESP_HOSTNAME  ?= esp-link
 # Base directory for the compiler. Needs a / at the end.
 # Typically you'll install https://github.com/pfalcon/esp-open-sdk
 # IMPORTANT: use esp-open-sdk `make STANDALONE=n`: the SDK bundled with esp-open-sdk will *not* work!
-XTENSA_TOOLS_ROOT ?= $(abspath ../esp-open-sdk/xtensa-lx106-elf/bin)/
+XTENSA_TOOLS_ROOT ?= $(abspath ../espressif/xtensa-lx106-elf/bin)/
+$(warning Using XTENSA TOOLS from $(XTENSA_TOOLS_ROOT))
 
 # Firmware version 
 # WARNING: if you change this expect to make code adjustments elsewhere, don't expect
 # that esp-link will magically work with a different version of the SDK!!!
 SDK_VERS ?= esp_iot_sdk_v2.0.0.p1
+# Uncomment this line if you're using windows to build with the C:\espressif structure
+# SDK_VERS ?= ESP8266_SDK 
 
 # Try to find the firmware manually extracted, e.g. after downloading from Espressif's BBS,
 # http://bbs.espressif.com/viewforum.php?f=46
@@ -66,16 +69,17 @@ SDK_BASE ?= $(wildcard ../$(SDK_VERS))
 
 # If the firmware isn't there, see whether it got downloaded as part of esp-open-sdk
 # This used to work at some point, but is not supported, uncomment if you feel lucky ;-)
-#ifeq ($(SDK_BASE),)
-#SDK_BASE := $(wildcard $(XTENSA_TOOLS_ROOT)/../../$(SDK_VERS))
-#endif
+ifeq ($(SDK_BASE),)
+SDK_BASE := $(wildcard $(XTENSA_TOOLS_ROOT)/../../$(SDK_VERS))
+endif
 
 # Clean up SDK path
 SDK_BASE := $(abspath $(SDK_BASE))
 $(warning Using SDK from $(SDK_BASE))
 
 # Path to bootloader file
-BOOTFILE	?= $(SDK_BASE/bin/boot_v1.6.bin)
+BOOTFILE	?= $(SDK_BASE)/bin/boot_v1.6.bin
+$(warning Using boot file-> $(BOOTFILE))
 
 # Esptool.py path and port, only used for 1-time serial flashing
 # Typically you'll use https://github.com/themadinventor/esptool
@@ -127,8 +131,10 @@ GZIP_COMPRESSION ?= yes
 # http://yui.github.io/yuicompressor/
 # enabled by default.
 COMPRESS_W_HTMLCOMPRESSOR ?= yes
-HTML_COMPRESSOR ?= htmlcompressor-1.5.3.jar
-YUI_COMPRESSOR ?= yuicompressor-2.4.8.jar
+HTML_COMPRESSOR_VER ?= htmlcompressor-1.5.3.jar
+HTML_COMPRESSOR = tools/$(HTML_COMPRESSOR_VER)
+YUI_COMPRESSOR_VER ?= yuicompressor-2.4.8.jar
+YUI_COMPRESSOR = tools/$(YUI_COMPRESSOR_VER)
 
 # -------------- End of config options -------------
 
@@ -296,6 +302,13 @@ Q := @
 vecho := @echo
 endif
 
+#Fix for issues on some windows systems that call non GNU FIND
+FIND ?= $(which FIND)
+ifeq (,$(findstring system32,$(FIND)))
+  $(warning Non GNU 'find' called. Trying alternate path /usr/bin/find)
+  FIND = /usr/bin/find
+endif
+
 ifneq ($(strip $(STA_SSID)),)
 CFLAGS		+= -DSTA_SSID="$(STA_SSID)"
 endif
@@ -387,6 +400,7 @@ $(FW_BASE)/user2.bin: $(USER2_OUT) $(FW_BASE)
 	$(Q) COMPILE=gcc PATH=$(XTENSA_TOOLS_ROOT):$(PATH) python $(APPGEN_TOOL) $(USER2_OUT) 2 $(ESP_FLASH_MODE) $(ESP_FLASH_FREQ_DIV) $(ESP_SPI_SIZE) 1 >/dev/null
 	$(Q) rm -f eagle.app.v6.*.bin
 	$(Q) mv eagle.app.flash.bin $@
+	@echo "** user2.bin uses $$(stat -c '%s' $@) bytes of" $(ESP_FLASH_MAX) "available"
 	$(Q) if [ $$(stat -c '%s' $@) -gt $$(( $(ESP_FLASH_MAX) )) ]; then echo "$@ too big!"; false; fi
 
 $(APP_AR): $(OBJ)
@@ -406,18 +420,18 @@ baseflash: all
 
 flash: all
 	$(Q) $(ESPTOOL) --port $(ESPPORT) --baud $(ESPBAUD) write_flash -fs $(ET_FS) -ff $(ET_FF) \
-	  0x00000 "$(SDK_BASE)/bin/boot_v1.5.bin" 0x01000 $(FW_BASE)/user1.bin \
+	  0x00000 "$(BOOTFILE)" 0x01000 $(FW_BASE)/user1.bin \
 	  $(ET_BLANK) $(SDK_BASE)/bin/blank.bin
 
 tools/$(HTML_COMPRESSOR):
 	$(Q) echo "The jar files in the tools dir are missing, they should be in the source repo"
 	$(Q) echo "The following commands can be used to fetch them, but the URLs have changed..."
 	$(Q) echo mkdir -p tools
-	$(Q) echo "cd tools; wget --no-check-certificate https://github.com/yui/yuicompressor/releases/download/v2.4.8/$(YUI_COMPRESSOR) -O $(YUI_COMPRESSOR)"
-	$(Q) echo "cd tools; wget --no-check-certificate https://htmlcompressor.googlecode.com/files/$(HTML_COMPRESSOR) -O $(HTML_COMPRESSOR)"
+	$(Q) echo "cd tools; wget --no-check-certificate https://github.com/yui/yuicompressor/releases/download/v2.4.8/$(YUI_COMPRESSOR_VER) -O $(YUI_COMPRESSOR_VER)"
+	$(Q) echo "cd tools; wget --no-check-certificate https://htmlcompressor.googlecode.com/files/$(HTML_COMPRESSOR_VER) -O $(HTML_COMPRESSOR_VER)"
 
 ifeq ("$(COMPRESS_W_HTMLCOMPRESSOR)","yes")
-$(BUILD_BASE)/espfs_img.o: tools/$(HTML_COMPRESSOR)
+$(BUILD_BASE)/espfs_img.o: $(HTML_COMPRESSOR)
 endif
 
 $(BUILD_BASE)/espfs_img.o: html/ html/wifi/ espfs/mkespfsimage/mkespfsimage
@@ -428,38 +442,38 @@ $(BUILD_BASE)/espfs_img.o: html/ html/wifi/ espfs/mkespfsimage/mkespfsimage
 	$(Q) cp -r html/wifi/*.png html_compressed/wifi;
 	$(Q) cp -r html/wifi/*.js html_compressed/wifi;
 ifeq ("$(COMPRESS_W_HTMLCOMPRESSOR)","yes")
-	$(Q) echo "Compressing assets with htmlcompressor. This may take a while..."
-	$(Q) java -jar tools/$(HTML_COMPRESSOR) \
+	$(Q) echo "Compressing assets with htmlcompressor. This may take a while...";
+	$(Q) java -jar $(HTML_COMPRESSOR) \
 	  -t html --remove-surrounding-spaces max --remove-quotes --remove-intertag-spaces \
 	  -o $(abspath ./html_compressed)/ \
 	  $(HTML_PATH)head- \
 	  $(HTML_PATH)*.html
-	$(Q) java -jar tools/$(HTML_COMPRESSOR) \
+	$(Q) java -jar $(HTML_COMPRESSOR) \
 	  -t html --remove-surrounding-spaces max --remove-quotes --remove-intertag-spaces \
 	  -o $(abspath ./html_compressed)/wifi/ \
 	  $(WIFI_PATH)*.html
 	$(Q) echo "Compressing assets with yui-compressor. This may take a while..."
-	$(Q) for file in `find html_compressed -type f -name "*.js"`; do \
-	    java -jar tools/$(YUI_COMPRESSOR) $$file --line-break 0 -o $$file; \
-	  done
-	$(Q) for file in `find html_compressed -type f -name "*.css"`; do \
-	    java -jar tools/$(YUI_COMPRESSOR) $$file -o $$file; \
-	  done
+	$(Q) java -jar $(YUI_COMPRESSOR) ./html_compressed/*.css -o '.css$:.css'
+	$(Q) java -jar $(YUI_COMPRESSOR) ./html_compressed/*.js -o '.js$:.js'
+	$(Q) java -jar $(YUI_COMPRESSOR) ./html_compressed/wifi/*.js -o '.js$:.js'
 else
 	$(Q) cp -r html/head- html_compressed;
 	$(Q) cp -r html/*.html html_compressed;
 	$(Q) cp -r html/wifi/*.html html_compressed/wifi;	
 endif
+
 ifeq (,$(findstring mqtt,$(MODULES)))
 	$(Q) rm -rf html_compressed/mqtt.html
 	$(Q) rm -rf html_compressed/mqtt.js
 endif
-	$(Q) for file in `find html_compressed -type f -name "*.htm*"`; do \
+
+	$(Q) for file in `$(FIND) html_compressed -type f -name "*.htm*"`; do \
 	    cat html_compressed/head- $$file >$${file}-; \
 	    mv $$file- $$file; \
 	  done
 	$(Q) rm html_compressed/head-
-	$(Q) cd html_compressed; find . \! -name \*- | ../espfs/mkespfsimage/mkespfsimage > ../build/espfs.img; cd ..;
+	$(Q) echo "Compressing assets into espfs.img with Gzip. This may take a while..."
+	$(Q) cd html_compressed; $(FIND) . \! -name \*- | ../espfs/mkespfsimage/mkespfsimage > ../build/espfs.img; cd ..;
 	$(Q) ls -sl build/espfs.img
 	$(Q) cd build; $(OBJCP) -I binary -O elf32-xtensa-le -B xtensa --rename-section .data=.espfs \
 	  espfs.img espfs_img.o; cd ..
@@ -483,7 +497,7 @@ release: all
 	$(Q) egrep -a 'esp-link [a-z0-9.]+ - 201' $(FW_BASE)/user1.bin | cut -b 1-80
 	$(Q) egrep -a 'esp-link [a-z0-9.]+ - 201' $(FW_BASE)/user2.bin | cut -b 1-80
 	$(Q) cp $(FW_BASE)/user1.bin $(FW_BASE)/user2.bin $(SDK_BASE)/bin/blank.bin \
-	       "$(SDK_BASE)/bin/boot_v1.6.bin" "$(SDK_BASE)/bin/esp_init_data_default.bin" \
+	       "$(BOOTFILE)" "$(SDK_BASE)/bin/esp_init_data_default.bin" \
 	       wiflash avrflash release/esp-link-$(BRANCH)
 	$(Q) tar zcf esp-link-$(BRANCH)-$(SHA).tgz -C release esp-link-$(BRANCH)
 	$(Q) echo "Release file: esp-link-$(BRANCH)-$(SHA).tgz"
@@ -494,12 +508,12 @@ docker:
 clean:
 	$(Q) rm -f $(APP_AR)
 	$(Q) rm -f $(TARGET_OUT)
-	$(Q) find $(BUILD_BASE) -type f | xargs rm -f
+	$(Q) $(FIND) $(BUILD_BASE) -type f | xargs rm -f
 	$(Q) make -C espfs/mkespfsimage/ clean
 	$(Q) rm -rf $(FW_BASE)
 	$(Q) rm -f webpages.espfs
 ifeq ("$(COMPRESS_W_HTMLCOMPRESSOR)","yes")
 	$(Q) rm -rf html_compressed
 endif
 
-$(foreach bdir,$(BUILD_DIR),$(eval $(call compile-objects,$(bdir))))
+$(foreach bdir,$(BUILD_DIR),$(eval $(call compile-objects,$(bdir))))

README.md

@@ -149,6 +149,8 @@ From there, more advanced steps are:
 
 ### Serial bridge
 
+Note that the default ports of 23 & 2323 may be changed via the webinterface.
+
 In order to connect through the esp-link to a microcontroller use port 23. For example,
 on linux you can use `nc esp-hostname 23` or `telnet esp-hostname 23`.
 

esp-link/cgi.c

@@ -190,7 +190,7 @@ int ICACHE_FLASH_ATTR printGlobalInfo(char *buff, int buflen, char *token) {
 
 extern char *esp_link_version; // in user_main.c
 
-int ICACHE_FLASH_ATTR cgiMenu(HttpdConnData *connData) {
+int ICACHE_FLASH_ATTR cgiMenu(HttpdConnData *connData) { //This is where we can modify the navigation that is auto generated
   if (connData->conn==NULL) return HTTPD_CGI_DONE; // Connection aborted. Clean up.
   char buff[1024];
   // don't use jsonHeader so the response does get cached

esp-link/cgipins.c

@@ -1,4 +1,3 @@
-
 #include <esp8266.h>
 #include "cgi.h"
 #include "espfs.h"

esp-link/cgitelnet.c

@@ -0,0 +1,120 @@
+#include <esp8266.h>
+#include "cgi.h"
+#include "config.h"
+#include "serbridge.h"
+
+static char *portMode[] = { "open", "disabled", "secure" };
+
+// Cgi to return choice of Telnet ports
+int ICACHE_FLASH_ATTR cgiTelnetGet(HttpdConnData *connData) {
+  char buff[80];
+
+  if (connData->conn==NULL) return HTTPD_CGI_DONE; // Connection aborted
+
+  int len;
+
+  os_printf("Current telnet ports: port0=%d port1=%d\n",
+	flashConfig.telnet_port0, flashConfig.telnet_port1);
+
+  len = os_sprintf(buff,
+      "{ \"port0\": \"%d\", \"port1\": \"%d\" }",
+      flashConfig.telnet_port0, flashConfig.telnet_port1);
+
+  jsonHeader(connData, 200);
+  httpdSend(connData, buff, len);
+
+  return HTTPD_CGI_DONE;
+}
+
+// Cgi to change choice of Telnet ports
+int ICACHE_FLASH_ATTR cgiTelnetSet(HttpdConnData *connData) {
+  char buf[80];
+
+  if (connData->conn==NULL) {
+    return HTTPD_CGI_DONE; // Connection aborted
+  }
+
+  int8_t ok = 0;
+  uint16_t port0, port1;
+  ok |= getUInt16Arg(connData, "port0", &port0);
+  ok |= getUInt16Arg(connData, "port1", &port1);
+
+  if (ok <= 0) { //If we get at least one good value, this should be >= 1
+    ets_sprintf(buf, "Unable to fetch telnet ports.\n Received: port0=%d port1=%d\n",
+	  flashConfig.telnet_port0, flashConfig.telnet_port1);
+    os_printf(buf);
+    errorResponse(connData, 400, buf);
+    return HTTPD_CGI_DONE;
+  }
+
+  if (ok > 0) {
+    // fill both port variables from flash or ajax provided value
+    if (!port0) port0 = flashConfig.telnet_port0;
+    if (!port1) port1 = flashConfig.telnet_port1;
+
+    // check whether ports are different
+    if (port0 == port1) {
+      os_sprintf(buf, "Ports cannot be the same.\n Tried to set: port0=%d port1=%d\n",
+        flashConfig.telnet_port0, flashConfig.telnet_port1);
+      os_printf(buf);
+      errorResponse(connData, 400, buf);
+      return HTTPD_CGI_DONE;
+    }
+
+    // we're good, set flashconfig
+    flashConfig.telnet_port0 = port0;
+    flashConfig.telnet_port1 = port1;
+    os_printf("Telnet ports changed: port0=%d port1=%d\n",
+	  flashConfig.telnet_port0, flashConfig.telnet_port1);
+
+    // save to flash
+    if (configSave()) {
+      httpdStartResponse(connData, 204);
+      httpdEndHeaders(connData);
+    } else {
+      httpdStartResponse(connData, 500);
+      httpdEndHeaders(connData);
+      httpdSend(connData, "Failed to save config", -1);
+    }
+
+    // apply the changes
+    serbridgeInit();
+    serbridgeStart(0, flashConfig.telnet_port0, flashDefault.telnet_port0mode);
+    serbridgeStart(1, flashConfig.telnet_port1, flashDefault.telnet_port1mode);
+
+  }
+
+  return HTTPD_CGI_DONE;
+}
+
+int ICACHE_FLASH_ATTR cgiTelnet(HttpdConnData *connData) {
+  if (connData->conn==NULL) return HTTPD_CGI_DONE; // Connection aborted. Clean up.
+  if (connData->requestType == HTTPD_METHOD_GET) {
+    return cgiTelnetGet(connData);
+  } else if (connData->requestType == HTTPD_METHOD_POST) {
+    return cgiTelnetSet(connData);
+  } else {
+    jsonHeader(connData, 404);
+    return HTTPD_CGI_DONE;
+  }
+}
+
+static char *portMode2string(int8_t m) { //Should we put this into flash?
+   if (m < 0 || m > 2) return "?";
+   return portMode[m];
+ }
+
+ // print various Telnet information into json buffer
+ int ICACHE_FLASH_ATTR printTelnetSecurity(char *buff) {
+   int len;
+
+   len = os_sprintf(buff,
+     "{ \"port0mode\": \"%s\", \"port0portnumber\": \"%d\", \"port0pwd\": \"%s\", "
+     "\"port1mode\": \"%s\", \"port1portnumber\": \"%d\", \"port1pwd\": \"%s\" }",
+     portMode2string(flashConfig.telnet_port0mode), flashConfig.telnet_port0, flashConfig.telnet_port0pass,
+     portMode2string(flashConfig.telnet_port1mode), flashConfig.telnet_port1, flashConfig.telnet_port1pass
+   );
+
+   return len;
+ }
+

esp-link/cgitelnet.h

@@ -0,0 +1,8 @@
+#ifndef CGITELNET_H
+#define CGITELNET_H
+
+#include "httpd.h"
+
+int cgiTelnet(HttpdConnData *connData);
+
+#endif // CGITELNET_H