Implement check sum for Serial upload as mandatory for Marlin

Add 2 new [ESPXXX] command as check sum helper
* Send GCode with check sum caching right line numbering
[ESP600]<gcode>

* Send line checksum
[ESP601]<line>

Implemented only for Sync WebServer at this moment, so Async is disabled in Travis

Author: luc-github

.travis.yml

@@ -62,12 +62,12 @@ script:
   - build_sketch  $TRAVIS_BUILD_DIR/examples/basicesp3d/basicesp3d.ino
   - arduino --board esp32:esp32:esp32 --save-prefs
   - build_sketch  $TRAVIS_BUILD_DIR/examples/basicesp3d/basicesp3d.ino
-  - sed -i "s/\/\/#define ASYNCWEBSERVER /#define ASYNCWEBSERVER/g" $HOME/arduino_ide/libraries/ESP3D/src/config.h
-  - arduino --board esp8266com:esp8266:generic --save-prefs
-  - arduino --get-pref sketchbook.path
-  - build_sketch  $TRAVIS_BUILD_DIR/examples/basicesp3d/basicesp3d.ino
-  - arduino --board esp32:esp32:esp32 --save-prefs
-  - build_sketch  $TRAVIS_BUILD_DIR/examples/basicesp3d/basicesp3d.ino
+#  - sed -i "s/\/\/#define ASYNCWEBSERVER /#define ASYNCWEBSERVER/g" $HOME/arduino_ide/libraries/ESP3D/src/config.h
+#  - arduino --board esp8266com:esp8266:generic --save-prefs
+#  - arduino --get-pref sketchbook.path
+#  - build_sketch  $TRAVIS_BUILD_DIR/examples/basicesp3d/basicesp3d.ino
+#  - arduino --board esp32:esp32:esp32 --save-prefs
+#  - build_sketch  $TRAVIS_BUILD_DIR/examples/basicesp3d/basicesp3d.ino
 
 notifications:
   email:

docs/Commands.txt

@@ -136,6 +136,12 @@ if authentication is on, need admin password for RESET, RESTART and SAFEMODE
 [ESP555]<password>pwd=<admin password>
 if no password set it use default one
 
+* Send GCode with check sum caching right line numbering
+[ESP600]<gcode>
+
+* Send line checksum
+[ESP601]<line>
+    
 * Read SPIFFS file and send each line to serial
 [ESP700]<filename>
 

src/command.cpp

@@ -49,6 +49,9 @@ String COMMAND::buffer_tcp;
 #define INCORRECT_CMD_MSG (output == WEB_PIPE)?F("Error: Incorrect Command"):F("Incorrect Cmd")
 #define OK_CMD_MSG (output == WEB_PIPE)?F("ok"):F("Cmd Ok")
 
+extern uint8_t Checksum(const char * line, uint16_t lineSize);
+extern bool sendLine2Serial (String &  line, int32_t linenb, int32_t* newlinenb);
+
 String COMMAND::get_param (String & cmd_params, const char * id, bool withspace)
 {
     static String parameter;
@@ -1403,6 +1406,47 @@ bool COMMAND::execute_command (int cmd, String cmd_params, tpipe output, level_a
         break;
     }
 #endif
+    //[ESP600]<gcode>
+    case 600: { //send GCode with check sum caching right line numbering
+        //be sure serial is locked
+        if ( (web_interface->blockserial) ) {
+            break;
+        }
+        int32_t linenb = 1;
+        cmd_params.trim() ;
+        if (sendLine2Serial (cmd_params, linenb,  &linenb))ESPCOM::println (OK_CMD_MSG, output, espresponse);
+        else { //it may failed because of skip if repetier so let's reset numbering first
+            if ( ( CONFIG::GetFirmwareTarget() == REPETIER4DV) || (CONFIG::GetFirmwareTarget() == REPETIER) ) {
+                //reset numbering
+                String cmd = "M110 N0";
+                if (sendLine2Serial (cmd, -1,  NULL)){
+                    linenb = 1;
+                    //if success let's try again to send the command
+                    if (sendLine2Serial (cmd_params, linenb,  &linenb))ESPCOM::println (OK_CMD_MSG, output, espresponse);
+                    else {
+                        ESPCOM::println (ERROR_CMD_MSG, output, espresponse);
+                        response = false;
+                    }
+                } else {
+                    ESPCOM::println (ERROR_CMD_MSG, output, espresponse);
+                    response = false;
+                }
+            } else {
+                
+                ESPCOM::println (ERROR_CMD_MSG, output, espresponse);
+                response = false;
+            }
+        }
+    }
+        break;
+    //[ESP601]<line>
+    case 601: { //send line checksum
+        cmd_params.trim();
+        int8_t chk = Checksum(cmd_params.c_str(),cmd_params.length());
+        String schecksum = "Checksum: " + String(chk);
+        ESPCOM::println (schecksum, output, espresponse);
+    }
+        break;
     //[ESP700]<filename>
     case 700: { //read local file
         //be sure serial is locked

src/config.h

@@ -19,7 +19,7 @@
 */
 
 //version and sources location
-#define FW_VERSION "2.0.0.c20"
+#define FW_VERSION "2.0.0.c21"
 #define REPOSITORY "https://github.com/luc-github/ESP3D"
 
 //Customize ESP3D ////////////////////////////////////////////////////////////////////////
@@ -71,10 +71,10 @@
 #define DIRECT_PIN_FEATURE
 
 //ESP_OLED_FEATURE: allow oled screen output
-#define ESP_OLED_FEATURE
+//#define ESP_OLED_FEATURE
 
 //DHT_FEATURE: send update of temperature / humidity based on DHT 11/22
-#define DHT_FEATURE
+//#define DHT_FEATURE
 
 //AUTHENTICATION_FEATURE: protect pages by login password
 //#define AUTHENTICATION_FEATURE
@@ -83,7 +83,7 @@
 #define WS_DATA_FEATURE
 
 //TIMESTAMP_FEATURE: Time stamp feature on direct SD  files
-#define TIMESTAMP_FEATURE
+//#define TIMESTAMP_FEATURE
 
 //Extra features /////////////////////////////////////////////////////////////////////////
 
@@ -216,7 +216,7 @@ using fs::File;
 #endif
 #ifdef DEBUG_OUTPUT_TCP
 #include "espcom.h"
-#define LOG(string) {ESPCOM::send2TCP(string, true);}
+#define LOG(string) {ESPCOM::send2TCP(string, false);}
 #define DEBUG_PIPE TCP_PIPE
 #endif
 #else

src/syncwebserver.cpp

@@ -101,9 +101,9 @@ void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t length
 
 
 extern bool  deleteRecursive(String path);
-extern void CloseSerialUpload (bool iserror, String & filename);
-extern bool sendLine2Serial (String &  line);
-
+extern void CloseSerialUpload (bool iserror, String & filename, int32_t linenb);
+extern bool sendLine2Serial (String &  line, int32_t linenb, int32_t* newlinenb);
+extern bool purge_serial();
 
 const uint8_t PAGE_404 [] PROGMEM = "<HTML>\n<HEAD>\n<title>Redirecting...</title> \n</HEAD>\n<BODY>\n<CENTER>Unknown page : $QUERY$- you will be redirected...\n<BR><BR>\nif not redirected, <a href='http://$WEB_ADDRESS$'>click here</a>\n<BR><BR>\n<PROGRESS name='prg' id='prg'></PROGRESS>\n\n<script>\nvar i = 0; \nvar x = document.getElementById(\"prg\"); \nx.max=5; \nvar interval=setInterval(function(){\ni=i+1; \nvar x = document.getElementById(\"prg\"); \nx.value=i; \nif (i>5) \n{\nclearInterval(interval);\nwindow.location.href='/';\n}\n},1000);\n</script>\n</CENTER>\n</BODY>\n</HTML>\n\n";
 const uint8_t PAGE_CAPTIVE [] PROGMEM = "<HTML>\n<HEAD>\n<title>Captive Portal</title> \n</HEAD>\n<BODY>\n<CENTER>Captive Portal page : $QUERY$- you will be redirected...\n<BR><BR>\nif not redirected, <a href='http://$WEB_ADDRESS$'>click here</a>\n<BR><BR>\n<PROGRESS name='prg' id='prg'></PROGRESS>\n\n<script>\nvar i = 0; \nvar x = document.getElementById(\"prg\"); \nx.max=5; \nvar interval=setInterval(function(){\ni=i+1; \nvar x = document.getElementById(\"prg\"); \nx.value=i; \nif (i>5) \n{\nclearInterval(interval);\nwindow.location.href='/';\n}\n},1000);\n</script>\n</CENTER>\n</BODY>\n</HTML>\n\n";
@@ -559,7 +559,6 @@ void SPIFFSFileupload()
     if(upload.status == UPLOAD_FILE_START) {
 		String upload_filename = upload.filename;
 		String  sizeargname  = upload_filename + "S";
-		if (web_interface->web_server.hasArg ("plain") ) Serial.println("Yes");
 		if (upload_filename[0] != '/') filename = "/" + upload_filename;
 		else filename = upload.filename;
         //according User or Admin the root is different as user is isolate to /user when admin has full access
@@ -1152,6 +1151,7 @@ void handle_serial_SDFileList()
 //SD file upload by serial
 void SDFile_serial_upload()
 {
+    static int32_t lineNb =-1;
     static String current_line;
     static bool is_comment = false;
     static String current_filename;
@@ -1174,93 +1174,70 @@ void SDFile_serial_upload()
     //Upload start
     //**************
     if(upload.status == UPLOAD_FILE_START) {
+        LOG("Upload Start\r\n")
+        String command = "M29";
+        String resetcmd = "M110 N0";
+        if (CONFIG::GetFirmwareTarget() == SMOOTHIEWARE)resetcmd = "N0 M110";
+        lineNb=1;
+        //close any ongoing upload and get current line number
+        if(!sendLine2Serial (command,1, &lineNb)){
+            //it can failed for repetier
+            if ( ( CONFIG::GetFirmwareTarget() == REPETIER4DV) || (CONFIG::GetFirmwareTarget() == REPETIER) ) {
+                if(!sendLine2Serial (command,-1, NULL)){
+                    LOG("Start Upload failed")
+                    web_interface->_upload_status= UPLOAD_STATUS_FAILED;
+                    return;
+                }
+            } else {
+                LOG("Start Upload failed")
+                web_interface->_upload_status= UPLOAD_STATUS_FAILED;
+                return;
+            }
+        }
+        //Reset line numbering
+        if(!sendLine2Serial (resetcmd,-1, NULL)){
+            LOG("Reset Numbering failed")
+            web_interface->_upload_status= UPLOAD_STATUS_FAILED;
+            return;
+        }
+        lineNb=1;
         //need to lock serial out to avoid garbage in file
         (web_interface->blockserial) = true;
         current_line ="";
-		is_comment = false;
-		String response;
-        web_interface->_upload_status= UPLOAD_STATUS_ONGOING;
+        current_filename = upload.filename;
+        is_comment = false;
+        String response;
         ESPCOM::println (F ("Uploading..."), PRINTER_PIPE);
+        //Clear all serial
         ESPCOM::flush (DEFAULT_PRINTER_PIPE);
-        LOG("Clear Serial\r\n");
-        if(ESPCOM::available(DEFAULT_PRINTER_PIPE)) {
-			ESPCOM::bridge();
-			CONFIG::wait(1);
-		}
-        //command to pritnter to start print
-        String command = "M28 " + upload.filename;
-        LOG(command);
-        LOG("\r\n");
-        ESPCOM::println (command, DEFAULT_PRINTER_PIPE);
-        ESPCOM::flush (DEFAULT_PRINTER_PIPE);
-        current_filename = upload.filename;
-        CONFIG::wait (500);
-        uint32_t timeout = millis();
-        bool done = false;
-        while (!done) { //time out is  2000ms
-            CONFIG::wait(0);
-            //if there is something in serial buffer
-            size_t len = ESPCOM::available(DEFAULT_PRINTER_PIPE);
-            //get size of buffer
-            if (len > 0) {
-                CONFIG::wait(0);
-                uint8_t * sbuf = (uint8_t *)malloc(len+1);
-				if(!sbuf){
-					        ESPCOM::println (F ("SD upload rejected"), PRINTER_PIPE);
-							LOG("SD upload rejected\r\n");
-							LOG("Need to stop");
-#if defined ( ARDUINO_ARCH_ESP8266)
-							web_interface->web_server.client().stopAll();
-#else 
-							web_interface->web_server.client().stop();
-#endif
-							return ;
-						}
-                //read buffer
-                ESPCOM::readBytes (DEFAULT_PRINTER_PIPE, sbuf, len);
-                //convert buffer to zero end array
-                sbuf[len] = '\0';
-                //use string because easier to handle
-                response = (const char*) sbuf;
-                LOG (response);
-                //if there is a wait it means purge is done
-                if (response.indexOf ("wait") > -1) {
-                    LOG ("Exit start writing\r\n");
-                    done = true;
-                    free(sbuf);
-                    break;
-                }
-                //it is first command if it is failed no need to continue
-                //and resend command won't help
-                if (response.indexOf ("Resend") > -1 || response.indexOf ("failed") > -1) {
-                    web_interface->blockserial = false;
-                    LOG ("Error start writing\r\n");
-                    web_interface->_upload_status = UPLOAD_STATUS_FAILED;
-#if defined ( ARDUINO_ARCH_ESP8266)
-					web_interface->web_server.client().stopAll();
-#else 
-					web_interface->web_server.client().stop();
-#endif
-					free(sbuf);
-                    return;
-                }
-             free(sbuf);
-            }
-            if ( (millis() - timeout) > SERIAL_CHECK_TIMEOUT) {
-                done = true;
-            }
+        purge_serial();
+        //besure nothing left again
+        purge_serial();
+        command = "M28 " + upload.filename;
+        //send start upload
+        //no correction allowed because it means reset numbering was failed
+        if (sendLine2Serial(command, lineNb, NULL)){
+            CONFIG::wait(1200);
+            //additional purge, in case it is slow to answer
+            purge_serial();
+            web_interface->_upload_status= UPLOAD_STATUS_ONGOING;
+            LOG("Creation Ok\r\n")
+            
+        } else  {
+            web_interface->_upload_status= UPLOAD_STATUS_FAILED;
+           LOG("Creation failed\r\n");
         }
         //Upload write
         //**************
         //upload is on going with data coming by 2K blocks
     } else if(upload.status == UPLOAD_FILE_WRITE) { //if com error no need to send more data to serial
-        web_interface->_upload_status= UPLOAD_STATUS_ONGOING;
+        if (web_interface->_upload_status == UPLOAD_STATUS_ONGOING) {
         for (int pos = 0; pos < upload.currentSize; pos++) { //parse full post data
             //feed watchdog
             CONFIG::wait(0);
             //it is a comment
             if (upload.buf[pos] == ';') {
-                LOG ("Comment\n")
+                LOG ("Comment\r\n")
                 is_comment = true;
             }
             //it is an end line
@@ -1271,10 +1248,11 @@ void SDFile_serial_upload()
                 if (current_line.length() < 126) {
                     //do we have something in buffer ?
                     if (current_line.length() > 0 ) {
-                        current_line += "\r\n";
-                        if (!sendLine2Serial (current_line) ) {
+                        lineNb++;
+                        if (!sendLine2Serial (current_line, lineNb, NULL) ) {
+                           //fup.println("[Log]Write Error");
                             LOG ("Error over buffer\n")
-                            CloseSerialUpload (true, current_filename);
+                            CloseSerialUpload (true, current_filename,lineNb);
 #if defined ( ARDUINO_ARCH_ESP8266)
 					web_interface->web_server.client().stopAll();
 #else 
@@ -1291,7 +1269,8 @@ void SDFile_serial_upload()
                 } else {
                     //error buffer overload
                     LOG ("Error over buffer\n")
-                    CloseSerialUpload (true, current_filename);
+                    lineNb++;
+                    CloseSerialUpload (true, current_filename, lineNb);
 #if defined ( ARDUINO_ARCH_ESP8266)
 					web_interface->web_server.client().stopAll();
 #else 
@@ -1304,7 +1283,8 @@ void SDFile_serial_upload()
                     current_line += char (upload.buf[pos]);  //copy current char to buffer to send/resend
                 } else {
                     LOG ("Error over buffer\n")
-                    CloseSerialUpload (true, current_filename);
+                    lineNb++;
+                    CloseSerialUpload (true, current_filename, lineNb);
 #if defined ( ARDUINO_ARCH_ESP8266)
 					web_interface->web_server.client().stopAll();
 #else 
@@ -1314,15 +1294,28 @@ void SDFile_serial_upload()
                 }
             }
         }
+        } else {
+                    LOG ("Error upload\n")
+                    web_interface->_upload_status = UPLOAD_STATUS_FAILED;
+                    lineNb++;
+                    CloseSerialUpload (true, current_filename, lineNb);
+#if defined ( ARDUINO_ARCH_ESP8266)
+					web_interface->web_server.client().stopAll();
+#else 
+					web_interface->web_server.client().stop();
+#endif
+                    return;
+        }
         //Upload end
         //**************
-    } else if(upload.status == UPLOAD_FILE_END) {
+    } else if(upload.status == UPLOAD_FILE_END && web_interface->_upload_status == UPLOAD_STATUS_ONGOING) {
         //if last part does not have '\n'
         if (current_line.length()  > 0) {
-            current_line += "\r\n";
-            if (!sendLine2Serial (current_line) ) {
+            lineNb++;
+            if (!sendLine2Serial (current_line, lineNb, NULL) ) {
                 LOG ("Error sending buffer\n")
-                CloseSerialUpload (true, current_filename);
+                lineNb++;
+                CloseSerialUpload (true, current_filename, lineNb);
 #if defined ( ARDUINO_ARCH_ESP8266)
 				web_interface->web_server.client().stopAll();
 #else 
@@ -1332,12 +1325,14 @@ void SDFile_serial_upload()
             }
         }
         LOG ("Upload finished ");
-        CloseSerialUpload (false, current_filename);
+        lineNb++;
+        CloseSerialUpload (false, current_filename, lineNb);
         //Upload cancelled
         //**************
     } else { //UPLOAD_FILE_ABORTED
         LOG("Error, Something happened\r\n");
-		CloseSerialUpload (true, current_filename);
+        lineNb++;
+		CloseSerialUpload (true, current_filename, lineNb);
 #if defined ( ARDUINO_ARCH_ESP8266)
 		web_interface->web_server.client().stopAll();
 #else