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 24KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (c) 2020 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. * module/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 "../MarlinCore.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. #if ENABLED(BLTOUCH)
  48. #include "../feature/bltouch.h"
  49. #endif
  50. #if ENABLED(HOST_PROMPT_SUPPORT)
  51. #include "../feature/host_actions.h" // for PROMPT_USER_CONTINUE
  52. #endif
  53. #if HAS_Z_SERVO_PROBE
  54. #include "servo.h"
  55. #endif
  56. #if ENABLED(SENSORLESS_PROBING)
  57. #include "stepper.h"
  58. #include "../feature/tmc_util.h"
  59. #endif
  60. #if QUIET_PROBING
  61. #include "stepper/indirection.h"
  62. #endif
  63. #if ENABLED(EXTENSIBLE_UI)
  64. #include "../lcd/extui/ui_api.h"
  65. #endif
  66. #define DEBUG_OUT ENABLED(DEBUG_LEVELING_FEATURE)
  67. #include "../core/debug_out.h"
  68. Probe probe;
  69. xyz_pos_t Probe::offset; // Initialized by settings.load()
  70. #if HAS_PROBE_XY_OFFSET
  71. const xyz_pos_t &Probe::offset_xy = Probe::offset;
  72. #endif
  73. #if ENABLED(Z_PROBE_SLED)
  74. #ifndef SLED_DOCKING_OFFSET
  75. #define SLED_DOCKING_OFFSET 0
  76. #endif
  77. /**
  78. * Method to dock/undock a sled designed by Charles Bell.
  79. *
  80. * stow[in] If false, move to MAX_X and engage the solenoid
  81. * If true, move to MAX_X and release the solenoid
  82. */
  83. static void dock_sled(const bool stow) {
  84. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("dock_sled(", stow, ")");
  85. // Dock sled a bit closer to ensure proper capturing
  86. do_blocking_move_to_x(X_MAX_POS + SLED_DOCKING_OFFSET - ((stow) ? 1 : 0));
  87. #if HAS_SOLENOID_1 && DISABLED(EXT_SOLENOID)
  88. WRITE(SOL1_PIN, !stow); // switch solenoid
  89. #endif
  90. }
  91. #elif ENABLED(TOUCH_MI_PROBE)
  92. // Move to the magnet to unlock the probe
  93. inline void run_deploy_moves_script() {
  94. #ifndef TOUCH_MI_DEPLOY_XPOS
  95. #define TOUCH_MI_DEPLOY_XPOS X_MIN_POS
  96. #elif TOUCH_MI_DEPLOY_XPOS > X_MAX_BED
  97. TemporaryGlobalEndstopsState unlock_x(false);
  98. #endif
  99. #if TOUCH_MI_DEPLOY_YPOS > Y_MAX_BED
  100. TemporaryGlobalEndstopsState unlock_y(false);
  101. #endif
  102. #if ENABLED(TOUCH_MI_MANUAL_DEPLOY)
  103. const screenFunc_t prev_screen = ui.currentScreen;
  104. LCD_MESSAGEPGM(MSG_MANUAL_DEPLOY_TOUCHMI);
  105. ui.return_to_status();
  106. TERN_(HOST_PROMPT_SUPPORT, host_prompt_do(PROMPT_USER_CONTINUE, PSTR("Deploy TouchMI"), CONTINUE_STR));
  107. wait_for_user_response();
  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. inline 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. inline 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. inline 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 Probe::set_probing_paused(const bool p) {
  203. TERN_(PROBING_HEATERS_OFF, thermalManager.pause(p));
  204. TERN_(PROBING_FANS_OFF, thermalManager.set_fans_paused(p));
  205. #if ENABLED(PROBING_STEPPERS_OFF)
  206. disable_e_steppers();
  207. #if NONE(DELTA, HOME_AFTER_DEACTIVATE)
  208. DISABLE_AXIS_X(); DISABLE_AXIS_Y();
  209. #endif
  210. #endif
  211. if (p) safe_delay(25
  212. #if DELAY_BEFORE_PROBING > 25
  213. - 25 + DELAY_BEFORE_PROBING
  214. #endif
  215. );
  216. }
  217. #endif // QUIET_PROBING
  218. /**
  219. * Raise Z to a minimum height to make room for a probe to move
  220. */
  221. void Probe::do_z_raise(const float z_raise) {
  222. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("Probe::move_z(", z_raise, ")");
  223. float z_dest = z_raise;
  224. if (offset.z < 0) z_dest -= offset.z;
  225. NOMORE(z_dest, Z_MAX_POS);
  226. if (z_dest > current_position.z)
  227. do_blocking_move_to_z(z_dest);
  228. }
  229. FORCE_INLINE void probe_specific_action(const bool deploy) {
  230. #if ENABLED(PAUSE_BEFORE_DEPLOY_STOW)
  231. do {
  232. #if ENABLED(PAUSE_PROBE_DEPLOY_WHEN_TRIGGERED)
  233. if (deploy == (READ(Z_MIN_PROBE_PIN) == Z_MIN_PROBE_ENDSTOP_INVERTING)) break;
  234. #endif
  235. BUZZ(100, 659);
  236. BUZZ(100, 698);
  237. PGM_P const ds_str = deploy ? GET_TEXT(MSG_MANUAL_DEPLOY) : GET_TEXT(MSG_MANUAL_STOW);
  238. ui.return_to_status(); // To display the new status message
  239. ui.set_status_P(ds_str, 99);
  240. serialprintPGM(ds_str);
  241. SERIAL_EOL();
  242. TERN_(HOST_PROMPT_SUPPORT, host_prompt_do(PROMPT_USER_CONTINUE, PSTR("Stow Probe"), CONTINUE_STR));
  243. TERN_(EXTENSIBLE_UI, ExtUI::onUserConfirmRequired_P(PSTR("Stow Probe")));
  244. wait_for_user_response();
  245. ui.reset_status();
  246. } while (ENABLED(PAUSE_PROBE_DEPLOY_WHEN_TRIGGERED));
  247. #endif // PAUSE_BEFORE_DEPLOY_STOW
  248. #if ENABLED(SOLENOID_PROBE)
  249. #if HAS_SOLENOID_1
  250. WRITE(SOL1_PIN, deploy);
  251. #endif
  252. #elif ENABLED(Z_PROBE_SLED)
  253. dock_sled(!deploy);
  254. #elif ENABLED(BLTOUCH)
  255. deploy ? bltouch.deploy() : bltouch.stow();
  256. #elif HAS_Z_SERVO_PROBE
  257. MOVE_SERVO(Z_PROBE_SERVO_NR, servo_angles[Z_PROBE_SERVO_NR][deploy ? 0 : 1]);
  258. #elif EITHER(TOUCH_MI_PROBE, Z_PROBE_ALLEN_KEY)
  259. deploy ? run_deploy_moves_script() : run_stow_moves_script();
  260. #elif ENABLED(RACK_AND_PINION_PROBE)
  261. do_blocking_move_to_x(deploy ? Z_PROBE_DEPLOY_X : Z_PROBE_RETRACT_X);
  262. #elif DISABLED(PAUSE_BEFORE_DEPLOY_STOW)
  263. UNUSED(deploy);
  264. #endif
  265. }
  266. /**
  267. * Attempt to deploy or stow the probe
  268. *
  269. * Return TRUE if the probe could not be deployed/stowed
  270. */
  271. bool Probe::set_deployed(const bool deploy) {
  272. if (DEBUGGING(LEVELING)) {
  273. DEBUG_POS("Probe::set_deployed", current_position);
  274. DEBUG_ECHOLNPAIR("deploy: ", deploy);
  275. }
  276. if (endstops.z_probe_enabled == deploy) return false;
  277. // Make room for probe to deploy (or stow)
  278. // Fix-mounted probe should only raise for deploy
  279. // unless PAUSE_BEFORE_DEPLOY_STOW is enabled
  280. #if EITHER(FIX_MOUNTED_PROBE, NOZZLE_AS_PROBE) && DISABLED(PAUSE_BEFORE_DEPLOY_STOW)
  281. const bool deploy_stow_condition = deploy;
  282. #else
  283. constexpr bool deploy_stow_condition = true;
  284. #endif
  285. // For beds that fall when Z is powered off only raise for trusted Z
  286. #if ENABLED(UNKNOWN_Z_NO_RAISE)
  287. const bool unknown_condition = TEST(axis_known_position, Z_AXIS);
  288. #else
  289. constexpr float unknown_condition = true;
  290. #endif
  291. if (deploy_stow_condition && unknown_condition)
  292. do_z_raise(_MAX(Z_CLEARANCE_BETWEEN_PROBES, Z_CLEARANCE_DEPLOY_PROBE));
  293. #if EITHER(Z_PROBE_SLED, Z_PROBE_ALLEN_KEY)
  294. if (axis_unhomed_error(TERN_(Z_PROBE_SLED, _BV(X_AXIS)))) {
  295. SERIAL_ERROR_MSG(STR_STOP_UNHOMED);
  296. stop();
  297. return true;
  298. }
  299. #endif
  300. const xy_pos_t old_xy = current_position;
  301. #if ENABLED(PROBE_TRIGGERED_WHEN_STOWED_TEST)
  302. #if HAS_CUSTOM_PROBE_PIN
  303. #define PROBE_STOWED() (READ(Z_MIN_PROBE_PIN) != Z_MIN_PROBE_ENDSTOP_INVERTING)
  304. #else
  305. #define PROBE_STOWED() (READ(Z_MIN_PIN) != Z_MIN_ENDSTOP_INVERTING)
  306. #endif
  307. #endif
  308. #ifdef PROBE_STOWED
  309. // Only deploy/stow if needed
  310. if (PROBE_STOWED() == deploy) {
  311. if (!deploy) endstops.enable_z_probe(false); // Switch off triggered when stowed probes early
  312. // otherwise an Allen-Key probe can't be stowed.
  313. probe_specific_action(deploy);
  314. }
  315. if (PROBE_STOWED() == deploy) { // Unchanged after deploy/stow action?
  316. if (IsRunning()) {
  317. SERIAL_ERROR_MSG("Z-Probe failed");
  318. LCD_ALERTMESSAGEPGM_P(PSTR("Err: ZPROBE"));
  319. }
  320. stop();
  321. return true;
  322. }
  323. #else
  324. probe_specific_action(deploy);
  325. #endif
  326. do_blocking_move_to(old_xy);
  327. endstops.enable_z_probe(deploy);
  328. return false;
  329. }
  330. #ifdef Z_AFTER_PROBING
  331. // After probing move to a preferred Z position
  332. void Probe::move_z_after_probing() {
  333. if (current_position.z != Z_AFTER_PROBING) {
  334. do_blocking_move_to_z(Z_AFTER_PROBING);
  335. current_position.z = Z_AFTER_PROBING;
  336. }
  337. }
  338. #endif
  339. /**
  340. * @brief Used by run_z_probe to do a single Z probe move.
  341. *
  342. * @param z Z destination
  343. * @param fr_mm_s Feedrate in mm/s
  344. * @return true to indicate an error
  345. */
  346. /**
  347. * @brief Move down until the probe triggers or the low limit is reached
  348. *
  349. * @details Used by run_z_probe to get each bed Z height measurement.
  350. * Sets current_position.z to the height where the probe triggered
  351. * (according to the Z stepper count). The float Z is propagated
  352. * back to the planner.position to preempt any rounding error.
  353. *
  354. * @return TRUE if the probe failed to trigger.
  355. */
  356. bool Probe::probe_down_to_z(const float z, const feedRate_t fr_mm_s) {
  357. if (DEBUGGING(LEVELING)) DEBUG_POS(">>> Probe::probe_down_to_z", current_position);
  358. #if BOTH(HAS_HEATED_BED, WAIT_FOR_BED_HEATER)
  359. thermalManager.wait_for_bed_heating();
  360. #endif
  361. #if ENABLED(BLTOUCH) && DISABLED(BLTOUCH_HS_MODE)
  362. if (bltouch.deploy()) return true; // DEPLOY in LOW SPEED MODE on every probe action
  363. #endif
  364. // Disable stealthChop if used. Enable diag1 pin on driver.
  365. #if ENABLED(SENSORLESS_PROBING)
  366. sensorless_t stealth_states { false };
  367. #if ENABLED(DELTA)
  368. stealth_states.x = tmc_enable_stallguard(stepperX);
  369. stealth_states.y = tmc_enable_stallguard(stepperY);
  370. #endif
  371. stealth_states.z = tmc_enable_stallguard(stepperZ);
  372. endstops.enable(true);
  373. #endif
  374. TERN_(QUIET_PROBING, set_probing_paused(true));
  375. // Move down until the probe is triggered
  376. do_blocking_move_to_z(z, fr_mm_s);
  377. // Check to see if the probe was triggered
  378. const bool probe_triggered =
  379. #if BOTH(DELTA, SENSORLESS_PROBING)
  380. endstops.trigger_state() & (_BV(X_MIN) | _BV(Y_MIN) | _BV(Z_MIN))
  381. #else
  382. TEST(endstops.trigger_state(), TERN(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN, Z_MIN, Z_MIN_PROBE))
  383. #endif
  384. ;
  385. TERN_(QUIET_PROBING, set_probing_paused(false));
  386. // Re-enable stealthChop if used. Disable diag1 pin on driver.
  387. #if ENABLED(SENSORLESS_PROBING)
  388. endstops.not_homing();
  389. #if ENABLED(DELTA)
  390. tmc_disable_stallguard(stepperX, stealth_states.x);
  391. tmc_disable_stallguard(stepperY, stealth_states.y);
  392. #endif
  393. tmc_disable_stallguard(stepperZ, stealth_states.z);
  394. #endif
  395. #if ENABLED(BLTOUCH) && DISABLED(BLTOUCH_HS_MODE)
  396. if (probe_triggered && bltouch.stow()) return true; // STOW in LOW SPEED MODE on trigger on every probe action
  397. #endif
  398. // Clear endstop flags
  399. endstops.hit_on_purpose();
  400. // Get Z where the steppers were interrupted
  401. set_current_from_steppers_for_axis(Z_AXIS);
  402. // Tell the planner where we actually are
  403. sync_plan_position();
  404. if (DEBUGGING(LEVELING)) DEBUG_POS("<<< Probe::probe_down_to_z", current_position);
  405. return !probe_triggered;
  406. }
  407. /**
  408. * @brief Probe at the current XY (possibly more than once) to find the bed Z.
  409. *
  410. * @details Used by probe_at_point to get the bed Z height at the current XY.
  411. * Leaves current_position.z at the height where the probe triggered.
  412. *
  413. * @return The Z position of the bed at the current XY or NAN on error.
  414. */
  415. float Probe::run_z_probe(const bool sanity_check/*=true*/) {
  416. if (DEBUGGING(LEVELING)) DEBUG_POS(">>> Probe::run_z_probe", current_position);
  417. auto try_to_probe = [&](PGM_P const plbl, const float &z_probe_low_point, const feedRate_t fr_mm_s, const bool scheck, const float clearance) {
  418. // Do a first probe at the fast speed
  419. const bool probe_fail = probe_down_to_z(z_probe_low_point, fr_mm_s), // No probe trigger?
  420. early_fail = (scheck && current_position.z > -offset.z + clearance); // Probe triggered too high?
  421. #if ENABLED(DEBUG_LEVELING_FEATURE)
  422. if (DEBUGGING(LEVELING) && (probe_fail || early_fail)) {
  423. DEBUG_PRINT_P(plbl);
  424. DEBUG_ECHOPGM(" Probe fail! -");
  425. if (probe_fail) DEBUG_ECHOPGM(" No trigger.");
  426. if (early_fail) DEBUG_ECHOPGM(" Triggered early.");
  427. DEBUG_EOL();
  428. DEBUG_POS("<<< run_z_probe", current_position);
  429. }
  430. #else
  431. UNUSED(plbl);
  432. #endif
  433. return probe_fail || early_fail;
  434. };
  435. // Stop the probe before it goes too low to prevent damage.
  436. // If Z isn't known then probe to -10mm.
  437. const float z_probe_low_point = TEST(axis_known_position, Z_AXIS) ? -offset.z + Z_PROBE_LOW_POINT : -10.0;
  438. // Double-probing does a fast probe followed by a slow probe
  439. #if TOTAL_PROBING == 2
  440. // Do a first probe at the fast speed
  441. if (try_to_probe(PSTR("FAST"), z_probe_low_point, MMM_TO_MMS(Z_PROBE_SPEED_FAST),
  442. sanity_check, _MAX(Z_CLEARANCE_BETWEEN_PROBES, 4) / 2) ) return NAN;
  443. const float first_probe_z = current_position.z;
  444. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("1st Probe Z:", first_probe_z);
  445. // Raise to give the probe clearance
  446. do_blocking_move_to_z(current_position.z + Z_CLEARANCE_MULTI_PROBE, MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  447. #elif Z_PROBE_SPEED_FAST != Z_PROBE_SPEED_SLOW
  448. // If the nozzle is well over the travel height then
  449. // move down quickly before doing the slow probe
  450. const float z = Z_CLEARANCE_DEPLOY_PROBE + 5.0 + (offset.z < 0 ? -offset.z : 0);
  451. if (current_position.z > z) {
  452. // Probe down fast. If the probe never triggered, raise for probe clearance
  453. if (!probe_down_to_z(z, MMM_TO_MMS(Z_PROBE_SPEED_FAST)))
  454. do_blocking_move_to_z(current_position.z + Z_CLEARANCE_BETWEEN_PROBES, MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  455. }
  456. #endif
  457. #ifdef EXTRA_PROBING
  458. float probes[TOTAL_PROBING];
  459. #endif
  460. #if TOTAL_PROBING > 2
  461. float probes_z_sum = 0;
  462. for (
  463. #if EXTRA_PROBING
  464. uint8_t p = 0; p < TOTAL_PROBING; p++
  465. #else
  466. uint8_t p = TOTAL_PROBING; p--;
  467. #endif
  468. )
  469. #endif
  470. {
  471. // Probe downward slowly to find the bed
  472. if (try_to_probe(PSTR("SLOW"), z_probe_low_point, MMM_TO_MMS(Z_PROBE_SPEED_SLOW),
  473. sanity_check, _MAX(Z_CLEARANCE_MULTI_PROBE, 4) / 2) ) return NAN;
  474. TERN_(MEASURE_BACKLASH_WHEN_PROBING, backlash.measure_with_probe());
  475. const float z = current_position.z;
  476. #if EXTRA_PROBING
  477. // Insert Z measurement into probes[]. Keep it sorted ascending.
  478. LOOP_LE_N(i, p) { // Iterate the saved Zs to insert the new Z
  479. if (i == p || probes[i] > z) { // Last index or new Z is smaller than this Z
  480. for (int8_t m = p; --m >= i;) probes[m + 1] = probes[m]; // Shift items down after the insertion point
  481. probes[i] = z; // Insert the new Z measurement
  482. break; // Only one to insert. Done!
  483. }
  484. }
  485. #elif TOTAL_PROBING > 2
  486. probes_z_sum += z;
  487. #else
  488. UNUSED(z);
  489. #endif
  490. #if TOTAL_PROBING > 2
  491. // Small Z raise after all but the last probe
  492. if (TERN(EXTRA_PROBING, p < TOTAL_PROBING - 1, p))
  493. do_blocking_move_to_z(z + Z_CLEARANCE_MULTI_PROBE, MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  494. #endif
  495. }
  496. #if TOTAL_PROBING > 2
  497. #if EXTRA_PROBING
  498. // Take the center value (or average the two middle values) as the median
  499. static constexpr int PHALF = (TOTAL_PROBING - 1) / 2;
  500. const float middle = probes[PHALF],
  501. median = ((TOTAL_PROBING) & 1) ? middle : (middle + probes[PHALF + 1]) * 0.5f;
  502. // Remove values farthest from the median
  503. uint8_t min_avg_idx = 0, max_avg_idx = TOTAL_PROBING - 1;
  504. for (uint8_t i = EXTRA_PROBING; i--;)
  505. if (ABS(probes[max_avg_idx] - median) > ABS(probes[min_avg_idx] - median))
  506. max_avg_idx--; else min_avg_idx++;
  507. // Return the average value of all remaining probes.
  508. LOOP_S_LE_N(i, min_avg_idx, max_avg_idx)
  509. probes_z_sum += probes[i];
  510. #endif
  511. const float measured_z = probes_z_sum * RECIPROCAL(MULTIPLE_PROBING);
  512. #elif TOTAL_PROBING == 2
  513. const float z2 = current_position.z;
  514. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("2nd Probe Z:", z2, " Discrepancy:", first_probe_z - z2);
  515. // Return a weighted average of the fast and slow probes
  516. const float measured_z = (z2 * 3.0 + first_probe_z * 2.0) * 0.2;
  517. #else
  518. // Return the single probe result
  519. const float measured_z = current_position.z;
  520. #endif
  521. if (DEBUGGING(LEVELING)) DEBUG_POS("<<< run_z_probe", current_position);
  522. return measured_z;
  523. }
  524. /**
  525. * - Move to the given XY
  526. * - Deploy the probe, if not already deployed
  527. * - Probe the bed, get the Z position
  528. * - Depending on the 'stow' flag
  529. * - Stow the probe, or
  530. * - Raise to the BETWEEN height
  531. * - Return the probed Z position
  532. */
  533. float Probe::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*/, const bool sanity_check/*=true*/) {
  534. if (DEBUGGING(LEVELING)) {
  535. DEBUG_ECHOLNPAIR(
  536. ">>> Probe::probe_at_point(", LOGICAL_X_POSITION(rx), ", ", LOGICAL_Y_POSITION(ry),
  537. ", ", raise_after == PROBE_PT_RAISE ? "raise" : raise_after == PROBE_PT_STOW ? "stow" : "none",
  538. ", ", int(verbose_level),
  539. ", ", probe_relative ? "probe" : "nozzle", "_relative)"
  540. );
  541. DEBUG_POS("", current_position);
  542. }
  543. #if BOTH(BLTOUCH, BLTOUCH_HS_MODE)
  544. if (bltouch.triggered()) bltouch._reset();
  545. #endif
  546. // TODO: Adapt for SCARA, where the offset rotates
  547. xyz_pos_t npos = { rx, ry };
  548. if (probe_relative) { // The given position is in terms of the probe
  549. if (!can_reach(npos)) {
  550. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPGM("Position Not Reachable");
  551. return NAN;
  552. }
  553. npos -= offset_xy; // Get the nozzle position
  554. }
  555. else if (!position_is_reachable(npos)) return NAN; // The given position is in terms of the nozzle
  556. npos.z =
  557. #if ENABLED(DELTA)
  558. // Move below clip height or xy move will be aborted by do_blocking_move_to
  559. _MIN(current_position.z, delta_clip_start_height)
  560. #else
  561. current_position.z
  562. #endif
  563. ;
  564. const float old_feedrate_mm_s = feedrate_mm_s;
  565. feedrate_mm_s = XY_PROBE_FEEDRATE_MM_S;
  566. // Move the probe to the starting XYZ
  567. do_blocking_move_to(npos);
  568. float measured_z = NAN;
  569. if (!deploy()) measured_z = run_z_probe(sanity_check) + offset.z;
  570. if (!isnan(measured_z)) {
  571. const bool big_raise = raise_after == PROBE_PT_BIG_RAISE;
  572. if (big_raise || raise_after == PROBE_PT_RAISE)
  573. do_blocking_move_to_z(current_position.z + (big_raise ? 25 : Z_CLEARANCE_BETWEEN_PROBES), MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  574. else if (raise_after == PROBE_PT_STOW)
  575. if (stow()) measured_z = NAN; // Error on stow?
  576. if (verbose_level > 2) {
  577. SERIAL_ECHOPAIR_F("Bed X: ", LOGICAL_X_POSITION(rx), 3);
  578. SERIAL_ECHOPAIR_F( " Y: ", LOGICAL_Y_POSITION(ry), 3);
  579. SERIAL_ECHOLNPAIR_F( " Z: ", measured_z, 3);
  580. }
  581. }
  582. feedrate_mm_s = old_feedrate_mm_s;
  583. if (isnan(measured_z)) {
  584. stow();
  585. LCD_MESSAGEPGM(MSG_LCD_PROBING_FAILED);
  586. SERIAL_ERROR_MSG(STR_ERR_PROBING_FAILED);
  587. }
  588. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPGM("<<< Probe::probe_at_point");
  589. return measured_z;
  590. }
  591. #if HAS_Z_SERVO_PROBE
  592. void Probe::servo_probe_init() {
  593. /**
  594. * Set position of Z Servo Endstop
  595. *
  596. * The servo might be deployed and positioned too low to stow
  597. * when starting up the machine or rebooting the board.
  598. * There's no way to know where the nozzle is positioned until
  599. * homing has been done - no homing with z-probe without init!
  600. *
  601. */
  602. STOW_Z_SERVO();
  603. }
  604. #endif // HAS_Z_SERVO_PROBE
  605. #endif // HAS_BED_PROBE