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.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2016 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. * endstops.cpp - A singleton object to manage endstops
  24. */
  25. #include "Marlin.h"
  26. #include "cardreader.h"
  27. #include "endstops.h"
  28. #include "temperature.h"
  29. #include "stepper.h"
  30. #include "ultralcd.h"
  31. // TEST_ENDSTOP: test the old and the current status of an endstop
  32. #define TEST_ENDSTOP(ENDSTOP) (TEST(current_endstop_bits & old_endstop_bits, ENDSTOP))
  33. Endstops endstops;
  34. // public:
  35. bool Endstops::enabled = true,
  36. Endstops::enabled_globally =
  37. #if ENABLED(ENDSTOPS_ALWAYS_ON_DEFAULT)
  38. (true)
  39. #else
  40. (false)
  41. #endif
  42. ;
  43. volatile char Endstops::endstop_hit_bits; // use X_MIN, Y_MIN, Z_MIN and Z_MIN_PROBE as BIT value
  44. #if ENABLED(Z_DUAL_ENDSTOPS)
  45. uint16_t
  46. #else
  47. byte
  48. #endif
  49. Endstops::current_endstop_bits = 0,
  50. Endstops::old_endstop_bits = 0;
  51. #if HAS_BED_PROBE
  52. volatile bool Endstops::z_probe_enabled = false;
  53. #endif
  54. /**
  55. * Class and Instance Methods
  56. */
  57. void Endstops::init() {
  58. #if HAS_X_MIN
  59. #if ENABLED(ENDSTOPPULLUP_XMIN)
  60. SET_INPUT_PULLUP(X_MIN_PIN);
  61. #else
  62. SET_INPUT(X_MIN_PIN);
  63. #endif
  64. #endif
  65. #if HAS_Y_MIN
  66. #if ENABLED(ENDSTOPPULLUP_YMIN)
  67. SET_INPUT_PULLUP(Y_MIN_PIN);
  68. #else
  69. SET_INPUT(Y_MIN_PIN);
  70. #endif
  71. #endif
  72. #if HAS_Z_MIN
  73. #if ENABLED(ENDSTOPPULLUP_ZMIN)
  74. SET_INPUT_PULLUP(Z_MIN_PIN);
  75. #else
  76. SET_INPUT(Z_MIN_PIN);
  77. #endif
  78. #endif
  79. #if HAS_Z2_MIN
  80. #if ENABLED(ENDSTOPPULLUP_ZMIN)
  81. SET_INPUT_PULLUP(Z2_MIN_PIN);
  82. #else
  83. SET_INPUT(Z2_MIN_PIN);
  84. #endif
  85. #endif
  86. #if HAS_X_MAX
  87. #if ENABLED(ENDSTOPPULLUP_XMAX)
  88. SET_INPUT_PULLUP(X_MAX_PIN);
  89. #else
  90. SET_INPUT(X_MAX_PIN);
  91. #endif
  92. #endif
  93. #if HAS_Y_MAX
  94. #if ENABLED(ENDSTOPPULLUP_YMAX)
  95. SET_INPUT_PULLUP(Y_MAX_PIN);
  96. #else
  97. SET_INPUT(Y_MAX_PIN);
  98. #endif
  99. #endif
  100. #if HAS_Z_MAX
  101. #if ENABLED(ENDSTOPPULLUP_ZMAX)
  102. SET_INPUT_PULLUP(Z_MAX_PIN);
  103. #else
  104. SET_INPUT(Z_MAX_PIN);
  105. #endif
  106. #endif
  107. #if HAS_Z2_MAX
  108. #if ENABLED(ENDSTOPPULLUP_ZMAX)
  109. SET_INPUT_PULLUP(Z2_MAX_PIN);
  110. #else
  111. SET_INPUT(Z2_MAX_PIN);
  112. #endif
  113. #endif
  114. #if ENABLED(Z_MIN_PROBE_ENDSTOP)
  115. #if ENABLED(ENDSTOPPULLUP_ZMIN_PROBE)
  116. SET_INPUT_PULLUP(Z_MIN_PROBE_PIN);
  117. #else
  118. SET_INPUT(Z_MIN_PROBE_PIN);
  119. #endif
  120. #endif
  121. } // Endstops::init
  122. void Endstops::report_state() {
  123. if (endstop_hit_bits) {
  124. #if ENABLED(ULTRA_LCD)
  125. char chrX = ' ', chrY = ' ', chrZ = ' ', chrP = ' ';
  126. #define _SET_STOP_CHAR(A,C) (chr## A = C)
  127. #else
  128. #define _SET_STOP_CHAR(A,C) ;
  129. #endif
  130. #define _ENDSTOP_HIT_ECHO(A,C) do{ \
  131. SERIAL_ECHOPAIR(" " STRINGIFY(A) ":", stepper.triggered_position_mm(A ##_AXIS)); \
  132. _SET_STOP_CHAR(A,C); }while(0)
  133. #define _ENDSTOP_HIT_TEST(A,C) \
  134. if (TEST(endstop_hit_bits, A ##_MIN) || TEST(endstop_hit_bits, A ##_MAX)) \
  135. _ENDSTOP_HIT_ECHO(A,C)
  136. #define ENDSTOP_HIT_TEST_X() _ENDSTOP_HIT_TEST(X,'X')
  137. #define ENDSTOP_HIT_TEST_Y() _ENDSTOP_HIT_TEST(Y,'Y')
  138. #define ENDSTOP_HIT_TEST_Z() _ENDSTOP_HIT_TEST(Z,'Z')
  139. SERIAL_ECHO_START();
  140. SERIAL_ECHOPGM(MSG_ENDSTOPS_HIT);
  141. ENDSTOP_HIT_TEST_X();
  142. ENDSTOP_HIT_TEST_Y();
  143. ENDSTOP_HIT_TEST_Z();
  144. #if ENABLED(Z_MIN_PROBE_ENDSTOP)
  145. #define P_AXIS Z_AXIS
  146. if (TEST(endstop_hit_bits, Z_MIN_PROBE)) _ENDSTOP_HIT_ECHO(P, 'P');
  147. #endif
  148. SERIAL_EOL();
  149. #if ENABLED(ULTRA_LCD)
  150. lcd_status_printf_P(0, PSTR(MSG_LCD_ENDSTOPS " %c %c %c %c"), chrX, chrY, chrZ, chrP);
  151. #endif
  152. hit_on_purpose();
  153. #if ENABLED(ABORT_ON_ENDSTOP_HIT_FEATURE_ENABLED) && ENABLED(SDSUPPORT)
  154. if (stepper.abort_on_endstop_hit) {
  155. card.sdprinting = false;
  156. card.closefile();
  157. quickstop_stepper();
  158. thermalManager.disable_all_heaters(); // switch off all heaters.
  159. }
  160. #endif
  161. }
  162. } // Endstops::report_state
  163. void Endstops::M119() {
  164. SERIAL_PROTOCOLLNPGM(MSG_M119_REPORT);
  165. #if HAS_X_MIN
  166. SERIAL_PROTOCOLPGM(MSG_X_MIN);
  167. SERIAL_PROTOCOLLN(((READ(X_MIN_PIN)^X_MIN_ENDSTOP_INVERTING) ? MSG_ENDSTOP_HIT : MSG_ENDSTOP_OPEN));
  168. #endif
  169. #if HAS_X_MAX
  170. SERIAL_PROTOCOLPGM(MSG_X_MAX);
  171. SERIAL_PROTOCOLLN(((READ(X_MAX_PIN)^X_MAX_ENDSTOP_INVERTING) ? MSG_ENDSTOP_HIT : MSG_ENDSTOP_OPEN));
  172. #endif
  173. #if HAS_Y_MIN
  174. SERIAL_PROTOCOLPGM(MSG_Y_MIN);
  175. SERIAL_PROTOCOLLN(((READ(Y_MIN_PIN)^Y_MIN_ENDSTOP_INVERTING) ? MSG_ENDSTOP_HIT : MSG_ENDSTOP_OPEN));
  176. #endif
  177. #if HAS_Y_MAX
  178. SERIAL_PROTOCOLPGM(MSG_Y_MAX);
  179. SERIAL_PROTOCOLLN(((READ(Y_MAX_PIN)^Y_MAX_ENDSTOP_INVERTING) ? MSG_ENDSTOP_HIT : MSG_ENDSTOP_OPEN));
  180. #endif
  181. #if HAS_Z_MIN
  182. SERIAL_PROTOCOLPGM(MSG_Z_MIN);
  183. SERIAL_PROTOCOLLN(((READ(Z_MIN_PIN)^Z_MIN_ENDSTOP_INVERTING) ? MSG_ENDSTOP_HIT : MSG_ENDSTOP_OPEN));
  184. #endif
  185. #if HAS_Z2_MIN
  186. SERIAL_PROTOCOLPGM(MSG_Z2_MIN);
  187. SERIAL_PROTOCOLLN(((READ(Z2_MIN_PIN)^Z2_MIN_ENDSTOP_INVERTING) ? MSG_ENDSTOP_HIT : MSG_ENDSTOP_OPEN));
  188. #endif
  189. #if HAS_Z_MAX
  190. SERIAL_PROTOCOLPGM(MSG_Z_MAX);
  191. SERIAL_PROTOCOLLN(((READ(Z_MAX_PIN)^Z_MAX_ENDSTOP_INVERTING) ? MSG_ENDSTOP_HIT : MSG_ENDSTOP_OPEN));
  192. #endif
  193. #if HAS_Z2_MAX
  194. SERIAL_PROTOCOLPGM(MSG_Z2_MAX);
  195. SERIAL_PROTOCOLLN(((READ(Z2_MAX_PIN)^Z2_MAX_ENDSTOP_INVERTING) ? MSG_ENDSTOP_HIT : MSG_ENDSTOP_OPEN));
  196. #endif
  197. #if ENABLED(Z_MIN_PROBE_ENDSTOP)
  198. SERIAL_PROTOCOLPGM(MSG_Z_PROBE);
  199. SERIAL_PROTOCOLLN(((READ(Z_MIN_PROBE_PIN)^Z_MIN_PROBE_ENDSTOP_INVERTING) ? MSG_ENDSTOP_HIT : MSG_ENDSTOP_OPEN));
  200. #endif
  201. #if ENABLED(FILAMENT_RUNOUT_SENSOR)
  202. SERIAL_PROTOCOLPGM(MSG_FILAMENT_RUNOUT_SENSOR);
  203. SERIAL_PROTOCOLLN(((READ(FIL_RUNOUT_PIN)^FIL_RUNOUT_INVERTING) ? MSG_ENDSTOP_HIT : MSG_ENDSTOP_OPEN));
  204. #endif
  205. } // Endstops::M119
  206. #if ENABLED(Z_DUAL_ENDSTOPS)
  207. // Pass the result of the endstop test
  208. void Endstops::test_dual_z_endstops(const EndstopEnum es1, const EndstopEnum es2) {
  209. byte z_test = TEST_ENDSTOP(es1) | (TEST_ENDSTOP(es2) << 1); // bit 0 for Z, bit 1 for Z2
  210. if (z_test && stepper.current_block->steps[Z_AXIS] > 0) {
  211. SBI(endstop_hit_bits, Z_MIN);
  212. if (!stepper.performing_homing || (z_test == 0x3)) //if not performing home or if both endstops were trigged during homing...
  213. stepper.kill_current_block();
  214. }
  215. }
  216. #endif
  217. // Check endstops - Called from ISR!
  218. void Endstops::update() {
  219. #define _ENDSTOP(AXIS, MINMAX) AXIS ##_## MINMAX
  220. #define _ENDSTOP_PIN(AXIS, MINMAX) AXIS ##_## MINMAX ##_PIN
  221. #define _ENDSTOP_INVERTING(AXIS, MINMAX) AXIS ##_## MINMAX ##_ENDSTOP_INVERTING
  222. #define _ENDSTOP_HIT(AXIS) SBI(endstop_hit_bits, _ENDSTOP(AXIS, MIN))
  223. // UPDATE_ENDSTOP_BIT: set the current endstop bits for an endstop to its status
  224. #define UPDATE_ENDSTOP_BIT(AXIS, MINMAX) SET_BIT(current_endstop_bits, _ENDSTOP(AXIS, MINMAX), (READ(_ENDSTOP_PIN(AXIS, MINMAX)) != _ENDSTOP_INVERTING(AXIS, MINMAX)))
  225. // COPY_BIT: copy the value of SRC_BIT to DST_BIT in DST
  226. #define COPY_BIT(DST, SRC_BIT, DST_BIT) SET_BIT(DST, DST_BIT, TEST(DST, SRC_BIT))
  227. #define UPDATE_ENDSTOP(AXIS,MINMAX) do { \
  228. UPDATE_ENDSTOP_BIT(AXIS, MINMAX); \
  229. if (TEST_ENDSTOP(_ENDSTOP(AXIS, MINMAX)) && stepper.current_block->steps[_AXIS(AXIS)] > 0) { \
  230. _ENDSTOP_HIT(AXIS); \
  231. stepper.endstop_triggered(_AXIS(AXIS)); \
  232. } \
  233. } while(0)
  234. #if ENABLED(G38_PROBE_TARGET) && PIN_EXISTS(Z_MIN_PROBE) && !(CORE_IS_XY || CORE_IS_XZ)
  235. // If G38 command is active check Z_MIN_PROBE for ALL movement
  236. if (G38_move) {
  237. UPDATE_ENDSTOP_BIT(Z, MIN_PROBE);
  238. if (TEST_ENDSTOP(_ENDSTOP(Z, MIN_PROBE))) {
  239. if (stepper.current_block->steps[_AXIS(X)] > 0) { _ENDSTOP_HIT(X); stepper.endstop_triggered(_AXIS(X)); }
  240. else if (stepper.current_block->steps[_AXIS(Y)] > 0) { _ENDSTOP_HIT(Y); stepper.endstop_triggered(_AXIS(Y)); }
  241. else if (stepper.current_block->steps[_AXIS(Z)] > 0) { _ENDSTOP_HIT(Z); stepper.endstop_triggered(_AXIS(Z)); }
  242. G38_endstop_hit = true;
  243. }
  244. }
  245. #endif
  246. /**
  247. * Define conditions for checking endstops
  248. */
  249. #if IS_CORE
  250. #define S_(N) stepper.current_block->steps[CORE_AXIS_##N]
  251. #define D_(N) stepper.motor_direction(CORE_AXIS_##N)
  252. #endif
  253. #if CORE_IS_XY || CORE_IS_XZ
  254. /**
  255. * Head direction in -X axis for CoreXY and CoreXZ bots.
  256. *
  257. * If steps differ, both axes are moving.
  258. * If DeltaA == -DeltaB, the movement is only in the 2nd axis (Y or Z, handled below)
  259. * If DeltaA == DeltaB, the movement is only in the 1st axis (X)
  260. */
  261. #if ENABLED(COREXY) || ENABLED(COREXZ)
  262. #define X_CMP ==
  263. #else
  264. #define X_CMP !=
  265. #endif
  266. #define X_MOVE_TEST ( S_(1) != S_(2) || (S_(1) > 0 && D_(1) X_CMP D_(2)) )
  267. #define X_AXIS_HEAD X_HEAD
  268. #else
  269. #define X_MOVE_TEST stepper.current_block->steps[X_AXIS] > 0
  270. #define X_AXIS_HEAD X_AXIS
  271. #endif
  272. #if CORE_IS_XY || CORE_IS_YZ
  273. /**
  274. * Head direction in -Y axis for CoreXY / CoreYZ bots.
  275. *
  276. * If steps differ, both axes are moving
  277. * If DeltaA == DeltaB, the movement is only in the 1st axis (X or Y)
  278. * If DeltaA == -DeltaB, the movement is only in the 2nd axis (Y or Z)
  279. */
  280. #if ENABLED(COREYX) || ENABLED(COREYZ)
  281. #define Y_CMP ==
  282. #else
  283. #define Y_CMP !=
  284. #endif
  285. #define Y_MOVE_TEST ( S_(1) != S_(2) || (S_(1) > 0 && D_(1) Y_CMP D_(2)) )
  286. #define Y_AXIS_HEAD Y_HEAD
  287. #else
  288. #define Y_MOVE_TEST stepper.current_block->steps[Y_AXIS] > 0
  289. #define Y_AXIS_HEAD Y_AXIS
  290. #endif
  291. #if CORE_IS_XZ || CORE_IS_YZ
  292. /**
  293. * Head direction in -Z axis for CoreXZ or CoreYZ bots.
  294. *
  295. * If steps differ, both axes are moving
  296. * If DeltaA == DeltaB, the movement is only in the 1st axis (X or Y, already handled above)
  297. * If DeltaA == -DeltaB, the movement is only in the 2nd axis (Z)
  298. */
  299. #if ENABLED(COREZX) || ENABLED(COREZY)
  300. #define Z_CMP ==
  301. #else
  302. #define Z_CMP !=
  303. #endif
  304. #define Z_MOVE_TEST ( S_(1) != S_(2) || (S_(1) > 0 && D_(1) Z_CMP D_(2)) )
  305. #define Z_AXIS_HEAD Z_HEAD
  306. #else
  307. #define Z_MOVE_TEST stepper.current_block->steps[Z_AXIS] > 0
  308. #define Z_AXIS_HEAD Z_AXIS
  309. #endif
  310. // With Dual X, endstops are only checked in the homing direction for the active extruder
  311. #if ENABLED(DUAL_X_CARRIAGE)
  312. #define E0_ACTIVE stepper.current_block->active_extruder == 0
  313. #define X_MIN_TEST ((X_HOME_DIR < 0 && E0_ACTIVE) || (X2_HOME_DIR < 0 && !E0_ACTIVE))
  314. #define X_MAX_TEST ((X_HOME_DIR > 0 && E0_ACTIVE) || (X2_HOME_DIR > 0 && !E0_ACTIVE))
  315. #else
  316. #define X_MIN_TEST true
  317. #define X_MAX_TEST true
  318. #endif
  319. /**
  320. * Check and update endstops according to conditions
  321. */
  322. if (X_MOVE_TEST) {
  323. if (stepper.motor_direction(X_AXIS_HEAD)) {
  324. if (X_MIN_TEST) { // -direction
  325. #if HAS_X_MIN
  326. UPDATE_ENDSTOP(X, MIN);
  327. #endif
  328. }
  329. }
  330. else if (X_MAX_TEST) { // +direction
  331. #if HAS_X_MAX
  332. UPDATE_ENDSTOP(X, MAX);
  333. #endif
  334. }
  335. }
  336. if (Y_MOVE_TEST) {
  337. if (stepper.motor_direction(Y_AXIS_HEAD)) { // -direction
  338. #if HAS_Y_MIN
  339. UPDATE_ENDSTOP(Y, MIN);
  340. #endif
  341. }
  342. else { // +direction
  343. #if HAS_Y_MAX
  344. UPDATE_ENDSTOP(Y, MAX);
  345. #endif
  346. }
  347. }
  348. if (Z_MOVE_TEST) {
  349. if (stepper.motor_direction(Z_AXIS_HEAD)) { // Z -direction. Gantry down, bed up.
  350. #if HAS_Z_MIN
  351. #if ENABLED(Z_DUAL_ENDSTOPS)
  352. UPDATE_ENDSTOP_BIT(Z, MIN);
  353. #if HAS_Z2_MIN
  354. UPDATE_ENDSTOP_BIT(Z2, MIN);
  355. #else
  356. COPY_BIT(current_endstop_bits, Z_MIN, Z2_MIN);
  357. #endif
  358. test_dual_z_endstops(Z_MIN, Z2_MIN);
  359. #else // !Z_DUAL_ENDSTOPS
  360. #if ENABLED(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN)
  361. if (z_probe_enabled) UPDATE_ENDSTOP(Z, MIN);
  362. #else
  363. UPDATE_ENDSTOP(Z, MIN);
  364. #endif
  365. #endif // !Z_DUAL_ENDSTOPS
  366. #endif // HAS_Z_MIN
  367. // When closing the gap check the enabled probe
  368. #if ENABLED(Z_MIN_PROBE_ENDSTOP)
  369. if (z_probe_enabled) {
  370. UPDATE_ENDSTOP(Z, MIN_PROBE);
  371. if (TEST_ENDSTOP(Z_MIN_PROBE)) SBI(endstop_hit_bits, Z_MIN_PROBE);
  372. }
  373. #endif
  374. }
  375. else { // Z +direction. Gantry up, bed down.
  376. #if HAS_Z_MAX
  377. // Check both Z dual endstops
  378. #if ENABLED(Z_DUAL_ENDSTOPS)
  379. UPDATE_ENDSTOP_BIT(Z, MAX);
  380. #if HAS_Z2_MAX
  381. UPDATE_ENDSTOP_BIT(Z2, MAX);
  382. #else
  383. COPY_BIT(current_endstop_bits, Z_MAX, Z2_MAX);
  384. #endif
  385. test_dual_z_endstops(Z_MAX, Z2_MAX);
  386. // If this pin is not hijacked for the bed probe
  387. // then it belongs to the Z endstop
  388. #elif DISABLED(Z_MIN_PROBE_ENDSTOP) || Z_MAX_PIN != Z_MIN_PROBE_PIN
  389. UPDATE_ENDSTOP(Z, MAX);
  390. #endif // !Z_MIN_PROBE_PIN...
  391. #endif // Z_MAX_PIN
  392. }
  393. }
  394. old_endstop_bits = current_endstop_bits;
  395. } // Endstops::update()