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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783
  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. #if ENABLED(HOST_PROMPT_SUPPORT)
  107. host_prompt_do(PROMPT_USER_CONTINUE, PSTR("Deploy TouchMI"), CONTINUE_STR);
  108. #endif
  109. wait_for_user_response();
  110. ui.reset_status();
  111. ui.goto_screen(prev_screen);
  112. #elif defined(TOUCH_MI_DEPLOY_XPOS) && defined(TOUCH_MI_DEPLOY_YPOS)
  113. do_blocking_move_to_xy(TOUCH_MI_DEPLOY_XPOS, TOUCH_MI_DEPLOY_YPOS);
  114. #elif defined(TOUCH_MI_DEPLOY_XPOS)
  115. do_blocking_move_to_x(TOUCH_MI_DEPLOY_XPOS);
  116. #elif defined(TOUCH_MI_DEPLOY_YPOS)
  117. do_blocking_move_to_y(TOUCH_MI_DEPLOY_YPOS);
  118. #endif
  119. }
  120. // Move down to the bed to stow the probe
  121. inline void run_stow_moves_script() {
  122. const xyz_pos_t oldpos = current_position;
  123. endstops.enable_z_probe(false);
  124. do_blocking_move_to_z(TOUCH_MI_RETRACT_Z, MMM_TO_MMS(HOMING_FEEDRATE_Z));
  125. do_blocking_move_to(oldpos, MMM_TO_MMS(HOMING_FEEDRATE_Z));
  126. }
  127. #elif ENABLED(Z_PROBE_ALLEN_KEY)
  128. inline void run_deploy_moves_script() {
  129. #ifdef Z_PROBE_ALLEN_KEY_DEPLOY_1
  130. #ifndef Z_PROBE_ALLEN_KEY_DEPLOY_1_FEEDRATE
  131. #define Z_PROBE_ALLEN_KEY_DEPLOY_1_FEEDRATE 0.0
  132. #endif
  133. constexpr xyz_pos_t deploy_1 = Z_PROBE_ALLEN_KEY_DEPLOY_1;
  134. do_blocking_move_to(deploy_1, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_DEPLOY_1_FEEDRATE));
  135. #endif
  136. #ifdef Z_PROBE_ALLEN_KEY_DEPLOY_2
  137. #ifndef Z_PROBE_ALLEN_KEY_DEPLOY_2_FEEDRATE
  138. #define Z_PROBE_ALLEN_KEY_DEPLOY_2_FEEDRATE 0.0
  139. #endif
  140. constexpr xyz_pos_t deploy_2 = Z_PROBE_ALLEN_KEY_DEPLOY_2;
  141. do_blocking_move_to(deploy_2, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_DEPLOY_2_FEEDRATE));
  142. #endif
  143. #ifdef Z_PROBE_ALLEN_KEY_DEPLOY_3
  144. #ifndef Z_PROBE_ALLEN_KEY_DEPLOY_3_FEEDRATE
  145. #define Z_PROBE_ALLEN_KEY_DEPLOY_3_FEEDRATE 0.0
  146. #endif
  147. constexpr xyz_pos_t deploy_3 = Z_PROBE_ALLEN_KEY_DEPLOY_3;
  148. do_blocking_move_to(deploy_3, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_DEPLOY_3_FEEDRATE));
  149. #endif
  150. #ifdef Z_PROBE_ALLEN_KEY_DEPLOY_4
  151. #ifndef Z_PROBE_ALLEN_KEY_DEPLOY_4_FEEDRATE
  152. #define Z_PROBE_ALLEN_KEY_DEPLOY_4_FEEDRATE 0.0
  153. #endif
  154. constexpr xyz_pos_t deploy_4 = Z_PROBE_ALLEN_KEY_DEPLOY_4;
  155. do_blocking_move_to(deploy_4, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_DEPLOY_4_FEEDRATE));
  156. #endif
  157. #ifdef Z_PROBE_ALLEN_KEY_DEPLOY_5
  158. #ifndef Z_PROBE_ALLEN_KEY_DEPLOY_5_FEEDRATE
  159. #define Z_PROBE_ALLEN_KEY_DEPLOY_5_FEEDRATE 0.0
  160. #endif
  161. constexpr xyz_pos_t deploy_5 = Z_PROBE_ALLEN_KEY_DEPLOY_5;
  162. do_blocking_move_to(deploy_5, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_DEPLOY_5_FEEDRATE));
  163. #endif
  164. }
  165. inline void run_stow_moves_script() {
  166. #ifdef Z_PROBE_ALLEN_KEY_STOW_1
  167. #ifndef Z_PROBE_ALLEN_KEY_STOW_1_FEEDRATE
  168. #define Z_PROBE_ALLEN_KEY_STOW_1_FEEDRATE 0.0
  169. #endif
  170. constexpr xyz_pos_t stow_1 = Z_PROBE_ALLEN_KEY_STOW_1;
  171. do_blocking_move_to(stow_1, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_STOW_1_FEEDRATE));
  172. #endif
  173. #ifdef Z_PROBE_ALLEN_KEY_STOW_2
  174. #ifndef Z_PROBE_ALLEN_KEY_STOW_2_FEEDRATE
  175. #define Z_PROBE_ALLEN_KEY_STOW_2_FEEDRATE 0.0
  176. #endif
  177. constexpr xyz_pos_t stow_2 = Z_PROBE_ALLEN_KEY_STOW_2;
  178. do_blocking_move_to(stow_2, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_STOW_2_FEEDRATE));
  179. #endif
  180. #ifdef Z_PROBE_ALLEN_KEY_STOW_3
  181. #ifndef Z_PROBE_ALLEN_KEY_STOW_3_FEEDRATE
  182. #define Z_PROBE_ALLEN_KEY_STOW_3_FEEDRATE 0.0
  183. #endif
  184. constexpr xyz_pos_t stow_3 = Z_PROBE_ALLEN_KEY_STOW_3;
  185. do_blocking_move_to(stow_3, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_STOW_3_FEEDRATE));
  186. #endif
  187. #ifdef Z_PROBE_ALLEN_KEY_STOW_4
  188. #ifndef Z_PROBE_ALLEN_KEY_STOW_4_FEEDRATE
  189. #define Z_PROBE_ALLEN_KEY_STOW_4_FEEDRATE 0.0
  190. #endif
  191. constexpr xyz_pos_t stow_4 = Z_PROBE_ALLEN_KEY_STOW_4;
  192. do_blocking_move_to(stow_4, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_STOW_4_FEEDRATE));
  193. #endif
  194. #ifdef Z_PROBE_ALLEN_KEY_STOW_5
  195. #ifndef Z_PROBE_ALLEN_KEY_STOW_5_FEEDRATE
  196. #define Z_PROBE_ALLEN_KEY_STOW_5_FEEDRATE 0.0
  197. #endif
  198. constexpr xyz_pos_t stow_5 = Z_PROBE_ALLEN_KEY_STOW_5;
  199. do_blocking_move_to(stow_5, MMM_TO_MMS(Z_PROBE_ALLEN_KEY_STOW_5_FEEDRATE));
  200. #endif
  201. }
  202. #endif // Z_PROBE_ALLEN_KEY
  203. #if QUIET_PROBING
  204. void Probe::set_probing_paused(const bool p) {
  205. #if ENABLED(PROBING_HEATERS_OFF)
  206. thermalManager.pause(p);
  207. #endif
  208. #if ENABLED(PROBING_FANS_OFF)
  209. thermalManager.set_fans_paused(p);
  210. #endif
  211. #if ENABLED(PROBING_STEPPERS_OFF)
  212. disable_e_steppers();
  213. #if NONE(DELTA, HOME_AFTER_DEACTIVATE)
  214. DISABLE_AXIS_X(); DISABLE_AXIS_Y();
  215. #endif
  216. #endif
  217. if (p) safe_delay(
  218. #if DELAY_BEFORE_PROBING > 25
  219. DELAY_BEFORE_PROBING
  220. #else
  221. 25
  222. #endif
  223. );
  224. }
  225. #endif // QUIET_PROBING
  226. /**
  227. * Raise Z to a minimum height to make room for a probe to move
  228. */
  229. void Probe::do_z_raise(const float z_raise) {
  230. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("Probe::move_z(", z_raise, ")");
  231. float z_dest = z_raise;
  232. if (offset.z < 0) z_dest -= offset.z;
  233. NOMORE(z_dest, Z_MAX_POS);
  234. if (z_dest > current_position.z)
  235. do_blocking_move_to_z(z_dest);
  236. }
  237. FORCE_INLINE void probe_specific_action(const bool deploy) {
  238. #if ENABLED(PAUSE_BEFORE_DEPLOY_STOW)
  239. do {
  240. #if ENABLED(PAUSE_PROBE_DEPLOY_WHEN_TRIGGERED)
  241. if (deploy == (READ(Z_MIN_PROBE_PIN) == Z_MIN_PROBE_ENDSTOP_INVERTING)) break;
  242. #endif
  243. BUZZ(100, 659);
  244. BUZZ(100, 698);
  245. PGM_P const ds_str = deploy ? GET_TEXT(MSG_MANUAL_DEPLOY) : GET_TEXT(MSG_MANUAL_STOW);
  246. ui.return_to_status(); // To display the new status message
  247. ui.set_status_P(ds_str, 99);
  248. serialprintPGM(ds_str);
  249. SERIAL_EOL();
  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. wait_for_user_response();
  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 ENABLED(BLTOUCH)
  273. deploy ? bltouch.deploy() : bltouch.stow();
  274. #elif HAS_Z_SERVO_PROBE
  275. MOVE_SERVO(Z_PROBE_SERVO_NR, servo_angles[Z_PROBE_SERVO_NR][deploy ? 0 : 1]);
  276. #elif EITHER(TOUCH_MI_PROBE, Z_PROBE_ALLEN_KEY)
  277. deploy ? run_deploy_moves_script() : run_stow_moves_script();
  278. #elif ENABLED(RACK_AND_PINION_PROBE)
  279. do_blocking_move_to_x(deploy ? Z_PROBE_DEPLOY_X : Z_PROBE_RETRACT_X);
  280. #elif DISABLED(PAUSE_BEFORE_DEPLOY_STOW)
  281. UNUSED(deploy);
  282. #endif
  283. }
  284. /**
  285. * Attempt to deploy or stow the probe
  286. *
  287. * Return TRUE if the probe could not be deployed/stowed
  288. */
  289. bool Probe::set_deployed(const bool deploy) {
  290. if (DEBUGGING(LEVELING)) {
  291. DEBUG_POS("Probe::set_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_z_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(STR_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 Probe::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. /**
  369. * @brief Move down until the probe triggers or the low limit is reached
  370. *
  371. * @details Used by run_z_probe to get each bed Z height measurement.
  372. * Sets current_position.z to the height where the probe triggered
  373. * (according to the Z stepper count). The float Z is propagated
  374. * back to the planner.position to preempt any rounding error.
  375. *
  376. * @return TRUE if the probe failed to trigger.
  377. */
  378. bool Probe::probe_down_to_z(const float z, const feedRate_t fr_mm_s) {
  379. if (DEBUGGING(LEVELING)) DEBUG_POS(">>> Probe::probe_down_to_z", current_position);
  380. #if HAS_HEATED_BED && ENABLED(WAIT_FOR_BED_HEATER)
  381. thermalManager.wait_for_bed_heating();
  382. #endif
  383. #if ENABLED(BLTOUCH) && DISABLED(BLTOUCH_HS_MODE)
  384. if (bltouch.deploy()) return true; // DEPLOY in LOW SPEED MODE on every probe action
  385. #endif
  386. // Disable stealthChop if used. Enable diag1 pin on driver.
  387. #if ENABLED(SENSORLESS_PROBING)
  388. sensorless_t stealth_states { false };
  389. #if ENABLED(DELTA)
  390. stealth_states.x = tmc_enable_stallguard(stepperX);
  391. stealth_states.y = tmc_enable_stallguard(stepperY);
  392. #endif
  393. stealth_states.z = tmc_enable_stallguard(stepperZ);
  394. endstops.enable(true);
  395. #endif
  396. #if QUIET_PROBING
  397. set_probing_paused(true);
  398. #endif
  399. // Move down until the probe is triggered
  400. do_blocking_move_to_z(z, fr_mm_s);
  401. // Check to see if the probe was triggered
  402. const bool probe_triggered =
  403. #if BOTH(DELTA, SENSORLESS_PROBING)
  404. endstops.trigger_state() & (_BV(X_MIN) | _BV(Y_MIN) | _BV(Z_MIN))
  405. #else
  406. TEST(endstops.trigger_state(),
  407. #if ENABLED(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN)
  408. Z_MIN
  409. #else
  410. Z_MIN_PROBE
  411. #endif
  412. )
  413. #endif
  414. ;
  415. #if QUIET_PROBING
  416. set_probing_paused(false);
  417. #endif
  418. // Re-enable stealthChop if used. Disable diag1 pin on driver.
  419. #if ENABLED(SENSORLESS_PROBING)
  420. endstops.not_homing();
  421. #if ENABLED(DELTA)
  422. tmc_disable_stallguard(stepperX, stealth_states.x);
  423. tmc_disable_stallguard(stepperY, stealth_states.y);
  424. #endif
  425. tmc_disable_stallguard(stepperZ, stealth_states.z);
  426. #endif
  427. #if ENABLED(BLTOUCH) && DISABLED(BLTOUCH_HS_MODE)
  428. if (probe_triggered && bltouch.stow()) return true; // STOW in LOW SPEED MODE on trigger on every probe action
  429. #endif
  430. // Clear endstop flags
  431. endstops.hit_on_purpose();
  432. // Get Z where the steppers were interrupted
  433. set_current_from_steppers_for_axis(Z_AXIS);
  434. // Tell the planner where we actually are
  435. sync_plan_position();
  436. if (DEBUGGING(LEVELING)) DEBUG_POS("<<< Probe::probe_down_to_z", current_position);
  437. return !probe_triggered;
  438. }
  439. /**
  440. * @brief Probe at the current XY (possibly more than once) to find the bed Z.
  441. *
  442. * @details Used by probe_at_point to get the bed Z height at the current XY.
  443. * Leaves current_position.z at the height where the probe triggered.
  444. *
  445. * @return The Z position of the bed at the current XY or NAN on error.
  446. */
  447. float Probe::run_z_probe(const bool sanity_check/*=true*/) {
  448. if (DEBUGGING(LEVELING)) DEBUG_POS(">>> Probe::run_z_probe", current_position);
  449. // Stop the probe before it goes too low to prevent damage.
  450. // If Z isn't known then probe to -10mm.
  451. const float z_probe_low_point = TEST(axis_known_position, Z_AXIS) ? -offset.z + Z_PROBE_LOW_POINT : -10.0;
  452. // Double-probing does a fast probe followed by a slow probe
  453. #if TOTAL_PROBING == 2
  454. // Do a first probe at the fast speed
  455. if (probe_down_to_z(z_probe_low_point, MMM_TO_MMS(Z_PROBE_SPEED_FAST)) // No probe trigger?
  456. || (sanity_check && current_position.z > -offset.z + _MAX(Z_CLEARANCE_BETWEEN_PROBES, 4) / 2) // Probe triggered too high?
  457. ) {
  458. if (DEBUGGING(LEVELING)) {
  459. DEBUG_ECHOLNPGM("FAST Probe fail!");
  460. DEBUG_POS("<<< run_z_probe", current_position);
  461. }
  462. return NAN;
  463. }
  464. const float first_probe_z = current_position.z;
  465. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("1st Probe Z:", first_probe_z);
  466. // Raise to give the probe clearance
  467. do_blocking_move_to_z(current_position.z + Z_CLEARANCE_MULTI_PROBE, MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  468. #elif Z_PROBE_SPEED_FAST != Z_PROBE_SPEED_SLOW
  469. // If the nozzle is well over the travel height then
  470. // move down quickly before doing the slow probe
  471. const float z = Z_CLEARANCE_DEPLOY_PROBE + 5.0 + (offset.z < 0 ? -offset.z : 0);
  472. if (current_position.z > z) {
  473. // Probe down fast. If the probe never triggered, raise for probe clearance
  474. if (!probe_down_to_z(z, MMM_TO_MMS(Z_PROBE_SPEED_FAST)))
  475. do_blocking_move_to_z(current_position.z + Z_CLEARANCE_BETWEEN_PROBES, MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  476. }
  477. #endif
  478. #ifdef EXTRA_PROBING
  479. float probes[TOTAL_PROBING];
  480. #endif
  481. #if TOTAL_PROBING > 2
  482. float probes_z_sum = 0;
  483. for (
  484. #if EXTRA_PROBING
  485. uint8_t p = 0; p < TOTAL_PROBING; p++
  486. #else
  487. uint8_t p = TOTAL_PROBING; p--;
  488. #endif
  489. )
  490. #endif
  491. {
  492. // Probe downward slowly to find the bed
  493. if (probe_down_to_z(z_probe_low_point, MMM_TO_MMS(Z_PROBE_SPEED_SLOW)) // No probe trigger?
  494. || (sanity_check && current_position.z > -offset.z + _MAX(Z_CLEARANCE_MULTI_PROBE, 4) / 2) // Probe triggered too high?
  495. ) {
  496. if (DEBUGGING(LEVELING)) {
  497. DEBUG_ECHOLNPGM("SLOW Probe fail!");
  498. DEBUG_POS("<<< run_z_probe", current_position);
  499. }
  500. return NAN;
  501. }
  502. #if ENABLED(MEASURE_BACKLASH_WHEN_PROBING)
  503. backlash.measure_with_probe();
  504. #endif
  505. const float z = current_position.z;
  506. #if EXTRA_PROBING
  507. // Insert Z measurement into probes[]. Keep it sorted ascending.
  508. LOOP_LE_N(i, p) { // Iterate the saved Zs to insert the new Z
  509. if (i == p || probes[i] > z) { // Last index or new Z is smaller than this Z
  510. for (int8_t m = p; --m >= i;) probes[m + 1] = probes[m]; // Shift items down after the insertion point
  511. probes[i] = z; // Insert the new Z measurement
  512. break; // Only one to insert. Done!
  513. }
  514. }
  515. #elif TOTAL_PROBING > 2
  516. probes_z_sum += z;
  517. #else
  518. UNUSED(z);
  519. #endif
  520. #if TOTAL_PROBING > 2
  521. // Small Z raise after all but the last probe
  522. if (p
  523. #if EXTRA_PROBING
  524. < TOTAL_PROBING - 1
  525. #endif
  526. ) do_blocking_move_to_z(z + Z_CLEARANCE_MULTI_PROBE, MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  527. #endif
  528. }
  529. #if TOTAL_PROBING > 2
  530. #if EXTRA_PROBING
  531. // Take the center value (or average the two middle values) as the median
  532. static constexpr int PHALF = (TOTAL_PROBING - 1) / 2;
  533. const float middle = probes[PHALF],
  534. median = ((TOTAL_PROBING) & 1) ? middle : (middle + probes[PHALF + 1]) * 0.5f;
  535. // Remove values farthest from the median
  536. uint8_t min_avg_idx = 0, max_avg_idx = TOTAL_PROBING - 1;
  537. for (uint8_t i = EXTRA_PROBING; i--;)
  538. if (ABS(probes[max_avg_idx] - median) > ABS(probes[min_avg_idx] - median))
  539. max_avg_idx--; else min_avg_idx++;
  540. // Return the average value of all remaining probes.
  541. LOOP_S_LE_N(i, min_avg_idx, max_avg_idx)
  542. probes_z_sum += probes[i];
  543. #endif
  544. const float measured_z = probes_z_sum * RECIPROCAL(MULTIPLE_PROBING);
  545. #elif TOTAL_PROBING == 2
  546. const float z2 = current_position.z;
  547. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPAIR("2nd Probe Z:", z2, " Discrepancy:", first_probe_z - z2);
  548. // Return a weighted average of the fast and slow probes
  549. const float measured_z = (z2 * 3.0 + first_probe_z * 2.0) * 0.2;
  550. #else
  551. // Return the single probe result
  552. const float measured_z = current_position.z;
  553. #endif
  554. if (DEBUGGING(LEVELING)) DEBUG_POS("<<< run_z_probe", current_position);
  555. return measured_z;
  556. }
  557. /**
  558. * - Move to the given XY
  559. * - Deploy the probe, if not already deployed
  560. * - Probe the bed, get the Z position
  561. * - Depending on the 'stow' flag
  562. * - Stow the probe, or
  563. * - Raise to the BETWEEN height
  564. * - Return the probed Z position
  565. */
  566. 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*/) {
  567. if (DEBUGGING(LEVELING)) {
  568. DEBUG_ECHOLNPAIR(
  569. ">>> Probe::probe_at_point(", LOGICAL_X_POSITION(rx), ", ", LOGICAL_Y_POSITION(ry),
  570. ", ", raise_after == PROBE_PT_RAISE ? "raise" : raise_after == PROBE_PT_STOW ? "stow" : "none",
  571. ", ", int(verbose_level),
  572. ", ", probe_relative ? "probe" : "nozzle", "_relative)"
  573. );
  574. DEBUG_POS("", current_position);
  575. }
  576. #if BOTH(BLTOUCH, BLTOUCH_HS_MODE)
  577. if (bltouch.triggered()) bltouch._reset();
  578. #endif
  579. // TODO: Adapt for SCARA, where the offset rotates
  580. xyz_pos_t npos = { rx, ry };
  581. if (probe_relative) { // The given position is in terms of the probe
  582. if (!can_reach(npos)) {
  583. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPGM("Position Not Reachable");
  584. return NAN;
  585. }
  586. npos -= offset_xy; // Get the nozzle position
  587. }
  588. else if (!position_is_reachable(npos)) return NAN; // The given position is in terms of the nozzle
  589. npos.z =
  590. #if ENABLED(DELTA)
  591. // Move below clip height or xy move will be aborted by do_blocking_move_to
  592. _MIN(current_position.z, delta_clip_start_height)
  593. #else
  594. current_position.z
  595. #endif
  596. ;
  597. const float old_feedrate_mm_s = feedrate_mm_s;
  598. feedrate_mm_s = XY_PROBE_FEEDRATE_MM_S;
  599. // Move the probe to the starting XYZ
  600. do_blocking_move_to(npos);
  601. float measured_z = NAN;
  602. if (!deploy()) measured_z = run_z_probe(sanity_check) + offset.z;
  603. if (!isnan(measured_z)) {
  604. const bool big_raise = raise_after == PROBE_PT_BIG_RAISE;
  605. if (big_raise || raise_after == PROBE_PT_RAISE)
  606. do_blocking_move_to_z(current_position.z + (big_raise ? 25 : Z_CLEARANCE_BETWEEN_PROBES), MMM_TO_MMS(Z_PROBE_SPEED_FAST));
  607. else if (raise_after == PROBE_PT_STOW)
  608. if (stow()) measured_z = NAN; // Error on stow?
  609. if (verbose_level > 2) {
  610. SERIAL_ECHOPAIR_F("Bed X: ", LOGICAL_X_POSITION(rx), 3);
  611. SERIAL_ECHOPAIR_F( " Y: ", LOGICAL_Y_POSITION(ry), 3);
  612. SERIAL_ECHOLNPAIR_F( " Z: ", measured_z, 3);
  613. }
  614. }
  615. feedrate_mm_s = old_feedrate_mm_s;
  616. if (isnan(measured_z)) {
  617. stow();
  618. LCD_MESSAGEPGM(MSG_LCD_PROBING_FAILED);
  619. SERIAL_ERROR_MSG(STR_ERR_PROBING_FAILED);
  620. }
  621. if (DEBUGGING(LEVELING)) DEBUG_ECHOLNPGM("<<< Probe::probe_at_point");
  622. return measured_z;
  623. }
  624. #if HAS_Z_SERVO_PROBE
  625. void Probe::servo_probe_init() {
  626. /**
  627. * Set position of Z Servo Endstop
  628. *
  629. * The servo might be deployed and positioned too low to stow
  630. * when starting up the machine or rebooting the board.
  631. * There's no way to know where the nozzle is positioned until
  632. * homing has been done - no homing with z-probe without init!
  633. *
  634. */
  635. STOW_Z_SERVO();
  636. }
  637. #endif // HAS_Z_SERVO_PROBE
  638. #endif // HAS_BED_PROBE