Merge branch 'develop'

@companje This would add build info, create main.js.out which was used in later concat tasks. Without this task the final code would lack the main.js code.

.gitignore

@@ -18,18 +18,11 @@ img/logo/logo_smaller.png
 img/logo/logo_smaller_8bit.png
 img/logo/logo_smaller_wide_8bit.png
 img/logo/logo_smallest.png
-css/_backup20131010/*
-css/_backup20131011/*
 d3d_btns.css
-index.html.orig
-js/Thermometer.js.orig
-js/buttonbehaviors.js.orig
-js/gcodeGenerating_v01.js.orig
-js/init_layout backup20130918.js
 js/main.js.orig
-js/previewRendering_v02.js.orig
 less/verticalshapes.css
 less/verticalshapes_backup.css
 __settings.html
 css/_settings.css
 node_modules/*
+js/main.js.out

.settings/com.eclipsesource.jshint.ui.prefs

@@ -0,0 +1,2 @@
+eclipse.preferences.version=1
+included=//*.js

Gruntfile.js

@@ -10,6 +10,32 @@ module.exports = function(grunt) {
       '<%= pkg.homepage ? "* " + pkg.homepage + "\\n" : "" %>' +
       '* Copyright (c) <%= grunt.template.today("yyyy") %> <%= pkg.author.name %>;' +
       ' Licensed <%= _.pluck(pkg.licenses, "type").join(", ") %> */\n',
+    gitinfo: {
+    	options: {},
+      commands: { 'tag': ['tag', '--points-at', 'HEAD'] }
+    },
+    template: {
+    	'add_build_info': {
+    		options: {
+    			data: function() {
+    				grunt.task.requires('gitinfo');
+    				var gi = grunt.config('gitinfo');
+    				var lbc = gi.local.branch.current;
+
+    				var tags = (gi.tag == '') ? 'no_tag' : gi.tag;
+            tags = tags.split('\n').join(',');
+    				var commitMsg = lbc.lastCommitMessage.slice(1, -1).split('\n')[0].replace(/"/g, '\\\"');
+
+    				var buildInfo = lbc.shortSHA + "/" + lbc.name + "/" + tags +
+    						" (" + lbc.lastCommitTime.slice(1, -1) + "; \'" + commitMsg + "'";
+    				return { 'build_info': buildInfo };
+    			}
+    		},
+    		files: {
+    			'js/main.js.out': ['js/main.js']
+    		}
+    	}
+    },
     concat: {
       options: {
 //         separator: ';'
@@ -22,7 +48,8 @@ module.exports = function(grunt) {
           'js/*.js',
           // make sure we put main.js last
           '!js/main.js',
-          'js/main.js',         ],
+          'js/main.js.out'
+        ],
         dest: 'www/js/<%= pkg.name %>.js'
       }
     },
@@ -129,6 +156,8 @@ module.exports = function(grunt) {
   });
 
   // These plugins provide necessary tasks.
+  grunt.loadNpmTasks('grunt-gitinfo');
+  grunt.loadNpmTasks('grunt-template');
   grunt.loadNpmTasks('grunt-contrib-less');
   grunt.loadNpmTasks('grunt-contrib-concat');
   grunt.loadNpmTasks('grunt-contrib-uglify');
@@ -139,6 +168,8 @@ module.exports = function(grunt) {
 
   // Default task.
   grunt.registerTask('default', [
+    'gitinfo',
+    'template',
     'less',
     'autoprefixer',
     'cssmin',

Makefile

@@ -34,6 +34,7 @@ endef
 
 define Build/Prepare
 	mkdir -p $(PKG_BUILD_DIR)
+	$(CP) js $(PKG_BUILD_DIR)/
 	$(CP) less $(PKG_BUILD_DIR)/
 	$(CP) www $(PKG_BUILD_DIR)/
 	$(CP) Gruntfile.js $(PKG_BUILD_DIR)/
@@ -43,12 +44,16 @@ define Build/Prepare
 endef
 
 define Build/Compile
+	# We're running grunt in the shared folder, so
+	# grunt can access git info
 	npm install
 ifeq ($(CONFIG_DOODLE3D_CLIENT_MINIFY_JS),y)
-		grunt less autoprefixer cssmin concat uglify
+	grunt gitinfo template less autoprefixer cssmin concat uglify
 else
-		grunt less autoprefixer cssmin concat
+	grunt gitinfo template less autoprefixer cssmin concat
 endif
+	# Copy compiled files to build dir
+	$(CP) www $(PKG_BUILD_DIR)/
 endef
 
 define Package/doodle3d-client/install

js/Message.js

@@ -25,7 +25,7 @@ function Message() {
     this.$element = $element;
  	}
 	this.set = function(contents,mode,autoHide,disableEffect) {
-		console.log("Message:set: ",contents,mode,autoHide,disableEffect);
+		//console.log("Message:set: ",contents,mode,autoHide,disableEffect);
 		if(disableEffect) {
 			self.fill(contents,mode,autoHide)
 		} else{

js/Printer.js

@@ -19,6 +19,7 @@ function setPrintprogress(val) {
 //*/
 
 function Printer() {
+  /* CONSTANTS */
 
 	Printer.WIFIBOX_DISCONNECTED_STATE	= "wifibox disconnected";
 	Printer.UNKNOWN_STATE				= "unknown";				// happens when a printer is connection but there isn't communication yet
@@ -32,11 +33,29 @@ function Printer() {
 
 	Printer.ON_BEFORE_UNLOAD_MESSAGE = "You're doodle is still being sent to the printer, leaving will result in a incomplete 3D print";
 
+  //after buffer full message has been received, wait until the buffer load is below this ratio before sending new data
+  Printer.GCODE_BUFFER_WAIT_LOAD_RATIO = 0.75;
+  Printer.BUFFER_SPACE_WAIT_TIMEOUT = 30000; // how often to recheck buffer load
+  
+  //time to wait when wifibox connection is lost while printing
+  Printer.DISCONNECTED_RETRY_DELAY = 5000;
+  
+  Printer.MAX_LINES_PER_POST = 500; // max amount of gcode lines per post (limited because WiFi box can't handle too much)
+  Printer.MAX_GCODE_SIZE = 10; // max size of gcode in MB's (estimation)
+
+  // Events
+  Printer.UPDATE = "update";
+
+  
+  /* MEMBER VARIABLES */
+
 	this.temperature 		= 0;
 	this.targetTemperature 	= 0;
 	this.currentLine 		= 0;
 	this.totalLines			= 0;
 	this.bufferedLines		= 0;
+	this.bufferSize = 0;
+	this.maxBufferSize = 0;
 	this.state				= Printer.UNKNOWN_STATE;
 	this.hasControl			= true;	// whether this client has control access
 
@@ -47,8 +66,8 @@ function Printer() {
 	this.timeoutTime = 3000;
 	this.sendPrintPartTimeoutTime = 5000;
 
-	this.gcode; 							// gcode to be printed
-	this.sendLength = 500; 					// max amount of gcode lines per post (limited because WiFi box can't handle too much)
+	this.gcode = []; // gcode to be printed
+	this.gcodeNumChunks = 0; //number of chunks to be sent (used for sequence numbering)
 
 	this.retryDelay = 2000; 				// retry setTimout delay
 	this.retrySendPrintPartDelay; 			// retry setTimout instance
@@ -56,12 +75,10 @@ function Printer() {
 	this.retryStopDelay;					// retry setTimout instance
 	this.retryPreheatDelay;					// retry setTimout instance
 
-	Printer.MAX_GCODE_SIZE = 10;			// max size of gcode in MB's (estimation)
-
 	this.stateOverruled = false;
 
-	// Events
-	Printer.UPDATE = "update";
+	
+	/* FUNCTIONS */
 
 	var self = this;
 
@@ -120,6 +137,7 @@ function Printer() {
 
 		this.sendIndex = 0;
 		this.gcode = gcode;
+		this.gcodeNumChunks = Math.ceil(this.gcode.length / Printer.MAX_LINES_PER_POST);
 
 		//console.log("  gcode[20]: ",gcode[20]);
 		var gcodeLineSize = this.byteSize(gcode[20]);
@@ -142,7 +160,7 @@ function Printer() {
 
 		//this.targetTemperature = settings["printer.temperature"]; // slight hack
 
-		this.sendPrintPart(this.sendIndex, this.sendLength);
+		this.sendPrintPart(this.sendIndex, Printer.MAX_LINES_PER_POST);
 	}
 
 	this.byteSize = function(s){
@@ -150,26 +168,43 @@ function Printer() {
 	}
 
 	this.sendPrintPart = function(sendIndex,sendLength) {
-		console.log("Printer:sendPrintPart sendIndex: " + sendIndex + "/" + this.gcode.length + ", sendLength: " + sendLength);
-
-
-		var sendPercentage = Math.round(sendIndex/this.gcode.length*100);
-		message.set("Sending doodle to printer: "+sendPercentage+"%",Message.NOTICE,false,true);
-
-		var firstOne = (sendIndex == 0)? true : false;
-		var start = firstOne; // start printing right away
+		var self = this;
+		// Abort if stopping
+		// sendPrintPart can be called by delayed retry after request timeout for example
+		if (self.state === Printer.STOPPING_STATE) return;
 
 		var completed = false;
 		if (this.gcode.length < (sendIndex + sendLength)) {
-			console.log("  sending less than max sendLength (and last)");
 			sendLength = this.gcode.length - sendIndex;
-			//lastOne = true;
 			completed = true;
 		}
-		var gcodePart = this.gcode.slice(sendIndex, sendIndex+sendLength);
 
-		var postData = { gcode: gcodePart.join("\n"), first: firstOne, start: start};
-		var self = this;
+
+		/* prepare post data */
+
+		var gcodePart = this.gcode.slice(sendIndex, sendIndex + sendLength);
+		var firstOne = (sendIndex == 0) ? true : false;
+		var start = firstOne; // start printing right away
+		var seqNum = Math.floor(sendIndex / Printer.MAX_LINES_PER_POST);
+		var postData = {
+				gcode: gcodePart.join("\n"), total_lines: this.gcode.length,
+				clear: firstOne, start: start,
+				seq_number: seqNum, seq_total: this.gcodeNumChunks
+		};
+
+		
+		/* inform user what's going on */
+
+		var lessThanMaxText = completed ? " (last one, max=" + Printer.MAX_LINES_PER_POST + ")" : "";
+		console.log("Printer:sendPrintPart: sendIndex=" + sendIndex + "/" + this.gcode.length +
+				", sendLength=" + sendLength + lessThanMaxText +
+				", sequence numbers: " + seqNum + "/" + this.gcodeNumChunks);
+
+		var sendPercentage = Math.round(sendIndex / this.gcode.length * 100);
+		message.set("Sending doodle to printer: " + sendPercentage + "%", Message.NOTICE, false, true);
+
+		
+		/* send data */
 		if (communicateWithWifibox) {
 			$.ajax({
 				url: this.wifiboxURL + "/printer/print",
@@ -178,13 +213,13 @@ function Printer() {
 				dataType: 'json',
 				timeout: this.sendPrintPartTimeoutTime,
 				success: function(data){
-					console.log("Printer:sendPrintPart response: ",data);
+					//console.log("Printer:sendPrintPart success response: ", data);
 
 					if(data.status == "success") {
 						if (completed) {
-							console.log("Printer:sendPrintPart:gcode sending completed");
+							console.log("Printer:sendPrintPart: gcode sending completed");
 							this.gcode = [];
-							btnStop.css("display","block"); // hack
+							this.gcodeNumChunks = 0;
 							self.removeLeaveWarning();
 							message.set("Doodle has been sent to printer...",Message.INFO,true);
 							//self.targetTemperature = settings["printer.temperature"]; // slight hack
@@ -195,23 +230,48 @@ function Printer() {
 							if(self.state == Printer.PRINTING_STATE || self.state == Printer.BUFFERING_STATE) {
 								//console.log("Printer:sendPrintPart:sending next part");
 								self.sendPrintPart(sendIndex + sendLength, sendLength);
+							} else if (Printer.WIFIBOX_DISCONNECTED_STATE) {
+								console.warn("Printer:sendPrintPart: wifibox connection lost while printing, retrying in " + (Printer.DISCONNECTED_RETRY_DELAY / 1000) + " seconds");
+								clearTimeout(self.retrySendPrintPartDelay);
+								self.retrySendPrintPartDelay = setTimeout(function() {
+									console.log("Printer:sendPrintPart: retrying after wifibox disconnect was detected");
+									self.sendPrintPart(sendIndex, sendLength);
+								}, Printer.DISCONNECTED_RETRY_DELAY);
 							}
 						}
+					} else if (data.status == "fail") {
+					  if (data.data.status == "buffer_full") {
+					  	console.log("Printer:sendPrintPart: print server reported buffer full, pausing data transmission");
+					    //this will wait in a setTimeout loop until enough room is available and then call sendPrintPart again.
+					    self.waitForBufferSpace(sendIndex, sendLength);
+					  } else if (data.data.status == "seq_num_mismatch" && data.data.seq_number == seqNum) {
+				  		console.warn("Printer:sendPrintPart: received sequence error, server is one chunk ahead. Proceeding with next chunk...");
+				  		self.sendPrintPart(sendIndex + sendLength, sendLength);
+					  } else {
+					    console.error("Printer:sendPrintPart: unexpected failure response for API endpoint printer/print (" +
+					    		data.data.status + ", current server seq. info: " + data.data.seq_number + "/" + data.data.seq_total + ")");
+					    //sequence errors should not occur, except perhaps when 'stop' was clicked while still sending (https://github.com/Doodle3D/doodle3d-client/issues/226).
+					    if (self.state != Printer.STOPPING_STATE) {
+					    	message.set("Unexpected error sending doodle to printer (" + data.data.status + "), please retry", Message.ERROR, false, true);
+					    }
+					  }
 					}
-					// after we know the first gcode packed has bin received or failed
+
+					// after we know the first gcode part has been received or failed
 					// (and the driver had time to update the printer.state)
 					// we start checking the status again
 					if(sendIndex == 0) {
 						self.startStatusCheckInterval();
 					}
 				}
-			}).fail(function() {
-				console.log("Printer:sendPrintPart: failed");
+			}).fail(function(jqXHr, textStatus, errorThrown) {
+				console.error("Printer:sendPrintPart: failed (AJAX status: '" + textStatus + "') AJAX exception (if any):", errorThrown);
+				console.warn("Printer:sendPrintPart: retrying in " + (Printer.DISCONNECTED_RETRY_DELAY / 1000) + " seconds");
 				clearTimeout(self.retrySendPrintPartDelay);
 				self.retrySendPrintPartDelay = setTimeout(function() {
-					console.log("request printer:sendPrintPart failed retry");
+					console.log("Printer:sendPrintPart: retrying after AJAX failure");
 					self.sendPrintPart(sendIndex, sendLength)
-				},self.retryDelay); // retry after delay
+				}, Printer.DISCONNECTED_RETRY_DELAY);
 
 				// after we know the gcode packed has bin received or failed
 				// (and the driver had time to update the printer.state)
@@ -222,13 +282,47 @@ function Printer() {
 			console.log ("Printer >> f:sendPrintPart() >> communicateWithWifibox is false, so not executing this function");
 		}
 	}
+	
+	/*
+	 * Called by sendPrintPart when a buffer_full fail response is received.
+	 * This function keeps calling itself until the GCodeBuffer's load ratio
+	 * drops below a predefined value and then calls sendPrintPart again.
+	 */
+	this.waitForBufferSpace = function(sendIndex,sendLength) {
+    var fillRatio = this.bufferSize / this.maxBufferSize;
+    var self = this;
+
+    //console.log("buffer fill state: " + self.bufferSize + "/" + self.maxBufferSize + " (" + fillPercent + "%)");
+
+    if (fillRatio >= Printer.GCODE_BUFFER_WAIT_LOAD_RATIO) {
+      var fillPercent = (fillRatio * 100).toFixed(2);
+      console.log("Printer:waitForBufferSpace: waiting until gcode buffer load ratio is below " +
+          (Printer.GCODE_BUFFER_WAIT_LOAD_RATIO * 100) + "% (current: " + fillPercent + "% of " +
+          (self.maxBufferSize / 1024) + "KiB)");
+      self.waitForBufferSpaceDelay = setTimeout(function() { self.waitForBufferSpace(sendIndex, sendLength); }, Printer.BUFFER_SPACE_WAIT_TIMEOUT);
+    } else {
+      if(self.state == Printer.PRINTING_STATE || self.state == Printer.BUFFERING_STATE) {
+        console.log("Printer:waitForBufferSpace: load ratio dropped below " + (Printer.GCODE_BUFFER_WAIT_LOAD_RATIO * 100) + "%, calling sendPrintPart...");
+        self.sendPrintPart(sendIndex, sendLength);
+      } else {
+        console.log("Printer:waitForBufferSpace: load ratio dropped far enough but printer state is not printing or buffering anymore, not resuming.");
+      }
+    }
+	}
 
 	this.stop = function() {
 		console.log("Printer:stop");
+		var self = this;
+		if (self.retrySendPrintPartDelay !== undefined) {
+			clearTimeout(self.retrySendPrintPartDelay);
+		}
+		if (self.waitForBufferSpaceDelay !== undefined) {
+			clearTimeout(self.waitForBufferSpaceDelay);
+		}
+
 		endCode = generateEndCode();
 		console.log("  endCode: ",endCode);
 		var postData = { gcode: endCode.join("\n")};
-		var self = this;
 		if (communicateWithWifibox) {
 			$.ajax({
 				url: this.wifiboxURL + "/printer/stop",
@@ -325,7 +419,9 @@ function Printer() {
 			// progress
 			self.currentLine = data.current_line;
 			self.totalLines = data.total_lines;
-			self.bufferedLines = data.buffered_lines
+			self.bufferedLines = data.buffered_lines;
+			self.bufferSize = data.buffer_size;
+			self.maxBufferSize = data.max_buffer_size;
 
 			// access
 			self.hasControl = data.has_control;

js/buttonbehaviors.js

@@ -232,8 +232,6 @@ function print(e) {
 		//setState(Printer.BUFFERING_STATE,printer.hasControl);
 		printer.overruleState(Printer.BUFFERING_STATE);
 
-		btnStop.css("display","none"); // hack
-
 		// we put the gcode generation in a little delay
 		// so that for example the print button is disabled right away
 		clearTimeout(gcodeGenerateDelayer);
@@ -358,7 +356,7 @@ function setState(newState,newHasControl) {
 
 	prevState = state;
 
-	console.log("setState: ",prevState," > ",newState," ( ",newHasControl,")");
+	console.log("setState: " + prevState + " > " + newState + " ( " + newHasControl + ")");
 	setDebugText("State: "+newState);
 
 	// print button

js/main.js

@@ -34,7 +34,8 @@ var POPUP_SHOW_DURATION = 175;
 var BUTTON_GROUP_SHOW_DURATION = 80;
 
 $(function() {
-  console.log("ready");
+  console.log("Doodle3D client ready");
+  console.log("Build information - <%= build_info %>)");
   
   if (getURLParameter("d") != "null") debugMode = (getURLParameter("d") == "1");
   if (getURLParameter("p") != "null") sendPrintCommands = (getURLParameter("p") == "1");

js/settings/UpdatePanel.js

@@ -204,7 +204,7 @@ function UpdatePanel() {
 	this.setState = function(newState,refresh) {
 		//console.log("UpdatePanel:setState");
 		if(!refresh && this.state == newState) return;
-		console.log("UpdatePanel:setState: ",this.state," > ",newState,"(",this.stateText,") (in Access Point Mode: ",_inAccessPointMode,") (newestVersion: ",self.newestVersion,") (refresh: ",refresh,")");
+		console.log("UpdatePanel:setState: " + this.state + " > " + newState + "(" + this.stateText + ") (in Access Point Mode: " + _inAccessPointMode + ") (newestVersion: " + self.newestVersion + ") (refresh: " + refresh + ")");
 		this.state = newState;
 
 		// should personal sketches and settings be retained over update?

js/sketches.js

@@ -41,7 +41,7 @@ function setSketchModified(_isModified) {
 }
 
 function updateSketchButtonStates() {
-	console.log('sketch: isModified',isModified,'curSketch',curSketch,'sketches.length',sketches.length);
+	console.log('sketch: isModified: ' + isModified + ', curSketch: ' + curSketch + ', sketches.length: ' + sketches.length);
 
 	if (isModified) {
 		btnSave.enable();
@@ -72,7 +72,7 @@ function loadSketch(_curSketch) {
 
 	var id = sketches[curSketch];
 
-	console.log('sketch: loadSketch curSketch',curSketch,'id',id);
+	console.log('sketch: loadSketch curSketch:' + curSketch + ', id: ' + id);
 
 	$.get(wifiboxURL + "/sketch", {id:id}, function(response) {
 		if (response.status=='success') {

license-spec.lua

@@ -1,8 +1,10 @@
 local M = {
-	BASE_PATH = 'js_src',
+	BASE_PATH = 'js',
 	EXCLUDE_FILES = {},
 	PROCESS_FILES = {
-		['js_src/[^/]*%.js'] = 'cstyle'
+		['js/[^/]*%.js'] = 'cstyle',
+		['js/api/[^/]*%.js'] = 'cstyle',
+		['js/settings/[^/]*%.js'] = 'cstyle'
 	},
 	IGNORE_GIT_CHANGED = false
 }

package.json

@@ -9,7 +9,7 @@
   "author": "Peter Uithoven, Adriaan Wormgoor, Rick Companje, Wouter Reckman",
   "readmeFilename": "README.md",
   "devDependencies": {
-    "grunt": "~0.4.1",
+    "grunt": "~0.4.5",
     "grunt-cli": "~0.1.9",
     "grunt-contrib-less": "~0.7.0",
     "grunt-contrib-watch": "~0.5.3",
@@ -17,6 +17,11 @@
     "grunt-contrib-jshint": "~0.6.4",
     "grunt-autoprefixer": "~0.4.0",
     "grunt-contrib-cssmin": "~0.6.2",
-    "grunt-contrib-concat": "~0.3.0"
+    "grunt-contrib-concat": "~0.3.0",
+    "grunt-gitinfo": "~0.1.7",
+    "grunt-template": "~0.2.3"
+  },
+  "scripts": {
+    "start": "grunt"
   }
 }