My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

probe.cpp 23KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (c) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. /**
  23. * probe.cpp
  24. */
  25. #include "../inc/MarlinConfig.h"
  26. #if HAS_BED_PROBE
  27. #include "probe.h"
  28. #include "../libs/buzzer.h"
  29. #include "motion.h"
  30. #include "temperature.h"
  31. #include "endstops.h"
  32. #include "../gcode/gcode.h"
  33. #include "../lcd/ultralcd.h"
  34. #include "../Marlin.h" // for stop(), disable_e_steppers, wait_for_user
  35. #if HAS_LEVELING
  36. #include "../feature/bedlevel/bedlevel.h"
  37. #endif
  38. #if ENABLED(DELTA)
  39. #include "delta.h"
  40. #endif
  41. #if ENABLED(BABYSTEP_ZPROBE_OFFSET)
  42. #include "planner.h"
  43. #endif
  44. #if ENABLED(MEASURE_BACKLASH_WHEN_PROBING)
  45. #include "../feature/backlash.h"
  46. #endif
  47. xyz_pos_t probe_offset; // Initialized by settings.load()
  48. #if ENABLED(BLTOUCH)
  49. #include "../feature/bltouch.h"
  50. #endif
  51. #if ENABLED(HOST_PROMPT_SUPPORT)
  52. #include "../feature/host_actions.h" // for PROMPT_USER_CONTINUE
  53. #endif
  54. #if HAS_Z_SERVO_PROBE
  55. #include "servo.h"
  56. #endif
  57. #if ENABLED(SENSORLESS_PROBING)
  58. #include "stepper.h"
  59. #include "../feature/tmc_util.h"
  60. #endif
  61. #if QUIET_PROBING
  62. #include "stepper/indirection.h"
  63. #endif
  64. #if ENABLED(EXTENSIBLE_UI)
  65. #include "../lcd/extensible_ui/ui_api.h"
  66. #endif
  67. #define DEBUG_OUT ENABLED(DEBUG_LEVELING_FEATURE)
  68. #include "../core/debug_out.h"
  69. #if ENABLED(Z_PROBE_SLED)
  70. #ifndef SLED_DOCKING_OFFSET
  71. #define SLED_DOCKING_OFFSET 0
  72. #endif
  73. /**
  74. * Method to dock/undock a sled designed by Charles Bell.
  75. *
  76. * stow[in] If false, move to MAX_X and engage the solenoid
  77. * If true, move to MAX_X and release the solenoid
  78. */
  79. static void dock_sled(bool stow) {
  80. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("dock_sled(", stow, ")");
  81. // Dock sled a bit closer to ensure proper capturing
  82. do_blocking_move_to_x(X_MAX_POS + SLED_DOCKING_OFFSET - ((stow) ? 1 : 0));
  83. #if HAS_SOLENOID_1 && DISABLED(EXT_SOLENOID)
  84. WRITE(SOL1_PIN, !stow); // switch solenoid
  85. #endif
  86. }
  87. #elif ENABLED(TOUCH_MI_PROBE)
  88. // Move to the magnet to unlock the probe
  89. void run_deploy_moves_script() {
  90. #ifndef TOUCH_MI_DEPLOY_XPOS
  91. #define TOUCH_MI_DEPLOY_XPOS X_MIN_POS
  92. #elif TOUCH_MI_DEPLOY_XPOS > X_MAX_BED
  93. TemporaryGlobalEndstopsState unlock_x(false);
  94. #endif
  95. #if TOUCH_MI_DEPLOY_YPOS > Y_MAX_BED
  96. TemporaryGlobalEndstopsState unlock_y(false);
  97. #endif
  98. #if ENABLED(TOUCH_MI_MANUAL_DEPLOY)
  99. const screenFunc_t prev_screen = ui.currentScreen;
  100. LCD_MESSAGEPGM(MSG_MANUAL_DEPLOY_TOUCHMI);
  101. ui.return_to_status();
  102. KEEPALIVE_STATE(PAUSED_FOR_USER);
  103. wait_for_user = true; // LCD click or M108 will clear this
  104. #if ENABLED(HOST_PROMPT_SUPPORT)
  105. host_prompt_do(PROMPT_USER_CONTINUE, PSTR("Deploy TouchMI probe."), CONTINUE_STR);
  106. #endif
  107. while (wait_for_user) idle();
  108. ui.reset_status();
  109. ui.goto_screen(prev_screen);
  110. #elif defined(TOUCH_MI_DEPLOY_XPOS) && defined(TOUCH_MI_DEPLOY_YPOS)
  111. do_blocking_move_to_xy(TOUCH_MI_DEPLOY_XPOS, TOUCH_MI_DEPLOY_YPOS);
  112. #elif defined(TOUCH_MI_DEPLOY_XPOS)
  113. do_blocking_move_to_x(TOUCH_MI_DEPLOY_XPOS);
  114. #elif defined(TOUCH_MI_DEPLOY_YPOS)
  115. do_blocking_move_to_y(TOUCH_MI_DEPLOY_YPOS);
  116. #endif
  117. }
  118. // Move down to the bed to stow the probe
  119. void run_stow_moves_script() {
  120. const xyz_pos_t oldpos = current_position;
  121. endstops.enable_z_probe(false);
  122. do_blocking_move_to_z(TOUCH_MI_RETRACT_Z, MMM_TO_MMS(HOMING_FEEDRATE_Z));
  123. do_blocking_move_to(oldpos, MMM_TO_MMS(HOMING_FEEDRATE_Z));
  124. }
  125. #elif ENABLED(Z_PROBE_ALLEN_KEY)
  126. void run_deploy_moves_script() {
  127. #ifdef Z_PROBE_ALLEN_KEY_DEPLOY_1
  128. #ifndef Z_PROBE_ALLEN_KEY_DEPLOY_1_FEEDRATE
  129. #define Z_PROBE_ALLEN_KEY_DEPLOY_1_FEEDRATE 0.0
  130. #endif
  131. constexpr xyz_pos_t deploy_1 = Z_PROBE_ALLEN_KEY_DEPLOY_1;
  132. do_blocking_move_to(deploy_1, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_DEPLOY_1_FEEDRATE));
  133. #endif
  134. #ifdef Z_PROBE_ALLEN_KEY_DEPLOY_2
  135. #ifndef Z_PROBE_ALLEN_KEY_DEPLOY_2_FEEDRATE
  136. #define Z_PROBE_ALLEN_KEY_DEPLOY_2_FEEDRATE 0.0
  137. #endif
  138. constexpr xyz_pos_t deploy_2 = Z_PROBE_ALLEN_KEY_DEPLOY_2;
  139. do_blocking_move_to(deploy_2, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_DEPLOY_2_FEEDRATE));
  140. #endif
  141. #ifdef Z_PROBE_ALLEN_KEY_DEPLOY_3
  142. #ifndef Z_PROBE_ALLEN_KEY_DEPLOY_3_FEEDRATE
  143. #define Z_PROBE_ALLEN_KEY_DEPLOY_3_FEEDRATE 0.0
  144. #endif
  145. constexpr xyz_pos_t deploy_3 = Z_PROBE_ALLEN_KEY_DEPLOY_3;
  146. do_blocking_move_to(deploy_3, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_DEPLOY_3_FEEDRATE));
  147. #endif
  148. #ifdef Z_PROBE_ALLEN_KEY_DEPLOY_4
  149. #ifndef Z_PROBE_ALLEN_KEY_DEPLOY_4_FEEDRATE
  150. #define Z_PROBE_ALLEN_KEY_DEPLOY_4_FEEDRATE 0.0
  151. #endif
  152. constexpr xyz_pos_t deploy_4 = Z_PROBE_ALLEN_KEY_DEPLOY_4;
  153. do_blocking_move_to(deploy_4, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_DEPLOY_4_FEEDRATE));
  154. #endif
  155. #ifdef Z_PROBE_ALLEN_KEY_DEPLOY_5
  156. #ifndef Z_PROBE_ALLEN_KEY_DEPLOY_5_FEEDRATE
  157. #define Z_PROBE_ALLEN_KEY_DEPLOY_5_FEEDRATE 0.0
  158. #endif
  159. constexpr xyz_pos_t deploy_5 = Z_PROBE_ALLEN_KEY_DEPLOY_5;
  160. do_blocking_move_to(deploy_5, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_DEPLOY_5_FEEDRATE));
  161. #endif
  162. }
  163. void run_stow_moves_script() {
  164. #ifdef Z_PROBE_ALLEN_KEY_STOW_1
  165. #ifndef Z_PROBE_ALLEN_KEY_STOW_1_FEEDRATE
  166. #define Z_PROBE_ALLEN_KEY_STOW_1_FEEDRATE 0.0
  167. #endif
  168. constexpr xyz_pos_t stow_1 = Z_PROBE_ALLEN_KEY_STOW_1;
  169. do_blocking_move_to(stow_1, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_STOW_1_FEEDRATE));
  170. #endif
  171. #ifdef Z_PROBE_ALLEN_KEY_STOW_2
  172. #ifndef Z_PROBE_ALLEN_KEY_STOW_2_FEEDRATE
  173. #define Z_PROBE_ALLEN_KEY_STOW_2_FEEDRATE 0.0
  174. #endif
  175. constexpr xyz_pos_t stow_2 = Z_PROBE_ALLEN_KEY_STOW_2;
  176. do_blocking_move_to(stow_2, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_STOW_2_FEEDRATE));
  177. #endif
  178. #ifdef Z_PROBE_ALLEN_KEY_STOW_3
  179. #ifndef Z_PROBE_ALLEN_KEY_STOW_3_FEEDRATE
  180. #define Z_PROBE_ALLEN_KEY_STOW_3_FEEDRATE 0.0
  181. #endif
  182. constexpr xyz_pos_t stow_3 = Z_PROBE_ALLEN_KEY_STOW_3;
  183. do_blocking_move_to(stow_3, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_STOW_3_FEEDRATE));
  184. #endif
  185. #ifdef Z_PROBE_ALLEN_KEY_STOW_4
  186. #ifndef Z_PROBE_ALLEN_KEY_STOW_4_FEEDRATE
  187. #define Z_PROBE_ALLEN_KEY_STOW_4_FEEDRATE 0.0
  188. #endif
  189. constexpr xyz_pos_t stow_4 = Z_PROBE_ALLEN_KEY_STOW_4;
  190. do_blocking_move_to(stow_4, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_STOW_4_FEEDRATE));
  191. #endif
  192. #ifdef Z_PROBE_ALLEN_KEY_STOW_5
  193. #ifndef Z_PROBE_ALLEN_KEY_STOW_5_FEEDRATE
  194. #define Z_PROBE_ALLEN_KEY_STOW_5_FEEDRATE 0.0
  195. #endif
  196. constexpr xyz_pos_t stow_5 = Z_PROBE_ALLEN_KEY_STOW_5;
  197. do_blocking_move_to(stow_5, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_STOW_5_FEEDRATE));
  198. #endif
  199. }
  200. #endif // Z_PROBE_ALLEN_KEY
  201. #if QUIET_PROBING
  202. void probing_pause(const bool p) {
  203. #if ENABLED(PROBING_HEATERS_OFF)
  204. thermalManager.pause(p);
  205. #endif
  206. #if ENABLED(PROBING_FANS_OFF)
  207. thermalManager.set_fans_paused(p);
  208. #endif
  209. #if ENABLED(PROBING_STEPPERS_OFF)
  210. disable_e_steppers();
  211. #if NONE(DELTA, HOME_AFTER_DEACTIVATE)
  212. disable_X(); disable_Y();
  213. #endif
  214. #endif
  215. if (p) safe_delay(
  216. #if DELAY_BEFORE_PROBING > 25
  217. DELAY_BEFORE_PROBING
  218. #else
  219. 25
  220. #endif
  221. );
  222. }
  223. #endif // QUIET_PROBING
  224. /**
  225. * Raise Z to a minimum height to make room for a probe to move
  226. */
  227. inline void do_probe_raise(const float z_raise) {
  228. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("do_probe_raise(", z_raise, ")");
  229. float z_dest = z_raise;
  230. if (probe_offset.z < 0) z_dest -= probe_offset.z;
  231. NOMORE(z_dest, Z_MAX_POS);
  232. if (z_dest > current_position.z)
  233. do_blocking_move_to_z(z_dest);
  234. }
  235. FORCE_INLINE void probe_specific_action(const bool deploy) {
  236. #if ENABLED(PAUSE_BEFORE_DEPLOY_STOW)
  237. do {
  238. #if ENABLED(PAUSE_PROBE_DEPLOY_WHEN_TRIGGERED)
  239. if (deploy == (READ(Z_MIN_PROBE_PIN) == Z_MIN_PROBE_ENDSTOP_INVERTING)) break;
  240. #endif
  241. BUZZ(100, 659);
  242. BUZZ(100, 698);
  243. PGM_P const ds_str = deploy ? GET_TEXT(MSG_MANUAL_DEPLOY) : GET_TEXT(MSG_MANUAL_STOW);
  244. ui.return_to_status(); // To display the new status message
  245. ui.set_status_P(ds_str, 99);
  246. serialprintPGM(ds_str);
  247. SERIAL_EOL();
  248. KEEPALIVE_STATE(PAUSED_FOR_USER);
  249. wait_for_user = true;
  250. #if ENABLED(HOST_PROMPT_SUPPORT)
  251. host_prompt_do(PROMPT_USER_CONTINUE, PSTR("Stow Probe"), CONTINUE_STR);
  252. #endif
  253. #if ENABLED(EXTENSIBLE_UI)
  254. ExtUI::onUserConfirmRequired_P(PSTR("Stow Probe"));
  255. #endif
  256. while (wait_for_user) idle();
  257. ui.reset_status();
  258. } while(
  259. #if ENABLED(PAUSE_PROBE_DEPLOY_WHEN_TRIGGERED)
  260. true
  261. #else
  262. false
  263. #endif
  264. );
  265. #endif // PAUSE_BEFORE_DEPLOY_STOW
  266. #if ENABLED(SOLENOID_PROBE)
  267. #if HAS_SOLENOID_1
  268. WRITE(SOL1_PIN, deploy);
  269. #endif
  270. #elif ENABLED(Z_PROBE_SLED)
  271. dock_sled(!deploy);
  272. #elif HAS_Z_SERVO_PROBE
  273. #if DISABLED(BLTOUCH)
  274. MOVE_SERVO(Z_PROBE_SERVO_NR, servo_angles[Z_PROBE_SERVO_NR][deploy ? 0 : 1]);
  275. #elif ENABLED(BLTOUCH_HS_MODE)
  276. // In HIGH SPEED MODE, use the normal retractable probe logic in this code
  277. // i.e. no intermediate STOWs and DEPLOYs in between individual probe actions
  278. if (deploy) bltouch.deploy(); else bltouch.stow();
  279. #endif
  280. #elif EITHER(TOUCH_MI_PROBE, Z_PROBE_ALLEN_KEY)
  281. deploy ? run_deploy_moves_script() : run_stow_moves_script();
  282. #elif ENABLED(RACK_AND_PINION_PROBE)
  283. do_blocking_move_to_x(deploy ? Z_PROBE_DEPLOY_X : Z_PROBE_RETRACT_X);
  284. #elif DISABLED(PAUSE_BEFORE_DEPLOY_STOW)
  285. UNUSED(deploy);
  286. #endif
  287. }
  288. // returns false for ok and true for failure
  289. bool set_probe_deployed(const bool deploy) {
  290. if (DEBUGGING(LEVELING)) {
  291. DEBUG_POS("set_probe_deployed", current_position);
  292. DEBUG_ECHOLNPAIR("deploy: ", deploy);
  293. }
  294. if (endstops.z_probe_enabled == deploy) return false;
  295. // Make room for probe to deploy (or stow)
  296. // Fix-mounted probe should only raise for deploy
  297. // unless PAUSE_BEFORE_DEPLOY_STOW is enabled
  298. #if EITHER(FIX_MOUNTED_PROBE, NOZZLE_AS_PROBE) && DISABLED(PAUSE_BEFORE_DEPLOY_STOW)
  299. const bool deploy_stow_condition = deploy;
  300. #else
  301. constexpr bool deploy_stow_condition = true;
  302. #endif
  303. // For beds that fall when Z is powered off only raise for trusted Z
  304. #if ENABLED(UNKNOWN_Z_NO_RAISE)
  305. const bool unknown_condition = TEST(axis_known_position, Z_AXIS);
  306. #else
  307. constexpr float unknown_condition = true;
  308. #endif
  309. if (deploy_stow_condition && unknown_condition)
  310. do_probe_raise(_MAX(Z_CLEARANCE_BETWEEN_PROBES, Z_CLEARANCE_DEPLOY_PROBE));
  311. #if EITHER(Z_PROBE_SLED, Z_PROBE_ALLEN_KEY)
  312. if (axis_unhomed_error(
  313. #if ENABLED(Z_PROBE_SLED)
  314. _BV(X_AXIS)
  315. #endif
  316. )) {
  317. SERIAL_ERROR_MSG(MSG_STOP_UNHOMED);
  318. stop();
  319. return true;
  320. }
  321. #endif
  322. const xy_pos_t old_xy = current_position;
  323. #if ENABLED(PROBE_TRIGGERED_WHEN_STOWED_TEST)
  324. #if HAS_CUSTOM_PROBE_PIN
  325. #define PROBE_STOWED() (READ(Z_MIN_PROBE_PIN) != Z_MIN_PROBE_ENDSTOP_INVERTING)
  326. #else
  327. #define PROBE_STOWED() (READ(Z_MIN_PIN) != Z_MIN_ENDSTOP_INVERTING)
  328. #endif
  329. #endif
  330. #ifdef PROBE_STOWED
  331. // Only deploy/stow if needed
  332. if (PROBE_STOWED() == deploy) {
  333. if (!deploy) endstops.enable_z_probe(false); // Switch off triggered when stowed probes early
  334. // otherwise an Allen-Key probe can't be stowed.
  335. probe_specific_action(deploy);
  336. }
  337. if (PROBE_STOWED() == deploy) { // Unchanged after deploy/stow action?
  338. if (IsRunning()) {
  339. SERIAL_ERROR_MSG("Z-Probe failed");
  340. LCD_ALERTMESSAGEPGM_P(PSTR("Err: ZPROBE"));
  341. }
  342. stop();
  343. return true;
  344. }
  345. #else
  346. probe_specific_action(deploy);
  347. #endif
  348. do_blocking_move_to(old_xy);
  349. endstops.enable_z_probe(deploy);
  350. return false;
  351. }
  352. #ifdef Z_AFTER_PROBING
  353. // After probing move to a preferred Z position
  354. void move_z_after_probing() {
  355. if (current_position.z != Z_AFTER_PROBING) {
  356. do_blocking_move_to_z(Z_AFTER_PROBING);
  357. current_position.z = Z_AFTER_PROBING;
  358. }
  359. }
  360. #endif
  361. /**
  362. * @brief Used by run_z_probe to do a single Z probe move.
  363. *
  364. * @param z Z destination
  365. * @param fr_mm_s Feedrate in mm/s
  366. * @return true to indicate an error
  367. */
  368. #if HAS_HEATED_BED && ENABLED(WAIT_FOR_BED_HEATER)
  369. const char msg_wait_for_bed_heating[25] PROGMEM = "Wait for bed heating...\n";
  370. #endif
  371. static bool do_probe_move(const float z, const feedRate_t fr_mm_s) {
  372. if (DEBUGGING(LEVELING)) DEBUG_POS(">>> do_probe_move", current_position);
  373. #if HAS_HEATED_BED && ENABLED(WAIT_FOR_BED_HEATER)
  374. // Wait for bed to heat back up between probing points
  375. if (thermalManager.isHeatingBed()) {
  376. serialprintPGM(msg_wait_for_bed_heating);
  377. LCD_MESSAGEPGM(MSG_BED_HEATING);
  378. thermalManager.wait_for_bed();
  379. ui.reset_status();
  380. }
  381. #endif
  382. #if ENABLED(BLTOUCH) && DISABLED(BLTOUCH_HS_MODE)
  383. if (bltouch.deploy()) return true; // DEPLOY in LOW SPEED MODE on every probe action
  384. #endif
  385. // Disable stealthChop if used. Enable diag1 pin on driver.
  386. #if ENABLED(SENSORLESS_PROBING)
  387. sensorless_t stealth_states { false };
  388. #if ENABLED(DELTA)
  389. stealth_states.x = tmc_enable_stallguard(stepperX);
  390. stealth_states.y = tmc_enable_stallguard(stepperY);
  391. #endif
  392. stealth_states.z = tmc_enable_stallguard(stepperZ);
  393. endstops.enable(true);
  394. #endif
  395. #if QUIET_PROBING
  396. probing_pause(true);
  397. #endif
  398. // Move down until the probe is triggered
  399. do_blocking_move_to_z(z, fr_mm_s);
  400. // Check to see if the probe was triggered
  401. const bool probe_triggered =
  402. #if BOTH(DELTA, SENSORLESS_PROBING)
  403. endstops.trigger_state() & (_BV(X_MIN) | _BV(Y_MIN) | _BV(Z_MIN))
  404. #else
  405. TEST(endstops.trigger_state(),
  406. #if ENABLED(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN)
  407. Z_MIN
  408. #else
  409. Z_MIN_PROBE
  410. #endif
  411. )
  412. #endif
  413. ;
  414. #if QUIET_PROBING
  415. probing_pause(false);
  416. #endif
  417. // Re-enable stealthChop if used. Disable diag1 pin on driver.
  418. #if ENABLED(SENSORLESS_PROBING)
  419. endstops.not_homing();
  420. #if ENABLED(DELTA)
  421. tmc_disable_stallguard(stepperX, stealth_states.x);
  422. tmc_disable_stallguard(stepperY, stealth_states.y);
  423. #endif
  424. tmc_disable_stallguard(stepperZ, stealth_states.z);
  425. #endif
  426. #if ENABLED(BLTOUCH) && DISABLED(BLTOUCH_HS_MODE)
  427. if (probe_triggered && bltouch.stow()) return true; // STOW in LOW SPEED MODE on trigger on every probe action
  428. #endif
  429. // Clear endstop flags
  430. endstops.hit_on_purpose();
  431. // Get Z where the steppers were interrupted
  432. set_current_from_steppers_for_axis(Z_AXIS);
  433. // Tell the planner where we actually are
  434. sync_plan_position();
  435. if (DEBUGGING(LEVELING)) DEBUG_POS("<<< do_probe_move", current_position);
  436. return !probe_triggered;
  437. }
  438. /**
  439. * @brief Probe at the current XY (possibly more than once) to find the bed Z.
  440. *
  441. * @details Used by probe_at_point to get the bed Z height at the current XY.
  442. * Leaves current_position.z at the height where the probe triggered.
  443. *
  444. * @return The Z position of the bed at the current XY or NAN on error.
  445. */
  446. static float run_z_probe() {
  447. if (DEBUGGING(LEVELING)) DEBUG_POS(">>> run_z_probe", current_position);
  448. // Stop the probe before it goes too low to prevent damage.
  449. // If Z isn't known then probe to -10mm.
  450. const float z_probe_low_point = TEST(axis_known_position, Z_AXIS) ? -probe_offset.z + Z_PROBE_LOW_POINT : -10.0;
  451. // Double-probing does a fast probe followed by a slow probe
  452. #if TOTAL_PROBING == 2
  453. // Do a first probe at the fast speed
  454. if (do_probe_move(z_probe_low_point, MMM_TO_MMS(Z_PROBE_SPEED_FAST))) {
  455. if (DEBUGGING(LEVELING)) {
  456. DEBUG_ECHOLNPGM("FAST Probe fail!");
  457. DEBUG_POS("<<< run_z_probe", current_position);
  458. }
  459. return NAN;
  460. }
  461. const float first_probe_z = current_position.z;
  462. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("1st Probe Z:", first_probe_z);
  463. // Raise to give the probe clearance
  464. do_blocking_move_to_z(current_position.z + Z_CLEARANCE_MULTI_PROBE, MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  465. #elif Z_PROBE_SPEED_FAST != Z_PROBE_SPEED_SLOW
  466. // If the nozzle is well over the travel height then
  467. // move down quickly before doing the slow probe
  468. const float z = Z_CLEARANCE_DEPLOY_PROBE + 5.0 + (probe_offset.z < 0 ? -probe_offset.z : 0);
  469. if (current_position.z > z) {
  470. // Probe down fast. If the probe never triggered, raise for probe clearance
  471. if (!do_probe_move(z, MMM_TO_MMS(Z_PROBE_SPEED_FAST)))
  472. do_blocking_move_to_z(current_position.z + Z_CLEARANCE_BETWEEN_PROBES, MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  473. }
  474. #endif
  475. #ifdef EXTRA_PROBING
  476. float probes[TOTAL_PROBING];
  477. #endif
  478. #if TOTAL_PROBING > 2
  479. float probes_total = 0;
  480. for (
  481. #if EXTRA_PROBING
  482. uint8_t p = 0; p < TOTAL_PROBING; p++
  483. #else
  484. uint8_t p = TOTAL_PROBING; p--;
  485. #endif
  486. )
  487. #endif
  488. {
  489. // Probe downward slowly to find the bed
  490. if (do_probe_move(z_probe_low_point, MMM_TO_MMS(Z_PROBE_SPEED_SLOW))) {
  491. if (DEBUGGING(LEVELING)) {
  492. DEBUG_ECHOLNPGM("SLOW Probe fail!");
  493. DEBUG_POS("<<< run_z_probe", current_position);
  494. }
  495. return NAN;
  496. }
  497. #if ENABLED(MEASURE_BACKLASH_WHEN_PROBING)
  498. backlash.measure_with_probe();
  499. #endif
  500. const float z = current_position.z;
  501. #if EXTRA_PROBING
  502. // Insert Z measurement into probes[]. Keep it sorted ascending.
  503. for (uint8_t i = 0; i <= p; i++) { // Iterate the saved Zs to insert the new Z
  504. if (i == p || probes[i] > z) { // Last index or new Z is smaller than this Z
  505. for (int8_t m = p; --m >= i;) probes[m + 1] = probes[m]; // Shift items down after the insertion point
  506. probes[i] = z; // Insert the new Z measurement
  507. break; // Only one to insert. Done!
  508. }
  509. }
  510. #elif TOTAL_PROBING > 2
  511. probes_total += z;
  512. #else
  513. UNUSED(z);
  514. #endif
  515. #if TOTAL_PROBING > 2
  516. // Small Z raise after all but the last probe
  517. if (p
  518. #if EXTRA_PROBING
  519. < TOTAL_PROBING - 1
  520. #endif
  521. ) do_blocking_move_to_z(z + Z_CLEARANCE_MULTI_PROBE, MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  522. #endif
  523. }
  524. #if TOTAL_PROBING > 2
  525. #if EXTRA_PROBING
  526. // Take the center value (or average the two middle values) as the median
  527. static constexpr int PHALF = (TOTAL_PROBING - 1) / 2;
  528. const float middle = probes[PHALF],
  529. median = ((TOTAL_PROBING) & 1) ? middle : (middle + probes[PHALF + 1]) * 0.5f;
  530. // Remove values farthest from the median
  531. uint8_t min_avg_idx = 0, max_avg_idx = TOTAL_PROBING - 1;
  532. for (uint8_t i = EXTRA_PROBING; i--;)
  533. if (ABS(probes[max_avg_idx] - median) > ABS(probes[min_avg_idx] - median))
  534. max_avg_idx--; else min_avg_idx++;
  535. // Return the average value of all remaining probes.
  536. for (uint8_t i = min_avg_idx; i <= max_avg_idx; i++)
  537. probes_total += probes[i];
  538. #endif
  539. const float measured_z = probes_total * RECIPROCAL(MULTIPLE_PROBING);
  540. #elif TOTAL_PROBING == 2
  541. const float z2 = current_position.z;
  542. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("2nd Probe Z:", z2, " Discrepancy:", first_probe_z - z2);
  543. // Return a weighted average of the fast and slow probes
  544. const float measured_z = (z2 * 3.0 + first_probe_z * 2.0) * 0.2;
  545. #else
  546. // Return the single probe result
  547. const float measured_z = current_position.z;
  548. #endif
  549. if (DEBUGGING(LEVELING)) DEBUG_POS("<<< run_z_probe", current_position);
  550. return measured_z;
  551. }
  552. /**
  553. * - Move to the given XY
  554. * - Deploy the probe, if not already deployed
  555. * - Probe the bed, get the Z position
  556. * - Depending on the 'stow' flag
  557. * - Stow the probe, or
  558. * - Raise to the BETWEEN height
  559. * - Return the probed Z position
  560. */
  561. float probe_at_point(const float &rx, const float &ry, const ProbePtRaise raise_after/*=PROBE_PT_NONE*/, const uint8_t verbose_level/*=0*/, const bool probe_relative/*=true*/) {
  562. if (DEBUGGING(LEVELING)) {
  563. DEBUG_ECHOLNPAIR(
  564. ">>> probe_at_point(", LOGICAL_X_POSITION(rx), ", ", LOGICAL_Y_POSITION(ry),
  565. ", ", raise_after == PROBE_PT_RAISE ? "raise" : raise_after == PROBE_PT_STOW ? "stow" : "none",
  566. ", ", int(verbose_level),
  567. ", ", probe_relative ? "probe" : "nozzle", "_relative)"
  568. );
  569. DEBUG_POS("", current_position);
  570. }
  571. // TODO: Adapt for SCARA, where the offset rotates
  572. xyz_pos_t npos = { rx, ry };
  573. if (probe_relative) {
  574. if (!position_is_reachable_by_probe(npos)) return NAN; // The given position is in terms of the probe
  575. npos -= probe_offset; // Get the nozzle position
  576. }
  577. else if (!position_is_reachable(npos)) return NAN; // The given position is in terms of the nozzle
  578. npos.z =
  579. #if ENABLED(DELTA)
  580. // Move below clip height or xy move will be aborted by do_blocking_move_to
  581. _MIN(current_position.z, delta_clip_start_height)
  582. #else
  583. current_position.z
  584. #endif
  585. ;
  586. const float old_feedrate_mm_s = feedrate_mm_s;
  587. feedrate_mm_s = XY_PROBE_FEEDRATE_MM_S;
  588. // Move the probe to the starting XYZ
  589. do_blocking_move_to(npos);
  590. float measured_z = NAN;
  591. if (!DEPLOY_PROBE()) {
  592. measured_z = run_z_probe() + probe_offset.z;
  593. const bool big_raise = raise_after == PROBE_PT_BIG_RAISE;
  594. if (big_raise || raise_after == PROBE_PT_RAISE)
  595. do_blocking_move_to_z(current_position.z + (big_raise ? 25 : Z_CLEARANCE_BETWEEN_PROBES), MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  596. else if (raise_after == PROBE_PT_STOW)
  597. if (STOW_PROBE()) measured_z = NAN;
  598. }
  599. if (verbose_level > 2) {
  600. SERIAL_ECHOPAIR_F("Bed X: ", LOGICAL_X_POSITION(rx), 3);
  601. SERIAL_ECHOPAIR_F(" Y: ", LOGICAL_Y_POSITION(ry), 3);
  602. SERIAL_ECHOLNPAIR_F(" Z: ", measured_z, 3);
  603. }
  604. feedrate_mm_s = old_feedrate_mm_s;
  605. if (isnan(measured_z)) {
  606. STOW_PROBE();
  607. LCD_MESSAGEPGM(MSG_LCD_PROBING_FAILED);
  608. SERIAL_ERROR_MSG(MSG_ERR_PROBING_FAILED);
  609. }
  610. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPGM("<<< probe_at_point");
  611. return measured_z;
  612. }
  613. #if HAS_Z_SERVO_PROBE
  614. void servo_probe_init() {
  615. /**
  616. * Set position of Z Servo Endstop
  617. *
  618. * The servo might be deployed and positioned too low to stow
  619. * when starting up the machine or rebooting the board.
  620. * There's no way to know where the nozzle is positioned until
  621. * homing has been done - no homing with z-probe without init!
  622. *
  623. */
  624. STOW_Z_SERVO();
  625. }
  626. #endif // HAS_Z_SERVO_PROBE
  627. #endif // HAS_BED_PROBE