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 "checksumm.h"
  19 #include "ConfigValue.h"
  20 #include "SlowTicker.h"
  21 #include "Planner.h"
  22 #include "SerialMessage.h"
  23 #include "PublicDataRequest.h"
  24 #include "EndstopsPublicAccess.h"
  25 #include "PublicData.h"
  26 #include "LevelingStrategy.h"
  27 #include "StepTicker.h"
  28 #include "utils.h"
  29
  30 // strategies we know about
  31 #include "DeltaCalibrationStrategy.h"
  32 #include "ThreePointStrategy.h"
  33 //#include "ZGridStrategy.h"
  34 #include "DeltaGridStrategy.h"
  35
  36 #define enable_checksum          CHECKSUM("enable")
  37 #define probe_pin_checksum       CHECKSUM("probe_pin")
  38 #define debounce_ms_checksum     CHECKSUM("debounce_ms")
  39 #define slow_feedrate_checksum   CHECKSUM("slow_feedrate")
  40 #define fast_feedrate_checksum   CHECKSUM("fast_feedrate")
  41 #define return_feedrate_checksum CHECKSUM("return_feedrate")
  42 #define probe_height_checksum    CHECKSUM("probe_height")
  43 #define gamma_max_checksum       CHECKSUM("gamma_max")
  44 #define reverse_z_direction_checksum CHECKSUM("reverse_z")
  45
  46 // from endstop section
  47 #define delta_homing_checksum    CHECKSUM("delta_homing")
  48 #define rdelta_homing_checksum    CHECKSUM("rdelta_homing")
  49
  50 #define X_AXIS 0
  51 #define Y_AXIS 1
  52 #define Z_AXIS 2
  53
  54 #define STEPPER THEROBOT->actuators
  55 #define STEPS_PER_MM(a) (STEPPER[a]->get_steps_per_mm())
  56 #define Z_STEPS_PER_MM STEPS_PER_MM(Z_AXIS)
  57
  58 #define abs(a) ((a<0) ? -a : a)
  59
  60 void ZProbe::on_module_loaded()
  61 {
  62     // if the module is disabled -> do nothing
  63     if(!THEKERNEL->config->value( zprobe_checksum, enable_checksum )->by_default(false)->as_bool()) {
  64         // as this module is not needed free up the resource
  65         delete this;
  66         return;
  67     }
  68
  69     // load settings
  70     this->config_load();
  71     // register event-handlers
  72     register_for_event(ON_GCODE_RECEIVED);
  73
  74     // we read the probe in this timer, currently only for G38 probes.
  75     probing= false;
  76     THEKERNEL->slow_ticker->attach(1000, this, &ZProbe::read_probe);
  77 }
  78
  79 void ZProbe::config_load()
  80 {
  81     this->pin.from_string( THEKERNEL->config->value(zprobe_checksum, probe_pin_checksum)->by_default("nc" )->as_string())->as_input();
  82     this->debounce_ms    = THEKERNEL->config->value(zprobe_checksum, debounce_ms_checksum)->by_default(0  )->as_number();
  83
  84     // get strategies to load
  85     vector<uint16_t> modules;
  86     THEKERNEL->config->get_module_list( &modules, leveling_strategy_checksum);
  87     for( auto cs : modules ){
  88         if( THEKERNEL->config->value(leveling_strategy_checksum, cs, enable_checksum )->as_bool() ){
  89             bool found= false;
  90             // check with each known strategy and load it if it matches
  91             switch(cs) {
  92                 case delta_calibration_strategy_checksum:
  93                     this->strategies.push_back(new DeltaCalibrationStrategy(this));
  94                     found= true;
  95                     break;
  96
  97                 case three_point_leveling_strategy_checksum:
  98                     // NOTE this strategy is mutually exclusive with the delta calibration strategy
  99                     this->strategies.push_back(new ThreePointStrategy(this));
 100                     found= true;
 101                     break;
 102
 103                 // case ZGrid_leveling_checksum:
 104                 //      this->strategies.push_back(new ZGridStrategy(this));
 105                 //      found= true;
 106                 //      break;
 107
 108                 case delta_grid_leveling_strategy_checksum:
 109                     this->strategies.push_back(new DeltaGridStrategy(this));
 110                     found= true;
 111                     break;
 112             }
 113             if(found) this->strategies.back()->handleConfig();
 114         }
 115     }
 116
 117     // need to know if we need to use delta kinematics for homing
 118     this->is_delta = THEKERNEL->config->value(delta_homing_checksum)->by_default(false)->as_bool();
 119     this->is_rdelta = THEKERNEL->config->value(rdelta_homing_checksum)->by_default(false)->as_bool();
 120
 121     // default for backwards compatibility add DeltaCalibrationStrategy if a delta
 122     // will be deprecated
 123     if(this->strategies.empty()) {
 124         if(this->is_delta) {
 125             this->strategies.push_back(new DeltaCalibrationStrategy(this));
 126             this->strategies.back()->handleConfig();
 127         }
 128     }
 129
 130     this->probe_height  = THEKERNEL->config->value(zprobe_checksum, probe_height_checksum)->by_default(5.0F)->as_number();
 131     this->slow_feedrate = THEKERNEL->config->value(zprobe_checksum, slow_feedrate_checksum)->by_default(5)->as_number(); // feedrate in mm/sec
 132     this->fast_feedrate = THEKERNEL->config->value(zprobe_checksum, fast_feedrate_checksum)->by_default(100)->as_number(); // feedrate in mm/sec
 133     this->return_feedrate = THEKERNEL->config->value(zprobe_checksum, return_feedrate_checksum)->by_default(0)->as_number(); // feedrate in mm/sec
 134     this->reverse_z     = THEKERNEL->config->value(zprobe_checksum, reverse_z_direction_checksum)->by_default(false)->as_bool(); // Z probe moves in reverse direction
 135     this->max_z         = THEKERNEL->config->value(gamma_max_checksum)->by_default(500)->as_number(); // maximum zprobe distance
 136 }
 137
 138 uint32_t ZProbe::read_probe(uint32_t dummy)
 139 {
 140     if(!probing || probe_detected) return 0;
 141
 142     if(STEPPER[Z_AXIS]->is_moving()) {
 143         // if it is moving then we check the probe, and debounce it
 144         if(this->pin.get()) {
 145             if(debounce < debounce_ms) {
 146                 debounce++;
 147             } else {
 148                 // we signal the motors to stop, which will preempt any moves on that axis
 149                 // we do all motors as it may be a delta
 150                 for(auto &a : THEROBOT->actuators) a->stop_moving();
 151                 probe_detected= true;
 152                 debounce= 0;
 153             }
 154
 155         } else {
 156             // The endstop was not hit yet
 157             debounce= 0;
 158         }
 159     }
 160
 161     return 0;
 162 }
 163
 164 // single probe in Z with custom feedrate
 165 // returns boolean value indicating if probe was triggered
 166 bool ZProbe::run_probe(float& mm, float feedrate, float max_dist, bool reverse)
 167 {
 168     float maxz= max_dist < 0 ? this->max_z*2 : max_dist;
 169
 170     probing= true;
 171     probe_detected= false;
 172     debounce= 0;
 173
 174     // save current actuator position so we can report how far we moved
 175     ActuatorCoordinates start_pos{
 176         THEROBOT->actuators[X_AXIS]->get_current_position(),
 177         THEROBOT->actuators[Y_AXIS]->get_current_position(),
 178         THEROBOT->actuators[Z_AXIS]->get_current_position()
 179     };
 180
 181     // move Z down
 182     THEROBOT->disable_segmentation= true; // we must disable segmentation as this won't work with it enabled
 183     bool dir= (!reverse_z != reverse); // xor
 184     float delta[3]= {0,0,0};
 185     delta[Z_AXIS]= dir ? -maxz : maxz;
 186     THEROBOT->delta_move(delta, feedrate, 3);
 187
 188     // wait until finished
 189     THECONVEYOR->wait_for_empty_queue();
 190     THEROBOT->disable_segmentation= false;
 191
 192     // now see how far we moved, get delta in z we moved
 193     // NOTE this works for deltas as well as all three actuators move the same amount in Z
 194     mm= start_pos[2] - THEROBOT->actuators[2]->get_current_position();
 195
 196     // set the last probe position to the actuator units moved during this home
 197     THEROBOT->set_last_probe_position(
 198         std::make_tuple(
 199             start_pos[0] - THEROBOT->actuators[0]->get_current_position(),
 200             start_pos[1] - THEROBOT->actuators[1]->get_current_position(),
 201             mm,
 202             probe_detected?1:0));
 203
 204     probing= false;
 205
 206     if(probe_detected) {
 207         // if the probe stopped the move we need to correct the last_milestone as it did not reach where it thought
 208         THEROBOT->reset_position_from_current_actuator_position();
 209     }
 210
 211     return probe_detected;
 212 }
 213
 214 bool ZProbe::return_probe(float mm, bool reverse)
 215 {
 216     // move probe back to where it was
 217     float fr;
 218     if(this->return_feedrate != 0) { // use return_feedrate if set
 219         fr = this->return_feedrate;
 220     } else {
 221         fr = this->slow_feedrate*2; // nominally twice slow feedrate
 222         if(fr > this->fast_feedrate) fr = this->fast_feedrate; // unless that is greater than fast feedrate
 223     }
 224
 225     bool dir= ((mm < 0) != reverse_z); // xor
 226     if(reverse) dir= !dir;
 227
 228     float delta[3]= {0,0,0};
 229     delta[Z_AXIS]= dir ? -mm : mm;
 230     THEROBOT->delta_move(delta, fr, 3);
 231
 232     // wait until finished
 233     THECONVEYOR->wait_for_empty_queue();
 234
 235     return true;
 236 }
 237
 238 bool ZProbe::doProbeAt(float &mm, float x, float y)
 239 {
 240     float s;
 241     // move to xy
 242     coordinated_move(x, y, NAN, getFastFeedrate());
 243     if(!run_probe(s)) return false;
 244
 245     // return to original Z
 246     return_probe(s);
 247     mm = s;
 248
 249     return true;
 250 }
 251
 252 float ZProbe::probeDistance(float x, float y)
 253 {
 254     float s;
 255     if(!doProbeAt(s, x, y)) return NAN;
 256     return s;
 257 }
 258
 259 void ZProbe::on_gcode_received(void *argument)
 260 {
 261     Gcode *gcode = static_cast<Gcode *>(argument);
 262
 263     if( gcode->has_g && gcode->g >= 29 && gcode->g <= 32) {
 264
 265         // make sure the probe is defined and not already triggered before moving motors
 266         if(!this->pin.connected()) {
 267             gcode->stream->printf("ZProbe not connected.\n");
 268             return;
 269         }
 270         if(this->pin.get()) {
 271             gcode->stream->printf("ZProbe triggered before move, aborting command.\n");
 272             return;
 273         }
 274
 275         if( gcode->g == 30 ) { // simple Z probe
 276             // first wait for an empty queue i.e. no moves left
 277             THEKERNEL->conveyor->wait_for_empty_queue();
 278
 279             bool probe_result;
 280             bool reverse= (gcode->has_letter('R') && gcode->get_value('R') != 0); // specify to probe in reverse direction
 281             float rate= gcode->has_letter('F') ? gcode->get_value('F') / 60 : this->slow_feedrate;
 282             float mm;
 283             probe_result = run_probe(mm, rate, -1, reverse);
 284
 285             if(probe_result) {
 286                 // the result is in actuator coordinates and raw steps
 287                 gcode->stream->printf("Z:%1.4f\n", mm);
 288
 289                 // set the last probe position to the current actuator units
 290                 THEROBOT->set_last_probe_position(std::make_tuple(
 291                     THEROBOT->actuators[X_AXIS]->get_current_position(),
 292                     THEROBOT->actuators[Y_AXIS]->get_current_position(),
 293                     THEROBOT->actuators[Z_AXIS]->get_current_position(),
 294                     1));
 295
 296                 // move back to where it started, unless a Z is specified (and not a rotary delta)
 297                 if(gcode->has_letter('Z') && !is_rdelta) {
 298                     // set Z to the specified value, and leave probe where it is
 299                     THEROBOT->reset_axis_position(gcode->get_value('Z'), Z_AXIS);
 300
 301                 } else {
 302                     // return to pre probe position
 303                     return_probe(mm, reverse);
 304                 }
 305
 306             } else {
 307                 gcode->stream->printf("ZProbe not triggered\n");
 308                 THEROBOT->set_last_probe_position(std::make_tuple(
 309                     THEROBOT->actuators[X_AXIS]->get_current_position(),
 310                     THEROBOT->actuators[Y_AXIS]->get_current_position(),
 311                     THEROBOT->actuators[Z_AXIS]->get_current_position(),
 312                     0));
 313             }
 314
 315         } else {
 316             if(!gcode->has_letter('P')) {
 317                 // find the first strategy to handle the gcode
 318                 for(auto s : strategies){
 319                     if(s->handleGcode(gcode)) {
 320                         return;
 321                     }
 322                 }
 323                 gcode->stream->printf("No strategy found to handle G%d\n", gcode->g);
 324
 325             }else{
 326                 // P paramater selects which strategy to send the code to
 327                 // they are loaded in the order they are defined in config, 0 being the first, 1 being the second and so on.
 328                 uint16_t i= gcode->get_value('P');
 329                 if(i < strategies.size()) {
 330                     if(!strategies[i]->handleGcode(gcode)){
 331                         gcode->stream->printf("strategy #%d did not handle G%d\n", i, gcode->g);
 332                     }
 333                     return;
 334
 335                 }else{
 336                     gcode->stream->printf("strategy #%d is not loaded\n", i);
 337                 }
 338             }
 339         }
 340
 341     } else if(gcode->has_g && gcode->g == 38 ) { // G38.2 Straight Probe with error, G38.3 straight probe without error
 342         // linuxcnc/grbl style probe http://www.linuxcnc.org/docs/2.5/html/gcode/gcode.html#sec:G38-probe
 343         if(gcode->subcode != 2 && gcode->subcode != 3) {
 344             gcode->stream->printf("error:Only G38.2 and G38.3 are supported\n");
 345             return;
 346         }
 347
 348         // make sure the probe is defined and not already triggered before moving motors
 349         if(!this->pin.connected()) {
 350             gcode->stream->printf("error:ZProbe not connected.\n");
 351             return;
 352         }
 353
 354         if(this->pin.get()) {
 355             gcode->stream->printf("error:ZProbe triggered before move, aborting command.\n");
 356             return;
 357         }
 358
 359         // first wait for an empty queue i.e. no moves left
 360         THEKERNEL->conveyor->wait_for_empty_queue();
 361
 362         // turn off any compensation transform
 363         auto savect= THEROBOT->compensationTransform;
 364         THEROBOT->compensationTransform= nullptr;
 365
 366         if(gcode->has_letter('X')) {
 367             // probe in the X axis
 368             probe_XYZ(gcode, X_AXIS);
 369
 370         }else if(gcode->has_letter('Y')) {
 371             // probe in the Y axis
 372             probe_XYZ(gcode, Y_AXIS);
 373
 374         }else if(gcode->has_letter('Z')) {
 375             // probe in the Z axis
 376             probe_XYZ(gcode, Z_AXIS);
 377
 378         }else{
 379             gcode->stream->printf("error:at least one of X Y or Z must be specified\n");
 380         }
 381
 382         // restore compensationTransform
 383         THEROBOT->compensationTransform= savect;
 384
 385         return;
 386
 387     } else if(gcode->has_m) {
 388         // M code processing here
 389         int c;
 390         switch (gcode->m) {
 391             case 119:
 392                 c = this->pin.get();
 393                 gcode->stream->printf(" Probe: %d", c);
 394                 gcode->add_nl = true;
 395                 break;
 396
 397             case 670:
 398                 if (gcode->has_letter('S')) this->slow_feedrate = gcode->get_value('S');
 399                 if (gcode->has_letter('K')) this->fast_feedrate = gcode->get_value('K');
 400                 if (gcode->has_letter('R')) this->return_feedrate = gcode->get_value('R');
 401                 if (gcode->has_letter('Z')) this->max_z = gcode->get_value('Z');
 402                 if (gcode->has_letter('H')) this->probe_height = gcode->get_value('H');
 403                 if (gcode->has_letter('I')) { // NOTE this is temporary and toggles the invertion status of the pin
 404                     invert_override= (gcode->get_value('I') != 0);
 405                     pin.set_inverting(pin.is_inverting() != invert_override); // XOR so inverted pin is not inverted and vice versa
 406                 }
 407                 break;
 408
 409             case 500: // save settings
 410             case 503: // print settings
 411                 gcode->stream->printf(";Probe feedrates Slow/fast(K)/Return (mm/sec) max_z (mm) height (mm):\nM670 S%1.2f K%1.2f R%1.2f Z%1.2f H%1.2f\n",
 412                     this->slow_feedrate, this->fast_feedrate, this->return_feedrate, this->max_z, this->probe_height);
 413
 414                 // fall through is intended so leveling strategies can handle m-codes too
 415
 416             default:
 417                 for(auto s : strategies){
 418                     if(s->handleGcode(gcode)) {
 419                         return;
 420                     }
 421                 }
 422         }
 423     }
 424 }
 425
 426 // special way to probe in the X or Y or Z direction using planned moves, should work with any kinematics
 427 void ZProbe::probe_XYZ(Gcode *gcode, int axis)
 428 {
 429     // enable the probe checking in the timer
 430     probing= true;
 431     probe_detected= false;
 432     THEROBOT->disable_segmentation= true; // we must disable segmentation as this won't work with it enabled (beware on deltas probing in X or Y)
 433
 434     // get probe feedrate if specified
 435     float rate = (gcode->has_letter('F')) ? gcode->get_value('F')*60 : this->slow_feedrate;
 436
 437     // do a regular move which will stop as soon as the probe is triggered, or the distance is reached
 438     switch(axis) {
 439         case X_AXIS: coordinated_move(gcode->get_value('X'), 0, 0, rate, true); break;
 440         case Y_AXIS: coordinated_move(0, gcode->get_value('Y'), 0, rate, true); break;
 441         case Z_AXIS: coordinated_move(0, 0, gcode->get_value('Z'), rate, true); break;
 442     }
 443
 444     // coordinated_move returns when the move is finished
 445
 446     // disable probe checking
 447     probing= false;
 448     THEROBOT->disable_segmentation= false;
 449
 450     float pos[3];
 451     {
 452         // get the current position
 453         ActuatorCoordinates current_position{
 454             THEROBOT->actuators[X_AXIS]->get_current_position(),
 455             THEROBOT->actuators[Y_AXIS]->get_current_position(),
 456             THEROBOT->actuators[Z_AXIS]->get_current_position()
 457         };
 458
 459         // get machine position from the actuator position using FK
 460         THEROBOT->arm_solution->actuator_to_cartesian(current_position, pos);
 461     }
 462
 463     uint8_t probeok= this->probe_detected ? 1 : 0;
 464
 465     // print results using the GRBL format
 466     gcode->stream->printf("[PRB:%1.3f,%1.3f,%1.3f:%d]\n", pos[X_AXIS], pos[Y_AXIS], pos[Z_AXIS], probeok);
 467     THEROBOT->set_last_probe_position(std::make_tuple(pos[X_AXIS], pos[Y_AXIS], pos[Z_AXIS], probeok));
 468
 469     if(!probeok && gcode->subcode == 2) {
 470         // issue error if probe was not triggered and subcode == 2
 471         gcode->stream->printf("ALARM:Probe fail\n");
 472         THEKERNEL->call_event(ON_HALT, nullptr);
 473
 474     }else if(probeok){
 475         // if the probe stopped the move we need to correct the last_milestone as it did not reach where it thought
 476         THEROBOT->reset_position_from_current_actuator_position();
 477     }
 478 }
 479
 480 // issue a coordinated move directly to robot, and return when done
 481 // Only move the coordinates that are passed in as not nan
 482 // NOTE must use G53 to force move in machine coordinates and ignore any WCS offsets
 483 void ZProbe::coordinated_move(float x, float y, float z, float feedrate, bool relative)
 484 {
 485     char buf[32];
 486     char cmd[64];
 487
 488     if(relative) strcpy(cmd, "G91 G0 ");
 489     else strcpy(cmd, "G53 G0 "); // G53 forces movement in machine coordinate system
 490
 491     if(!isnan(x)) {
 492         int n = snprintf(buf, sizeof(buf), " X%1.3f", x);
 493         strncat(cmd, buf, n);
 494     }
 495     if(!isnan(y)) {
 496         int n = snprintf(buf, sizeof(buf), " Y%1.3f", y);
 497         strncat(cmd, buf, n);
 498     }
 499     if(!isnan(z)) {
 500         int n = snprintf(buf, sizeof(buf), " Z%1.3f", z);
 501         strncat(cmd, buf, n);
 502     }
 503
 504     // use specified feedrate (mm/sec)
 505     int n = snprintf(buf, sizeof(buf), " F%1.1f", feedrate * 60); // feed rate is converted to mm/min
 506     strncat(cmd, buf, n);
 507     if(relative) strcat(cmd, " G90");
 508
 509     //THEKERNEL->streams->printf("DEBUG: move: %s\n", cmd);
 510
 511     // send as a command line as may have multiple G codes in it
 512     struct SerialMessage message;
 513     message.message = cmd;
 514     message.stream = &(StreamOutput::NullStream);
 515     THEKERNEL->call_event(ON_CONSOLE_LINE_RECEIVED, &message );
 516     THEKERNEL->conveyor->wait_for_empty_queue();
 517 }
 518
 519 // issue home command
 520 void ZProbe::home()
 521 {
 522     Gcode gc("G28", &(StreamOutput::NullStream));
 523     THEKERNEL->call_event(ON_GCODE_RECEIVED, &gc);
 524 }