[clinton/Smoothieware.git] / src / modules / communication / GcodeDispatch.cpp

/*
      This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
      Smoothie is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
      Smoothie is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
      You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
*/

#include "GcodeDispatch.h"

#include "libs/Kernel.h"
#include "Robot.h"
#include "utils/Gcode.h"
#include "libs/nuts_bolts.h"
#include "modules/robot/Conveyor.h"
#include "libs/SerialMessage.h"
#include "libs/StreamOutput.h"
#include "libs/StreamOutputPool.h"
#include "libs/FileStream.h"
#include "libs/AppendFileStream.h"
#include "Config.h"
#include "checksumm.h"
#include "ConfigValue.h"
#include "PublicDataRequest.h"
#include "PublicData.h"
#include "SimpleShell.h"
#include "utils.h"
#include "LPC17xx.h"
#include "version.h"

#define panel_display_message_checksum CHECKSUM("display_message")
#define panel_checksum             CHECKSUM("panel")

// goes in Flash, list of Mxxx codes that are allowed when in Halted state
static const int allowed_mcodes[]= {2,5,9,30,105,114,119,80,81,911,503,106,107}; // get temp, get pos, get endstops etc
static bool is_allowed_mcode(int m) {
    for (size_t i = 0; i < sizeof(allowed_mcodes)/sizeof(int); ++i) {
        if(allowed_mcodes[i] == m) return true;
    }
    return false;
}

GcodeDispatch::GcodeDispatch()
{
    uploading = false;
    currentline = -1;
    modal_group_1= 0;
}

// Called when the module has just been loaded
void GcodeDispatch::on_module_loaded()
{
    this->register_for_event(ON_CONSOLE_LINE_RECEIVED);
}

// When a command is received, if it is a Gcode, dispatch it as an object via an event
void GcodeDispatch::on_console_line_received(void *line)
{
    SerialMessage new_message = *static_cast<SerialMessage *>(line);
    string possible_command = new_message.message;

    int ln = 0;
    int cs = 0;

    // just reply ok to empty lines
    if(possible_command.empty()) {
        new_message.stream->printf("ok\r\n");
        return;
    }

try_again:

    char first_char = possible_command[0];
    unsigned int n;

    if(first_char == '$') {
        // ignore as simpleshell will handle it
        return;

    }else if(islower(first_char)) {
        // ignore all lowercase as they are simpleshell commands
        return;
    }

    if ( first_char == 'G' || first_char == 'M' || first_char == 'T' || first_char == 'S' || first_char == 'N' ) {

        //Get linenumber
        if ( first_char == 'N' ) {
            Gcode full_line = Gcode(possible_command, new_message.stream, false);
            ln = (int) full_line.get_value('N');
            int chksum = (int) full_line.get_value('*');

            //Catch message if it is M110: Set Current Line Number
            if ( full_line.has_m ) {
                if ( full_line.m == 110 ) {
                    currentline = ln;
                    new_message.stream->printf("ok\r\n");
                    return;
                }
            }

            //Strip checksum value from possible_command
            size_t chkpos = possible_command.find_first_of("*");

			//Calculate checksum
            if ( chkpos != string::npos ) {
				possible_command = possible_command.substr(0, chkpos);
                for (auto c = possible_command.cbegin(); *c != '*' && c != possible_command.cend(); c++)
                    cs = cs ^ *c;
                cs &= 0xff;  // Defensive programming...
                cs -= chksum;
			}

            //Strip line number value from possible_command
			size_t lnsize = possible_command.find_first_not_of("N0123456789.,- ");
			if(lnsize != string::npos) {
				possible_command = possible_command.substr(lnsize);
			}else{
				// it is a blank line
				possible_command.clear();
			}

        } else {
            //Assume checks succeeded
            cs = 0x00;
            ln = currentline + 1;
        }

        //Remove comments
        size_t comment = possible_command.find_first_of(";(");
        if( comment != string::npos ) {
            possible_command = possible_command.substr(0, comment);
        }

        //If checksum passes then process message, else request resend
        int nextline = currentline + 1;
        if( cs == 0x00 && ln == nextline ) {
            if( first_char == 'N' ) {
                currentline = nextline;
            }

            bool sent_ok= false; // used for G1 optimization
            while(possible_command.size() > 0) {
                // assumes G or M are always the first on the line
                size_t nextcmd = possible_command.find_first_of("GM", 2);
                string single_command;
                if(nextcmd == string::npos) {
                    single_command = possible_command;
                    possible_command = "";
                } else {
                    single_command = possible_command.substr(0, nextcmd);
                    possible_command = possible_command.substr(nextcmd);
                }


                if(!uploading || upload_stream != new_message.stream) {
                    // Prepare gcode for dispatch
                    Gcode *gcode = new Gcode(single_command, new_message.stream);

                    if(THEKERNEL->is_halted()) {
                        // we ignore all commands until M999, unless it is in the exceptions list (like M105 get temp)
                        if(gcode->has_m && gcode->m == 999) {
                            if(THEKERNEL->is_halted()) {
                                THEKERNEL->call_event(ON_HALT, (void *)1); // clears on_halt
                                new_message.stream->printf("WARNING: After HALT you should HOME as position is currently unknown\n");
                            }
                            new_message.stream->printf("ok\n");
                            delete gcode;
                            return;

                        }else if(!is_allowed_mcode(gcode->m)) {
                            // ignore everything, return error string to host
                            if(THEKERNEL->is_grbl_mode()) {
                                new_message.stream->printf("error:Alarm lock\n");

                            }else{
                                new_message.stream->printf("!!\r\n");
                            }
                            delete gcode;
                            return;
                        }
                    }

                    if(gcode->has_g) {
                        if(gcode->g == 53) { // G53 makes next movement command use machine coordinates
                            // this is ugly to implement as there may or may not be a G0/G1 on the same line
                            // valid version seem to include G53 G0 X1 Y2 Z3 G53 X1 Y2
                            if(possible_command.empty()) {
                                // use last gcode G1 or G0 if none on the line, and pass through as if it was a G0/G1
                                // TODO it is really an error if the last is not G0 thru G3
                                if(modal_group_1 > 3) {
                                    delete gcode;
                                    new_message.stream->printf("ok - Invalid G53\r\n");
                                    return;
                                }
                                // use last G0 or G1
                                gcode->g= modal_group_1;

                            }else{
                                delete gcode;
                                // extract next G0/G1 from the rest of the line, ignore if it is not one of these
                                gcode = new Gcode(possible_command, new_message.stream);
                                possible_command= "";
                                if(!gcode->has_g || gcode->g > 1) {
                                    // not G0 or G1 so ignore it as it is invalid
                                    delete gcode;
                                    new_message.stream->printf("ok - Invalid G53\r\n");
                                    return;
                                }
                            }
                            // makes it handle the parameters as a machine position
                            THEROBOT->next_command_is_MCS= true;

                        } else if(gcode->g == 1) {
                            // optimize G1 to send ok immediately (one per line) before it is planned
                            if(!sent_ok) {
                                sent_ok= true;
                                new_message.stream->printf("ok\n");
                            }
                        }

                        // remember last modal group 1 code
                        if(gcode->g < 4) {
                            modal_group_1= gcode->g;
                        }
                    }

                    if(gcode->has_m) {
                        switch (gcode->m) {
                            case 28: // start upload command
                                delete gcode;

                                this->upload_filename = "/sd/" + single_command.substr(4); // rest of line is filename
                                // open file
                                upload_fd = fopen(this->upload_filename.c_str(), "w");
                                if(upload_fd != NULL) {
                                    this->uploading = true;
                                    new_message.stream->printf("Writing to file: %s\r\nok\r\n", this->upload_filename.c_str());
                                } else {
                                    new_message.stream->printf("open failed, File: %s.\r\nok\r\n", this->upload_filename.c_str());
                                }

                                // only save stuff from this stream
                                upload_stream= new_message.stream;

                                //printf("Start Uploading file: %s, %p\n", upload_filename.c_str(), upload_fd);
                                continue;

                            case 30: // end of program
                                if(!THEKERNEL->is_grbl_mode()) break; // Special case M30 as it is also delete sd card file so only do this if in grbl mode
                                // fall through to M2
                            case 2:
                                {
                                    modal_group_1= 1; // set to G1
                                    // issue M5 and M9 in case spindle and coolant are being used
                                    Gcode gc1("M5", &StreamOutput::NullStream);
                                    THEKERNEL->call_event(ON_GCODE_RECEIVED, &gc1);
                                    Gcode gc2("M9", &StreamOutput::NullStream);
                                    THEKERNEL->call_event(ON_GCODE_RECEIVED, &gc2);
                                }
                                break;

                            case 112: // emergency stop, do the best we can with this
                                // this is also handled out-of-band (it is now with ^X in the serial driver)
                                // disables heaters and motors, ignores further incoming Gcode and clears block queue
                                THEKERNEL->call_event(ON_HALT, nullptr);
                                THEKERNEL->streams->printf("ok Emergency Stop Requested - reset or M999 required to exit HALT state\r\n");
                                delete gcode;
                                return;

                            case 115: { // M115 Get firmware version and capabilities
                                Version vers;

                                new_message.stream->printf("FIRMWARE_NAME:Smoothieware, FIRMWARE_URL:http%%3A//smoothieware.org, X-SOURCE_CODE_URL:https://github.com/Smoothieware/Smoothieware, FIRMWARE_VERSION:%s, X-FIRMWARE_BUILD_DATE:%s, X-SYSTEM_CLOCK:%ldMHz, X-AXES:%d", vers.get_build(), vers.get_build_date(), SystemCoreClock / 1000000, MAX_ROBOT_ACTUATORS);

                                #ifdef CNC
                                new_message.stream->printf(", X-CNC:1");
                                #else
                                new_message.stream->printf(", X-CNC:0");
                                #endif

                                #ifdef DISABLEMSD
                                new_message.stream->printf(", X-MSD:0");
                                #else
                                new_message.stream->printf(", X-MSD:1");
                                #endif

                                new_message.stream->printf("\nok\n");
                                return;
                            }

                            case 117: // M117 is a special non compliant Gcode as it allows arbitrary text on the line following the command
                            {    // concatenate the command again and send to panel if enabled
                                string str= single_command.substr(4) + possible_command;
                                PublicData::set_value( panel_checksum, panel_display_message_checksum, &str );
                                delete gcode;
                                new_message.stream->printf("ok\r\n");
                                return;
                            }

                            case 1000: // M1000 is a special command that will pass thru the raw lowercased command to the simpleshell (for hosts that do not allow such things)
                            {
                                // reconstruct entire command line again
                                string str= single_command.substr(5) + possible_command;
                                while(is_whitespace(str.front())){ str= str.substr(1); } // strip leading whitespace

                                delete gcode;

                                if(str.empty()) {
                                    SimpleShell::parse_command("help", "", new_message.stream);

                                }else{
                                    string args= lc(str);
                                    string cmd = shift_parameter(args);
                                    // find command and execute it
                                    if(!SimpleShell::parse_command(cmd.c_str(), args, new_message.stream)) {
                                        new_message.stream->printf("Command not found: %s\n", cmd.c_str());
                                    }
                                }

                                new_message.stream->printf("ok\r\n");
                                return;
                            }

                            case 500: // M500 save volatile settings to config-override
                                THEKERNEL->conveyor->wait_for_idle(); //just to be safe as it can take a while to run
                                //remove(THEKERNEL->config_override_filename()); // seems to cause a hang every now and then
                                __disable_irq();
                                {
                                    FileStream fs(THEKERNEL->config_override_filename());
                                    fs.printf("; DO NOT EDIT THIS FILE\n");
                                    // this also will truncate the existing file instead of deleting it
                                }
                                // replace stream with one that writes to config-override file
                                gcode->stream = new AppendFileStream(THEKERNEL->config_override_filename());
                                // dispatch the M500 here so we can free up the stream when done
                                THEKERNEL->call_event(ON_GCODE_RECEIVED, gcode );
                                delete gcode->stream;
                                delete gcode;
                                __enable_irq();
                                new_message.stream->printf("Settings Stored to %s\r\nok\r\n", THEKERNEL->config_override_filename());
                                continue;

                            case 501: // load config override
                            case 504: // save to specific config override file
                                {
                                    string arg= get_arguments(single_command + possible_command); // rest of line is filename
                                    if(arg.empty()) arg= "/sd/config-override";
                                    else arg= "/sd/config-override." + arg;
                                    //new_message.stream->printf("args: <%s>\n", arg.c_str());
                                    SimpleShell::parse_command((gcode->m == 501) ? "load_command" : "save_command", arg, new_message.stream);
                                }
                                delete gcode;
                                new_message.stream->printf("ok\r\n");
                                return;

                            case 502: // M502 deletes config-override so everything defaults to what is in config
                                remove(THEKERNEL->config_override_filename());
                                delete gcode;
                                new_message.stream->printf("config override file deleted %s, reboot needed\r\nok\r\n", THEKERNEL->config_override_filename());
                                continue;

                            case 503: { // M503 display live settings and indicates if there is an override file
                                FILE *fd = fopen(THEKERNEL->config_override_filename(), "r");
                                if(fd != NULL) {
                                    fclose(fd);
                                    new_message.stream->printf("; config override present: %s\n",  THEKERNEL->config_override_filename());

                                } else {
                                    new_message.stream->printf("; No config override\n");
                                }
                                gcode->add_nl= true;
                                break; // fall through to process by modules
                            }

                        }
                    }

                    //printf("dispatch %p: '%s' G%d M%d...", gcode, gcode->command.c_str(), gcode->g, gcode->m);
                    //Dispatch message!
                    THEKERNEL->call_event(ON_GCODE_RECEIVED, gcode );

                    if (gcode->is_error) {
                        // report error
                        if(THEKERNEL->is_grbl_mode()) {
                            new_message.stream->printf("error:");
                        }else{
                            new_message.stream->printf("Error: ");
                        }

                        if(!gcode->txt_after_ok.empty()) {
                            new_message.stream->printf("%s\r\n", gcode->txt_after_ok.c_str());
                            gcode->txt_after_ok.clear();

                        }else{
                            new_message.stream->printf("unknown\r\n");
                        }

                        // we cannot continue safely after an error so we enter HALT state
                        new_message.stream->printf("Entering Alarm/Halt state\n");
                        THEKERNEL->call_event(ON_HALT, nullptr);

                    }else if(!sent_ok) {

                        if(gcode->add_nl)
                            new_message.stream->printf("\r\n");

                        if(!gcode->txt_after_ok.empty()) {
                            new_message.stream->printf("ok %s\r\n", gcode->txt_after_ok.c_str());
                            gcode->txt_after_ok.clear();

                        } else {
                            if(THEKERNEL->is_ok_per_line() || THEKERNEL->is_grbl_mode()) {
                                // only send ok once per line if this is a multi g code line send ok on the last one
                                if(possible_command.empty())
                                    new_message.stream->printf("ok\r\n");
                            } else {
                                // maybe should do the above for all hosts?
                                new_message.stream->printf("ok\r\n");
                            }
                        }
                    }

                    delete gcode;

                } else {
                    // we are uploading and it is the upload stream so so save it
                    if(single_command.substr(0, 3) == "M29") {
                        // done uploading, close file
                        fclose(upload_fd);
                        upload_fd = NULL;
                        uploading = false;
                        upload_filename.clear();
                        upload_stream= nullptr;
                        new_message.stream->printf("Done saving file.\r\nok\r\n");
                        continue;
                    }

                    if(upload_fd == NULL) {
                        // error detected writing to file so discard everything until it stops
                        new_message.stream->printf("ok\r\n");
                        continue;
                    }

                    single_command.append("\n");
                    if(fwrite(single_command.c_str(), 1, single_command.size(), upload_fd) != single_command.size()) {
                        // error writing to file
                        new_message.stream->printf("Error:error writing to file.\r\n");
                        fclose(upload_fd);
                        upload_fd = NULL;
                        continue;

                    } else {
                         new_message.stream->printf("ok\r\n");
                        //printf("uploading file write ok\n");
                    }
                }
            }

        } else {
            //Request resend
            new_message.stream->printf("rs N%d\r\n", nextline);
        }

    } else if( (n=possible_command.find_first_of("XYZF")) == 0 || (first_char == ' ' && n != string::npos) ) {
        // handle pycam syntax, use last modal group 1 command and resubmit if an X Y Z or F is found on its own line
        char buf[6];
        snprintf(buf, sizeof(buf), "G%d ", modal_group_1);
        possible_command.insert(0, buf);
        goto try_again;

    } else if ( first_char == ';' || first_char == '(' || first_char == ' ' || first_char == '\n' || first_char == '\r' ) {
        // Ignore comments and blank lines
        new_message.stream->printf("ok\n");

    } else {
        // an uppercase non command word on its own (except XYZF) just returns ok, we could add an error but no hosts expect that.
        new_message.stream->printf("ok - ignored\n");
    }
}
Commit	Line	Data
de91760a	1	/*
4cff3ded AW	2	This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
	3	Smoothie is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
	4	Smoothie is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
de91760a	5	You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
4cff3ded AW	6	*/
4cff3ded AW	7
b14f84e0 JM	8	#include "GcodeDispatch.h"
b14f84e0 JM	9
4cff3ded	10	#include "libs/Kernel.h"
00e607c7	11	#include "Robot.h"
4cff3ded	12	#include "utils/Gcode.h"
436a2cd1	13	#include "libs/nuts_bolts.h"
3fceb8eb	14	#include "modules/robot/Conveyor.h"
423df6df	15	#include "libs/SerialMessage.h"
838b33b4	16	#include "libs/StreamOutput.h"
17704c93	17	#include "libs/StreamOutputPool.h"
c4d4e3f8	18	#include "libs/FileStream.h"
825f27de	19	#include "libs/AppendFileStream.h"
61134a65	20	#include "Config.h"
7af0714f	21	#include "checksumm.h"
8d54c34c	22	#include "ConfigValue.h"
c89338bd JM	23	#include "PublicDataRequest.h"
c89338bd JM	24	#include "PublicData.h"
5c051155 JM	25	#include "SimpleShell.h"
5c051155 JM	26	#include "utils.h"
5534e39e	27	#include "LPC17xx.h"
620b6dff	28	#include "version.h"
4cff3ded	29
c89338bd JM	30	#define panel_display_message_checksum CHECKSUM("display_message")
c89338bd JM	31	#define panel_checksum CHECKSUM("panel")
b375ba1d	32
4fb7087f	33	// goes in Flash, list of Mxxx codes that are allowed when in Halted state
f88068ec	34	static const int allowed_mcodes[]= {2,5,9,30,105,114,119,80,81,911,503,106,107}; // get temp, get pos, get endstops etc
4fb7087f JM	35	static bool is_allowed_mcode(int m) {
	36	for (size_t i = 0; i < sizeof(allowed_mcodes)/sizeof(int); ++i) {
	37	if(allowed_mcodes[i] == m) return true;
	38	}
	39	return false;
	40	}
	41
b375ba1d JM	42	GcodeDispatch::GcodeDispatch()
b375ba1d JM	43	{
b375ba1d JM	44	uploading = false;
b375ba1d JM	45	currentline = -1;
ae7c4219	46	modal_group_1= 0;
b375ba1d	47	}
4cff3ded AW	48
4cff3ded AW	49	// Called when the module has just been loaded
adf89655 JM	50	void GcodeDispatch::on_module_loaded()
adf89655 JM	51	{
4cff3ded AW	52	this->register_for_event(ON_CONSOLE_LINE_RECEIVED);
	53	}
	54
	55	// When a command is received, if it is a Gcode, dispatch it as an object via an event
adf89655 JM	56	void GcodeDispatch::on_console_line_received(void *line)
	57	{
	58	SerialMessage new_message = static_cast<SerialMessage >(line);
de91760a	59	string possible_command = new_message.message;
b6c86164	60
62567509 MC	61	int ln = 0;
62567509 MC	62	int cs = 0;
c4c70e85	63
2a58aabf	64	// just reply ok to empty lines
543c4b6d JM	65	if(possible_command.empty()) {
	66	new_message.stream->printf("ok\r\n");
	67	return;
	68	}
	69
2a58aabf JM	70	try_again:
2a58aabf JM	71
c4c70e85	72	char first_char = possible_command[0];
c2885de8	73	unsigned int n;
6c0193b3 JM	74
	75	if(first_char == '$') {
	76	// ignore as simpleshell will handle it
	77	return;
	78
	79	}else if(islower(first_char)) {
	80	// ignore all lowercase as they are simpleshell commands
	81	return;
	82	}
	83
7d105bc4	84	if ( first_char == 'G' \|\| first_char == 'M' \|\| first_char == 'T' \|\| first_char == 'S' \|\| first_char == 'N' ) {
9a29161f	85
62567509	86	//Get linenumber
adf89655	87	if ( first_char == 'N' ) {
aae5a789	88	Gcode full_line = Gcode(possible_command, new_message.stream, false);
534e17b9 MC	89	ln = (int) full_line.get_value('N');
534e17b9 MC	90	int chksum = (int) full_line.get_value('*');
62567509	91
f337d8fd	92	//Catch message if it is M110: Set Current Line Number
b9b1bb25 JM	93	if ( full_line.has_m ) {
b9b1bb25 JM	94	if ( full_line.m == 110 ) {
f337d8fd MC	95	currentline = ln;
	96	new_message.stream->printf("ok\r\n");
	97	return;
	98	}
	99	}
	100
534e17b9	101	//Strip checksum value from possible_command
62567509	102	size_t chkpos = possible_command.find_first_of("*");
a36d0341 JM	103
a36d0341 JM	104	//Calculate checksum
adf89655	105	if ( chkpos != string::npos ) {
a36d0341	106	possible_command = possible_command.substr(0, chkpos);
adf89655	107	for (auto c = possible_command.cbegin(); c != '' && c != possible_command.cend(); c++)
7a2ca498	108	cs = cs ^ *c;
62567509	109	cs &= 0xff; // Defensive programming...
534e17b9	110	cs -= chksum;
a36d0341	111	}
27fdf020	112
534e17b9	113	//Strip line number value from possible_command
a36d0341 JM	114	size_t lnsize = possible_command.find_first_not_of("N0123456789.,- ");
	115	if(lnsize != string::npos) {
	116	possible_command = possible_command.substr(lnsize);
	117	}else{
	118	// it is a blank line
	119	possible_command.clear();
	120	}
f337d8fd	121
adf89655	122	} else {
534e17b9 MC	123	//Assume checks succeeded
	124	cs = 0x00;
	125	ln = currentline + 1;
9a29161f MC	126	}
9a29161f MC	127
436a2cd1	128	//Remove comments
30c006fd	129	size_t comment = possible_command.find_first_of(";(");
adf89655 JM	130	if( comment != string::npos ) {
	131	possible_command = possible_command.substr(0, comment);
	132	}
436a2cd1	133
62567509 MC	134	//If checksum passes then process message, else request resend
62567509 MC	135	int nextline = currentline + 1;
adf89655	136	if( cs == 0x00 && ln == nextline ) {
f337d8fd	137	if( first_char == 'N' ) {
534e17b9	138	currentline = nextline;
f337d8fd MC	139	}
f337d8fd MC	140
0b88bf55	141	bool sent_ok= false; // used for G1 optimization
d6190d18	142	while(possible_command.size() > 0) {
49d2ca86 JM	143	// assumes G or M are always the first on the line
49d2ca86 JM	144	size_t nextcmd = possible_command.find_first_of("GM", 2);
d6190d18	145	string single_command;
85bb8e89	146	if(nextcmd == string::npos) {
d6190d18 MC	147	single_command = possible_command;
d6190d18 MC	148	possible_command = "";
adf89655 JM	149	} else {
adf89655 JM	150	single_command = possible_command.substr(0, nextcmd);
2c4285ec	151	possible_command = possible_command.substr(nextcmd);
d6190d18	152	}
702023f3	153
b375ba1d	154
bb270b88 JM	155	if(!uploading \|\| upload_stream != new_message.stream) {
bb270b88 JM	156	// Prepare gcode for dispatch
adf89655	157	Gcode *gcode = new Gcode(single_command, new_message.stream);
c4c70e85	158
73706276	159	if(THEKERNEL->is_halted()) {
4fb7087f	160	// we ignore all commands until M999, unless it is in the exceptions list (like M105 get temp)
b375ba1d	161	if(gcode->has_m && gcode->m == 999) {
b9ad75de JM	162	if(THEKERNEL->is_halted()) {
	163	THEKERNEL->call_event(ON_HALT, (void *)1); // clears on_halt
	164	new_message.stream->printf("WARNING: After HALT you should HOME as position is currently unknown\n");
	165	}
	166	new_message.stream->printf("ok\n");
	167	delete gcode;
0b88bf55	168	return;
4fb7087f JM	169
4fb7087f JM	170	}else if(!is_allowed_mcode(gcode->m)) {
76217df5	171	// ignore everything, return error string to host
6c0193b3	172	if(THEKERNEL->is_grbl_mode()) {
07186543	173	new_message.stream->printf("error:Alarm lock\n");
6c0193b3 JM	174
	175	}else{
	176	new_message.stream->printf("!!\r\n");
	177	}
76217df5	178	delete gcode;
1fc40bdc	179	return;
b375ba1d	180	}
b375ba1d JM	181	}
b375ba1d JM	182
c2885de8	183	if(gcode->has_g) {
00e607c7 JM	184	if(gcode->g == 53) { // G53 makes next movement command use machine coordinates
00e607c7 JM	185	// this is ugly to implement as there may or may not be a G0/G1 on the same line
a3be54e3	186	// valid version seem to include G53 G0 X1 Y2 Z3 G53 X1 Y2
00e607c7	187	if(possible_command.empty()) {
5d2319a9	188	// use last gcode G1 or G0 if none on the line, and pass through as if it was a G0/G1
ae7c4219 JM	189	// TODO it is really an error if the last is not G0 thru G3
ae7c4219 JM	190	if(modal_group_1 > 3) {
5d2319a9 JM	191	delete gcode;
	192	new_message.stream->printf("ok - Invalid G53\r\n");
	193	return;
	194	}
	195	// use last G0 or G1
ae7c4219	196	gcode->g= modal_group_1;
00e607c7 JM	197
	198	}else{
	199	delete gcode;
	200	// extract next G0/G1 from the rest of the line, ignore if it is not one of these
	201	gcode = new Gcode(possible_command, new_message.stream);
5d2319a9	202	possible_command= "";
00e607c7 JM	203	if(!gcode->has_g \|\| gcode->g > 1) {
	204	// not G0 or G1 so ignore it as it is invalid
	205	delete gcode;
	206	new_message.stream->printf("ok - Invalid G53\r\n");
	207	return;
	208	}
	209	}
	210	// makes it handle the parameters as a machine position
c8bac202	211	THEROBOT->next_command_is_MCS= true;
5d2319a9	212
0b88bf55 JM	213	} else if(gcode->g == 1) {
	214	// optimize G1 to send ok immediately (one per line) before it is planned
	215	if(!sent_ok) {
	216	sent_ok= true;
	217	new_message.stream->printf("ok\n");
	218	}
00e607c7	219	}
5d2319a9	220
ae7c4219 JM	221	// remember last modal group 1 code
	222	if(gcode->g < 4) {
	223	modal_group_1= gcode->g;
	224	}
c2885de8	225	}
b375ba1d	226
adf89655 JM	227	if(gcode->has_m) {
	228	switch (gcode->m) {
	229	case 28: // start upload command
	230	delete gcode;
	231
	232	this->upload_filename = "/sd/" + single_command.substr(4); // rest of line is filename
	233	// open file
	234	upload_fd = fopen(this->upload_filename.c_str(), "w");
	235	if(upload_fd != NULL) {
	236	this->uploading = true;
6d91d256	237	new_message.stream->printf("Writing to file: %s\r\nok\r\n", this->upload_filename.c_str());
adf89655	238	} else {
6d91d256	239	new_message.stream->printf("open failed, File: %s.\r\nok\r\n", this->upload_filename.c_str());
adf89655	240	}
bb270b88 JM	241
	242	// only save stuff from this stream
	243	upload_stream= new_message.stream;
	244
adf89655 JM	245	//printf("Start Uploading file: %s, %p\n", upload_filename.c_str(), upload_fd);
	246	continue;
	247
01a8d21a JM	248	case 30: // end of program
	249	if(!THEKERNEL->is_grbl_mode()) break; // Special case M30 as it is also delete sd card file so only do this if in grbl mode
	250	// fall through to M2
	251	case 2:
8ad60a4c JM	252	{
	253	modal_group_1= 1; // set to G1
	254	// issue M5 and M9 in case spindle and coolant are being used
	255	Gcode gc1("M5", &StreamOutput::NullStream);
	256	THEKERNEL->call_event(ON_GCODE_RECEIVED, &gc1);
	257	Gcode gc2("M9", &StreamOutput::NullStream);
	258	THEKERNEL->call_event(ON_GCODE_RECEIVED, &gc2);
	259	}
	260	break;
	261
17704c93	262	case 112: // emergency stop, do the best we can with this
e714bd32	263	// this is also handled out-of-band (it is now with ^X in the serial driver)
b375ba1d	264	// disables heaters and motors, ignores further incoming Gcode and clears block queue
728477c4	265	THEKERNEL->call_event(ON_HALT, nullptr);
e714bd32	266	THEKERNEL->streams->printf("ok Emergency Stop Requested - reset or M999 required to exit HALT state\r\n");
b375ba1d	267	delete gcode;
17704c93 JM	268	return;
17704c93 JM	269
927cd05f	270	case 115: { // M115 Get firmware version and capabilities
620b6dff RW	271	Version vers;
620b6dff RW	272
27fdf020	273	new_message.stream->printf("FIRMWARE_NAME:Smoothieware, FIRMWARE_URL:http%%3A//smoothieware.org, X-SOURCE_CODE_URL:https://github.com/Smoothieware/Smoothieware, FIRMWARE_VERSION:%s, X-FIRMWARE_BUILD_DATE:%s, X-SYSTEM_CLOCK:%ldMHz, X-AXES:%d", vers.get_build(), vers.get_build_date(), SystemCoreClock / 1000000, MAX_ROBOT_ACTUATORS);
620b6dff RW	274
620b6dff RW	275	#ifdef CNC
27fdf020	276	new_message.stream->printf(", X-CNC:1");
620b6dff	277	#else
27fdf020	278	new_message.stream->printf(", X-CNC:0");
620b6dff RW	279	#endif
	280
	281	#ifdef DISABLEMSD
27fdf020	282	new_message.stream->printf(", X-MSD:0");
620b6dff	283	#else
27fdf020	284	new_message.stream->printf(", X-MSD:1");
620b6dff RW	285	#endif
620b6dff RW	286
27fdf020	287	new_message.stream->printf("\nok\n");
620b6dff	288	return;
927cd05f	289	}
620b6dff	290
c89338bd JM	291	case 117: // M117 is a special non compliant Gcode as it allows arbitrary text on the line following the command
	292	{ // concatenate the command again and send to panel if enabled
	293	string str= single_command.substr(4) + possible_command;
	294	PublicData::set_value( panel_checksum, panel_display_message_checksum, &str );
	295	delete gcode;
	296	new_message.stream->printf("ok\r\n");
	297	return;
	298	}
	299
e714bd32	300	case 1000: // M1000 is a special command that will pass thru the raw lowercased command to the simpleshell (for hosts that do not allow such things)
5c051155 JM	301	{
	302	// reconstruct entire command line again
	303	string str= single_command.substr(5) + possible_command;
	304	while(is_whitespace(str.front())){ str= str.substr(1); } // strip leading whitespace
	305
	306	delete gcode;
	307
	308	if(str.empty()) {
	309	SimpleShell::parse_command("help", "", new_message.stream);
	310
	311	}else{
	312	string args= lc(str);
	313	string cmd = shift_parameter(args);
	314	// find command and execute it
	315	if(!SimpleShell::parse_command(cmd.c_str(), args, new_message.stream)) {
	316	new_message.stream->printf("Command not found: %s\n", cmd.c_str());
	317	}
	318	}
	319
	320	new_message.stream->printf("ok\r\n");
	321	return;
	322	}
	323
adf89655	324	case 500: // M500 save volatile settings to config-override
04782655	325	THEKERNEL->conveyor->wait_for_idle(); //just to be safe as it can take a while to run
c4d4e3f8	326	//remove(THEKERNEL->config_override_filename()); // seems to cause a hang every now and then
5534e39e	327	__disable_irq();
c4d4e3f8 JM	328	{
	329	FileStream fs(THEKERNEL->config_override_filename());
	330	fs.printf("; DO NOT EDIT THIS FILE\n");
	331	// this also will truncate the existing file instead of deleting it
	332	}
f2f0dfed	333	// replace stream with one that writes to config-override file
825f27de	334	gcode->stream = new AppendFileStream(THEKERNEL->config_override_filename());
adf89655	335	// dispatch the M500 here so we can free up the stream when done
314ab8f7	336	THEKERNEL->call_event(ON_GCODE_RECEIVED, gcode );
adf89655 JM	337	delete gcode->stream;
adf89655 JM	338	delete gcode;
5534e39e	339	__enable_irq();
347854ff	340	new_message.stream->printf("Settings Stored to %s\r\nok\r\n", THEKERNEL->config_override_filename());
adf89655 JM	341	continue;
adf89655 JM	342
c0b50fa8 JM	343	case 501: // load config override
	344	case 504: // save to specific config override file
	345	{
	346	string arg= get_arguments(single_command + possible_command); // rest of line is filename
	347	if(arg.empty()) arg= "/sd/config-override";
	348	else arg= "/sd/config-override." + arg;
b95ebd3a	349	//new_message.stream->printf("args: <%s>\n", arg.c_str());
c0b50fa8 JM	350	SimpleShell::parse_command((gcode->m == 501) ? "load_command" : "save_command", arg, new_message.stream);
	351	}
	352	delete gcode;
	353	new_message.stream->printf("ok\r\n");
	354	return;
	355
618c9b0f	356	case 502: // M502 deletes config-override so everything defaults to what is in config
347854ff	357	remove(THEKERNEL->config_override_filename());
adf89655	358	delete gcode;
5534e39e	359	new_message.stream->printf("config override file deleted %s, reboot needed\r\nok\r\n", THEKERNEL->config_override_filename());
adf89655 JM	360	continue;
	361
	362	case 503: { // M503 display live settings and indicates if there is an override file
347854ff	363	FILE *fd = fopen(THEKERNEL->config_override_filename(), "r");
adf89655 JM	364	if(fd != NULL) {
adf89655 JM	365	fclose(fd);
347854ff	366	new_message.stream->printf("; config override present: %s\n", THEKERNEL->config_override_filename());
adf89655 JM	367
	368	} else {
	369	new_message.stream->printf("; No config override\n");
	370	}
08d9afc6	371	gcode->add_nl= true;
618c9b0f	372	break; // fall through to process by modules
adf89655	373	}
c0b50fa8	374
44e8c359	375	}
33e4cc02 JM	376	}
	377
	378	//printf("dispatch %p: '%s' G%d M%d...", gcode, gcode->command.c_str(), gcode->g, gcode->m);
44e8c359	379	//Dispatch message!
314ab8f7	380	THEKERNEL->call_event(ON_GCODE_RECEIVED, gcode );
44e8c359	381
166836be JM	382	if (gcode->is_error) {
	383	// report error
	384	if(THEKERNEL->is_grbl_mode()) {
1fc40bdc	385	new_message.stream->printf("error:");
166836be	386	}else{
8e777b5f	387	new_message.stream->printf("Error: ");
166836be JM	388	}
	389
	390	if(!gcode->txt_after_ok.empty()) {
	391	new_message.stream->printf("%s\r\n", gcode->txt_after_ok.c_str());
	392	gcode->txt_after_ok.clear();
	393
	394	}else{
	395	new_message.stream->printf("unknown\r\n");
	396	}
	397
50cb3c04 JM	398	// we cannot continue safely after an error so we enter HALT state
	399	new_message.stream->printf("Entering Alarm/Halt state\n");
	400	THEKERNEL->call_event(ON_HALT, nullptr);
	401
0b88bf55	402	}else if(!sent_ok) {
166836be JM	403
	404	if(gcode->add_nl)
	405	new_message.stream->printf("\r\n");
	406
	407	if(!gcode->txt_after_ok.empty()) {
	408	new_message.stream->printf("ok %s\r\n", gcode->txt_after_ok.c_str());
	409	gcode->txt_after_ok.clear();
05cdadd6	410
05cdadd6	411	} else {
166836be JM	412	if(THEKERNEL->is_ok_per_line() \|\| THEKERNEL->is_grbl_mode()) {
	413	// only send ok once per line if this is a multi g code line send ok on the last one
	414	if(possible_command.empty())
	415	new_message.stream->printf("ok\r\n");
	416	} else {
	417	// maybe should do the above for all hosts?
	418	new_message.stream->printf("ok\r\n");
	419	}
05cdadd6 JM	420	}
05cdadd6 JM	421	}
44e8c359 JM	422
	423	delete gcode;
	424
adf89655	425	} else {
bb270b88	426	// we are uploading and it is the upload stream so so save it
44e8c359 JM	427	if(single_command.substr(0, 3) == "M29") {
	428	// done uploading, close file
	429	fclose(upload_fd);
adf89655 JM	430	upload_fd = NULL;
adf89655 JM	431	uploading = false;
44e8c359	432	upload_filename.clear();
bb270b88	433	upload_stream= nullptr;
6d91d256	434	new_message.stream->printf("Done saving file.\r\nok\r\n");
44e8c359 JM	435	continue;
44e8c359 JM	436	}
adf89655	437
44e8c359 JM	438	if(upload_fd == NULL) {
	439	// error detected writing to file so discard everything until it stops
	440	new_message.stream->printf("ok\r\n");
	441	continue;
	442	}
adf89655	443
44e8c359	444	single_command.append("\n");
44e8c359 JM	445	if(fwrite(single_command.c_str(), 1, single_command.size(), upload_fd) != single_command.size()) {
	446	// error writing to file
	447	new_message.stream->printf("Error:error writing to file.\r\n");
	448	fclose(upload_fd);
adf89655	449	upload_fd = NULL;
44e8c359	450	continue;
adf89655 JM	451
adf89655 JM	452	} else {
ed5e53ce	453	new_message.stream->printf("ok\r\n");
44e8c359 JM	454	//printf("uploading file write ok\n");
	455	}
	456	}
d6190d18	457	}
adf89655 JM	458
adf89655 JM	459	} else {
62567509	460	//Request resend
f337d8fd	461	new_message.stream->printf("rs N%d\r\n", nextline);
62567509	462	}
2bb8b390	463
c2885de8	464	} else if( (n=possible_command.find_first_of("XYZF")) == 0 \|\| (first_char == ' ' && n != string::npos) ) {
ae7c4219	465	// handle pycam syntax, use last modal group 1 command and resubmit if an X Y Z or F is found on its own line
c2885de8	466	char buf[6];
ae7c4219	467	snprintf(buf, sizeof(buf), "G%d ", modal_group_1);
c2885de8 JM	468	possible_command.insert(0, buf);
	469	goto try_again;
	470
adf89655	471	} else if ( first_char == ';' \|\| first_char == '(' \|\| first_char == ' ' \|\| first_char == '\n' \|\| first_char == '\r' ) {
b741188b JM	472	// Ignore comments and blank lines
	473	new_message.stream->printf("ok\n");
	474
	475	} else {
	476	// an uppercase non command word on its own (except XYZF) just returns ok, we could add an error but no hosts expect that.
	477	new_message.stream->printf("ok - ignored\n");
4cff3ded AW	478	}
	479	}
	480