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/>.
8 #include "libs/Module.h"
9 #include "libs/Kernel.h"
10 #include "libs/nuts_bolts.h"
18 #include "../communication/utils/Gcode.h"
22 clear_vector(this->steps
);
25 void Block::debug(Kernel
* kernel
){
26 kernel
->serial
->printf(" steps:%4d|%4d|%4d(max:%4d) nominal:r%10d/s%6.1f mm:%9.6f rdelta:%8d acc:%5d dec:%5d rates:%10d>%10d \r\n", this->steps
[0], this->steps
[1], this->steps
[2], this->steps_event_count
, this->nominal_rate
, this->nominal_speed
, this->millimeters
, this->rate_delta
, this->accelerate_until
, this->decelerate_after
, this->initial_rate
, this->final_rate
);
30 // Calculate a braking factor to reach baseline speed which is max_jerk/2, e.g. the
31 // speed under which you cannot exceed max_jerk no matter what you do.
32 double Block::compute_factor_for_safe_speed(){
33 return( this->planner
->max_jerk
/ this->nominal_speed
);
37 // Calculates trapezoid parameters so that the entry- and exit-speed is compensated by the provided factors.
38 // The factors represent a factor of braking and must be in the range 0.0-1.0.
39 // +--------+ <- nominal_rate
41 // nominal_rate*entry_factor -> + \
42 // | + <- nominal_rate*exit_factor
45 void Block::calculate_trapezoid( double entryfactor
, double exitfactor
){
46 this->initial_rate
= ceil(this->nominal_rate
* entryfactor
); // (step/min)
47 this->final_rate
= ceil(this->nominal_rate
* exitfactor
); // (step/min)
48 double acceleration_per_minute
= this->rate_delta
* this->planner
->kernel
->stepper
->acceleration_ticks_per_second
* 60.0;
49 int accelerate_steps
= ceil( this->estimate_acceleration_distance( this->initial_rate
, this->nominal_rate
, acceleration_per_minute
) );
50 int decelerate_steps
= ceil( this->estimate_acceleration_distance( this->nominal_rate
, this->final_rate
, -acceleration_per_minute
) );
52 // Calculate the size of Plateau of Nominal Rate.
53 int plateau_steps
= this->steps_event_count
-accelerate_steps
-decelerate_steps
;
55 // Is the Plateau of Nominal Rate smaller than nothing? That means no cruising, and we will
56 // have to use intersection_distance() to calculate when to abort acceleration and start braking
57 // in order to reach the final_rate exactly at the end of this block.
58 if (plateau_steps
< 0) {
59 accelerate_steps
= ceil(this->intersection_distance(this->initial_rate
, this->final_rate
, acceleration_per_minute
, this->steps_event_count
));
60 accelerate_steps
= max( accelerate_steps
, 0 ); // Check limits due to numerical round-off
61 accelerate_steps
= min( accelerate_steps
, int(this->steps_event_count
) );
65 this->accelerate_until
= accelerate_steps
;
66 this->decelerate_after
= accelerate_steps
+plateau_steps
;
70 // Calculates the distance (not time) it takes to accelerate from initial_rate to target_rate using the
71 // given acceleration:
72 double Block::estimate_acceleration_distance(double initialrate
, double targetrate
, double acceleration
) {
73 return( (targetrate
*targetrate
-initialrate
*initialrate
)/(2L*acceleration
));
76 // This function gives you the point at which you must start braking (at the rate of -acceleration) if
77 // you started at speed initial_rate and accelerated until this point and want to end at the final_rate after
78 // a total travel of distance. This can be used to compute the intersection point between acceleration and
79 // deceleration in the cases where the trapezoid has no plateau (i.e. never reaches maximum speed)
81 /* + <- some maximum rate we don't care about
86 initial_rate -> +----+--+
89 intersection_distance distance */
90 double Block::intersection_distance(double initialrate
, double finalrate
, double acceleration
, double distance
) {
91 return((2*acceleration
*distance
-initialrate
*initialrate
+finalrate
*finalrate
)/(4*acceleration
));
94 // Calculates the maximum allowable speed at this point when you must be able to reach target_velocity using the
95 // acceleration within the allotted distance.
96 inline double max_allowable_speed(double acceleration
, double target_velocity
, double distance
) {
98 sqrt(target_velocity
*target_velocity
-2L*acceleration
*60*60*distance
) //Was acceleration*60*60*distance, in case this breaks, but here we prefer to use seconds instead of minutes
103 // Called by Planner::recalculate() when scanning the plan from last to first entry.
104 void Block::reverse_pass(Block
* next
, Block
* previous
){
107 // If entry speed is already at the maximum entry speed, no need to recheck. Block is cruising.
108 // If not, block in state of acceleration or deceleration. Reset entry speed to maximum and
109 // check for maximum allowable speed reductions to ensure maximum possible planned speed.
110 if (this->entry_speed
!= this->max_entry_speed
) {
112 // If nominal length true, max junction speed is guaranteed to be reached. Only compute
113 // for max allowable speed if block is decelerating and nominal length is false.
114 if ((!this->nominal_length_flag
) && (this->max_entry_speed
> next
->entry_speed
)) {
115 this->entry_speed
= min( this->max_entry_speed
, max_allowable_speed(-this->planner
->acceleration
,next
->entry_speed
,this->millimeters
));
117 this->entry_speed
= this->max_entry_speed
;
119 this->recalculate_flag
= true;
122 } // Skip last block. Already initialized and set for recalculation.
127 // Called by Planner::recalculate() when scanning the plan from first to last entry.
128 void Block::forward_pass(Block
* previous
, Block
* next
){
130 if(!previous
) { return; } // Begin planning after buffer_tail
132 // If the previous block is an acceleration block, but it is not long enough to complete the
133 // full speed change within the block, we need to adjust the entry speed accordingly. Entry
134 // speeds have already been reset, maximized, and reverse planned by reverse planner.
135 // If nominal length is true, max junction speed is guaranteed to be reached. No need to recheck.
136 if (!previous
->nominal_length_flag
) {
137 if (previous
->entry_speed
< this->entry_speed
) {
138 double entry_speed
= min( this->entry_speed
,
139 max_allowable_speed(-this->planner
->acceleration
,previous
->entry_speed
,previous
->millimeters
) );
141 // Check for junction speed change
142 if (this->entry_speed
!= entry_speed
) {
143 this->entry_speed
= entry_speed
;
144 this->recalculate_flag
= true;
152 // Gcodes are attached to their respective blocks so that on_gcode_execute can be called with it
153 void Block::append_gcode(Gcode
* gcode
){
154 this->commands
.insert(this->commands
.begin(),gcode
->command
);
157 // The attached gcodes are then poped and the on_gcode_execute event is called with them as a parameter
158 void Block::pop_and_execute_gcode(Kernel
* &kernel
){
159 for(unsigned short index
=0; index
<this->commands
.size(); index
++){
160 string command
= this->commands
.at(index
);
161 Gcode gcode
= Gcode();
162 gcode
.command
= command
;
163 kernel
->call_event(ON_GCODE_EXECUTE
, &gcode
);