Merge branch 'develop'

Author: peteruithoven

README.md

@@ -14,10 +14,11 @@ Building natively is done using the script `build-local.sh` (or manually). The i
 Requirements to build and run the code natively are: cmake (more to come).
 
 ## Startup scripts
-- [print3d_init](https://github.com/Doodle3D/print3d/blob/master/src/script/print3d_init). A init script that starts the print3d-manager as a deamon. 
-- [print3d-manager](https://github.com/Doodle3D/print3d/blob/master/src/script/print3d-manager.sh). Uses inotifyd to start `print3d-new-device` when a new device is connected. 
-- [print3d-new-device](https://github.com/Doodle3D/print3d/blob/master/src/script/print3d-new-device.sh). Figures out whether to start print3d in a seemingly crude way. If appropriate it tries to start `print3d-runner`
-- [print3d-runner.sh](https://github.com/Doodle3D/print3d/blob/master/src/script/print3d-runner.sh). Starts the print3d deamon. 
+The Print3D package includes shell scripts that start print3D when a printer is connected.
+- `/etc.init.d/`[print3d](https://github.com/Doodle3D/print3d/blob/master/src/script/print3d_init). A init script that starts the print3d-manager as a deamon. 
+- `/usr/libexec/`[print3d-manager](https://github.com/Doodle3D/print3d/blob/master/src/script/print3d-manager.sh). Uses inotifyd to start `print3d-new-device` when a new device is connected. 
+- `/usr/libexec/`[print3d-new-device](https://github.com/Doodle3D/print3d/blob/master/src/script/print3d-new-device.sh). Figures out whether to start print3d in a seemingly crude way. If appropriate it tries to start `print3d-runner`
+- `/usr/libexec/`[print3d-runner.sh](https://github.com/Doodle3D/print3d/blob/master/src/script/print3d-runner.sh). Starts the print3d deamon. 
 
 ## CMDline usage
 - **Print3D** is a deamon that communicates with the printer. It sends the printer gcode line for line from it's buffer, it automatically checks the temperature etc. Preverably it's started when a printer is connected. 

build-local.sh

@@ -10,12 +10,21 @@ CMAKE_FLAGS=("-G" "Unix Makefiles")
 INTERACTIVE_MODE=no
 TEST_MODE=no
 
+command cmake --version > /dev/null 2>&1
+if [ $? -ne 0 ]; then
+	echo "Error: this build script needs cmake."
+	exit 1
+fi
+
 for arg in $@; do
 	case $arg in
 	-h)
-		echo "By default, the script builds for target '$BUILD_TARGET', specify one of 'Debug', 'Release', 'RelWithDebInfo' or 'MinSizeRel' to change this. Furthermore, the following arguments are valid:"
-		echo "\t-h\tshow this help"
-		echo "\t-i\trun interactive cmake configurator ($CCMAKE)"
+		echo -e "By default, the script builds for target '$BUILD_TARGET', specify one of 'Debug', 'Release', 'RelWithDebInfo' or 'MinSizeRel' to change this."
+		echo -e "The Lua front-end can be enabled/disabled by specifying 'Lua' or 'NoLua' correspondingly. Likewise, UCI supoprt can be enabled/disabled using 'Uci' or 'NoUci'."
+		echo -e "Furthermore, the following arguments are valid:"
+		echo -e "\t-h\tshow this help"
+		echo -e "\t-i\trun interactive cmake configurator ($CCMAKE)"
+		echo -e "\t-D*\tany -D define will be passed to cmake directly"
 		exit
 		;;
 	-i)
@@ -27,15 +36,28 @@ for arg in $@; do
 	*)
 		if [ $arg == "Debug" -o $arg == "Release" -o $arg == "RelWithDebInfo" -o $arg == "MinSizeRel" ]; then
 			BUILD_TARGET=$arg
+		elif [ $arg == "Lua" ]; then
+			LUA="ON"
+		elif [ $arg == "NoLua" ]; then
+			LUA="OFF"
+		elif [ $arg == "Uci" ]; then
+			UCI="ON"
+		elif [ $arg == "NoUci" ]; then
+			UCI="OFF"
+		elif [[ $arg == \-D* ]]; then
+			echo "adding arg '$arg'"
+			CMAKE_FLAGS+=("$arg")
 		else
-			echo "$0: unknown argument: '$arg'"
+			echo "$0: unknown argument: '$arg', try using the '-h' argument"
 			exit 1
 		fi
 		;;
 	esac
 done
 
 CMAKE_FLAGS+=("-DCMAKE_BUILD_TYPE:STRING=$BUILD_TARGET")
+if [ "x$LUA" != "x" ]; then CMAKE_FLAGS+=("-DLUA_FRONTEND=$LUA"); fi
+if [ "x$UCI" != "x" ]; then CMAKE_FLAGS+=("-DENABLE_UCI=$UCI"); fi
 
 if [ $INTERACTIVE_MODE == "yes" ]; then
 	echo "Building for target '$BUILD_TARGET'... (interactive)"

src/CMakeLists.txt

@@ -12,7 +12,19 @@ set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall")
 option(GENERATE_DOCS "generate documentation" OFF)
 #option(PRINT3D_DEBUG "debugging support" OFF)
 
-#configure_file( ${CMAKE_SOURCE_DIR}/config.h.in ${CMAKE_SOURCE_DIR}/config.h )
+if(CMAKE_SYSTEM_NAME STREQUAL Linux AND CMAKE_CROSSCOMPILING)
+	option(ENABLE_UCI "include UCI (OpenWrt only)" ON)
+else()
+	option(ENABLE_UCI "disable UCI (OpenWrt only)" OFF)
+endif(CMAKE_SYSTEM_NAME STREQUAL Linux AND CMAKE_CROSSCOMPILING)
+
+#define this here to make sure it has been initialized before configure_file()
+set(GCODE_BUFFER_MAX_SIZE_KB "3072" CACHE STRING "maximum gcode buffer size (KiB)")
+set(GCODE_BUFFER_SPLIT_SIZE_KB "8" CACHE STRING "gcode buffer split size (KiB)")
+
+configure_file("${PROJECT_SOURCE_DIR}/config.h.in" "${PROJECT_BINARY_DIR}/config.h")
+include_directories("${PROJECT_BINARY_DIR}")
+
 
 add_subdirectory(server)
 add_subdirectory(drivers)
@@ -29,9 +41,20 @@ target_link_libraries(logger ipc_shared)
 add_library(settings settings.c settings.h)
 set_target_properties(settings PROPERTIES COMPILE_FLAGS "-fPIC")
 
-if(CMAKE_SYSTEM_NAME STREQUAL Linux AND CMAKE_CROSSCOMPILING)
-	target_link_libraries(settings -luci)
-endif(CMAKE_SYSTEM_NAME STREQUAL Linux AND CMAKE_CROSSCOMPILING)
+if(ENABLE_UCI)
+	if(CMAKE_SYSTEM_NAME STREQUAL Linux AND CMAKE_CROSSCOMPILING)
+		target_link_libraries(settings -luci)
+		set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DUCI_ENABLED=1")
+		set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUCI_ENABLED=1")
+	else()
+		message(SEND_ERROR "Cannot enable UCI since we're not compiling for OpenWrt")
+		set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DUCI_ENABLED=0")
+		set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUCI_ENABLED=0")
+	endif(CMAKE_SYSTEM_NAME STREQUAL Linux AND CMAKE_CROSSCOMPILING)
+else()
+	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DUCI_ENABLED=0")
+	set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUCI_ENABLED=0")
+endif(ENABLE_UCI)
 
 add_library(timer Timer.cpp Timer.h)
 

src/config.h.in

@@ -0,0 +1,15 @@
+/*
+ * 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.
+ */
+
+#ifndef CONFIG_H_SEEN
+#define CONFIG_H_SEEN
+
+#define GCODE_BUFFER_MAX_SIZE_KB ${GCODE_BUFFER_MAX_SIZE_KB}
+#define GCODE_BUFFER_SPLIT_SIZE_KB ${GCODE_BUFFER_SPLIT_SIZE_KB}
+
+#endif /* ! CONFIG_H_SEEN */

src/drivers/AbstractDriver.cpp

@@ -8,6 +8,7 @@
 
 #include <errno.h>
 #include <algorithm>
+#include <iostream>
 #include <sstream>
 #include "AbstractDriver.h"
 #include "../server/Server.h"
@@ -24,7 +25,8 @@ const string AbstractDriver::STATE_NAMES[] = { "unknown", "disconnected", "conne
 const bool AbstractDriver::REQUEST_EXIT_ON_PORT_FAIL = true;
 
 AbstractDriver::AbstractDriver(Server& server, const string& serialPortPath, const uint32_t& baudrate)
-: temperature_(0),
+: heating_(false),
+  temperature_(0),
   targetTemperature_(0),
   bedTemperature_(0),
   targetBedTemperature_(0),
@@ -101,7 +103,6 @@ void AbstractDriver::heatup(int temperature) {
 	sendCode(oss.str());
 }
 
-#include <iostream>
 /*
  * Print control
  */
@@ -140,6 +141,10 @@ bool AbstractDriver::stopPrint() {
 /*
  * Getters and setters
  */
+bool AbstractDriver::isHeating() const {
+	return heating_;
+}
+
 uint16_t AbstractDriver::getTemperature() const {
 	return temperature_;
 }

src/drivers/AbstractDriver.h

@@ -78,6 +78,11 @@ class AbstractDriver {
 
 	void heatup(int temperature);
 
+	/*
+	 * Get cached heating state
+	 */
+	bool isHeating() const;
+
 	/*
 	 * Get cached extruder temperature
 	 */
@@ -119,6 +124,7 @@ class AbstractDriver {
 protected:
 	static const bool REQUEST_EXIT_ON_PORT_FAIL;
 
+	bool heating_;
 	uint16_t temperature_;
 	uint16_t targetTemperature_;
 	uint16_t bedTemperature_;

src/drivers/GCodeBuffer.cpp

@@ -10,40 +10,57 @@
 #include <algorithm>
 #include <stdlib.h>
 #include <string.h>
+#include "config.h"
+#include "../utils.h"
 using std::string;
 
 //NOTE: see Server.cpp for comments on this macro
 #define LOG(lvl, fmt, ...) log_.log(lvl, "[MLD] " fmt, ##__VA_ARGS__)
 
+#ifndef GCODE_BUFFER_MAX_SIZE_KB
+# define GCODE_BUFFER_MAX_SIZE_KB 1024 * 3
+#endif
+#ifndef GCODE_BUFFER_SPLIT_SIZE_KB
+# define GCODE_BUFFER_SPLIT_SIZE_KB 8
+#endif
+
 //private
 const uint32_t GCodeBuffer::MAX_BUCKET_SIZE = 1024 * 50;
-const uint32_t GCodeBuffer::MAX_BUFFER_SIZE = 1024 * 1024 * 3;
+const uint32_t GCodeBuffer::MAX_BUFFER_SIZE = 1024 * GCODE_BUFFER_MAX_SIZE_KB; //set to 0 to disable (TODO: actually, this isn used at all currently)
+const uint32_t GCodeBuffer::BUFFER_SPLIT_SIZE = 1024 * GCODE_BUFFER_SPLIT_SIZE_KB; //append will split its input on the first newline after this size
 
 GCodeBuffer::GCodeBuffer()
 : currentLine_(0), bufferedLines_(0), totalLines_(0), bufferSize_(0), log_(Logger::getInstance())
-{ /* empty */ }
+{
+	LOG(Logger::VERBOSE, "init: max size: %luKiB, bucket size: %luKiB, split size: %luKiB",
+		MAX_BUFFER_SIZE, MAX_BUCKET_SIZE, BUFFER_SPLIT_SIZE);
+}
 
 void GCodeBuffer::set(const string &gcode) {
 	clear();
 	append(gcode);
 }
 
-//NOTE: currently this function will never split given gcode into parts for
-//separate buckets, so MAX_BUCKET_SIZE is not a strict limit
+//NOTE: this function splits given code into chunk of approximately BUFFER_SPLIT_SIZE.
+//without this, huge chunks (>1MB) would make repeated erase operations very inefficient.
 void GCodeBuffer::append(const string &gcode) {
-
-	if (buckets_.size() == 0) buckets_.push_back(new string());
-	string *b = buckets_.back();
-	if (b->length() >= MAX_BUCKET_SIZE) {
-		b = new string();
-		buckets_.push_back(b);
+	uint32_t startTime = getMillis();
+	int count = 0;
+	size_t size = gcode.size();
+	size_t start = 0;
+	
+	while(start < gcode.size()) {
+		size_t len = BUFFER_SPLIT_SIZE;
+		size_t nl = gcode.find('\n', start + len);
+
+		len = (nl != string::npos) ? nl - start + 1 : gcode.size() - start;
+		appendChunk(gcode.substr(start, len));
+		count++;
+		start += len;
 	}
 
-	size_t pos = b->length();
-	b->append(gcode);
-	cleanupGCode(b, pos);
-	bufferSize_ += gcode.length();
-	updateStats(b, pos);
+	LOG(Logger::VERBOSE, "append(): added %zu bytes of gcode (%i chunks) in %lu ms",
+		size, count, getMillis() - startTime);
 }
 
 void GCodeBuffer::clear() {
@@ -137,10 +154,27 @@ bool GCodeBuffer::eraseLine(size_t amount) {
 	return pos != string::npos;
 }
 
+
 /*********************
  * PRIVATE FUNCTIONS *
  *********************/
 
+void GCodeBuffer::appendChunk(const string &gcode) {
+
+	if (buckets_.size() == 0) buckets_.push_back(new string());
+	string *b = buckets_.back();
+	if (b->length() >= MAX_BUCKET_SIZE) {
+		b = new string();
+		buckets_.push_back(b);
+	}
+
+	size_t pos = b->length();
+	b->append(gcode);
+	cleanupGCode(b, pos);
+	bufferSize_ += gcode.length();
+	updateStats(b, pos);
+}
+
 void GCodeBuffer::updateStats(string *buffer, size_t pos) {
 	int32_t addedLineCount = std::count(buffer->begin() + pos, buffer->end(), '\n');
 	if (buffer->length() > 0 && buffer->at(buffer->length() - 1) != '\n') addedLineCount++;
@@ -150,6 +184,8 @@ void GCodeBuffer::updateStats(string *buffer, size_t pos) {
 }
 
 void GCodeBuffer::cleanupGCode(string *buffer, size_t pos) {
+	uint32_t startTime = getMillis(), commentDelta, doubleNLDelta, endTime;
+
 //	LOG(Logger::BULK, "cleanupGCode");
 //	LOG(Logger::BULK, "  pos: %i",pos);
 //	LOG(Logger::BULK, "  ////////// buffer: ");
@@ -174,6 +210,8 @@ void GCodeBuffer::cleanupGCode(string *buffer, size_t pos) {
 		}
 	}
 
+	commentDelta = getMillis();
+
 	//replace \n\n with \n
 	std::size_t posDoubleNewline = pos;
 	// -1 to make sure we also check the first line of the part we're checking
@@ -183,20 +221,28 @@ void GCodeBuffer::cleanupGCode(string *buffer, size_t pos) {
 		buffer->replace(posDoubleNewline, 2, "\n");
 	}
 
+	doubleNLDelta = getMillis();
+
 	// remove empty first line
 	if(buffer->find("\n",0) == 0) {
 		buffer->erase(0, 1);
 		LOG(Logger::BULK, " erase first empty line");
 	}
 
-	// Make sure we end with an empty line
-	char& lastChar = buffer->at(buffer->length()-1);
-	if(lastChar != '\n') {
-		buffer->append("\n");
-//		LOG(Logger::BULK, " add empty line at end");
+	// Make sure we end with an empty line except when the buffer is empty
+	if (buffer->length() > 0) {
+		char lastChar = buffer->at(buffer->length()-1);
+		if(lastChar != '\n') {
+			buffer->append("\n");
+//			LOG(Logger::BULK, " add empty line at end");
+		}
 	}
 //	LOG(Logger::BULK, "  ////////// >>>buffer: ");
 //	LOG(Logger::BULK, "  \n%s\n////////// end >>>buffer",buffer->c_str());
 
 	bufferSize_ -= (buflen - buffer->length());
+
+	endTime = getMillis();
+	LOG(Logger::BULK, "cleanupGCode(): took %lu ms (%lu removing comments, %lu removing double newlines)",
+		endTime - startTime, commentDelta - startTime, doubleNLDelta - commentDelta);
 }

src/drivers/GCodeBuffer.h

@@ -39,6 +39,7 @@ class GCodeBuffer {
 private:
 	static const uint32_t MAX_BUCKET_SIZE;
 	static const uint32_t MAX_BUFFER_SIZE;
+	static const uint32_t BUFFER_SPLIT_SIZE;
 
 	deque_stringP buckets_;
 	int32_t currentLine_;
@@ -48,6 +49,7 @@ class GCodeBuffer {
 
 	Logger& log_;
 
+	void appendChunk(const std::string &gcode);
 	void updateStats(std::string *buffer, size_t pos);
 	void cleanupGCode(std::string *buffer, size_t pos);
 };

src/drivers/MakerbotDriver.cpp

@@ -200,6 +200,7 @@ const AbstractDriver::DriverInfo& MakerbotDriver::getDriverInfo() {
 		supportedFirmware.push_back( AbstractDriver::FirmwareDescription("makerbot_replicator2x") );
 		supportedFirmware.push_back( AbstractDriver::FirmwareDescription("makerbot_thingomatic") );
 		supportedFirmware.push_back( AbstractDriver::FirmwareDescription("makerbot_generic") );
+        supportedFirmware.push_back( AbstractDriver::FirmwareDescription("wanhao_duplicator4") );
 
 		info.supportedFirmware = supportedFirmware;
 		info.creator = &MakerbotDriver::create;