src/modules/robot/Planner.cpp

   1 /*
   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)
   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/>.
   6 */
   7
   8 using namespace std;
   9 #include <vector>
  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"
  17 #include "Block.h"
  18 #include "Planner.h"
  19 #include "Conveyor.h"
  20 #include "StepperMotor.h"
  21 #include "Config.h"
  22 #include "checksumm.h"
  23 #include "Robot.h"
  24 #include "Stepper.h"
  25 #include "ConfigValue.h"
  26
  27 #include <math.h>
  28
  29 #define acceleration_checksum          CHECKSUM("acceleration")
  30 #define z_acceleration_checksum        CHECKSUM("z_acceleration")
  31 #define junction_deviation_checksum    CHECKSUM("junction_deviation")
  32 #define z_junction_deviation_checksum  CHECKSUM("z_junction_deviation")
  33 #define minimum_planner_speed_checksum CHECKSUM("minimum_planner_speed")
  34
  35 // The Planner does the acceleration math for the queue of Blocks ( movements ).
  36 // It makes sure the speed stays within the configured constraints ( acceleration, junction_deviation, etc )
  37 // It goes over the list in both direction, every time a block is added, re-doing the math to make sure everything is optimal
  38
  39 Planner::Planner()
  40 {
  41     clear_vector_float(this->previous_unit_vec);
  42     config_load();
  43 }
  44
  45 // Configure acceleration
  46 void Planner::config_load()
  47 {
  48     this->acceleration = THEKERNEL->config->value(acceleration_checksum)->by_default(100.0F )->as_number(); // Acceleration is in mm/s^2
  49     this->z_acceleration = THEKERNEL->config->value(z_acceleration_checksum)->by_default(0.0F )->as_number(); // disabled by default
  50
  51     this->junction_deviation = THEKERNEL->config->value(junction_deviation_checksum)->by_default(0.05F)->as_number();
  52     this->z_junction_deviation = THEKERNEL->config->value(z_junction_deviation_checksum)->by_default(-1)->as_number(); // disabled by default
  53     this->minimum_planner_speed = THEKERNEL->config->value(minimum_planner_speed_checksum)->by_default(0.0f)->as_number();
  54 }
  55
  56
  57 // Append a block to the queue, compute it's speed factors
  58 void Planner::append_block( ActuatorCoordinates &actuator_pos, float rate_mm_s, float distance, float unit_vec[] )
  59 {
  60     float acceleration, junction_deviation;
  61
  62     // Create ( recycle ) a new block
  63     Block* block = THEKERNEL->conveyor->queue.head_ref();
  64
  65
  66     // Direction bits
  67     for (size_t i = 0; i < THEKERNEL->robot->actuators.size(); i++) {
  68         int steps = THEKERNEL->robot->actuators[i]->steps_to_target(actuator_pos[i]);
  69
  70         block->direction_bits[i] = (steps < 0) ? 1 : 0;
  71
  72         // Update current position
  73         THEKERNEL->robot->actuators[i]->last_milestone_steps += steps;
  74         THEKERNEL->robot->actuators[i]->last_milestone_mm = actuator_pos[i];
  75
  76         block->steps[i] = labs(steps);
  77     }
  78
  79     acceleration = this->acceleration;
  80     junction_deviation = this->junction_deviation;
  81
  82     // use either regular acceleration or a z only move accleration
  83     if(block->steps[ALPHA_STEPPER] == 0 && block->steps[BETA_STEPPER] == 0) {
  84         // z only move
  85         if(this->z_acceleration > 0.0F) acceleration = this->z_acceleration;
  86         if(this->z_junction_deviation >= 0.0F) junction_deviation = this->z_junction_deviation;
  87     }
  88
  89     block->acceleration = acceleration; // save in block
  90
  91     // Max number of steps, for all axes
  92     uint32_t steps_event_count = 0;
  93     for (size_t s = 0; s < THEKERNEL->robot->actuators.size(); s++) {
  94         steps_event_count = std::max(steps_event_count, block->steps[s]);
  95     }
  96     block->steps_event_count = steps_event_count;
  97
  98     block->millimeters = distance;
  99
 100     // Calculate speed in mm/sec for each axis. No divide by zero due to previous checks.
 101     // NOTE: Minimum stepper speed is limited by MINIMUM_STEPS_PER_MINUTE in stepper.c
 102     if( distance > 0.0F ) {
 103         block->nominal_speed = rate_mm_s;           // (mm/s) Always > 0
 104         block->nominal_rate = ceilf(block->steps_event_count * rate_mm_s / distance); // (step/s) Always > 0
 105     } else {
 106         block->nominal_speed = 0.0F;
 107         block->nominal_rate  = 0;
 108     }
 109
 110     // Compute the acceleration rate for the trapezoid generator. Depending on the slope of the line
 111     // average travel per step event changes. For a line along one axis the travel per step event
 112     // is equal to the travel/step in the particular axis. For a 45 degree line the steppers of both
 113     // axes might step for every step event. Travel per step event is then sqrt(travel_x^2+travel_y^2).
 114     // To generate trapezoids with contant acceleration between blocks the rate_delta must be computed
 115     // specifically for each line to compensate for this phenomenon:
 116     // Convert universal acceleration for direction-dependent stepper rate change parameter
 117     block->rate_delta = (block->steps_event_count * acceleration) / (distance * THEKERNEL->acceleration_ticks_per_second); // (step/min/acceleration_tick)
 118
 119     // Compute maximum allowable entry speed at junction by centripetal acceleration approximation.
 120     // Let a circle be tangent to both previous and current path line segments, where the junction
 121     // deviation is defined as the distance from the junction to the closest edge of the circle,
 122     // colinear with the circle center. The circular segment joining the two paths represents the
 123     // path of centripetal acceleration. Solve for max velocity based on max acceleration about the
 124     // radius of the circle, defined indirectly by junction deviation. This may be also viewed as
 125     // path width or max_jerk in the previous grbl version. This approach does not actually deviate
 126     // from path, but used as a robust way to compute cornering speeds, as it takes into account the
 127     // nonlinearities of both the junction angle and junction velocity.
 128
 129     // NOTE however it does not take into account independent axis, in most cartesian X and Y and Z are totally independent
 130     // 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.
 131     float vmax_junction = minimum_planner_speed; // Set default max junction speed
 132
 133     if (!THEKERNEL->conveyor->is_queue_empty()) {
 134         float previous_nominal_speed = THEKERNEL->conveyor->queue.item_ref(THEKERNEL->conveyor->queue.prev(THEKERNEL->conveyor->queue.head_i))->nominal_speed;
 135
 136         if (previous_nominal_speed > 0.0F && junction_deviation > 0.0F) {
 137             // Compute cosine of angle between previous and current path. (prev_unit_vec is negative)
 138             // NOTE: Max junction velocity is computed without sin() or acos() by trig half angle identity.
 139             float cos_theta = - this->previous_unit_vec[X_AXIS] * unit_vec[X_AXIS]
 140                               - this->previous_unit_vec[Y_AXIS] * unit_vec[Y_AXIS]
 141                               - this->previous_unit_vec[Z_AXIS] * unit_vec[Z_AXIS] ;
 142
 143             // Skip and use default max junction speed for 0 degree acute junction.
 144             if (cos_theta < 0.95F) {
 145                 vmax_junction = min(previous_nominal_speed, block->nominal_speed);
 146                 // Skip and avoid divide by zero for straight junctions at 180 degrees. Limit to min() of nominal speeds.
 147                 if (cos_theta > -0.95F) {
 148                     // Compute maximum junction velocity based on maximum acceleration and junction deviation
 149                     float sin_theta_d2 = sqrtf(0.5F * (1.0F - cos_theta)); // Trig half angle identity. Always positive.
 150                     vmax_junction = min(vmax_junction, sqrtf(acceleration * junction_deviation * sin_theta_d2 / (1.0F - sin_theta_d2)));
 151                 }
 152             }
 153         }
 154     }
 155     block->max_entry_speed = vmax_junction;
 156
 157     // Initialize block entry speed. Compute based on deceleration to user-defined minimum_planner_speed.
 158     float v_allowable = max_allowable_speed(-acceleration, minimum_planner_speed, block->millimeters);
 159     block->entry_speed = min(vmax_junction, v_allowable);
 160
 161     // Initialize planner efficiency flags
 162     // Set flag if block will always reach maximum junction speed regardless of entry/exit speeds.
 163     // If a block can de/ac-celerate from nominal speed to zero within the length of the block, then
 164     // the current block and next block junction speeds are guaranteed to always be at their maximum
 165     // junction speeds in deceleration and acceleration, respectively. This is due to how the current
 166     // block nominal speed limits both the current and next maximum junction speeds. Hence, in both
 167     // the reverse and forward planners, the corresponding block junction speed will always be at the
 168     // the maximum junction speed and may always be ignored for any speed reduction checks.
 169     if (block->nominal_speed <= v_allowable) { block->nominal_length_flag = true; }
 170     else { block->nominal_length_flag = false; }
 171
 172     // Always calculate trapezoid for new block
 173     block->recalculate_flag = true;
 174
 175     // Update previous path unit_vector and nominal speed
 176     memcpy(this->previous_unit_vec, unit_vec, sizeof(previous_unit_vec)); // previous_unit_vec[] = unit_vec[]
 177
 178     // Math-heavy re-computing of the whole queue to take the new
 179     this->recalculate();
 180
 181     // The block can now be used
 182     block->ready();
 183
 184     THEKERNEL->conveyor->queue_head_block();
 185 }
 186
 187 void Planner::recalculate()
 188 {
 189     Conveyor::Queue_t &queue = THEKERNEL->conveyor->queue;
 190
 191     unsigned int block_index;
 192
 193     Block* previous;
 194     Block* current;
 195
 196     /*
 197      * a newly added block is decel limited
 198      *
 199      * we find its max entry speed given its exit speed
 200      *
 201      * for each block, walking backwards in the queue:
 202      *
 203      * if max entry speed == current entry speed
 204      * then we can set recalculate to false, since clearly adding another block didn't allow us to enter faster
 205      * and thus we don't need to check entry speed for this block any more
 206      *
 207      * once we find an accel limited block, we must find the max exit speed and walk the queue forwards
 208      *
 209      * for each block, walking forwards in the queue:
 210      *
 211      * given the exit speed of the previous block and our own max entry speed
 212      * we can tell if we're accel or decel limited (or coasting)
 213      *
 214      * if prev_exit > max_entry
 215      *     then we're still decel limited. update previous trapezoid with our max entry for prev exit
 216      * if max_entry >= prev_exit
 217      *     then we're accel limited. set recalculate to false, work out max exit speed
 218      *
 219      * finally, work out trapezoid for the final (and newest) block.
 220      */
 221
 222     /*
 223      * Step 1:
 224      * For each block, given the exit speed and acceleration, find the maximum entry speed
 225      */
 226
 227     float entry_speed = minimum_planner_speed;
 228
 229     block_index = queue.head_i;
 230     current     = queue.item_ref(block_index);
 231
 232     if (!queue.is_empty()) {
 233         while ((block_index != queue.tail_i) && current->recalculate_flag) {
 234             entry_speed = current->reverse_pass(entry_speed);
 235
 236             block_index = queue.prev(block_index);
 237             current     = queue.item_ref(block_index);
 238         }
 239
 240         /*
 241          * Step 2:
 242          * now current points to either tail or first non-recalculate block
 243          * and has not had its reverse_pass called
 244          * or its calc trap
 245          * entry_speed is set to the *exit* speed of current.
 246          * each block from current to head has its entry speed set to its max entry speed- limited by decel or nominal_rate
 247          */
 248
 249         float exit_speed = current->max_exit_speed();
 250
 251         while (block_index != queue.head_i) {
 252             previous    = current;
 253             block_index = queue.next(block_index);
 254             current     = queue.item_ref(block_index);
 255
 256             // we pass the exit speed of the previous block
 257             // so this block can decide if it's accel or decel limited and update its fields as appropriate
 258             exit_speed = current->forward_pass(exit_speed);
 259
 260             previous->calculate_trapezoid(previous->entry_speed, current->entry_speed);
 261         }
 262     }
 263
 264     /*
 265      * Step 3:
 266      * work out trapezoid for final (and newest) block
 267      */
 268
 269     // now current points to the head item
 270     // which has not had calculate_trapezoid run yet
 271     current->calculate_trapezoid(current->entry_speed, minimum_planner_speed);
 272 }
 273
 274
 275 // Calculates the maximum allowable speed at this point when you must be able to reach target_velocity using the
 276 // acceleration within the allotted distance.
 277 float Planner::max_allowable_speed(float acceleration, float target_velocity, float distance)
 278 {
 279     return(
 280               sqrtf(target_velocity * target_velocity - 2.0F * acceleration * distance) //Was acceleration*60*60*distance, in case this breaks, but here we prefer to use seconds instead of minutes
 281           );
 282 }
 283
 284