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.

SanityCheck.h 24KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649
  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. * SanityCheck.h
  24. *
  25. * Test configuration values for errors at compile-time.
  26. */
  27. #ifndef SANITYCHECK_H
  28. #define SANITYCHECK_H
  29. /**
  30. * Due to the high number of issues related with old versions of Arduino IDE
  31. * we are now warning our users to update their toolkits. In a future Marlin
  32. * release we will stop supporting old IDE versions and will require user
  33. * action to proceed with compilation in such environments.
  34. */
  35. #if !defined(ARDUINO) || ARDUINO < 10600
  36. #error "Versions of Arduino IDE prior to 1.6.0 are no longer supported, please update your toolkit."
  37. #endif
  38. /**
  39. * We try our best to include sanity checks for all the changes configuration
  40. * directives because people have a tendency to use outdated config files with
  41. * the bleding edge source code, but sometimes this is not enough. This check
  42. * will force a minimum config file revision, otherwise Marlin will not build.
  43. */
  44. #if ! defined(CONFIGURATION_H_VERSION) || CONFIGURATION_H_VERSION < REQUIRED_CONFIGURATION_H_VERSION
  45. #error "You are using an old Configuration.h file, update it before building Marlin."
  46. #endif
  47. #if ! defined(CONFIGURATION_ADV_H_VERSION) || CONFIGURATION_ADV_H_VERSION < REQUIRED_CONFIGURATION_ADV_H_VERSION
  48. #error "You are using an old Configuration_adv.h file, update it before building Marlin."
  49. #endif
  50. /**
  51. * Marlin release, version and default string
  52. */
  53. #ifndef SHORT_BUILD_VERSION
  54. #error "SHORT_BUILD_VERSION must be specified."
  55. #elif !defined(DETAILED_BUILD_VERSION)
  56. #error "BUILD_VERSION must be specified."
  57. #elif !defined(STRING_DISTRIBUTION_DATE)
  58. #error "STRING_DISTRIBUTION_DATE must be specified."
  59. #elif !defined(PROTOCOL_VERSION)
  60. #error "PROTOCOL_VERSION must be specified."
  61. #elif !defined(MACHINE_NAME)
  62. #error "MACHINE_NAME must be specified."
  63. #elif !defined(SOURCE_CODE_URL)
  64. #error "SOURCE_CODE_URL must be specified."
  65. #elif !defined(DEFAULT_MACHINE_UUID)
  66. #error "DEFAULT_MACHINE_UUID must be specified."
  67. #elif !defined(WEBSITE_URL)
  68. #error "WEBSITE_URL must be specified."
  69. #endif
  70. /**
  71. * Dual Stepper Drivers
  72. */
  73. #if ENABLED(Z_DUAL_STEPPER_DRIVERS) && ENABLED(Y_DUAL_STEPPER_DRIVERS)
  74. #error "You cannot have dual stepper drivers for both Y and Z."
  75. #endif
  76. /**
  77. * Progress Bar
  78. */
  79. #if ENABLED(LCD_PROGRESS_BAR)
  80. #if DISABLED(SDSUPPORT)
  81. #error "LCD_PROGRESS_BAR requires SDSUPPORT."
  82. #endif
  83. #if ENABLED(DOGLCD)
  84. #error "LCD_PROGRESS_BAR does not apply to graphical displays."
  85. #endif
  86. #if ENABLED(FILAMENT_LCD_DISPLAY)
  87. #error "LCD_PROGRESS_BAR and FILAMENT_LCD_DISPLAY are not fully compatible. Comment out this line to use both."
  88. #endif
  89. #endif
  90. /**
  91. * Babystepping
  92. */
  93. #if ENABLED(BABYSTEPPING)
  94. #if DISABLED(ULTRA_LCD)
  95. #error "BABYSTEPPING requires an LCD controller."
  96. #endif
  97. #if ENABLED(SCARA)
  98. #error "BABYSTEPPING is not implemented for SCARA yet."
  99. #endif
  100. #if ENABLED(DELTA) && ENABLED(BABYSTEP_XY)
  101. #error "BABYSTEPPING only implemented for Z axis on deltabots."
  102. #endif
  103. #endif
  104. /**
  105. * Filament Runout needs a pin and either SD Support or Auto print start detection
  106. */
  107. #if ENABLED(FILAMENT_RUNOUT_SENSOR)
  108. #if !HAS_FIL_RUNOUT
  109. #error "FILAMENT_RUNOUT_SENSOR requires FIL_RUNOUT_PIN."
  110. #elif DISABLED(SDSUPPORT) && DISABLED(PRINTJOB_TIMER_AUTOSTART)
  111. #error "FILAMENT_RUNOUT_SENSOR requires SDSUPPORT or PRINTJOB_TIMER_AUTOSTART."
  112. #endif
  113. #endif
  114. /**
  115. * Filament Change with Extruder Runout Prevention
  116. */
  117. #if ENABLED(FILAMENT_CHANGE_FEATURE) && ENABLED(EXTRUDER_RUNOUT_PREVENT)
  118. #error "EXTRUDER_RUNOUT_PREVENT is incompatible with FILAMENT_CHANGE_FEATURE."
  119. #endif
  120. /**
  121. * Individual axis homing is useless for DELTAS
  122. */
  123. #if ENABLED(INDIVIDUAL_AXIS_HOMING_MENU) && ENABLED(DELTA)
  124. #error "INDIVIDUAL_AXIS_HOMING_MENU is incompatible with DELTA kinematics."
  125. #endif
  126. /**
  127. * Options only for EXTRUDERS > 1
  128. */
  129. #if EXTRUDERS > 1
  130. #if EXTRUDERS > 4
  131. #error "The maximum number of EXTRUDERS in Marlin is 4."
  132. #endif
  133. #if ENABLED(TEMP_SENSOR_1_AS_REDUNDANT)
  134. #error "EXTRUDERS must be 1 with TEMP_SENSOR_1_AS_REDUNDANT."
  135. #endif
  136. #if ENABLED(HEATERS_PARALLEL)
  137. #error "EXTRUDERS must be 1 with HEATERS_PARALLEL."
  138. #endif
  139. #if ENABLED(Y_DUAL_STEPPER_DRIVERS)
  140. #error "EXTRUDERS must be 1 with Y_DUAL_STEPPER_DRIVERS."
  141. #endif
  142. #if ENABLED(Z_DUAL_STEPPER_DRIVERS)
  143. #error "EXTRUDERS must be 1 with Z_DUAL_STEPPER_DRIVERS."
  144. #endif
  145. #elif ENABLED(SINGLENOZZLE)
  146. #error "SINGLENOZZLE requires 2 or more EXTRUDERS."
  147. #endif
  148. /**
  149. * Limited number of servos
  150. */
  151. #if defined(NUM_SERVOS) && NUM_SERVOS > 0
  152. #if NUM_SERVOS > 4
  153. #error "The maximum number of SERVOS in Marlin is 4."
  154. #elif HAS_Z_SERVO_ENDSTOP && Z_ENDSTOP_SERVO_NR >= NUM_SERVOS
  155. #error "Z_ENDSTOP_SERVO_NR must be smaller than NUM_SERVOS."
  156. #endif
  157. #endif
  158. /**
  159. * Servo deactivation depends on servo endstops
  160. */
  161. #if ENABLED(DEACTIVATE_SERVOS_AFTER_MOVE) && !HAS_Z_SERVO_ENDSTOP
  162. #error "Z_ENDSTOP_SERVO_NR is required for DEACTIVATE_SERVOS_AFTER_MOVE."
  163. #endif
  164. /**
  165. * Required LCD language
  166. */
  167. #if DISABLED(DOGLCD) && ENABLED(ULTRA_LCD) && !defined(DISPLAY_CHARSET_HD44780)
  168. #error "You must set DISPLAY_CHARSET_HD44780 to JAPANESE, WESTERN or CYRILLIC for your LCD controller."
  169. #endif
  170. /**
  171. * Bed Heating Options - PID vs Limit Switching
  172. */
  173. #if ENABLED(PIDTEMPBED) && ENABLED(BED_LIMIT_SWITCHING)
  174. #error "To use BED_LIMIT_SWITCHING you must disable PIDTEMPBED."
  175. #endif
  176. /**
  177. * Mesh Bed Leveling
  178. */
  179. #if ENABLED(MESH_BED_LEVELING)
  180. #if ENABLED(DELTA)
  181. #error "MESH_BED_LEVELING does not yet support DELTA printers."
  182. #endif
  183. #if ENABLED(AUTO_BED_LEVELING_FEATURE)
  184. #error "Select AUTO_BED_LEVELING_FEATURE or MESH_BED_LEVELING, not both."
  185. #endif
  186. #if MESH_NUM_X_POINTS > 7 || MESH_NUM_Y_POINTS > 7
  187. #error "MESH_NUM_X_POINTS and MESH_NUM_Y_POINTS need to be less than 8."
  188. #endif
  189. #elif ENABLED(MANUAL_BED_LEVELING)
  190. #error "MESH_BED_LEVELING is required for MANUAL_BED_LEVELING."
  191. #endif
  192. /**
  193. * Probes
  194. */
  195. #if PROBE_SELECTED
  196. /**
  197. * NUM_SERVOS is required for a Z servo probe
  198. */
  199. #if HAS_Z_SERVO_ENDSTOP
  200. #ifndef NUM_SERVOS
  201. #error "You must set NUM_SERVOS for a Z servo probe (Z_ENDSTOP_SERVO_NR)."
  202. #elif Z_ENDSTOP_SERVO_NR >= NUM_SERVOS
  203. #error "Z_ENDSTOP_SERVO_NR must be less than NUM_SERVOS."
  204. #endif
  205. #endif
  206. /**
  207. * A probe needs a pin
  208. */
  209. #if !PROBE_PIN_CONFIGURED
  210. #error "A probe needs a pin! Use Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN or Z_MIN_PROBE_PIN."
  211. #endif
  212. /**
  213. * Z_MIN_PIN and Z_MIN_PROBE_PIN can't co-exist when Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN
  214. */
  215. #if HAS_Z_MIN && HAS_Z_MIN_PROBE_PIN && ENABLED(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN)
  216. #error "A probe cannot have more than one pin! Use Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN or Z_MIN_PROBE_PIN."
  217. #endif
  218. /**
  219. * Make sure the plug is enabled if it's used
  220. */
  221. #if ENABLED(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN) && DISABLED(USE_ZMIN_PLUG)
  222. #error "You must enable USE_ZMIN_PLUG if any probe or endstop is connected to the ZMIN plug."
  223. #endif
  224. /**
  225. * Only allow one probe option to be defined
  226. */
  227. #if (ENABLED(FIX_MOUNTED_PROBE) && (ENABLED(Z_PROBE_ALLEN_KEY) || HAS_Z_SERVO_ENDSTOP || ENABLED(Z_PROBE_SLED))) \
  228. || (ENABLED(Z_PROBE_ALLEN_KEY) && (HAS_Z_SERVO_ENDSTOP || ENABLED(Z_PROBE_SLED))) \
  229. || (HAS_Z_SERVO_ENDSTOP && ENABLED(Z_PROBE_SLED))
  230. #error "Please define only one type of probe: Z Servo, Z_PROBE_ALLEN_KEY, Z_PROBE_SLED, or FIX_MOUNTED_PROBE."
  231. #endif
  232. /**
  233. * Don't allow nonsense probe-pin settings
  234. */
  235. #if ENABLED(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN) && ENABLED(Z_MIN_PROBE_ENDSTOP)
  236. #error "You can't enable both Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN and Z_MIN_PROBE_ENDSTOP."
  237. #elif ENABLED(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN) && ENABLED(DISABLE_Z_MIN_PROBE_ENDSTOP)
  238. #error "Don't enable DISABLE_Z_MIN_PROBE_ENDSTOP with Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN."
  239. #elif ENABLED(DISABLE_Z_MIN_PROBE_ENDSTOP) && DISABLED(Z_MIN_PROBE_ENDSTOP)
  240. #error "DISABLE_Z_MIN_PROBE_ENDSTOP requires Z_MIN_PROBE_ENDSTOP to be set."
  241. #endif
  242. /**
  243. * Require a Z probe pin if Z_MIN_PROBE_ENDSTOP is enabled.
  244. */
  245. #if ENABLED(Z_MIN_PROBE_ENDSTOP)
  246. #if !HAS_Z_MIN_PROBE_PIN
  247. #error "Z_MIN_PROBE_ENDSTOP requires a Z_MIN_PROBE_PIN in your board's pins_XXXX.h file."
  248. #endif
  249. // Forcing Servo definitions can break some hall effect sensor setups. Leaving these here for further comment.
  250. //#ifndef NUM_SERVOS
  251. // #error "You must have NUM_SERVOS defined and there must be at least 1 configured to use Z_MIN_PROBE_ENDSTOP."
  252. //#endif
  253. //#if defined(NUM_SERVOS) && NUM_SERVOS < 1
  254. // #error "You must have at least 1 servo defined for NUM_SERVOS to use Z_MIN_PROBE_ENDSTOP."
  255. //#endif
  256. //#if Z_ENDSTOP_SERVO_NR < 0
  257. // #error "You must have Z_ENDSTOP_SERVO_NR set to at least 0 or above to use Z_MIN_PROBE_ENDSTOP."
  258. //#endif
  259. //#ifndef Z_SERVO_ANGLES
  260. // #error "You must have Z_SERVO_ANGLES defined for Z Extend and Retract to use Z_MIN_PROBE_ENDSTOP."
  261. //#endif
  262. #endif
  263. /**
  264. * Make sure Z raise values are set
  265. */
  266. #if defined(Z_RAISE_BEFORE_PROBING) || defined(Z_RAISE_AFTER_PROBING)
  267. #error "Z_RAISE_(BEFORE|AFTER)_PROBING are deprecated. Use Z_RAISE_PROBE_DEPLOY_STOW instead."
  268. #elif !defined(Z_RAISE_PROBE_DEPLOY_STOW)
  269. #error "You must set Z_RAISE_PROBE_DEPLOY_STOW in your configuration."
  270. #elif !defined(Z_RAISE_BETWEEN_PROBINGS)
  271. #error "You must set Z_RAISE_BETWEEN_PROBINGS in your configuration."
  272. #elif Z_RAISE_PROBE_DEPLOY_STOW < 1
  273. #error "Probes need Z_RAISE_PROBE_DEPLOY_STOW >= 1."
  274. #elif Z_RAISE_BETWEEN_PROBINGS < 1
  275. #error "Probes need Z_RAISE_BETWEEN_PROBINGS >= 1."
  276. #endif
  277. #else
  278. /**
  279. * Require some kind of probe for bed leveling and probe testing
  280. */
  281. #if ENABLED(AUTO_BED_LEVELING_FEATURE)
  282. #error "AUTO_BED_LEVELING_FEATURE requires a probe! Define a Z Servo, Z_PROBE_ALLEN_KEY, Z_PROBE_SLED, or FIX_MOUNTED_PROBE."
  283. #elif ENABLED(Z_MIN_PROBE_REPEATABILITY_TEST)
  284. #error "Z_MIN_PROBE_REPEATABILITY_TEST requires a probe! Define a Z Servo, Z_PROBE_ALLEN_KEY, Z_PROBE_SLED, or FIX_MOUNTED_PROBE."
  285. #endif
  286. #endif
  287. /**
  288. * Auto Bed Leveling
  289. */
  290. #if ENABLED(AUTO_BED_LEVELING_FEATURE)
  291. /**
  292. * Require a Z min pin
  293. */
  294. #if !PIN_EXISTS(Z_MIN)
  295. #if !PIN_EXISTS(Z_MIN_PROBE) || (DISABLED(Z_MIN_PROBE_ENDSTOP) || ENABLED(DISABLE_Z_MIN_PROBE_ENDSTOP)) // It's possible for someone to set a pin for the Z probe, but not enable it.
  296. #error "AUTO_BED_LEVELING_FEATURE requires a Z_MIN or Z_PROBE endstop. Z_MIN_PIN or Z_MIN_PROBE_PIN must point to a valid hardware pin."
  297. #endif
  298. #endif
  299. /**
  300. * Check if Probe_Offset * Grid Points is greater than Probing Range
  301. */
  302. #if ENABLED(AUTO_BED_LEVELING_GRID)
  303. #ifndef DELTA_PROBEABLE_RADIUS
  304. // Be sure points are in the right order
  305. #if LEFT_PROBE_BED_POSITION > RIGHT_PROBE_BED_POSITION
  306. #error "LEFT_PROBE_BED_POSITION must be less than RIGHT_PROBE_BED_POSITION."
  307. #elif FRONT_PROBE_BED_POSITION > BACK_PROBE_BED_POSITION
  308. #error "FRONT_PROBE_BED_POSITION must be less than BACK_PROBE_BED_POSITION."
  309. #endif
  310. // Make sure probing points are reachable
  311. #if LEFT_PROBE_BED_POSITION < MIN_PROBE_X
  312. #error "The given LEFT_PROBE_BED_POSITION can't be reached by the Z probe."
  313. #elif RIGHT_PROBE_BED_POSITION > MAX_PROBE_X
  314. #error "The given RIGHT_PROBE_BED_POSITION can't be reached by the Z probe."
  315. #elif FRONT_PROBE_BED_POSITION < MIN_PROBE_Y
  316. #error "The given FRONT_PROBE_BED_POSITION can't be reached by the Z probe."
  317. #elif BACK_PROBE_BED_POSITION > MAX_PROBE_Y
  318. #error "The given BACK_PROBE_BED_POSITION can't be reached by the Z probe."
  319. #endif
  320. #endif
  321. #else // !AUTO_BED_LEVELING_GRID
  322. // Check the triangulation points
  323. #if ABL_PROBE_PT_1_X < MIN_PROBE_X || ABL_PROBE_PT_1_X > MAX_PROBE_X
  324. #error "The given ABL_PROBE_PT_1_X can't be reached by the Z probe."
  325. #elif ABL_PROBE_PT_2_X < MIN_PROBE_X || ABL_PROBE_PT_2_X > MAX_PROBE_X
  326. #error "The given ABL_PROBE_PT_2_X can't be reached by the Z probe."
  327. #elif ABL_PROBE_PT_3_X < MIN_PROBE_X || ABL_PROBE_PT_3_X > MAX_PROBE_X
  328. #error "The given ABL_PROBE_PT_3_X can't be reached by the Z probe."
  329. #elif ABL_PROBE_PT_1_Y < MIN_PROBE_Y || ABL_PROBE_PT_1_Y > MAX_PROBE_Y
  330. #error "The given ABL_PROBE_PT_1_Y can't be reached by the Z probe."
  331. #elif ABL_PROBE_PT_2_Y < MIN_PROBE_Y || ABL_PROBE_PT_2_Y > MAX_PROBE_Y
  332. #error "The given ABL_PROBE_PT_2_Y can't be reached by the Z probe."
  333. #elif ABL_PROBE_PT_3_Y < MIN_PROBE_Y || ABL_PROBE_PT_3_Y > MAX_PROBE_Y
  334. #error "The given ABL_PROBE_PT_3_Y can't be reached by the Z probe."
  335. #endif
  336. #endif // !AUTO_BED_LEVELING_GRID
  337. #endif // AUTO_BED_LEVELING_FEATURE
  338. /**
  339. * Advance Extrusion
  340. */
  341. #if ENABLED(ADVANCE) && ENABLED(LIN_ADVANCE)
  342. #error "You can enable ADVANCE or LIN_ADVANCE, but not both."
  343. #endif
  344. /**
  345. * Filament Width Sensor
  346. */
  347. #if ENABLED(FILAMENT_WIDTH_SENSOR) && !HAS_FILAMENT_WIDTH_SENSOR
  348. #error "FILAMENT_WIDTH_SENSOR requires a FILWIDTH_PIN to be defined."
  349. #endif
  350. /**
  351. * ULTIPANEL encoder
  352. */
  353. #if ENABLED(ULTIPANEL) && DISABLED(NEWPANEL) && DISABLED(SR_LCD_2W_NL) && !defined(SHIFT_CLK)
  354. #error "ULTIPANEL requires some kind of encoder."
  355. #endif
  356. #if ENCODER_PULSES_PER_STEP < 0
  357. #error "ENCODER_PULSES_PER_STEP should not be negative, use REVERSE_MENU_DIRECTION instead."
  358. #endif
  359. /**
  360. * SAV_3DGLCD display options
  361. */
  362. #if ENABLED(U8GLIB_SSD1306) && ENABLED(U8GLIB_SH1106)
  363. #error "Only enable one SAV_3DGLCD display type: U8GLIB_SSD1306 or U8GLIB_SH1106."
  364. #endif
  365. /**
  366. * Delta has limited bed leveling options
  367. */
  368. #if ENABLED(DELTA)
  369. #if ENABLED(AUTO_BED_LEVELING_FEATURE)
  370. #if DISABLED(AUTO_BED_LEVELING_GRID)
  371. #error "Only AUTO_BED_LEVELING_GRID is supported with DELTA."
  372. #endif
  373. #if ENABLED(Z_PROBE_SLED)
  374. #error "You cannot use Z_PROBE_SLED with DELTA."
  375. #endif
  376. #endif
  377. #endif
  378. /**
  379. * Don't set more than one kinematic type
  380. */
  381. #if (ENABLED(DELTA) && (ENABLED(SCARA) || ENABLED(COREXY) || ENABLED(COREXZ) || ENABLED(COREYZ))) \
  382. || (ENABLED(SCARA) && (ENABLED(COREXY) || ENABLED(COREXZ) || ENABLED(COREYZ))) \
  383. || (ENABLED(COREXY) && (ENABLED(COREXZ) || ENABLED(COREYZ))) \
  384. || (ENABLED(COREXZ) && ENABLED(COREYZ))
  385. #error "Please enable only one of DELTA, SCARA, COREXY, COREXZ, or COREYZ."
  386. #endif
  387. /**
  388. * Allen Key
  389. * Deploying the Allen Key probe uses big moves in z direction. Too dangerous for an unhomed z-axis.
  390. */
  391. #if ENABLED(Z_PROBE_ALLEN_KEY) && (Z_HOME_DIR < 0) && ENABLED(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN)
  392. #error "You can't home to a z min endstop with a Z_PROBE_ALLEN_KEY"
  393. #endif
  394. /**
  395. * Dual X Carriage requirements
  396. */
  397. #if ENABLED(DUAL_X_CARRIAGE)
  398. #if EXTRUDERS == 1
  399. #error "DUAL_X_CARRIAGE requires 2 (or more) extruders."
  400. #elif ENABLED(COREXY) || ENABLED(COREXZ)
  401. #error "DUAL_X_CARRIAGE cannot be used with COREXY or COREXZ."
  402. #elif !HAS_X2_ENABLE || !HAS_X2_STEP || !HAS_X2_DIR
  403. #error "DUAL_X_CARRIAGE requires X2 stepper pins to be defined."
  404. #elif !HAS_X_MAX
  405. #error "DUAL_X_CARRIAGE requires USE_XMAX_PLUG and an X Max Endstop."
  406. #elif !defined(X2_HOME_POS) || !defined(X2_MIN_POS) || !defined(X2_MAX_POS)
  407. #error "DUAL_X_CARRIAGE requires X2_HOME_POS, X2_MIN_POS, and X2_MAX_POS."
  408. #elif X_HOME_DIR != -1 || X2_HOME_DIR != 1
  409. #error "DUAL_X_CARRIAGE requires X_HOME_DIR -1 and X2_HOME_DIR 1."
  410. #endif
  411. #endif // DUAL_X_CARRIAGE
  412. /**
  413. * Make sure auto fan pins don't conflict with the fan pin
  414. */
  415. #if HAS_AUTO_FAN
  416. #if HAS_FAN0
  417. #if EXTRUDER_0_AUTO_FAN_PIN == FAN_PIN
  418. #error "You cannot set EXTRUDER_0_AUTO_FAN_PIN equal to FAN_PIN."
  419. #elif EXTRUDER_1_AUTO_FAN_PIN == FAN_PIN
  420. #error "You cannot set EXTRUDER_1_AUTO_FAN_PIN equal to FAN_PIN."
  421. #elif EXTRUDER_2_AUTO_FAN_PIN == FAN_PIN
  422. #error "You cannot set EXTRUDER_2_AUTO_FAN_PIN equal to FAN_PIN."
  423. #elif EXTRUDER_3_AUTO_FAN_PIN == FAN_PIN
  424. #error "You cannot set EXTRUDER_3_AUTO_FAN_PIN equal to FAN_PIN."
  425. #endif
  426. #endif
  427. #endif
  428. #if HAS_FAN0 && CONTROLLERFAN_PIN == FAN_PIN
  429. #error "You cannot set CONTROLLERFAN_PIN equal to FAN_PIN."
  430. #endif
  431. #if HAS_CONTROLLERFAN
  432. #if EXTRUDER_0_AUTO_FAN_PIN == CONTROLLERFAN_PIN
  433. #error "You cannot set EXTRUDER_0_AUTO_FAN_PIN equal to CONTROLLERFAN_PIN."
  434. #elif EXTRUDER_1_AUTO_FAN_PIN == CONTROLLERFAN_PIN
  435. #error "You cannot set EXTRUDER_1_AUTO_FAN_PIN equal to CONTROLLERFAN_PIN."
  436. #elif EXTRUDER_2_AUTO_FAN_PIN == CONTROLLERFAN_PIN
  437. #error "You cannot set EXTRUDER_2_AUTO_FAN_PIN equal to CONTROLLERFAN_PIN."
  438. #elif EXTRUDER_3_AUTO_FAN_PIN == CONTROLLERFAN_PIN
  439. #error "You cannot set EXTRUDER_3_AUTO_FAN_PIN equal to CONTROLLERFAN_PIN."
  440. #endif
  441. #endif
  442. /**
  443. * Test Heater, Temp Sensor, and Extruder Pins; Sensor Type must also be set.
  444. */
  445. #if !HAS_HEATER_0
  446. #error "HEATER_0_PIN not defined for this board."
  447. #elif !PIN_EXISTS(TEMP_0)
  448. #error "TEMP_0_PIN not defined for this board."
  449. #elif !PIN_EXISTS(E0_STEP) || !PIN_EXISTS(E0_DIR) || !PIN_EXISTS(E0_ENABLE)
  450. #error "E0_STEP_PIN, E0_DIR_PIN, or E0_ENABLE_PIN not defined for this board."
  451. #elif TEMP_SENSOR_0 == 0
  452. #error "TEMP_SENSOR_0 is required."
  453. #endif
  454. #if HOTENDS > 1 || ENABLED(HEATERS_PARALLEL)
  455. #if !HAS_HEATER_1
  456. #error "HEATER_1_PIN not defined for this board."
  457. #endif
  458. #endif
  459. #if HOTENDS > 1
  460. #if TEMP_SENSOR_1 == 0
  461. #error "TEMP_SENSOR_1 is required with 2 or more HOTENDS."
  462. #elif !PIN_EXISTS(TEMP_1)
  463. #error "TEMP_1_PIN not defined for this board."
  464. #endif
  465. #if HOTENDS > 2
  466. #if TEMP_SENSOR_2 == 0
  467. #error "TEMP_SENSOR_2 is required with 3 or more HOTENDS."
  468. #elif !HAS_HEATER_2
  469. #error "HEATER_2_PIN not defined for this board."
  470. #elif !PIN_EXISTS(TEMP_2)
  471. #error "TEMP_2_PIN not defined for this board."
  472. #endif
  473. #if HOTENDS > 3
  474. #if TEMP_SENSOR_3 == 0
  475. #error "TEMP_SENSOR_3 is required with 4 HOTENDS."
  476. #elif !HAS_HEATER_3
  477. #error "HEATER_3_PIN not defined for this board."
  478. #elif !PIN_EXISTS(TEMP_3)
  479. #error "TEMP_3_PIN not defined for this board."
  480. #endif
  481. #endif
  482. #endif
  483. #endif
  484. #if ENABLED(TEMP_SENSOR_1_AS_REDUNDANT) && TEMP_SENSOR_1 == 0
  485. #error "TEMP_SENSOR_1 is required with TEMP_SENSOR_1_AS_REDUNDANT."
  486. #endif
  487. /**
  488. * Test Extruder Pins
  489. */
  490. #if EXTRUDERS > 3
  491. #if !PIN_EXISTS(E3_STEP) || !PIN_EXISTS(E3_DIR) || !PIN_EXISTS(E3_ENABLE)
  492. #error "E3_STEP_PIN, E3_DIR_PIN, or E3_ENABLE_PIN not defined for this board."
  493. #endif
  494. #elif EXTRUDERS > 2
  495. #if !PIN_EXISTS(E2_STEP) || !PIN_EXISTS(E2_DIR) || !PIN_EXISTS(E2_ENABLE)
  496. #error "E2_STEP_PIN, E2_DIR_PIN, or E2_ENABLE_PIN not defined for this board."
  497. #endif
  498. #elif EXTRUDERS > 1
  499. #if !PIN_EXISTS(E1_STEP) || !PIN_EXISTS(E1_DIR) || !PIN_EXISTS(E1_ENABLE)
  500. #error "E1_STEP_PIN, E1_DIR_PIN, or E1_ENABLE_PIN not defined for this board."
  501. #endif
  502. #endif
  503. /**
  504. * Endstops
  505. */
  506. #if DISABLED(USE_XMIN_PLUG) && DISABLED(USE_XMAX_PLUG) && !(ENABLED(Z_DUAL_ENDSTOPS) && Z2_USE_ENDSTOP >= _XMAX_ && Z2_USE_ENDSTOP <= _XMIN_)
  507. #error "You must enable USE_XMIN_PLUG or USE_XMAX_PLUG"
  508. #elif DISABLED(USE_YMIN_PLUG) && DISABLED(USE_YMAX_PLUG) && !(ENABLED(Z_DUAL_ENDSTOPS) && Z2_USE_ENDSTOP >= _YMAX_ && Z2_USE_ENDSTOP <= _YMIN_)
  509. #error "You must enable USE_YMIN_PLUG or USE_YMAX_PLUG"
  510. #elif DISABLED(USE_ZMIN_PLUG) && DISABLED(USE_ZMAX_PLUG) && !(ENABLED(Z_DUAL_ENDSTOPS) && Z2_USE_ENDSTOP >= _ZMAX_ && Z2_USE_ENDSTOP <= _ZMIN_)
  511. #error "You must enable USE_ZMIN_PLUG or USE_ZMAX_PLUG"
  512. #elif ENABLED(Z_DUAL_ENDSTOPS) && !Z2_USE_ENDSTOP
  513. #error "You must set Z2_USE_ENDSTOP with Z_DUAL_ENDSTOPS"
  514. #endif
  515. /**
  516. * emergency-command parser
  517. */
  518. #if ENABLED(EMERGENCY_PARSER) && ENABLED(USBCON)
  519. #error "EMERGENCY_PARSER does not work on boards with AT90USB processors (USBCON)."
  520. #endif
  521. /**
  522. * Warnings for old configurations
  523. */
  524. #if WATCH_TEMP_PERIOD > 500
  525. #error "WATCH_TEMP_PERIOD now uses seconds instead of milliseconds."
  526. #elif DISABLED(THERMAL_PROTECTION_HOTENDS) && (defined(WATCH_TEMP_PERIOD) || defined(THERMAL_PROTECTION_PERIOD))
  527. #error "Thermal Runaway Protection for hotends is now enabled with THERMAL_PROTECTION_HOTENDS."
  528. #elif DISABLED(THERMAL_PROTECTION_BED) && defined(THERMAL_PROTECTION_BED_PERIOD)
  529. #error "Thermal Runaway Protection for the bed is now enabled with THERMAL_PROTECTION_BED."
  530. #elif ENABLED(COREXZ) && ENABLED(Z_LATE_ENABLE)
  531. #error "Z_LATE_ENABLE can't be used with COREXZ."
  532. #elif defined(X_HOME_RETRACT_MM)
  533. #error "[XYZ]_HOME_RETRACT_MM settings have been renamed [XYZ]_HOME_BUMP_MM."
  534. #elif defined(BEEPER)
  535. #error "BEEPER is now BEEPER_PIN. Please update your pins definitions."
  536. #elif defined(SDCARDDETECT)
  537. #error "SDCARDDETECT is now SD_DETECT_PIN. Please update your pins definitions."
  538. #elif defined(SDCARDDETECTINVERTED)
  539. #error "SDCARDDETECTINVERTED is now SD_DETECT_INVERTED. Please update your configuration."
  540. #elif defined(BTENABLED)
  541. #error "BTENABLED is now BLUETOOTH. Please update your configuration."
  542. #elif defined(CUSTOM_MENDEL_NAME)
  543. #error "CUSTOM_MENDEL_NAME is now CUSTOM_MACHINE_NAME. Please update your configuration."
  544. #elif defined(HAS_AUTOMATIC_VERSIONING)
  545. #error "HAS_AUTOMATIC_VERSIONING is now USE_AUTOMATIC_VERSIONING. Please update your configuration."
  546. #elif defined(ENABLE_AUTO_BED_LEVELING)
  547. #error "ENABLE_AUTO_BED_LEVELING is now AUTO_BED_LEVELING_FEATURE. Please update your configuration."
  548. #elif defined(SDSLOW)
  549. #error "SDSLOW deprecated. Set SPI_SPEED to SPI_HALF_SPEED instead."
  550. #elif defined(SDEXTRASLOW)
  551. #error "SDEXTRASLOW deprecated. Set SPI_SPEED to SPI_QUARTER_SPEED instead."
  552. #elif defined(Z_RAISE_BEFORE_HOMING)
  553. #error "Z_RAISE_BEFORE_HOMING is deprecated. Use MIN_Z_HEIGHT_FOR_HOMING instead."
  554. #elif defined(FILAMENT_SENSOR)
  555. #error "FILAMENT_SENSOR is deprecated. Use FILAMENT_WIDTH_SENSOR instead."
  556. #elif defined(DISABLE_MAX_ENDSTOPS) || defined(DISABLE_MIN_ENDSTOPS)
  557. #error "DISABLE_MAX_ENDSTOPS and DISABLE_MIN_ENDSTOPS deprecated. Use individual USE_*_PLUG options instead."
  558. #elif ENABLED(Z_DUAL_ENDSTOPS) && !defined(Z2_USE_ENDSTOP)
  559. #error "Z_DUAL_ENDSTOPS settings are simplified. Just set Z2_USE_ENDSTOP to the endstop you want to repurpose for Z2"
  560. #elif defined(LANGUAGE_INCLUDE)
  561. #error "LANGUAGE_INCLUDE has been replaced by LCD_LANGUAGE. Please update your configuration."
  562. #elif defined(EXTRUDER_OFFSET_X) || defined(EXTRUDER_OFFSET_Y)
  563. #error "EXTRUDER_OFFSET_[XY] is deprecated. Use HOTEND_OFFSET_[XY] instead."
  564. #elif defined(PID_PARAMS_PER_EXTRUDER)
  565. #error "PID_PARAMS_PER_EXTRUDER is deprecated. Use PID_PARAMS_PER_HOTEND instead."
  566. #elif defined(EXTRUDER_WATTS)
  567. #error "EXTRUDER_WATTS is deprecated. Use HOTEND_WATTS instead."
  568. #elif defined(SERVO_ENDSTOP_ANGLES)
  569. #error "SERVO_ENDSTOP_ANGLES is deprecated. Use Z_SERVO_ANGLES instead."
  570. #elif defined(X_ENDSTOP_SERVO_NR) || defined(Y_ENDSTOP_SERVO_NR)
  571. #error "X_ENDSTOP_SERVO_NR and Y_ENDSTOP_SERVO_NR are deprecated and should be removed."
  572. #elif defined(XY_TRAVEL_SPEED)
  573. #error "XY_TRAVEL_SPEED is deprecated. Use XY_PROBE_SPEED instead."
  574. #elif defined(PROBE_SERVO_DEACTIVATION_DELAY)
  575. #error "PROBE_SERVO_DEACTIVATION_DELAY is deprecated. Use DEACTIVATE_SERVOS_AFTER_MOVE instead."
  576. #elif defined(SERVO_DEACTIVATION_DELAY)
  577. #error "SERVO_DEACTIVATION_DELAY is deprecated. Use SERVO_DELAY instead."
  578. #elif ENABLED(FILAMENTCHANGEENABLE)
  579. #error "FILAMENTCHANGEENABLE is now FILAMENT_CHANGE_FEATURE. Please update your configuration."
  580. #endif
  581. #endif //SANITYCHECK_H