63 lines
2.3 KiB
C
63 lines
2.3 KiB
C
/*
|
|
protocol.h - controls Grbl execution protocol and procedures
|
|
Part of Grbl v0.9
|
|
|
|
Copyright (c) 2012-2014 Sungeun K. Jeon
|
|
|
|
Grbl 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.
|
|
|
|
Grbl 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 Grbl. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
/*
|
|
This file is based on work from Grbl v0.8, distributed under the
|
|
terms of the MIT-license. See COPYING for more details.
|
|
Copyright (c) 2009-2011 Simen Svale Skogsrud
|
|
Copyright (c) 2011-2012 Sungeun K. Jeon
|
|
*/
|
|
|
|
#ifndef protocol_h
|
|
#define protocol_h
|
|
|
|
// Line buffer size from the serial input stream to be executed.
|
|
// NOTE: Not a problem except for extreme cases, but the line buffer size can be too small
|
|
// and g-code blocks can get truncated. Officially, the g-code standards support up to 256
|
|
// characters. In future versions, this will be increased, when we know how much extra
|
|
// memory space we can invest into here or we re-write the g-code parser not to have this
|
|
// buffer.
|
|
#ifndef LINE_BUFFER_SIZE
|
|
#define LINE_BUFFER_SIZE 80
|
|
#endif
|
|
|
|
// Starts Grbl main loop. It handles all incoming characters from the serial port and executes
|
|
// them as they complete. It is also responsible for finishing the initialization procedures.
|
|
void protocol_main_loop();
|
|
|
|
// Checks and executes a runtime command at various stop points in main program
|
|
void protocol_execute_runtime();
|
|
|
|
// Notify the stepper subsystem to start executing the g-code program in buffer.
|
|
// void protocol_cycle_start();
|
|
|
|
// Reinitializes the buffer after a feed hold for a resume.
|
|
// void protocol_cycle_reinitialize();
|
|
|
|
// Initiates a feed hold of the running program
|
|
// void protocol_feed_hold();
|
|
|
|
// Executes the auto cycle feature, if enabled.
|
|
void protocol_auto_cycle_start();
|
|
|
|
// Block until all buffered steps are executed
|
|
void protocol_buffer_synchronize();
|
|
|
|
#endif
|