src/modules/tools/zprobe/ZProbe.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).
   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 #include "ZProbe.h"
   9
  10 #include "Kernel.h"
  11 #include "BaseSolution.h"
  12 #include "Config.h"
  13 #include "Robot.h"
  14 #include "StepperMotor.h"
  15 #include "StreamOutputPool.h"
  16 #include "Gcode.h"
  17 #include "Conveyor.h"
  18 #include "Stepper.h"
  19 #include "checksumm.h"
  20 #include "ConfigValue.h"
  21 #include "SlowTicker.h"
  22 #include "Planner.h"
  23 #include "SerialMessage.h"
  24 #include "PublicDataRequest.h"
  25 #include "EndstopsPublicAccess.h"
  26 #include "PublicData.h"
  27 #include "LevelingStrategy.h"
  28 #include "StepTicker.h"
  29
  30 // strategies we know about
  31 #include "DeltaCalibrationStrategy.h"
  32 #include "ThreePointStrategy.h"
  33 #include "ZGridStrategy.h"
  34
  35 #define enable_checksum          CHECKSUM("enable")
  36 #define probe_pin_checksum       CHECKSUM("probe_pin")
  37 #define debounce_count_checksum  CHECKSUM("debounce_count")
  38 #define slow_feedrate_checksum   CHECKSUM("slow_feedrate")
  39 #define fast_feedrate_checksum   CHECKSUM("fast_feedrate")
  40 #define return_feedrate_checksum CHECKSUM("return_feedrate")
  41 #define probe_height_checksum    CHECKSUM("probe_height")
  42 #define gamma_max_checksum       CHECKSUM("gamma_max")
  43
  44 // from endstop section
  45 #define delta_homing_checksum    CHECKSUM("delta_homing")
  46
  47 #define X_AXIS 0
  48 #define Y_AXIS 1
  49 #define Z_AXIS 2
  50
  51 #define STEPPER THEKERNEL->robot->actuators
  52 #define STEPS_PER_MM(a) (STEPPER[a]->get_steps_per_mm())
  53 #define Z_STEPS_PER_MM STEPS_PER_MM(Z_AXIS)
  54
  55 #define abs(a) ((a<0) ? -a : a)
  56
  57 void ZProbe::on_module_loaded()
  58 {
  59     // if the module is disabled -> do nothing
  60     if(!THEKERNEL->config->value( zprobe_checksum, enable_checksum )->by_default(false)->as_bool()) {
  61         // as this module is not needed free up the resource
  62         delete this;
  63         return;
  64     }
  65     this->running = false;
  66
  67     // load settings
  68     this->on_config_reload(this);
  69     // register event-handlers
  70     register_for_event(ON_GCODE_RECEIVED);
  71
  72     THEKERNEL->step_ticker->register_acceleration_tick_handler([this](){acceleration_tick(); });
  73 }
  74
  75 void ZProbe::on_config_reload(void *argument)
  76 {
  77     this->pin.from_string( THEKERNEL->config->value(zprobe_checksum, probe_pin_checksum)->by_default("nc" )->as_string())->as_input();
  78     this->debounce_count = THEKERNEL->config->value(zprobe_checksum, debounce_count_checksum)->by_default(0  )->as_number();
  79
  80     // get strategies to load
  81     vector<uint16_t> modules;
  82     THEKERNEL->config->get_module_list( &modules, leveling_strategy_checksum);
  83     for( auto cs : modules ){
  84         if( THEKERNEL->config->value(leveling_strategy_checksum, cs, enable_checksum )->as_bool() ){
  85             bool found= false;
  86             // check with each known strategy and load it if it matches
  87             switch(cs) {
  88                 case delta_calibration_strategy_checksum:
  89                     this->strategies.push_back(new DeltaCalibrationStrategy(this));
  90                     found= true;
  91                     break;
  92
  93                 case three_point_leveling_strategy_checksum:
  94                     // NOTE this strategy is mutually exclusive with the delta calibration strategy
  95                     this->strategies.push_back(new ThreePointStrategy(this));
  96                     found= true;
  97                     break;
  98
  99                 case ZGrid_leveling_checksum:
 100                      this->strategies.push_back(new ZGridStrategy(this));
 101                      found= true;
 102                      break;
 103
 104                 // add other strategies here
 105                 //case zheight_map_strategy:
 106                 //     this->strategies.push_back(new ZHeightMapStrategy(this));
 107                 //     found= true;
 108                 //     break;
 109             }
 110             if(found) this->strategies.back()->handleConfig();
 111         }
 112     }
 113
 114     // need to know if we need to use delta kinematics for homing
 115     this->is_delta = THEKERNEL->config->value(delta_homing_checksum)->by_default(false)->as_bool();
 116
 117     // default for backwards compatibility add DeltaCalibrationStrategy if a delta
 118     // will be deprecated
 119     if(this->strategies.empty()) {
 120         if(this->is_delta) {
 121             this->strategies.push_back(new DeltaCalibrationStrategy(this));
 122             this->strategies.back()->handleConfig();
 123         }
 124     }
 125
 126     this->probe_height  = THEKERNEL->config->value(zprobe_checksum, probe_height_checksum)->by_default(5.0F)->as_number();
 127     this->slow_feedrate = THEKERNEL->config->value(zprobe_checksum, slow_feedrate_checksum)->by_default(5)->as_number(); // feedrate in mm/sec
 128     this->fast_feedrate = THEKERNEL->config->value(zprobe_checksum, fast_feedrate_checksum)->by_default(100)->as_number(); // feedrate in mm/sec
 129     this->return_feedrate = THEKERNEL->config->value(zprobe_checksum, return_feedrate_checksum)->by_default(0)->as_number(); // feedrate in mm/sec
 130     this->max_z         = THEKERNEL->config->value(gamma_max_checksum)->by_default(500)->as_number(); // maximum zprobe distance
 131 }
 132
 133 bool ZProbe::wait_for_probe(int& steps)
 134 {
 135     unsigned int debounce = 0;
 136     while(true) {
 137         THEKERNEL->call_event(ON_IDLE);
 138         // if no stepper is moving, moves are finished and there was no touch
 139         if( !STEPPER[Z_AXIS]->is_moving() && (!is_delta || (!STEPPER[Y_AXIS]->is_moving() && !STEPPER[Z_AXIS]->is_moving())) ) {
 140             return false;
 141         }
 142
 143         // if the touchprobe is active...
 144         if( this->pin.get() ) {
 145             //...increase debounce counter...
 146             if( debounce < debounce_count) {
 147                 // ...but only if the counter hasn't reached the max. value
 148                 debounce++;
 149             } else {
 150                 // ...otherwise stop the steppers, return its remaining steps
 151                 if(STEPPER[Z_AXIS]->is_moving()){
 152                     steps= STEPPER[Z_AXIS]->get_stepped();
 153                     STEPPER[Z_AXIS]->move(0, 0);
 154                 }
 155                 if(is_delta) {
 156                     for( int i = X_AXIS; i <= Y_AXIS; i++ ) {
 157                         if ( STEPPER[i]->is_moving() ) {
 158                             STEPPER[i]->move(0, 0);
 159                         }
 160                     }
 161                 }
 162                 return true;
 163             }
 164         } else {
 165             // The probe was not hit yet, reset debounce counter
 166             debounce = 0;
 167         }
 168     }
 169 }
 170
 171 // single probe with custom feedrate
 172 // returns boolean value indicating if probe was triggered
 173 bool ZProbe::run_probe_feed(int& steps, float feedrate)
 174 {
 175     // not a block move so disable the last tick setting
 176     for ( int c = X_AXIS; c <= Z_AXIS; c++ ) {
 177         STEPPER[c]->set_moved_last_block(false);
 178     }
 179
 180     // Enable the motors
 181     THEKERNEL->stepper->turn_enable_pins_on();
 182     this->current_feedrate = feedrate * Z_STEPS_PER_MM; // steps/sec
 183     float maxz= this->max_z*2;
 184
 185     // move Z down
 186     STEPPER[Z_AXIS]->move(true, maxz * Z_STEPS_PER_MM, 0); // always probes down, no more than 2*maxz
 187     if(this->is_delta) {
 188         // for delta need to move all three actuators
 189         STEPPER[X_AXIS]->move(true, maxz * STEPS_PER_MM(X_AXIS), 0);
 190         STEPPER[Y_AXIS]->move(true, maxz * STEPS_PER_MM(Y_AXIS), 0);
 191     }
 192
 193     // start acceleration processing
 194     this->running = true;
 195
 196     bool r = wait_for_probe(steps);
 197     this->running = false;
 198     return r;
 199 }
 200
 201 // single probe with either fast or slow feedrate
 202 // returns boolean value indicating if probe was triggered
 203 bool ZProbe::run_probe(int& steps, bool fast)
 204 {
 205     float feedrate = (fast ? this->fast_feedrate : this->slow_feedrate);
 206     return run_probe_feed(steps, feedrate);
 207
 208 }
 209
 210 bool ZProbe::return_probe(int steps)
 211 {
 212     // move probe back to where it was
 213
 214     float fr;
 215     if(this->return_feedrate != 0) { // use return_feedrate if set
 216         fr = this->return_feedrate;
 217     } else {
 218         fr = this->slow_feedrate*2; // nominally twice slow feedrate
 219         if(fr > this->fast_feedrate) fr = this->fast_feedrate; // unless that is greater than fast feedrate
 220     }
 221
 222     this->current_feedrate = fr * Z_STEPS_PER_MM; // feedrate in steps/sec
 223     bool dir= steps < 0;
 224     steps= abs(steps);
 225
 226     STEPPER[Z_AXIS]->move(dir, steps, 0);
 227     if(this->is_delta) {
 228         STEPPER[X_AXIS]->move(dir, steps, 0);
 229         STEPPER[Y_AXIS]->move(dir, steps, 0);
 230     }
 231
 232     this->running = true;
 233     while(STEPPER[Z_AXIS]->is_moving() || (is_delta && (STEPPER[X_AXIS]->is_moving() || STEPPER[Y_AXIS]->is_moving())) ) {
 234         // wait for it to complete
 235         THEKERNEL->call_event(ON_IDLE);
 236     }
 237
 238     this->running = false;
 239
 240     return true;
 241 }
 242
 243 bool ZProbe::doProbeAt(int &steps, float x, float y)
 244 {
 245     int s;
 246     // move to xy
 247     coordinated_move(x, y, NAN, getFastFeedrate());
 248     if(!run_probe(s)) return false;
 249
 250     // return to original Z
 251     return_probe(s);
 252     steps = s;
 253
 254     return true;
 255 }
 256
 257 float ZProbe::probeDistance(float x, float y)
 258 {
 259     int s;
 260     if(!doProbeAt(s, x, y)) return NAN;
 261     return zsteps_to_mm(s);
 262 }
 263
 264 void ZProbe::on_gcode_received(void *argument)
 265 {
 266     Gcode *gcode = static_cast<Gcode *>(argument);
 267
 268     if( gcode->has_g && gcode->g >= 29 && gcode->g <= 32) {
 269         // make sure the probe is defined and not already triggered before moving motors
 270        if(!this->pin.connected()) {
 271             gcode->stream->printf("ZProbe not connected.\n");
 272             return;
 273         }
 274         if(this->pin.get()) {
 275             gcode->stream->printf("ZProbe triggered before move, aborting command.\n");
 276             return;
 277         }
 278
 279         if( gcode->g == 30 ) { // simple Z probe
 280             // first wait for an empty queue i.e. no moves left
 281             THEKERNEL->conveyor->wait_for_empty_queue();
 282
 283             int steps;
 284             bool probe_result;
 285             if(gcode->has_letter('F')) {
 286                 probe_result = run_probe_feed(steps, gcode->get_value('F') / 60);
 287             } else {
 288                 probe_result = run_probe(steps);
 289             }
 290
 291             if(probe_result) {
 292                 gcode->stream->printf("Z:%1.4f C:%d\n", steps / Z_STEPS_PER_MM, steps);
 293                 // move back to where it started, unless a Z is specified
 294                 if(gcode->has_letter('Z')) {
 295                     // set Z to the specified value, and leave probe where it is
 296                     THEKERNEL->robot->reset_axis_position(gcode->get_value('Z'), Z_AXIS);
 297                 } else {
 298                     return_probe(steps);
 299                 }
 300             } else {
 301                 gcode->stream->printf("ZProbe not triggered\n");
 302             }
 303
 304         } else {
 305             // find a strategy to handle the gcode
 306             for(auto s : strategies){
 307                 if(s->handleGcode(gcode)) {
 308                     return;
 309                 }
 310             }
 311             gcode->stream->printf("No strategy found to handle G%d\n", gcode->g);
 312         }
 313
 314     } else if(gcode->has_m) {
 315         // M code processing here
 316         if(gcode->m == 119) {
 317             int c = this->pin.get();
 318             gcode->stream->printf(" Probe: %d", c);
 319             gcode->add_nl = true;
 320
 321         }else {
 322             for(auto s : strategies){
 323                 if(s->handleGcode(gcode)) {
 324                     return;
 325                 }
 326             }
 327         }
 328     }
 329 }
 330
 331 // Called periodically to change the speed to match acceleration
 332 void ZProbe::acceleration_tick(void)
 333 {
 334     if(!this->running) return; // nothing to do
 335     if(STEPPER[Z_AXIS]->is_moving()) accelerate(Z_AXIS);
 336
 337     if(is_delta) {
 338          // deltas needs to move all actuators
 339         for ( int c = X_AXIS; c <= Y_AXIS; c++ ) {
 340             if( !STEPPER[c]->is_moving() ) continue;
 341             accelerate(c);
 342         }
 343     }
 344
 345     return;
 346 }
 347
 348 void ZProbe::accelerate(int c)
 349 {   uint32_t current_rate = STEPPER[c]->get_steps_per_second();
 350     uint32_t target_rate = floorf(this->current_feedrate);
 351
 352     // Z may have a different acceleration to X and Y
 353     float acc= (c==Z_AXIS) ? THEKERNEL->planner->get_z_acceleration() : THEKERNEL->planner->get_acceleration();
 354     if( current_rate < target_rate ) {
 355         uint32_t rate_increase = floorf((acc / THEKERNEL->acceleration_ticks_per_second) * STEPS_PER_MM(c));
 356         current_rate = min( target_rate, current_rate + rate_increase );
 357     }
 358     if( current_rate > target_rate ) {
 359         current_rate = target_rate;
 360     }
 361
 362     // steps per second
 363     STEPPER[c]->set_speed(current_rate);
 364 }
 365
 366 // issue a coordinated move directly to robot, and return when done
 367 // Only move the coordinates that are passed in as not nan
 368 void ZProbe::coordinated_move(float x, float y, float z, float feedrate, bool relative)
 369 {
 370     char buf[32];
 371     char cmd[64];
 372
 373     if(relative) strcpy(cmd, "G91 G0 ");
 374     else strcpy(cmd, "G0 ");
 375
 376     if(!isnan(x)) {
 377         int n = snprintf(buf, sizeof(buf), " X%1.3f", x);
 378         strncat(cmd, buf, n);
 379     }
 380     if(!isnan(y)) {
 381         int n = snprintf(buf, sizeof(buf), " Y%1.3f", y);
 382         strncat(cmd, buf, n);
 383     }
 384     if(!isnan(z)) {
 385         int n = snprintf(buf, sizeof(buf), " Z%1.3f", z);
 386         strncat(cmd, buf, n);
 387     }
 388
 389     // use specified feedrate (mm/sec)
 390     int n = snprintf(buf, sizeof(buf), " F%1.1f", feedrate * 60); // feed rate is converted to mm/min
 391     strncat(cmd, buf, n);
 392     if(relative) strcat(cmd, " G90");
 393
 394     //THEKERNEL->streams->printf("DEBUG: move: %s\n", cmd);
 395
 396     // send as a command line as may have multiple G codes in it
 397     struct SerialMessage message;
 398     message.message = cmd;
 399     message.stream = &(StreamOutput::NullStream);
 400     THEKERNEL->call_event(ON_CONSOLE_LINE_RECEIVED, &message );
 401     THEKERNEL->conveyor->wait_for_empty_queue();
 402 }
 403
 404 // issue home command
 405 void ZProbe::home()
 406 {
 407     Gcode gc("G28", &(StreamOutput::NullStream));
 408     THEKERNEL->call_event(ON_GCODE_RECEIVED, &gc);
 409 }
 410
 411 float ZProbe::zsteps_to_mm(float steps)
 412 {
 413     return steps / Z_STEPS_PER_MM;
 414 }