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.
5 You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
10 #include "libs/Kernel.h"
12 #include "libs/nuts_bolts.h"
13 #include "libs/utils.h"
14 #include "SerialConsole.h"
15 #include "libs/SerialMessage.h"
16 #include "libs/StreamOutputPool.h"
17 #include "libs/StreamOutput.h"
19 #include "checksumm.h"
21 #include "ConfigValue.h"
24 #include "modules/robot/Conveyor.h"
25 #include "DirHandle.h"
26 #include "PublicDataRequest.h"
27 #include "PublicData.h"
28 #include "PlayerPublicAccess.h"
29 #include "TemperatureControlPublicAccess.h"
30 #include "TemperatureControlPool.h"
31 #include "ExtruderPublicAccess.h"
39 #define on_boot_gcode_checksum CHECKSUM("on_boot_gcode")
40 #define on_boot_gcode_enable_checksum CHECKSUM("on_boot_gcode_enable")
41 #define after_suspend_gcode_checksum CHECKSUM("after_suspend_gcode")
42 #define before_resume_gcode_checksum CHECKSUM("before_resume_gcode")
43 #define leave_heaters_on_suspend_checksum CHECKSUM("leave_heaters_on_suspend")
49 this->playing_file
= false;
50 this->current_file_handler
= nullptr;
52 this->elapsed_secs
= 0;
53 this->reply_stream
= nullptr;
54 this->suspended
= false;
55 this->suspend_loops
= 0;
58 void Player::on_module_loaded()
60 this->register_for_event(ON_CONSOLE_LINE_RECEIVED
);
61 this->register_for_event(ON_MAIN_LOOP
);
62 this->register_for_event(ON_SECOND_TICK
);
63 this->register_for_event(ON_GET_PUBLIC_DATA
);
64 this->register_for_event(ON_SET_PUBLIC_DATA
);
65 this->register_for_event(ON_GCODE_RECEIVED
);
67 this->on_boot_gcode
= THEKERNEL
->config
->value(on_boot_gcode_checksum
)->by_default("/sd/on_boot.gcode")->as_string();
68 this->on_boot_gcode_enable
= THEKERNEL
->config
->value(on_boot_gcode_enable_checksum
)->by_default(true)->as_bool();
70 this->after_suspend_gcode
= THEKERNEL
->config
->value(after_suspend_gcode_checksum
)->by_default("")->as_string();
71 this->before_resume_gcode
= THEKERNEL
->config
->value(before_resume_gcode_checksum
)->by_default("")->as_string();
72 std::replace( this->after_suspend_gcode
.begin(), this->after_suspend_gcode
.end(), '_', ' '); // replace _ with space
73 std::replace( this->before_resume_gcode
.begin(), this->before_resume_gcode
.end(), '_', ' '); // replace _ with space
74 this->leave_heaters_on
= THEKERNEL
->config
->value(leave_heaters_on_suspend_checksum
)->by_default(false)->as_bool();
77 void Player::on_second_tick(void *)
79 if(this->playing_file
) this->elapsed_secs
++;
82 // extract any options found on line, terminates args at the space before the first option (-v)
83 // eg this is a file.gcode -v
84 // will return -v and set args to this is a file.gcode
85 string
Player::extract_options(string
& args
)
88 size_t pos
= args
.find(" -");
89 if(pos
!= string::npos
) {
90 opts
= args
.substr(pos
);
91 args
= args
.substr(0, pos
);
97 void Player::on_gcode_received(void *argument
)
99 Gcode
*gcode
= static_cast<Gcode
*>(argument
);
100 string args
= get_arguments(gcode
->get_command());
102 if (gcode
->m
== 21) { // Dummy code; makes Octoprint happy -- supposed to initialize SD card
104 gcode
->stream
->printf("SD card ok\r\n");
106 } else if (gcode
->m
== 23) {
108 string filename_argument
= "/sd/" + args
; // filename is whatever is in args
109 this->current_stream
= &(StreamOutput::NullStream
);
111 // Prepare playing the file
112 if( !this->prepare_playing(filename_argument
) ){
113 gcode
->stream
->printf("file.open failed: %s\r\n", filename_argument
.c_str());
117 // Display information confirming the file was opened and selected
118 gcode
->stream
->printf("File opened:%s Size:%ld\r\n", this->filename
.c_str(), this->file_size
);
119 gcode
->stream
->printf("File selected\r\n");
121 } else if (gcode
->m
== 24) { // start print
122 if (this->current_file_handler
!= NULL
) {
123 this->playing_file
= true;
124 // this would be a problem if the stream goes away before the file has finished,
125 // so we attach it to the kernel stream, however network connections from pronterface
126 // do not connect to the kernel streams so won't see this FIXME
127 this->reply_stream
= THEKERNEL
->streams
;
130 } else if (gcode
->m
== 25) { // pause print
131 this->playing_file
= false;
133 } else if (gcode
->m
== 26) { // Reset print. Slightly different than M26 in Marlin and the rest
134 if(this->current_file_handler
!= NULL
) {
135 string currentfn
= this->filename
.c_str();
136 unsigned long old_size
= this->file_size
;
139 abort_command("", gcode
->stream
);
141 if(!currentfn
.empty()) {
142 // reload the last file opened
143 this->current_file_handler
= fopen(currentfn
.c_str() , "r");
145 if(this->current_file_handler
== NULL
) {
146 gcode
->stream
->printf("file.open failed: %s\r\n", currentfn
.c_str());
148 this->filename
= currentfn
;
149 this->file_size
= old_size
;
150 this->current_stream
= &(StreamOutput::NullStream
);
154 gcode
->stream
->printf("No file loaded\r\n");
157 } else if (gcode
->m
== 27) { // report print progress, in format used by Marlin
158 progress_command("-b", gcode
->stream
);
160 } else if (gcode
->m
== 32) { // select file and start print
162 string filename_argument
= "/sd/" + args
; // filename is whatever is in args including spaces
163 this->current_stream
= &(StreamOutput::NullStream
);
165 // Prepare playing the file
166 if( !this->prepare_playing(filename_argument
) ){
167 gcode
->stream
->printf("file.open failed: %s\r\n", filename_argument
.c_str());
171 // Actually start playing
172 this->playing_file
= true;
174 } else if (gcode
->m
== 600) { // suspend print, Not entirely Marlin compliant, M600.1 will leave the heaters on
175 this->suspend_command((gcode
->subcode
== 1)?"h":"", gcode
->stream
);
177 } else if (gcode
->m
== 601) { // resume print
178 this->resume_command("", gcode
->stream
);
181 }else if(gcode
->has_g
) {
182 if(gcode
->g
== 28) { // homing cancels suspend
183 if(this->suspended
) {
185 this->suspended
= false;
186 THEKERNEL
->robot
->pop_state();
187 this->saved_temperatures
.clear();
188 this->was_playing_file
= false;
189 this->suspend_loops
= 0;
195 bool Player::prepare_playing(string filename_argument
){
197 if(this->playing_file
|| this->suspended
) {
198 // If a file is already playing, we need to store it before trying to access a new one
199 this->file_stack
.push_back({ this->filename
, this->played_cnt
});
201 // Then close the file so the new one can be open
202 this->playing_file
= false;
206 fclose(this->current_file_handler
);
207 current_file_handler
= NULL
;
211 this->current_file_handler
= fopen( filename_argument
.c_str(), "r");
213 // If the file was open
214 if( this->current_file_handler
!= NULL
){
215 this->get_current_file_size(); // Get file size
216 this->filename
= filename_argument
; // Remember the filename
218 // Initialize counters
219 this->played_cnt
= 0;
220 this->elapsed_secs
= 0;
225 // If the file was not opened, we need to pop the stacked file from the stack if it exists
226 this->pop_file_from_stack();
232 bool Player::pop_file_from_stack(){
233 // If there is a file in the stack, pop it and resume playing it
234 if( this->file_stack
.empty() ){ return false; }
235 stacked_file file
= this->file_stack
.back();
236 this->file_stack
.pop_back();
239 this->current_file_handler
= fopen( file
.filename
.c_str(), "r");
241 // If the file was open
242 if( this->current_file_handler
!= NULL
){
243 this->get_current_file_size(); // Get file size
244 this->filename
= file
.filename
; // Remember the filename
245 this->played_cnt
= file
.position
; // Initialize counters
246 fseek( this->current_file_handler
, this->played_cnt
, SEEK_SET
); // Seek to the current position
247 this->playing_file
= true; // Resume playing
254 void Player::get_current_file_size(){
255 int result
= fseek(this->current_file_handler
, 0, SEEK_END
);
256 if (0 != result
) { this->file_size
= 0; } else {
257 this->file_size
= ftell(this->current_file_handler
);
258 fseek(this->current_file_handler
, 0, SEEK_SET
);
262 // When a new line is received, check if it is a command, and if it is, act upon it
263 void Player::on_console_line_received( void *argument
)
265 if(THEKERNEL
->is_halted()) return; // if in halted state ignore any commands
267 SerialMessage new_message
= *static_cast<SerialMessage
*>(argument
);
269 // ignore comments and blank lines and if this is a G code then also ignore it
270 char first_char
= new_message
.message
[0];
271 if(strchr(";( \n\rGMTN", first_char
) != NULL
) return;
273 string possible_command
= new_message
.message
;
274 string cmd
= shift_parameter(possible_command
);
276 //new_message.stream->printf("Received %s\r\n", possible_command.c_str());
278 // Act depending on command
280 this->play_command( possible_command
, new_message
.stream
);
281 }else if (cmd
== "progress"){
282 this->progress_command( possible_command
, new_message
.stream
);
283 }else if (cmd
== "abort") {
284 this->abort_command( possible_command
, new_message
.stream
);
285 }else if (cmd
== "suspend") {
286 this->suspend_command( possible_command
, new_message
.stream
);
287 }else if (cmd
== "resume") {
288 this->resume_command( possible_command
, new_message
.stream
);
292 // Play a gcode file by considering each line as if it was received on the serial console
293 void Player::play_command( string parameters
, StreamOutput
*stream
)
295 // extract any options from the line and terminate the line there
296 string options
= extract_options(parameters
);
297 // Get filename which is the entire parameter line upto any options found or entire line
298 string filename_argument
= absolute_from_relative(parameters
);
299 this->current_stream
= stream
;
301 // Prepare playing the file
302 if( !this->prepare_playing(filename_argument
) ){
303 stream
->printf("File not found: %s\r\n", filename_argument
.c_str());
307 // Output to the current stream if we were passed the -v ( verbose ) option
308 if( options
.find_first_of("Vv") == string::npos
) {
309 // If this is recursive playing, we need to inherit/preserve the original stream, otherwise, we indeed talk to a nullstream
310 if( this->file_stack
.size() == 0 ){
311 this->current_stream
= &(StreamOutput::NullStream
);
314 // we send to the kernels stream as it cannot go away
315 this->current_stream
= THEKERNEL
->streams
;
318 // Warn the user playing has begun
319 stream
->printf("Playing %s\r\n", this->filename
.c_str());
321 // Actually start playing the file
322 this->playing_file
= true;
325 void Player::progress_command( string parameters
, StreamOutput
*stream
)
329 string options
= shift_parameter( parameters
);
330 bool sdprinting
= options
.find_first_of("Bb") != string::npos
;
332 if(!playing_file
&& current_file_handler
!= NULL
) {
334 stream
->printf("SD printing byte %lu/%lu\r\n", played_cnt
, file_size
);
336 stream
->printf("SD print is paused at %lu/%lu\r\n", played_cnt
, file_size
);
339 } else if(!playing_file
) {
340 stream
->printf("Not currently playing\r\n");
345 unsigned long est
= 0;
346 if(this->elapsed_secs
> 10) {
347 unsigned long bytespersec
= played_cnt
/ this->elapsed_secs
;
349 est
= (file_size
- played_cnt
) / bytespersec
;
352 unsigned int pcnt
= (file_size
- (file_size
- played_cnt
)) * 100 / file_size
;
353 // If -b or -B is passed, report in the format used by Marlin and the others.
355 stream
->printf("file: %s, %u %% complete, elapsed time: %lu s", this->filename
.c_str(), pcnt
, this->elapsed_secs
);
357 stream
->printf(", est time: %lu s", est
);
359 stream
->printf("\r\n");
361 stream
->printf("SD printing byte %lu/%lu\r\n", played_cnt
, file_size
);
365 stream
->printf("File size is unknown\r\n");
369 void Player::abort_command( string parameters
, StreamOutput
*stream
)
371 if(!playing_file
&& current_file_handler
== NULL
) {
372 stream
->printf("Not currently playing\r\n");
376 playing_file
= false;
380 this->current_stream
= NULL
;
381 fclose(current_file_handler
);
382 current_file_handler
= NULL
;
383 if(parameters
.empty()) {
384 // clear out the block queue, will wait until queue is empty
385 // MUST be called in on_main_loop to make sure there are no blocked main loops waiting to put something on the queue
386 THEKERNEL
->conveyor
->flush_queue();
388 // now the position will think it is at the last received pos, so we need to do FK to get the actuator position and reset the current position
389 THEKERNEL
->robot
->reset_position_from_current_actuator_position();
391 stream
->printf("Aborted playing or paused file. Please turn any heaters off manually\r\n");
394 void Player::on_main_loop(void *argument
)
396 if(suspended
&& suspend_loops
> 0) {
397 // if we are suspended we need to allow main loop to cycle a few times then finish off the suspend processing
398 if(--suspend_loops
== 0) {
404 if( !this->booted
) {
406 if( this->on_boot_gcode_enable
) {
407 this->play_command(this->on_boot_gcode
, THEKERNEL
->serial
);
409 //THEKERNEL->serial->printf("On boot gcode disabled! skipping...\n");
413 if( this->playing_file
) {
414 if(THEKERNEL
->is_halted()) {
415 abort_command("1", &(StreamOutput::NullStream
));
419 char buf
[130]; // lines upto 128 characters are allowed, anything longer is discarded
420 bool discard
= false;
422 while(fgets(buf
, sizeof(buf
), this->current_file_handler
) != NULL
) {
423 int len
= strlen(buf
);
424 if(len
== 0) continue; // empty line? should not be possible
425 if(buf
[len
- 1] == '\n' || feof(this->current_file_handler
)) {
426 if(discard
) { // we are discarding a long line
430 if(len
== 1) continue; // empty line
432 this->current_stream
->printf("%s", buf
);
433 struct SerialMessage message
;
434 message
.message
= buf
;
435 message
.stream
= this->current_stream
;
437 // waits for the queue to have enough room
438 played_cnt
+= len
; // Recursive branch note : this might need to move up one line or we'd be looping the recursion over and over
439 THEKERNEL
->call_event(ON_CONSOLE_LINE_RECEIVED
, &message
);
440 return; // we feed one line per main loop
444 this->current_stream
->printf("Warning: Discarded long line\n");
449 if( this->pop_file_from_stack() ){
450 // A file was popped from the stack, we continue playing it
453 // There was no file in the stack, we are completely done playing
454 this->playing_file
= false;
458 fclose(this->current_file_handler
);
459 current_file_handler
= NULL
;
460 this->current_stream
= NULL
;
462 if(this->reply_stream
!= NULL
) {
463 // if we were printing from an M command from pronterface we need to send this back
464 this->reply_stream
->printf("Done printing file\r\n");
465 this->reply_stream
= NULL
;
472 void Player::on_get_public_data(void *argument
)
474 PublicDataRequest
*pdr
= static_cast<PublicDataRequest
*>(argument
);
476 if(!pdr
->starts_with(player_checksum
)) return;
478 if(pdr
->second_element_is(is_playing_checksum
) || pdr
->second_element_is(is_suspended_checksum
)) {
479 static bool bool_data
;
480 bool_data
= pdr
->second_element_is(is_playing_checksum
) ? this->playing_file
: this->suspended
;
481 pdr
->set_data_ptr(&bool_data
);
484 } else if(pdr
->second_element_is(get_progress_checksum
)) {
485 static struct pad_progress p
;
486 if(file_size
> 0 && playing_file
) {
487 p
.elapsed_secs
= this->elapsed_secs
;
488 p
.percent_complete
= (this->file_size
- (this->file_size
- this->played_cnt
)) * 100 / this->file_size
;
489 p
.filename
= this->filename
;
490 pdr
->set_data_ptr(&p
);
496 void Player::on_set_public_data(void *argument
)
498 PublicDataRequest
*pdr
= static_cast<PublicDataRequest
*>(argument
);
500 if(!pdr
->starts_with(player_checksum
)) return;
502 if(pdr
->second_element_is(abort_play_checksum
)) {
503 abort_command("", &(StreamOutput::NullStream
));
509 Suspend a print in progress
510 1. send pause to upstream host, or pause if printing from sd
511 1a. loop on_main_loop several times to clear any buffered commmands
512 2. wait for empty queue
513 3. save the current position, extruder position, temperatures - any state that would need to be restored
514 4. retract by specifed amount either on command line or in config
516 6. optionally run after_suspend gcode (either in config or on command line)
518 User may jog or remove and insert filament at this point, extruding or retracting as needed
521 void Player::suspend_command(string parameters
, StreamOutput
*stream
)
524 stream
->printf("Already suspended\n");
528 stream
->printf("Suspending print, waiting for queue to empty...\n");
530 // override the leave_heaters_on setting
531 this->override_leave_heaters_on
= (parameters
== "h");
534 if( this->playing_file
) {
536 this->playing_file
= false;
537 this->was_playing_file
= true;
539 // send pause to upstream host, we send it on all ports as we don't know which it is on
540 THEKERNEL
->streams
->printf("// action:pause\r\n");
541 this->was_playing_file
= false;
544 // we need to allow main loop to cycle a few times to clear any buffered commands in the serial streams etc
548 // this completes the suspend
549 void Player::suspend_part2()
551 // need to use streams here as the original stream may have changed
552 THEKERNEL
->streams
->printf("// Waiting for queue to empty (Host must stop sending)...\n");
553 // wait for queue to empty
554 THEKERNEL
->conveyor
->wait_for_empty_queue();
556 THEKERNEL
->streams
->printf("// Saving current state...\n");
558 // save current XYZ position
559 THEKERNEL
->robot
->get_axis_position(this->saved_position
);
561 // save current extruder state
562 PublicData::set_value( extruder_checksum
, save_state_checksum
, nullptr );
564 // save state use M120
565 THEKERNEL
->robot
->push_state();
567 // TODO retract by optional amount...
569 this->saved_temperatures
.clear();
570 if(!this->leave_heaters_on
&& !this->override_leave_heaters_on
) {
571 // save current temperatures, get a vector of all the controllers data
572 std::vector
<struct pad_temperature
> controllers
;
573 bool ok
= PublicData::get_value(temperature_control_checksum
, poll_controls_checksum
, &controllers
);
575 // query each heater and save the target temperature if on
576 for (auto &c
: controllers
) {
577 // TODO see if in exclude list
578 if(c
.target_temperature
> 0) {
579 this->saved_temperatures
[c
.id
]= c
.target_temperature
;
584 // turn off heaters that were on
585 for(auto& h
: this->saved_temperatures
) {
587 PublicData::set_value( temperature_control_checksum
, h
.first
, &t
);
591 // execute optional gcode if defined
592 if(!after_suspend_gcode
.empty()) {
593 struct SerialMessage message
;
594 message
.message
= after_suspend_gcode
;
595 message
.stream
= &(StreamOutput::NullStream
);
596 THEKERNEL
->call_event(ON_CONSOLE_LINE_RECEIVED
, &message
);
599 THEKERNEL
->streams
->printf("// Print Suspended, enter resume to continue printing\n");
603 resume the suspended print
604 1. restore the temperatures and wait for them to get up to temp
605 2. optionally run before_resume gcode if specified
606 3. restore the position it was at and E and any other saved state
607 4. resume sd print or send resume upstream
609 void Player::resume_command(string parameters
, StreamOutput
*stream
)
612 stream
->printf("Not suspended\n");
616 stream
->printf("resuming print...\n");
618 // wait for them to reach temp
619 if(!this->saved_temperatures
.empty()) {
620 // set heaters to saved temps
621 for(auto& h
: this->saved_temperatures
) {
623 PublicData::set_value( temperature_control_checksum
, h
.first
, &t
);
625 stream
->printf("Waiting for heaters...\n");
627 uint32_t tus
= us_ticker_read(); // mbed call
632 if((us_ticker_read() - tus
) >= 1000000) { // print every 1 second
634 tus
= us_ticker_read(); // mbed call
637 for(auto& h
: this->saved_temperatures
) {
638 struct pad_temperature temp
;
639 if(PublicData::get_value( temperature_control_checksum
, current_temperature_checksum
, h
.first
, &temp
)) {
641 stream
->printf("%s:%3.1f /%3.1f @%d ", temp
.designator
.c_str(), temp
.current_temperature
, ((temp
.target_temperature
== -1) ? 0.0 : temp
.target_temperature
), temp
.pwm
);
642 wait
= wait
|| (temp
.current_temperature
< h
.second
);
645 if(timeup
) stream
->printf("\n");
648 THEKERNEL
->call_event(ON_IDLE
, this);
650 if(THEKERNEL
->is_halted()) {
651 // abort temp wait and rest of resume
652 THEKERNEL
->streams
->printf("Resume aborted by kill\n");
653 THEKERNEL
->robot
->pop_state();
654 this->saved_temperatures
.clear();
661 // execute optional gcode if defined
662 if(!before_resume_gcode
.empty()) {
663 stream
->printf("Executing before resume gcode...\n");
664 struct SerialMessage message
;
665 message
.message
= before_resume_gcode
;
666 message
.stream
= &(StreamOutput::NullStream
);
667 THEKERNEL
->call_event(ON_CONSOLE_LINE_RECEIVED
, &message
);
671 stream
->printf("Restoring saved XYZ positions and state...\n");
672 THEKERNEL
->robot
->pop_state();
673 bool abs_mode
= THEKERNEL
->robot
->absolute_mode
; // what mode we were in
674 // force absolute mode for restoring position, then set to the saved relative/absolute mode
675 THEKERNEL
->robot
->absolute_mode
= true;
678 int n
= snprintf(buf
, sizeof(buf
), "G1 X%f Y%f Z%f", saved_position
[0], saved_position
[1], saved_position
[2]);
680 Gcode
gcode(g
, &(StreamOutput::NullStream
));
681 THEKERNEL
->call_event(ON_GCODE_RECEIVED
, &gcode
);
683 THEKERNEL
->robot
->absolute_mode
= abs_mode
;
685 // restore extruder state
686 PublicData::set_value( extruder_checksum
, restore_state_checksum
, nullptr );
688 stream
->printf("Resuming print\n");
690 if(this->was_playing_file
) {
691 this->playing_file
= true;
692 this->was_playing_file
= false;
694 // Send resume to host
695 THEKERNEL
->streams
->printf("// action:resume\r\n");
699 this->saved_temperatures
.clear();