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

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