Commit | Line | Data |
---|---|---|
df27a6a3 | 1 | /* |
5886a464 | 2 | This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl) with additions from Sungeun K. Jeon (https://github.com/chamnit/grbl) |
4cff3ded AW |
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. | |
df27a6a3 | 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 | */ |
7 | ||
8 | using namespace std; | |
9 | #include <vector> | |
4dc5513d MM |
10 | |
11 | #include "mri.h" | |
12 | #include "nuts_bolts.h" | |
13 | #include "RingBuffer.h" | |
14 | #include "Gcode.h" | |
15 | #include "Module.h" | |
16 | #include "Kernel.h" | |
4cff3ded AW |
17 | #include "Block.h" |
18 | #include "Planner.h" | |
3fceb8eb | 19 | #include "Conveyor.h" |
5673fe39 | 20 | #include "StepperMotor.h" |
61134a65 JM |
21 | #include "Config.h" |
22 | #include "checksumm.h" | |
23 | #include "Robot.h" | |
8d54c34c | 24 | #include "ConfigValue.h" |
61134a65 JM |
25 | |
26 | #include <math.h> | |
374d0777 | 27 | #include <algorithm> |
b66fb830 | 28 | |
8b69c90d | 29 | #define junction_deviation_checksum CHECKSUM("junction_deviation") |
44de6ef3 | 30 | #define z_junction_deviation_checksum CHECKSUM("z_junction_deviation") |
8b69c90d JM |
31 | #define minimum_planner_speed_checksum CHECKSUM("minimum_planner_speed") |
32 | ||
edac9072 AW |
33 | // The Planner does the acceleration math for the queue of Blocks ( movements ). |
34 | // It makes sure the speed stays within the configured constraints ( acceleration, junction_deviation, etc ) | |
35 | // It goes over the list in both direction, every time a block is added, re-doing the math to make sure everything is optimal | |
4cff3ded | 36 | |
1b5776bf JM |
37 | Planner::Planner() |
38 | { | |
29e809e0 | 39 | memset(this->previous_unit_vec, 0, sizeof this->previous_unit_vec); |
558e170c | 40 | config_load(); |
da24d6ae AW |
41 | } |
42 | ||
edac9072 | 43 | // Configure acceleration |
1b5776bf JM |
44 | void Planner::config_load() |
45 | { | |
44de6ef3 | 46 | this->junction_deviation = THEKERNEL->config->value(junction_deviation_checksum)->by_default(0.05F)->as_number(); |
29e809e0 | 47 | this->z_junction_deviation = THEKERNEL->config->value(z_junction_deviation_checksum)->by_default(NAN)->as_number(); // disabled by default |
c5fe1787 | 48 | this->minimum_planner_speed = THEKERNEL->config->value(minimum_planner_speed_checksum)->by_default(0.0f)->as_number(); |
4cff3ded AW |
49 | } |
50 | ||
da24d6ae | 51 | |
4cff3ded | 52 | // Append a block to the queue, compute it's speed factors |
e560f057 | 53 | bool Planner::append_block( ActuatorCoordinates &actuator_pos, uint8_t n_motors, float rate_mm_s, float distance, float *unit_vec, float acceleration, float s_value, bool g123) |
da947c62 | 54 | { |
edac9072 | 55 | // Create ( recycle ) a new block |
7baa50df | 56 | Block* block = THECONVEYOR->queue.head_ref(); |
aab6cbba AW |
57 | |
58 | // Direction bits | |
e560f057 | 59 | bool has_steps = false; |
374d0777 | 60 | for (size_t i = 0; i < n_motors; i++) { |
ad6a77d1 JM |
61 | int32_t steps = THEROBOT->actuators[i]->steps_to_target(actuator_pos[i]); |
62 | // Update current position | |
6f5d947f JM |
63 | if(steps != 0) { |
64 | THEROBOT->actuators[i]->update_last_milestones(actuator_pos[i], steps); | |
e560f057 | 65 | has_steps = true; |
6f5d947f | 66 | } |
1cf31736 | 67 | |
ad6a77d1 | 68 | // find direction |
558e170c | 69 | block->direction_bits[i] = (steps < 0) ? 1 : 0; |
ad6a77d1 | 70 | // save actual steps in block |
78d0e16a MM |
71 | block->steps[i] = labs(steps); |
72 | } | |
1cf31736 | 73 | |
e560f057 JM |
74 | // sometimes even though there is a detectable movement it turns out there are no steps to be had from such a small move |
75 | if(!has_steps) { | |
76 | block->clear(); | |
77 | return false; | |
78 | } | |
79 | ||
80 | // info needed by laser | |
5c749b4a | 81 | block->s_value = roundf(s_value*(1<<11)); // 1.11 fixed point |
e70b6417 | 82 | block->is_g123 = g123; |
6f5d947f | 83 | |
ad6a77d1 JM |
84 | // use default JD |
85 | float junction_deviation = this->junction_deviation; | |
44de6ef3 | 86 | |
f41bc212 | 87 | // use either regular junction deviation or z specific and see if a primary axis move |
e560f057 JM |
88 | block->primary_axis = true; |
89 | if(block->steps[ALPHA_STEPPER] == 0 && block->steps[BETA_STEPPER] == 0) { | |
f41bc212 JM |
90 | if(block->steps[GAMMA_STEPPER] != 0) { |
91 | // z only move | |
92 | if(!isnan(this->z_junction_deviation)) junction_deviation = this->z_junction_deviation; | |
492cadb7 | 93 | |
e560f057 | 94 | } else { |
f41bc212 | 95 | // is not a primary axis move |
492cadb7 JM |
96 | block->primary_axis= false; |
97 | #if N_PRIMARY_AXIS > 3 | |
98 | for (int i = 3; i < N_PRIMARY_AXIS; ++i) { | |
99 | if(block->steps[i] != 0){ | |
100 | block->primary_axis= true; | |
101 | break; | |
102 | } | |
103 | } | |
104 | #endif | |
105 | ||
f41bc212 | 106 | } |
c5fe1787 JM |
107 | } |
108 | ||
1b5776bf | 109 | block->acceleration = acceleration; // save in block |
4fdd2470 | 110 | |
4cff3ded | 111 | // Max number of steps, for all axes |
e560f057 | 112 | auto mi = std::max_element(block->steps.begin(), block->steps.end()); |
374d0777 | 113 | block->steps_event_count = *mi; |
4cff3ded | 114 | |
4cff3ded | 115 | block->millimeters = distance; |
aab6cbba | 116 | |
9db65137 | 117 | // Calculate speed in mm/sec for each axis. No divide by zero due to previous checks. |
1b5776bf | 118 | if( distance > 0.0F ) { |
da947c62 | 119 | block->nominal_speed = rate_mm_s; // (mm/s) Always > 0 |
1598a726 | 120 | block->nominal_rate = block->steps_event_count * rate_mm_s / distance; // (step/s) Always > 0 |
1b5776bf | 121 | } else { |
130275f1 MM |
122 | block->nominal_speed = 0.0F; |
123 | block->nominal_rate = 0; | |
436a2cd1 | 124 | } |
aab6cbba | 125 | |
4cff3ded AW |
126 | // Compute the acceleration rate for the trapezoid generator. Depending on the slope of the line |
127 | // average travel per step event changes. For a line along one axis the travel per step event | |
128 | // is equal to the travel/step in the particular axis. For a 45 degree line the steppers of both | |
129 | // axes might step for every step event. Travel per step event is then sqrt(travel_x^2+travel_y^2). | |
1cf31736 | 130 | |
aab6cbba AW |
131 | // Compute maximum allowable entry speed at junction by centripetal acceleration approximation. |
132 | // Let a circle be tangent to both previous and current path line segments, where the junction | |
133 | // deviation is defined as the distance from the junction to the closest edge of the circle, | |
134 | // colinear with the circle center. The circular segment joining the two paths represents the | |
135 | // path of centripetal acceleration. Solve for max velocity based on max acceleration about the | |
136 | // radius of the circle, defined indirectly by junction deviation. This may be also viewed as | |
137 | // path width or max_jerk in the previous grbl version. This approach does not actually deviate | |
138 | // from path, but used as a robust way to compute cornering speeds, as it takes into account the | |
139 | // nonlinearities of both the junction angle and junction velocity. | |
4dfd2dce JM |
140 | |
141 | // NOTE however it does not take into account independent axis, in most cartesian X and Y and Z are totally independent | |
142 | // and this allows one to stop with little to no decleration in many cases. This is particualrly bad on leadscrew based systems that will skip steps. | |
8b69c90d | 143 | float vmax_junction = minimum_planner_speed; // Set default max junction speed |
aab6cbba | 144 | |
29e809e0 | 145 | // if unit_vec was null then it was not a primary axis move so we skip the junction deviation stuff |
7baa50df | 146 | if (unit_vec != nullptr && !THECONVEYOR->is_queue_empty()) { |
e560f057 | 147 | Block *prev_block = THECONVEYOR->queue.item_ref(THECONVEYOR->queue.prev(THECONVEYOR->queue.head_i)); |
f41bc212 | 148 | float previous_nominal_speed = prev_block->primary_axis ? prev_block->nominal_speed : 0; |
e75b3def | 149 | |
29e809e0 | 150 | if (junction_deviation > 0.0F && previous_nominal_speed > 0.0F) { |
e75b3def MM |
151 | // Compute cosine of angle between previous and current path. (prev_unit_vec is negative) |
152 | // NOTE: Max junction velocity is computed without sin() or acos() by trig half angle identity. | |
153 | float cos_theta = - this->previous_unit_vec[X_AXIS] * unit_vec[X_AXIS] | |
1b5776bf | 154 | - this->previous_unit_vec[Y_AXIS] * unit_vec[Y_AXIS] |
b5bd71f8 JM |
155 | - this->previous_unit_vec[Z_AXIS] * unit_vec[Z_AXIS]; |
156 | #if N_PRIMARY_AXIS > 3 | |
157 | for (int i = 3; i < N_PRIMARY_AXIS; ++i) { | |
158 | cos_theta -= this->previous_unit_vec[i] * unit_vec[i]; | |
159 | } | |
160 | #endif | |
e75b3def MM |
161 | |
162 | // Skip and use default max junction speed for 0 degree acute junction. | |
163 | if (cos_theta < 0.95F) { | |
29e809e0 | 164 | vmax_junction = std::min(previous_nominal_speed, block->nominal_speed); |
e75b3def MM |
165 | // Skip and avoid divide by zero for straight junctions at 180 degrees. Limit to min() of nominal speeds. |
166 | if (cos_theta > -0.95F) { | |
167 | // Compute maximum junction velocity based on maximum acceleration and junction deviation | |
168 | float sin_theta_d2 = sqrtf(0.5F * (1.0F - cos_theta)); // Trig half angle identity. Always positive. | |
29e809e0 | 169 | vmax_junction = std::min(vmax_junction, sqrtf(acceleration * junction_deviation * sin_theta_d2 / (1.0F - sin_theta_d2))); |
e75b3def MM |
170 | } |
171 | } | |
aab6cbba | 172 | } |
4cff3ded | 173 | } |
aab6cbba | 174 | block->max_entry_speed = vmax_junction; |
1cf31736 | 175 | |
8b69c90d | 176 | // Initialize block entry speed. Compute based on deceleration to user-defined minimum_planner_speed. |
c9cc5e06 | 177 | float v_allowable = max_allowable_speed(-acceleration, minimum_planner_speed, block->millimeters); |
29e809e0 | 178 | block->entry_speed = std::min(vmax_junction, v_allowable); |
aab6cbba AW |
179 | |
180 | // Initialize planner efficiency flags | |
181 | // Set flag if block will always reach maximum junction speed regardless of entry/exit speeds. | |
182 | // If a block can de/ac-celerate from nominal speed to zero within the length of the block, then | |
183 | // the current block and next block junction speeds are guaranteed to always be at their maximum | |
184 | // junction speeds in deceleration and acceleration, respectively. This is due to how the current | |
185 | // block nominal speed limits both the current and next maximum junction speeds. Hence, in both | |
186 | // the reverse and forward planners, the corresponding block junction speed will always be at the | |
187 | // the maximum junction speed and may always be ignored for any speed reduction checks. | |
188 | if (block->nominal_speed <= v_allowable) { block->nominal_length_flag = true; } | |
189 | else { block->nominal_length_flag = false; } | |
2134bcf2 MM |
190 | |
191 | // Always calculate trapezoid for new block | |
192 | block->recalculate_flag = true; | |
1cf31736 | 193 | |
aab6cbba | 194 | // Update previous path unit_vector and nominal speed |
c8bac202 | 195 | if(unit_vec != nullptr) { |
ad6a77d1 | 196 | memcpy(previous_unit_vec, unit_vec, sizeof(previous_unit_vec)); // previous_unit_vec[] = unit_vec[] |
e560f057 | 197 | } else { |
ad6a77d1 | 198 | memset(previous_unit_vec, 0, sizeof(previous_unit_vec)); |
c8bac202 | 199 | } |
1cf31736 | 200 | |
df27a6a3 | 201 | // Math-heavy re-computing of the whole queue to take the new |
4cff3ded | 202 | this->recalculate(); |
1cf31736 | 203 | |
df27a6a3 | 204 | // The block can now be used |
433d636f | 205 | block->ready(); |
2134bcf2 | 206 | |
7baa50df | 207 | THECONVEYOR->queue_head_block(); |
6f5d947f JM |
208 | |
209 | return true; | |
4cff3ded AW |
210 | } |
211 | ||
1b5776bf JM |
212 | void Planner::recalculate() |
213 | { | |
7baa50df | 214 | Conveyor::Queue_t &queue = THECONVEYOR->queue; |
4dc5513d | 215 | |
a617ac35 | 216 | unsigned int block_index; |
4cff3ded | 217 | |
391bc610 MM |
218 | Block* previous; |
219 | Block* current; | |
391bc610 | 220 | |
a617ac35 MM |
221 | /* |
222 | * a newly added block is decel limited | |
223 | * | |
224 | * we find its max entry speed given its exit speed | |
225 | * | |
d30d9611 MM |
226 | * for each block, walking backwards in the queue: |
227 | * | |
a617ac35 MM |
228 | * if max entry speed == current entry speed |
229 | * then we can set recalculate to false, since clearly adding another block didn't allow us to enter faster | |
d30d9611 MM |
230 | * and thus we don't need to check entry speed for this block any more |
231 | * | |
232 | * once we find an accel limited block, we must find the max exit speed and walk the queue forwards | |
a617ac35 | 233 | * |
d30d9611 | 234 | * for each block, walking forwards in the queue: |
a617ac35 MM |
235 | * |
236 | * given the exit speed of the previous block and our own max entry speed | |
237 | * we can tell if we're accel or decel limited (or coasting) | |
238 | * | |
239 | * if prev_exit > max_entry | |
d30d9611 | 240 | * then we're still decel limited. update previous trapezoid with our max entry for prev exit |
a617ac35 | 241 | * if max_entry >= prev_exit |
d30d9611 | 242 | * then we're accel limited. set recalculate to false, work out max exit speed |
a617ac35 | 243 | * |
d30d9611 | 244 | * finally, work out trapezoid for the final (and newest) block. |
a617ac35 MM |
245 | */ |
246 | ||
247 | /* | |
248 | * Step 1: | |
249 | * For each block, given the exit speed and acceleration, find the maximum entry speed | |
250 | */ | |
251 | ||
252 | float entry_speed = minimum_planner_speed; | |
253 | ||
254 | block_index = queue.head_i; | |
255 | current = queue.item_ref(block_index); | |
256 | ||
1b5776bf JM |
257 | if (!queue.is_empty()) { |
258 | while ((block_index != queue.tail_i) && current->recalculate_flag) { | |
a617ac35 | 259 | entry_speed = current->reverse_pass(entry_speed); |
391bc610 | 260 | |
a617ac35 MM |
261 | block_index = queue.prev(block_index); |
262 | current = queue.item_ref(block_index); | |
2134bcf2 | 263 | } |
13e4a3f9 | 264 | |
d30d9611 MM |
265 | /* |
266 | * Step 2: | |
267 | * now current points to either tail or first non-recalculate block | |
268 | * and has not had its reverse_pass called | |
121844b7 | 269 | * or its calculate_trapezoid |
d30d9611 MM |
270 | * entry_speed is set to the *exit* speed of current. |
271 | * each block from current to head has its entry speed set to its max entry speed- limited by decel or nominal_rate | |
272 | */ | |
2134bcf2 | 273 | |
a617ac35 | 274 | float exit_speed = current->max_exit_speed(); |
4cff3ded | 275 | |
1b5776bf | 276 | while (block_index != queue.head_i) { |
a617ac35 MM |
277 | previous = current; |
278 | block_index = queue.next(block_index); | |
279 | current = queue.item_ref(block_index); | |
280 | ||
281 | // we pass the exit speed of the previous block | |
282 | // so this block can decide if it's accel or decel limited and update its fields as appropriate | |
283 | exit_speed = current->forward_pass(exit_speed); | |
2134bcf2 | 284 | |
a617ac35 MM |
285 | previous->calculate_trapezoid(previous->entry_speed, current->entry_speed); |
286 | } | |
4cff3ded | 287 | } |
a617ac35 | 288 | |
d30d9611 MM |
289 | /* |
290 | * Step 3: | |
291 | * work out trapezoid for final (and newest) block | |
292 | */ | |
293 | ||
a617ac35 MM |
294 | // now current points to the head item |
295 | // which has not had calculate_trapezoid run yet | |
296 | current->calculate_trapezoid(current->entry_speed, minimum_planner_speed); | |
4cff3ded | 297 | } |
aab6cbba | 298 | |
a617ac35 | 299 | |
aab6cbba AW |
300 | // Calculates the maximum allowable speed at this point when you must be able to reach target_velocity using the |
301 | // acceleration within the allotted distance. | |
1b5776bf JM |
302 | float Planner::max_allowable_speed(float acceleration, float target_velocity, float distance) |
303 | { | |
1598a726 JM |
304 | // Was acceleration*60*60*distance, in case this breaks, but here we prefer to use seconds instead of minutes |
305 | return(sqrtf(target_velocity * target_velocity - 2.0F * acceleration * distance)); | |
aab6cbba AW |
306 | } |
307 | ||
308 |