From e8a22010305f11bbf2b89605ce03eb7b260450fb Mon Sep 17 00:00:00 2001
From: bdring <barton.dring@gmail.com>
Date: Sun, 27 Oct 2019 15:07:25 -0500
Subject: [PATCH] Added gcode comment message handling to SD card reader and
 cleanup

- Gcode comment messages on SD cards will now print on all interfaces.
- Moved cpu map for Atarti 1020 to its header file as a test of way to reduce cpu_map.h a bit.
---
 Grbl_Esp32/atari_1020.h | 110 ++++++++++++++++++++++++++++++++++++++++
 Grbl_Esp32/cpu_map.h    | 110 +---------------------------------------
 Grbl_Esp32/grbl_sd.cpp  |  14 +++--
 3 files changed, 122 insertions(+), 112 deletions(-)

diff --git a/Grbl_Esp32/atari_1020.h b/Grbl_Esp32/atari_1020.h
index b0dcf80b..94c0af96 100644
--- a/Grbl_Esp32/atari_1020.h
+++ b/Grbl_Esp32/atari_1020.h
@@ -22,6 +22,116 @@
 	Atari 1010 Pen Plotter
 */
 
+#define CPU_MAP_NAME "CPU_MAP_ATARI_1020"			
+	
+// ================== CPU MAP ====================== 	
+	#define USE_UNIPOLAR
+
+	#define X_UNIPOLAR	
+	#define X_PIN_PHASE_0	GPIO_NUM_13
+	#define X_PIN_PHASE_1	GPIO_NUM_21
+	#define X_PIN_PHASE_2	GPIO_NUM_16
+	#define X_PIN_PHASE_3	GPIO_NUM_22		
+	
+	#define Y_UNIPOLAR
+	#define Y_PIN_PHASE_0	GPIO_NUM_25
+	#define Y_PIN_PHASE_1	GPIO_NUM_27
+	#define Y_PIN_PHASE_2	GPIO_NUM_26
+	#define Y_PIN_PHASE_3	GPIO_NUM_32
+	
+		
+	#define SOLENOID_DIRECTION_PIN GPIO_NUM_4
+	#define SOLENOID_PEN_PIN GPIO_NUM_2
+	#define SOLENOID_CHANNEL_NUM 6	
+			
+	#ifdef HOMING_CYCLE_0
+		#undef HOMING_CYCLE_0		
+	#endif
+	#define HOMING_CYCLE_0 (1<<X_AXIS) // this 'bot only homes the X axis
+	#ifdef HOMING_CYCLE_1
+		#undef HOMING_CYCLE_1
+	#endif
+	#ifdef HOMING_CYCLE_2
+		#undef HOMING_CYCLE_2
+	#endif			
+		
+	#define REED_SW_PIN      	GPIO_NUM_17	
+	#define LIMIT_MASK      	0
+	
+	
+	#ifdef IGNORE_CONTROL_PINS // maybe set in config.h
+		#undef IGNORE_CONTROL_PINS
+	#endif
+	
+	
+	#ifndef ENABLE_CONTROL_SW_DEBOUNCE
+		#define ENABLE_CONTROL_SW_DEBOUNCE
+	#endif
+	
+	#ifdef INVERT_CONTROL_PIN_MASK
+		#undef IGNORE_CONTROL_PINS
+	#endif
+	#define INVERT_CONTROL_PIN_MASK   B01110000
+	
+	#define MACRO_BUTTON_0_PIN		GPIO_NUM_34  // Pen Switch
+	#define MACRO_BUTTON_1_PIN		GPIO_NUM_35	 // Color Switch
+	#define MACRO_BUTTON_2_PIN		GPIO_NUM_36  // Paper Switch
+	
+	#ifdef DEFAULTS_GENERIC
+		#undef DEFAULTS_GENERIC  // undefine generic then define each default below
+	#endif
+	#define DEFAULT_STEP_PULSE_MICROSECONDS 3 
+	#define DEFAULT_STEPPER_IDLE_LOCK_TIME 200 // 200ms
+	
+	#define DEFAULT_STEPPING_INVERT_MASK 0 // uint8_t
+	#define DEFAULT_DIRECTION_INVERT_MASK 0 // uint8_t
+	#define DEFAULT_INVERT_ST_ENABLE 0 // boolean
+	#define DEFAULT_INVERT_LIMIT_PINS 1 // boolean
+	#define DEFAULT_INVERT_PROBE_PIN 0 // boolean 
+	
+	#define DEFAULT_STATUS_REPORT_MASK 1
+	
+	#define DEFAULT_JUNCTION_DEVIATION 0.01 // mm
+	#define DEFAULT_ARC_TOLERANCE 0.002 // mm
+	#define DEFAULT_REPORT_INCHES 0 // false
+	
+	#define DEFAULT_SOFT_LIMIT_ENABLE 0 // false
+	#define DEFAULT_HARD_LIMIT_ENABLE 0  // false
+	
+	#define DEFAULT_HOMING_ENABLE 1
+	#define DEFAULT_HOMING_DIR_MASK 0 
+	#define DEFAULT_HOMING_FEED_RATE 3000.0 // mm/min
+	#define DEFAULT_HOMING_SEEK_RATE 3000.0 // mm/min
+	#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
+	#define DEFAULT_HOMING_PULLOFF 2.0 // mm
+
+	#define DEFAULT_SPINDLE_RPM_MAX 1000.0 // rpm
+	#define DEFAULT_SPINDLE_RPM_MIN 0.0 // rpm
+	
+	#define DEFAULT_LASER_MODE 0 // false
+	
+	#define DEFAULT_X_STEPS_PER_MM 10
+	#define DEFAULT_Y_STEPS_PER_MM 10
+	#define DEFAULT_Z_STEPS_PER_MM 100.0 // This is percent in servo mode
+	
+	
+	#define DEFAULT_X_MAX_RATE 5000.0 // mm/min
+	#define DEFAULT_Y_MAX_RATE 5000.0 // mm/min
+	#define DEFAULT_Z_MAX_RATE 200000.0 // mm/min
+	
+	#define DEFAULT_X_ACCELERATION (500.0*60*60) // 10*60*60 mm/min^2 = 10 mm/sec^2
+	#define DEFAULT_Y_ACCELERATION (500.0*60*60) // 10*60*60 mm/min^2 = 10 mm/sec^2
+	#define DEFAULT_Z_ACCELERATION (500.0*60*60) 
+	
+	#define DEFAULT_X_MAX_TRAVEL 120.0 // mm NOTE: Must be a positive value.
+	#define DEFAULT_Y_MAX_TRAVEL 20000.0 // mm NOTE: Must be a positive value.
+	#define DEFAULT_Z_MAX_TRAVEL 10.0 // This is percent in servo mode
+	
+// ================== CPU MAP ======================	
+
+#define ATARI_1020
+
+
 #define SOLENOID_PWM_FREQ 5000
 #define SOLENOID_PWM_RES_BITS 8
 
diff --git a/Grbl_Esp32/cpu_map.h b/Grbl_Esp32/cpu_map.h
index c482e4f3..db5c6c50 100644
--- a/Grbl_Esp32/cpu_map.h
+++ b/Grbl_Esp32/cpu_map.h
@@ -1341,115 +1341,7 @@
 #endif
 
 #ifdef CPU_MAP_ATARI_1020
-
-	#include "atari_1020.h"
-	
-	#define CPU_MAP_NAME "CPU_MAP_ATARI_1020"			
-	
-	#define ATARI_1020
-
-	#define USE_UNIPOLAR
-
-	#define X_UNIPOLAR	
-	#define X_PIN_PHASE_0	GPIO_NUM_13
-	#define X_PIN_PHASE_1	GPIO_NUM_21
-	#define X_PIN_PHASE_2	GPIO_NUM_16
-	#define X_PIN_PHASE_3	GPIO_NUM_22		
-	
-	#define Y_UNIPOLAR
-	#define Y_PIN_PHASE_0	GPIO_NUM_25
-	#define Y_PIN_PHASE_1	GPIO_NUM_27
-	#define Y_PIN_PHASE_2	GPIO_NUM_26
-	#define Y_PIN_PHASE_3	GPIO_NUM_32
-	
-		
-	#define SOLENOID_DIRECTION_PIN GPIO_NUM_4
-	#define SOLENOID_PEN_PIN GPIO_NUM_2
-	#define SOLENOID_CHANNEL_NUM 6	
-			
-	#ifdef HOMING_CYCLE_0
-		#undef HOMING_CYCLE_0		
-	#endif
-	#define HOMING_CYCLE_0 (1<<X_AXIS) // this 'bot only homes the X axis
-	#ifdef HOMING_CYCLE_1
-		#undef HOMING_CYCLE_1
-	#endif
-	#ifdef HOMING_CYCLE_2
-		#undef HOMING_CYCLE_2
-	#endif			
-		
-	#define REED_SW_PIN      	GPIO_NUM_17	
-	#define LIMIT_MASK      	0
-	
-	
-	#ifdef IGNORE_CONTROL_PINS // maybe set in config.h
-		#undef IGNORE_CONTROL_PINS
-	#endif
-	
-	
-	#ifndef ENABLE_CONTROL_SW_DEBOUNCE
-		#define ENABLE_CONTROL_SW_DEBOUNCE
-	#endif
-	
-	#ifdef INVERT_CONTROL_PIN_MASK
-		#undef IGNORE_CONTROL_PINS
-	#endif
-	#define INVERT_CONTROL_PIN_MASK   B01110000
-	
-	#define MACRO_BUTTON_0_PIN		GPIO_NUM_34  // Pen Switch
-	#define MACRO_BUTTON_1_PIN		GPIO_NUM_35	 // Color Switch
-	#define MACRO_BUTTON_2_PIN		GPIO_NUM_36  // Paper Switch
-	
-	#ifdef DEFAULTS_GENERIC
-		#undef DEFAULTS_GENERIC  // undefine generic then define each default below
-	#endif
-	#define DEFAULT_STEP_PULSE_MICROSECONDS 3 
-	#define DEFAULT_STEPPER_IDLE_LOCK_TIME 200 // 200ms
-	
-	#define DEFAULT_STEPPING_INVERT_MASK 0 // uint8_t
-	#define DEFAULT_DIRECTION_INVERT_MASK 0 // uint8_t
-	#define DEFAULT_INVERT_ST_ENABLE 0 // boolean
-	#define DEFAULT_INVERT_LIMIT_PINS 1 // boolean
-	#define DEFAULT_INVERT_PROBE_PIN 0 // boolean 
-	
-	#define DEFAULT_STATUS_REPORT_MASK 1
-	
-	#define DEFAULT_JUNCTION_DEVIATION 0.01 // mm
-	#define DEFAULT_ARC_TOLERANCE 0.002 // mm
-	#define DEFAULT_REPORT_INCHES 0 // false
-	
-	#define DEFAULT_SOFT_LIMIT_ENABLE 0 // false
-	#define DEFAULT_HARD_LIMIT_ENABLE 0  // false
-	
-	#define DEFAULT_HOMING_ENABLE 1
-	#define DEFAULT_HOMING_DIR_MASK 0 
-	#define DEFAULT_HOMING_FEED_RATE 3000.0 // mm/min
-	#define DEFAULT_HOMING_SEEK_RATE 3000.0 // mm/min
-	#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
-	#define DEFAULT_HOMING_PULLOFF 2.0 // mm
-
-	#define DEFAULT_SPINDLE_RPM_MAX 1000.0 // rpm
-	#define DEFAULT_SPINDLE_RPM_MIN 0.0 // rpm
-	
-	#define DEFAULT_LASER_MODE 0 // false
-	
-	#define DEFAULT_X_STEPS_PER_MM 10
-	#define DEFAULT_Y_STEPS_PER_MM 10
-	#define DEFAULT_Z_STEPS_PER_MM 100.0 // This is percent in servo mode
-	
-	
-	#define DEFAULT_X_MAX_RATE 5000.0 // mm/min
-	#define DEFAULT_Y_MAX_RATE 5000.0 // mm/min
-	#define DEFAULT_Z_MAX_RATE 200000.0 // mm/min
-	
-	#define DEFAULT_X_ACCELERATION (500.0*60*60) // 10*60*60 mm/min^2 = 10 mm/sec^2
-	#define DEFAULT_Y_ACCELERATION (500.0*60*60) // 10*60*60 mm/min^2 = 10 mm/sec^2
-	#define DEFAULT_Z_ACCELERATION (500.0*60*60) 
-	
-	#define DEFAULT_X_MAX_TRAVEL 120.0 // mm NOTE: Must be a positive value.
-	#define DEFAULT_Y_MAX_TRAVEL 20000.0 // mm NOTE: Must be a positive value.
-	#define DEFAULT_Z_MAX_TRAVEL 10.0 // This is percent in servo mode
-	
+	#include "atari_1020.h"	
 #endif
 
 	// ================= common to all machines ================================
diff --git a/Grbl_Esp32/grbl_sd.cpp b/Grbl_Esp32/grbl_sd.cpp
index a843dc1b..85b20221 100644
--- a/Grbl_Esp32/grbl_sd.cpp
+++ b/Grbl_Esp32/grbl_sd.cpp
@@ -29,6 +29,7 @@ File myFile;
 bool SD_ready_next = false; // Grbl has processed a line and is waiting for another
 uint8_t SD_client = CLIENT_SERIAL;
 uint32_t sd_current_line_number; // stores the most recent line number read from the SD
+static char comment[LINE_BUFFER_SIZE]; // Line to be executed. Zero-terminated.
 
 // attempt to mount the SD card
 /*bool sd_mount()
@@ -107,6 +108,7 @@ boolean readFileLine(char *line)
   char c;
   uint8_t index = 0;
   uint8_t line_flags = 0;
+  uint8_t comment_char_counter = 0;
 
   if (!myFile) {
     report_status_message(STATUS_SD_FAILED_READ, SD_client);
@@ -118,15 +120,21 @@ boolean readFileLine(char *line)
   while(myFile.available()) {
     c = myFile.read();
 		
+	if (line_flags & LINE_FLAG_COMMENT_PARENTHESES) {  // capture all characters into a comment buffer
+		comment[comment_char_counter++] = c;
+	}
+	
     if (c == '\r' || c == ' ' ) {
       // ignore these whitespace items
     } else if (c == '(') {
       line_flags |= LINE_FLAG_COMMENT_PARENTHESES;
     } else if (c == ')') {
       // End of '()' comment. Resume line allowed.
-      if (line_flags & LINE_FLAG_COMMENT_PARENTHESES) {
-        line_flags &= ~(LINE_FLAG_COMMENT_PARENTHESES);
-      }
+	  if (line_flags & LINE_FLAG_COMMENT_PARENTHESES) { 
+			line_flags &= ~(LINE_FLAG_COMMENT_PARENTHESES); 
+			comment[comment_char_counter] = 0; // null terminate								
+			report_gcode_comment(comment);								
+		}
     } else if (c == ';') {
       // NOTE: ';' comment to EOL is a LinuxCNC definition. Not NIST.
       if (!(line_flags & LINE_FLAG_COMMENT_PARENTHESES)) { // semi colon inside parentheses do not mean anything