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

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