doodle3d-client/js/Printer.js

/*
 * This file is part of the Doodle3D project (http://doodle3d.com).
 *
 * Copyright (c) 2013, Doodle3D
 * This software is licensed under the terms of the GNU GPL v2 or later.
 * See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details.
 */

/* not using this now
var $printProgressContainer = $("#printProgressContainer");
var $progressbar = $("#progressbar");
var $progressAmount = $(".progressAmount");
function setPrintprogress(val) {
	if (isNaN(val)) return;
//	console.log("f:setPrintprogress() >> val " + val);
	$progressbar.css("width", val*100 + "%");
	$progressAmount.text(Math.floor(val*100) + "%");
}
//*/

function Printer() {
	var className = 'Printer';

	Printer.WIFIBOX_DISCONNECTED_STATE	= "wifibox disconnected";
	Printer.UNKNOWN_STATE				= "unknown";				// happens when a printer is connection but there isn't communication yet
	Printer.DISCONNECTED_STATE			= "disconnected";			// printer disconnected
	Printer.CONNECTING_STATE 			= "connecting";				// printer connecting (printer found, but driver has not yet finished setting up the connection)
	Printer.IDLE_STATE 					= "idle"; 					// printer found and ready to use, but idle
	Printer.BUFFERING_STATE				= "buffering";				// printer is buffering (recieving) data, but not yet printing
	Printer.PRINTING_STATE				= "printing";
	Printer.STOPPING_STATE				= "stopping";				// when you stop (abort) a print it prints the endcode
	Printer.TOUR_STATE					= "tour";					// when in joyride mode

	Printer.ON_BEFORE_UNLOAD_MESSAGE = "You're doodle is still being sent to the printer, leaving will result in a incomplete 3D print";

	this.temperature 		= 0;
	this.targetTemperature 	= 0;
	this.currentLine 		= 0;
	this.totalLines			= 0;
	this.bufferedLines		= 0;
	this.state				= Printer.UNKNOWN_STATE;
	this.hasControl			= true;	// whether this client has control access

	this.wifiboxURL;

	this.checkStatusInterval = 3000;
	this.checkStatusDelay;
	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.retryDelay = 2000; 				// retry setTimout delay
	this.retrySendPrintPartDelay; 			// retry setTimout instance
	this.retryCheckStatusDelay; 			// retry setTimout instance
	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";

	var self = this;

	this.init = function() {
		//console.log("Printer:init");
		//this.wifiboxURL = "http://" + window.location.host + "/cgi-bin/d3dapi";
		//this.wifiboxURL = "http://192.168.5.1/cgi-bin/d3dapi";
		this.wifiboxURL = wifiboxURL;
		//this.wifiboxURL = "proxy5.php";
		//console.log("  wifiboxURL: ",this.wifiboxURL);

		if (autoUpdate) {
			this.startStatusCheckInterval();
		}
	}

	this.preheat = function() {
		console.log("Printer:preheat");

		if (this.state != Printer.IDLE_STATE) return;

		var self = this;
		if (communicateWithWifibox) {
			$.ajax({
				url: this.wifiboxURL + "/printer/heatup",
				type: "POST",
				dataType: 'json',
				timeout: this.timeoutTime,
				success: function(data){
					console.log("Printer:preheat response: ",data);
					if(data.status != "success") {
						clearTimeout(self.retryPreheatDelay);
						self.retryPreheatDelay = setTimeout(function() { self.preheat() },self.retryDelay); // retry after delay
					}
				}
			}).fail(function() {
				console.log("Printer:preheat: failed");
				clearTimeout(self.retryPreheatDelay);
				self.retryPreheatDelay = setTimeout(function() { self.preheat() },self.retryDelay); // retry after delay
			});
		} else {
			console.log ("Printer >> f:preheat() >> communicateWithWifibox is false, so not executing this function");
		}
	}

	this.print = function(gcode) {
		console.log("Printer:print");
		console.log("  gcode total # of lines: " + gcode.length);

		message.set("Sending doodle to printer...",Message.NOTICE);
		self.addLeaveWarning();

		/*for (i = 0; i < gcode.length; i++) {
			gcode[i] += " (" + i + ")";
		}*/

		this.sendIndex = 0;
		this.gcode = gcode;

		//console.log("  gcode[20]: ",gcode[20]);
		var gcodeLineSize = this.byteSize(gcode[20]);
		//console.log("  gcodeLineSize: ",gcodeLineSize);
		var gcodeSize = gcodeLineSize*gcode.length/1024/1024; // estimate gcode size in MB's
		console.log("  gcodeSize: ",gcodeSize);

		if(gcodeSize > Printer.MAX_GCODE_SIZE) {
			var msg = "Error: Printer:print: gcode file is probably too big ("+gcodeSize+"MB) (max: "+Printer.MAX_GCODE_SIZE+"MB)";
			alert(msg);
			console.log(msg);

			this.overruleState(Printer.IDLE_STATE);
			this.startStatusCheckInterval();
			message.hide();
			self.removeLeaveWarning();

			return;
		}

		//this.targetTemperature = settings["printer.temperature"]; // slight hack

		this.sendPrintPart(this.sendIndex, this.sendLength);
	}

	this.byteSize = function(s){
		return~-encodeURI(s).split(/%..|./).length;
	}

	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 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;
		if (communicateWithWifibox) {
			$.ajax({
				url: this.wifiboxURL + "/printer/print",
				type: "POST",
				data: postData,
				dataType: 'json',
				timeout: this.sendPrintPartTimeoutTime,
				success: function(data){
					console.log("Printer:sendPrintPart response: ",data);

					if(data.status == "success") {
						if (completed) {
							console.log("Printer:sendPrintPart:gcode sending completed");
							this.gcode = [];
							//btnStop.css("display","block"); // hack
							btnStop.enable(); //check me
							self.removeLeaveWarning();
							message.set("Doodle has been sent to printer...",Message.INFO,true);
							//self.targetTemperature = settings["printer.temperature"]; // slight hack
						} else {
							// only if the state hasn't been changed (by for example pressing stop) we send more gcode

							//console.log("Printer:sendPrintPart:gcode part received (state: ",self.state,")");
							if(self.state == Printer.PRINTING_STATE || self.state == Printer.BUFFERING_STATE) {
								//console.log("Printer:sendPrintPart:sending next part");
								self.sendPrintPart(sendIndex + sendLength, sendLength);
							}
						}
					}
					// after we know the first gcode packed has bin 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");
				clearTimeout(self.retrySendPrintPartDelay);
				self.retrySendPrintPartDelay = setTimeout(function() {
					console.log("request printer:sendPrintPart failed retry");
					self.sendPrintPart(sendIndex, sendLength)
				},self.retryDelay); // retry after delay

				// after we know the gcode packed has bin received or failed
				// (and the driver had time to update the printer.state)
				// we start checking the status again
				self.startStatusCheckInterval();
			});
		} else {
			console.log ("Printer >> f:sendPrintPart() >> communicateWithWifibox is false, so not executing this function");
		}
	}

	this.stop = function() {
		console.log("Printer:stop");
		endCode = generateEndCode();
		console.log("  endCode: ",endCode);
		var postData = { gcode: endCode.join("\n")};
		var self = this;
		if (communicateWithWifibox) {
			$.ajax({
				url: this.wifiboxURL + "/printer/stop",
				type: "POST",
				data: postData,
				dataType: 'json',
				timeout: this.timeoutTime,
				success: function(data){
					console.log("Printer:stop response: ", data);

					// after we know the stop has bin received or failed
					// (and the driver had time to update the printer.state)
					// we start checking the status again
					self.startStatusCheckInterval();
				}
			}).fail(function() {
				console.log("Printer:stop: failed");
				clearTimeout(self.retryStopDelay);
				self.retryStopDelay = setTimeout(function() { self.stop() },self.retryDelay); // retry after delay

				// after we know the stop has bin received or failed
				// (and the driver had time to update the printer.state)
				// we start checking the status again
				self.startStatusCheckInterval();
			});
		} else {
			console.log ("Printer >> f:stop() >> communicateWithWifibox is false, so not executing this function");
		}
	}

	this.startStatusCheckInterval = function() {
		console.log("Printer:startStatusCheckInterval");
		self.checkStatus();
		clearTimeout(self.checkStatusDelay);
		clearTimeout(self.retryCheckStatusDelay);
		self.checkStatusDelay = setTimeout(function() { self.checkStatus() }, self.checkStatusInterval);
	}

	this.stopStatusCheckInterval = function() {
		console.log("Printer:stopStatusCheckInterval");
		clearTimeout(self.checkStatusDelay);
		clearTimeout(self.retryCheckStatusDelay);
	}

	this.checkStatus = function() {

		if (limitedFeatures) {
			console.log(className,'ignoring checkStatus due to limitedFeatures mode');
			return; //don't check printer status when in limitedFeatures mode
		}

		//console.log("Printer:checkStatus");
		this.stateOverruled = false;
		//console.log("  stateOverruled: ",this.stateOverruled);
		var self = this;
		if (communicateWithWifibox) {
			$.ajax({
				url: this.wifiboxURL + "/info/status",
				dataType: 'json',
				timeout: this.timeoutTime,
				success: function(response){
					//console.log("  Printer:status: ",response.data.state); //," response: ",response);

					self.handleStatusUpdate(response);

					clearTimeout(self.checkStatusDelay);
					clearTimeout(self.retryCheckStatusDelay);
					self.checkStatusDelay = setTimeout(function() { self.checkStatus() }, self.checkStatusInterval);
				}
			}).fail(function() {
				console.log("Printer:checkStatus: failed");
				self.state = Printer.WIFIBOX_DISCONNECTED_STATE;
				clearTimeout(self.checkStatusDelay);
				clearTimeout(self.retryCheckStatusDelay);
				self.retryCheckStatusDelay = setTimeout(function() { self.checkStatus() },self.retryDelay); // retry after delay
				$(document).trigger(Printer.UPDATE);
			});
		} else {
			console.log ("Printer >> f:checkStatus() >> communicateWithWifibox is false, so not executing this function");
		}
	}

	this.handleStatusUpdate = function(response) {
		//console.log("Printer:handleStatusUpdate response: ",response);
		var data = response.data;
		if(response.status != "success") {
			self.state = Printer.UNKNOWN_STATE;
		} else {
			// state
			//console.log("  stateOverruled: ",this.stateOverruled);
			if(!this.stateOverruled) {
				self.state = data.state;
				//console.log("  state > ",self.state);
			}

			// temperature
			self.temperature = data.hotend;
			self.targetTemperature = data.hotend_target;

			// progress
			self.currentLine = data.current_line;
			self.totalLines = data.total_lines;
			self.bufferedLines = data.buffered_lines

			// access
			self.hasControl = data.has_control;

			if(self.state == Printer.PRINTING_STATE || self.state == Printer.STOPPING_STATE) {
				console.log("progress: ",self.currentLine+"/"+self.totalLines+" ("+self.bufferedLines+") ("+self.state+")");
			}
		}
		$(document).trigger(Printer.UPDATE);
	}

	this.overruleState = function(newState) {
		this.stateOverruled = true;
		console.log("  stateOverruled: ",this.stateOverruled);

		self.state = newState;

		$(document).trigger(Printer.UPDATE);

		this.stopStatusCheckInterval();
	}

	this.removeLeaveWarning = function() {
		window.onbeforeunload = null;
	}

	this.addLeaveWarning = function() {
		window.onbeforeunload = function() {
			console.log("WARNING:"+Printer.ON_BEFORE_UNLOAD_MESSAGE);
			return Printer.ON_BEFORE_UNLOAD_MESSAGE;
		};
	}
}