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.

ubl_G29.cpp 73KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842
  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. #include "MarlinConfig.h"
  23. #if ENABLED(AUTO_BED_LEVELING_UBL)
  24. #include "ubl.h"
  25. #include "Marlin.h"
  26. #include "hex_print_routines.h"
  27. #include "configuration_store.h"
  28. #include "ultralcd.h"
  29. #include "stepper.h"
  30. #include "planner.h"
  31. #include "gcode.h"
  32. #include "bitmap_flags.h"
  33. #include <math.h>
  34. #include "least_squares_fit.h"
  35. #define UBL_G29_P31
  36. extern float destination[XYZE], current_position[XYZE];
  37. #if ENABLED(NEWPANEL)
  38. void lcd_return_to_status();
  39. void lcd_mesh_edit_setup(const float initial);
  40. float lcd_mesh_edit();
  41. void lcd_z_offset_edit_setup(float);
  42. extern void _lcd_ubl_output_map_lcd();
  43. float lcd_z_offset_edit();
  44. #endif
  45. extern float meshedit_done;
  46. extern long babysteps_done;
  47. extern float probe_pt(const float &rx, const float &ry, const bool, const uint8_t, const bool=true);
  48. extern bool set_probe_deployed(bool);
  49. extern void set_bed_leveling_enabled(bool);
  50. typedef void (*screenFunc_t)();
  51. extern void lcd_goto_screen(screenFunc_t screen, const uint32_t encoder=0);
  52. #define SIZE_OF_LITTLE_RAISE 1
  53. #define BIG_RAISE_NOT_NEEDED 0
  54. int unified_bed_leveling::g29_verbose_level,
  55. unified_bed_leveling::g29_phase_value,
  56. unified_bed_leveling::g29_repetition_cnt,
  57. unified_bed_leveling::g29_storage_slot = 0,
  58. unified_bed_leveling::g29_map_type;
  59. bool unified_bed_leveling::g29_c_flag,
  60. unified_bed_leveling::g29_x_flag,
  61. unified_bed_leveling::g29_y_flag;
  62. float unified_bed_leveling::g29_x_pos,
  63. unified_bed_leveling::g29_y_pos,
  64. unified_bed_leveling::g29_card_thickness = 0.0,
  65. unified_bed_leveling::g29_constant = 0.0;
  66. #if HAS_BED_PROBE
  67. int unified_bed_leveling::g29_grid_size;
  68. #endif
  69. /**
  70. * G29: Unified Bed Leveling by Roxy
  71. *
  72. * Parameters understood by this leveling system:
  73. *
  74. * A Activate Activate the Unified Bed Leveling system.
  75. *
  76. * B # Business Use the 'Business Card' mode of the Manual Probe subsystem with P2.
  77. * Note: A non-compressible Spark Gap feeler gauge is recommended over a business card.
  78. * In this mode of G29 P2, a business or index card is used as a shim that the nozzle can
  79. * grab onto as it is lowered. In principle, the nozzle-bed distance is the same when the
  80. * same resistance is felt in the shim. You can omit the numerical value on first invocation
  81. * of G29 P2 B to measure shim thickness. Subsequent use of 'B' will apply the previously-
  82. * measured thickness by default.
  83. *
  84. * C Continue G29 P1 C continues the generation of a partially-constructed Mesh without invalidating
  85. * previous measurements.
  86. *
  87. * C Constant G29 P2 C specifies a Constant and tells the Manual Probe subsystem to use the current
  88. * location in its search for the closest unmeasured Mesh Point.
  89. *
  90. * G29 P3 C specifies the Constant for the fill. Otherwise, uses a "reasonable" value.
  91. *
  92. * C Current G29 Z C uses the Current location (instead of bed center or nearest edge).
  93. *
  94. * D Disable Disable the Unified Bed Leveling system.
  95. *
  96. * E Stow_probe Stow the probe after each sampled point.
  97. *
  98. * F # Fade Fade the amount of Mesh Based Compensation over a specified height. At the
  99. * specified height, no correction is applied and natural printer kenimatics take over. If no
  100. * number is specified for the command, 10mm is assumed to be reasonable.
  101. *
  102. * H # Height With P2, 'H' specifies the Height to raise the nozzle after each manual probe of the bed.
  103. * If omitted, the nozzle will raise by Z_CLEARANCE_BETWEEN_PROBES.
  104. *
  105. * H # Offset With P4, 'H' specifies the Offset above the mesh height to place the nozzle.
  106. * If omitted, Z_CLEARANCE_BETWEEN_PROBES will be used.
  107. *
  108. * I # Invalidate Invalidate the specified number of Mesh Points near the given 'X' 'Y'. If X or Y are omitted,
  109. * the nozzle location is used. If no 'I' value is given, only the point nearest to the location
  110. * is invalidated. Use 'T' to produce a map afterward. This command is useful to invalidate a
  111. * portion of the Mesh so it can be adjusted using other UBL tools. When attempting to invalidate
  112. * an isolated bad mesh point, the 'T' option shows the nozzle position in the Mesh with (#). You
  113. * can move the nozzle around and use this feature to select the center of the area (or cell) to
  114. * invalidate.
  115. *
  116. * J # Grid Perform a Grid Based Leveling of the current Mesh using a grid with n points on a side.
  117. * Not specifying a grid size will invoke the 3-Point leveling function.
  118. *
  119. * K # Kompare Kompare current Mesh with stored Mesh # replacing current Mesh with the result. This
  120. * command literally performs a diff between two Meshes.
  121. *
  122. * L Load Load Mesh from the previously activated location in the EEPROM.
  123. *
  124. * L # Load Load Mesh from the specified location in the EEPROM. Set this location as activated
  125. * for subsequent Load and Store operations.
  126. *
  127. * The P or Phase commands are used for the bulk of the work to setup a Mesh. In general, your Mesh will
  128. * start off being initialized with a G29 P0 or a G29 P1. Further refinement of the Mesh happens with
  129. * each additional Phase that processes it.
  130. *
  131. * P0 Phase 0 Zero Mesh Data and turn off the Mesh Compensation System. This reverts the
  132. * 3D Printer to the same state it was in before the Unified Bed Leveling Compensation
  133. * was turned on. Setting the entire Mesh to Zero is a special case that allows
  134. * a subsequent G or T leveling operation for backward compatibility.
  135. *
  136. * P1 Phase 1 Invalidate entire Mesh and continue with automatic generation of the Mesh data using
  137. * the Z-Probe. Usually the probe can't reach all areas that the nozzle can reach. On
  138. * Cartesian printers, points within the X_PROBE_OFFSET_FROM_EXTRUDER and Y_PROBE_OFFSET_FROM_EXTRUDER
  139. * area cannot be automatically probed. For Delta printers the area in which DELTA_PROBEABLE_RADIUS
  140. * and DELTA_PRINTABLE_RADIUS do not overlap will not be automatically probed.
  141. *
  142. * Unreachable points will be handled in Phase 2 and Phase 3.
  143. *
  144. * Use 'C' to leave the previous mesh intact and automatically probe needed points. This allows you
  145. * to invalidate parts of the Mesh but still use Automatic Probing.
  146. *
  147. * The 'X' and 'Y' parameters prioritize where to try and measure points. If omitted, the current
  148. * probe position is used.
  149. *
  150. * Use 'T' (Topology) to generate a report of mesh generation.
  151. *
  152. * P1 will suspend Mesh generation if the controller button is held down. Note that you may need
  153. * to press and hold the switch for several seconds if moves are underway.
  154. *
  155. * P2 Phase 2 Probe unreachable points.
  156. *
  157. * Use 'H' to set the height between Mesh points. If omitted, Z_CLEARANCE_BETWEEN_PROBES is used.
  158. * Smaller values will be quicker. Move the nozzle down till it barely touches the bed. Make sure the
  159. * nozzle is clean and unobstructed. Use caution and move slowly. This can damage your printer!
  160. * (Uses SIZE_OF_LITTLE_RAISE mm if the nozzle is moving less than BIG_RAISE_NOT_NEEDED mm.)
  161. *
  162. * The 'H' value can be negative if the Mesh dips in a large area. Press and hold the
  163. * controller button to terminate the current Phase 2 command. You can then re-issue "G29 P 2"
  164. * with an 'H' parameter more suitable for the area you're manually probing. Note that the command
  165. * tries to start in a corner of the bed where movement will be predictable. Override the distance
  166. * calculation location with the X and Y parameters. You can print a Mesh Map (G29 T) to see where
  167. * the mesh is invalidated and where the nozzle needs to move to complete the command. Use 'C' to
  168. * indicate that the search should be based on the current position.
  169. *
  170. * The 'B' parameter for this command is described above. It places the manual probe subsystem into
  171. * Business Card mode where the thickness of a business card is measured and then used to accurately
  172. * set the nozzle height in all manual probing for the duration of the command. A Business card can
  173. * be used, but you'll get better results with a flexible Shim that doesn't compress. This makes it
  174. * easier to produce similar amounts of force and get more accurate measurements. Google if you're
  175. * not sure how to use a shim.
  176. *
  177. * The 'T' (Map) parameter helps track Mesh building progress.
  178. *
  179. * NOTE: P2 requires an LCD controller!
  180. *
  181. * P3 Phase 3 Fill the unpopulated regions of the Mesh with a fixed value. There are two different paths to
  182. * go down:
  183. *
  184. * - If a 'C' constant is specified, the closest invalid mesh points to the nozzle will be filled,
  185. * and a repeat count can then also be specified with 'R'.
  186. *
  187. * - Leaving out 'C' invokes Smart Fill, which scans the mesh from the edges inward looking for
  188. * invalid mesh points. Adjacent points are used to determine the bed slope. If the bed is sloped
  189. * upward from the invalid point, it takes the value of the nearest point. If sloped downward, it's
  190. * replaced by a value that puts all three points in a line. This version of G29 P3 is a quick, easy
  191. * and (usually) safe way to populate unprobed mesh regions before continuing to G26 Mesh Validation
  192. * Pattern. Note that this populates the mesh with unverified values. Pay attention and use caution.
  193. *
  194. * P4 Phase 4 Fine tune the Mesh. The Delta Mesh Compensation System assumes the existence of
  195. * an LCD Panel. It is possible to fine tune the mesh without an LCD Panel using
  196. * G42 and M421. See the UBL documentation for further details.
  197. *
  198. * Phase 4 is meant to be used with G26 Mesh Validation to fine tune the mesh by direct editing
  199. * of Mesh Points. Raise and lower points to fine tune the mesh until it gives consistently reliable
  200. * adhesion.
  201. *
  202. * P4 moves to the closest Mesh Point (and/or the given X Y), raises the nozzle above the mesh height
  203. * by the given 'H' offset (or default Z_CLEARANCE_BETWEEN_PROBES), and waits while the controller is
  204. * used to adjust the nozzle height. On click the displayed height is saved in the mesh.
  205. *
  206. * Start Phase 4 at a specific location with X and Y. Adjust a specific number of Mesh Points with
  207. * the 'R' (Repeat) parameter. (If 'R' is left out, the whole matrix is assumed.) This command can be
  208. * terminated early (e.g., after editing the area of interest) by pressing and holding the encoder button.
  209. *
  210. * The general form is G29 P4 [R points] [X position] [Y position]
  211. *
  212. * The H [offset] parameter is useful if a shim is used to fine-tune the mesh. For a 0.4mm shim the
  213. * command would be G29 P4 H0.4. The nozzle is moved to the shim height, you adjust height to the shim,
  214. * and on click the height minus the shim thickness will be saved in the mesh.
  215. *
  216. * !!Use with caution, as a very poor mesh could cause the nozzle to crash into the bed!!
  217. *
  218. * NOTE: P4 is not available unless you have LCD support enabled!
  219. *
  220. * P5 Phase 5 Find Mean Mesh Height and Standard Deviation. Typically, it is easier to use and
  221. * work with the Mesh if it is Mean Adjusted. You can specify a C parameter to
  222. * Correct the Mesh to a 0.00 Mean Height. Adding a C parameter will automatically
  223. * execute a G29 P6 C <mean height>.
  224. *
  225. * P6 Phase 6 Shift Mesh height. The entire Mesh's height is adjusted by the height specified
  226. * with the C parameter. Being able to adjust the height of a Mesh is useful tool. It
  227. * can be used to compensate for poorly calibrated Z-Probes and other errors. Ideally,
  228. * you should have the Mesh adjusted for a Mean Height of 0.00 and the Z-Probe measuring
  229. * 0.000 at the Z Home location.
  230. *
  231. * Q Test Load specified Test Pattern to assist in checking correct operation of system. This
  232. * command is not anticipated to be of much value to the typical user. It is intended
  233. * for developers to help them verify correct operation of the Unified Bed Leveling System.
  234. *
  235. * R # Repeat Repeat this command the specified number of times. If no number is specified the
  236. * command will be repeated GRID_MAX_POINTS_X * GRID_MAX_POINTS_Y times.
  237. *
  238. * S Store Store the current Mesh in the Activated area of the EEPROM. It will also store the
  239. * current state of the Unified Bed Leveling system in the EEPROM.
  240. *
  241. * S # Store Store the current Mesh at the specified location in EEPROM. Activate this location
  242. * for subsequent Load and Store operations. Valid storage slot numbers begin at 0 and
  243. * extend to a limit related to the available EEPROM storage.
  244. *
  245. * S -1 Store Store the current Mesh as a print out that is suitable to be feed back into the system
  246. * at a later date. The GCode output can be saved and later replayed by the host software
  247. * to reconstruct the current mesh on another machine.
  248. *
  249. * T Topology Display the Mesh Map Topology.
  250. * 'T' can be used alone (e.g., G29 T) or in combination with most of the other commands.
  251. * This option works with all Phase commands (e.g., G29 P4 R 5 T X 50 Y100 C -.1 O)
  252. * This parameter can also specify a Map Type. T0 (the default) is user-readable. T1 can
  253. * is suitable to paste into a spreadsheet for a 3D graph of the mesh.
  254. *
  255. * U Unlevel Perform a probe of the outer perimeter to assist in physically leveling unlevel beds.
  256. * Only used for G29 P1 T U. This speeds up the probing of the edge of the bed. Useful
  257. * when the entire bed doesn't need to be probed because it will be adjusted.
  258. *
  259. * V # Verbosity Set the verbosity level (0-4) for extra details. (Default 0)
  260. *
  261. * W What? Display valuable Unified Bed Leveling System data.
  262. *
  263. * X # X Location for this command
  264. *
  265. * Y # Y Location for this command
  266. *
  267. *
  268. * Release Notes:
  269. * You MUST do M502, M500 to initialize the storage. Failure to do this will cause all
  270. * kinds of problems. Enabling EEPROM Storage is highly recommended. With EEPROM Storage
  271. * of the mesh, you are limited to 3-Point and Grid Leveling. (G29 P0 T and G29 P0 G
  272. * respectively.)
  273. *
  274. * When you do a G28 and then a G29 P1 to automatically build your first mesh, you are going to notice
  275. * the Unified Bed Leveling probes points further and further away from the starting location. (The
  276. * starting location defaults to the center of the bed.) The original Grid and Mesh leveling used
  277. * a Zig Zag pattern. The new pattern is better, especially for people with Delta printers. This
  278. * allows you to get the center area of the Mesh populated (and edited) quicker. This allows you to
  279. * perform a small print and check out your settings quicker. You do not need to populate the
  280. * entire mesh to use it. (You don't want to spend a lot of time generating a mesh only to realize
  281. * you don't have the resolution or zprobe_zoffset set correctly. The Mesh generation
  282. * gathers points closest to where the nozzle is located unless you specify an (X,Y) coordinate pair.
  283. *
  284. * The Unified Bed Leveling uses a lot of EEPROM storage to hold its data. And it takes some effort
  285. * to get this Mesh data correct for a user's printer. We do not want this data destroyed as
  286. * new versions of Marlin add or subtract to the items stored in EEPROM. So, for the benefit of
  287. * the users, we store the Mesh data at the end of the EEPROM and do not keep it contiguous with the
  288. * other data stored in the EEPROM. (For sure the developers are going to complain about this, but
  289. * this is going to be helpful to the users!)
  290. *
  291. * The foundation of this Bed Leveling System is built on Epatel's Mesh Bed Leveling code. A big
  292. * 'Thanks!' to him and the creators of 3-Point and Grid Based leveling. Combining their contributions
  293. * we now have the functionality and features of all three systems combined.
  294. */
  295. void unified_bed_leveling::G29() {
  296. if (!settings.calc_num_meshes()) {
  297. SERIAL_PROTOCOLLNPGM("?Enable EEPROM and init with M502, M500.\n");
  298. return;
  299. }
  300. if (g29_parameter_parsing()) return; // abort if parsing the simple parameters causes a problem,
  301. // Check for commands that require the printer to be homed
  302. if (axis_unhomed_error()) {
  303. const int8_t p_val = parser.intval('P', -1);
  304. if (p_val == 1 || p_val == 2 || p_val == 4 || parser.seen('J'))
  305. home_all_axes();
  306. }
  307. // Invalidate Mesh Points. This command is a little bit asymmetrical because
  308. // it directly specifies the repetition count and does not use the 'R' parameter.
  309. if (parser.seen('I')) {
  310. uint8_t cnt = 0;
  311. g29_repetition_cnt = parser.has_value() ? parser.value_int() : 1;
  312. if (g29_repetition_cnt >= GRID_MAX_POINTS) {
  313. set_all_mesh_points_to_value(NAN);
  314. }
  315. else {
  316. while (g29_repetition_cnt--) {
  317. if (cnt > 20) { cnt = 0; idle(); }
  318. const mesh_index_pair location = find_closest_mesh_point_of_type(REAL, g29_x_pos, g29_y_pos, USE_NOZZLE_AS_REFERENCE, NULL);
  319. if (location.x_index < 0) {
  320. // No more REACHABLE mesh points to invalidate, so we ASSUME the user
  321. // meant to invalidate the ENTIRE mesh, which cannot be done with
  322. // find_closest_mesh_point loop which only returns REACHABLE points.
  323. set_all_mesh_points_to_value(NAN);
  324. SERIAL_PROTOCOLLNPGM("Entire Mesh invalidated.\n");
  325. break; // No more invalid Mesh Points to populate
  326. }
  327. z_values[location.x_index][location.y_index] = NAN;
  328. cnt++;
  329. }
  330. }
  331. SERIAL_PROTOCOLLNPGM("Locations invalidated.\n");
  332. }
  333. if (parser.seen('Q')) {
  334. const int test_pattern = parser.has_value() ? parser.value_int() : -99;
  335. if (!WITHIN(test_pattern, -1, 2)) {
  336. SERIAL_PROTOCOLLNPGM("Invalid test_pattern value. (-1 to 2)\n");
  337. return;
  338. }
  339. SERIAL_PROTOCOLLNPGM("Loading test_pattern values.\n");
  340. switch (test_pattern) {
  341. case -1:
  342. g29_eeprom_dump();
  343. break;
  344. case 0:
  345. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++) { // Create a bowl shape - similar to
  346. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++) { // a poorly calibrated Delta.
  347. const float p1 = 0.5 * (GRID_MAX_POINTS_X) - x,
  348. p2 = 0.5 * (GRID_MAX_POINTS_Y) - y;
  349. z_values[x][y] += 2.0 * HYPOT(p1, p2);
  350. }
  351. }
  352. break;
  353. case 1:
  354. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++) { // Create a diagonal line several Mesh cells thick that is raised
  355. z_values[x][x] += 9.999;
  356. z_values[x][x + (x < GRID_MAX_POINTS_Y - 1) ? 1 : -1] += 9.999; // We want the altered line several mesh points thick
  357. }
  358. break;
  359. case 2:
  360. // Allow the user to specify the height because 10mm is a little extreme in some cases.
  361. for (uint8_t x = (GRID_MAX_POINTS_X) / 3; x < 2 * (GRID_MAX_POINTS_X) / 3; x++) // Create a rectangular raised area in
  362. for (uint8_t y = (GRID_MAX_POINTS_Y) / 3; y < 2 * (GRID_MAX_POINTS_Y) / 3; y++) // the center of the bed
  363. z_values[x][y] += parser.seen('C') ? g29_constant : 9.99;
  364. break;
  365. }
  366. }
  367. #if HAS_BED_PROBE
  368. if (parser.seen('J')) {
  369. if (g29_grid_size) { // if not 0 it is a normal n x n grid being probed
  370. save_ubl_active_state_and_disable();
  371. tilt_mesh_based_on_probed_grid(parser.seen('T'));
  372. restore_ubl_active_state_and_leave();
  373. }
  374. else { // grid_size == 0 : A 3-Point leveling has been requested
  375. float z3, z2, z1 = probe_pt(UBL_PROBE_PT_1_X, UBL_PROBE_PT_1_Y, false, g29_verbose_level);
  376. if (!isnan(z1)) {
  377. z2 = probe_pt(UBL_PROBE_PT_2_X, UBL_PROBE_PT_2_Y, false, g29_verbose_level);
  378. if (!isnan(z2))
  379. z3 = probe_pt(UBL_PROBE_PT_3_X, UBL_PROBE_PT_3_Y, true, g29_verbose_level);
  380. }
  381. if (isnan(z1) || isnan(z2) || isnan(z3)) { // probe_pt will return NAN if unreachable
  382. SERIAL_ERROR_START();
  383. SERIAL_ERRORLNPGM("Attempt to probe off the bed.");
  384. goto LEAVE;
  385. }
  386. // Adjust z1, z2, z3 by the Mesh Height at these points. Just because they're non-zero
  387. // doesn't mean the Mesh is tilted! (Compensate each probe point by what the Mesh says
  388. // its height is.)
  389. save_ubl_active_state_and_disable();
  390. z1 -= get_z_correction(UBL_PROBE_PT_1_X, UBL_PROBE_PT_1_Y) /* + zprobe_zoffset */ ;
  391. z2 -= get_z_correction(UBL_PROBE_PT_2_X, UBL_PROBE_PT_2_Y) /* + zprobe_zoffset */ ;
  392. z3 -= get_z_correction(UBL_PROBE_PT_3_X, UBL_PROBE_PT_3_Y) /* + zprobe_zoffset */ ;
  393. do_blocking_move_to_xy(0.5 * (MESH_MAX_X - (MESH_MIN_X)), 0.5 * (MESH_MAX_Y - (MESH_MIN_Y)));
  394. tilt_mesh_based_on_3pts(z1, z2, z3);
  395. restore_ubl_active_state_and_leave();
  396. }
  397. }
  398. #endif // HAS_BED_PROBE
  399. if (parser.seen('P')) {
  400. if (WITHIN(g29_phase_value, 0, 1) && storage_slot == -1) {
  401. storage_slot = 0;
  402. SERIAL_PROTOCOLLNPGM("Default storage slot 0 selected.");
  403. }
  404. switch (g29_phase_value) {
  405. case 0:
  406. //
  407. // Zero Mesh Data
  408. //
  409. reset();
  410. SERIAL_PROTOCOLLNPGM("Mesh zeroed.");
  411. break;
  412. #if HAS_BED_PROBE
  413. case 1:
  414. //
  415. // Invalidate Entire Mesh and Automatically Probe Mesh in areas that can be reached by the probe
  416. //
  417. if (!parser.seen('C')) {
  418. invalidate();
  419. SERIAL_PROTOCOLLNPGM("Mesh invalidated. Probing mesh.");
  420. }
  421. if (g29_verbose_level > 1) {
  422. SERIAL_PROTOCOLPAIR("Probing Mesh Points Closest to (", g29_x_pos);
  423. SERIAL_PROTOCOLCHAR(',');
  424. SERIAL_PROTOCOL(g29_y_pos);
  425. SERIAL_PROTOCOLLNPGM(").\n");
  426. }
  427. probe_entire_mesh(g29_x_pos + X_PROBE_OFFSET_FROM_EXTRUDER, g29_y_pos + Y_PROBE_OFFSET_FROM_EXTRUDER,
  428. parser.seen('T'), parser.seen('E'), parser.seen('U'));
  429. break;
  430. #endif // HAS_BED_PROBE
  431. case 2: {
  432. #if ENABLED(NEWPANEL)
  433. //
  434. // Manually Probe Mesh in areas that can't be reached by the probe
  435. //
  436. SERIAL_PROTOCOLLNPGM("Manually probing unreachable mesh locations.");
  437. do_blocking_move_to_z(Z_CLEARANCE_BETWEEN_PROBES);
  438. if (!g29_x_flag && !g29_y_flag) {
  439. /**
  440. * Use a good default location for the path.
  441. * The flipped > and < operators in these comparisons is intentional.
  442. * It should cause the probed points to follow a nice path on Cartesian printers.
  443. * It may make sense to have Delta printers default to the center of the bed.
  444. * Until that is decided, this can be forced with the X and Y parameters.
  445. */
  446. #if IS_KINEMATIC
  447. g29_x_pos = X_HOME_POS;
  448. g29_y_pos = Y_HOME_POS;
  449. #else // cartesian
  450. g29_x_pos = X_PROBE_OFFSET_FROM_EXTRUDER > 0 ? X_BED_SIZE : 0;
  451. g29_y_pos = Y_PROBE_OFFSET_FROM_EXTRUDER < 0 ? Y_BED_SIZE : 0;
  452. #endif
  453. }
  454. if (parser.seen('C')) {
  455. g29_x_pos = current_position[X_AXIS];
  456. g29_y_pos = current_position[Y_AXIS];
  457. }
  458. if (parser.seen('B')) {
  459. g29_card_thickness = parser.has_value() ? parser.value_float() : measure_business_card_thickness(Z_CLEARANCE_BETWEEN_PROBES);
  460. if (FABS(g29_card_thickness) > 1.5) {
  461. SERIAL_PROTOCOLLNPGM("?Error in Business Card measurement.");
  462. return;
  463. }
  464. }
  465. if (!position_is_reachable(g29_x_pos, g29_y_pos)) {
  466. SERIAL_PROTOCOLLNPGM("XY outside printable radius.");
  467. return;
  468. }
  469. const float height = parser.floatval('H', Z_CLEARANCE_BETWEEN_PROBES);
  470. manually_probe_remaining_mesh(g29_x_pos, g29_y_pos, height, g29_card_thickness, parser.seen('T'));
  471. SERIAL_PROTOCOLLNPGM("G29 P2 finished.");
  472. #else
  473. SERIAL_PROTOCOLLNPGM("?P2 is only available when an LCD is present.");
  474. return;
  475. #endif
  476. } break;
  477. case 3: {
  478. /**
  479. * Populate invalid mesh areas. Proceed with caution.
  480. * Two choices are available:
  481. * - Specify a constant with the 'C' parameter.
  482. * - Allow 'G29 P3' to choose a 'reasonable' constant.
  483. */
  484. if (g29_c_flag) {
  485. if (g29_repetition_cnt >= GRID_MAX_POINTS) {
  486. set_all_mesh_points_to_value(g29_constant);
  487. }
  488. else {
  489. while (g29_repetition_cnt--) { // this only populates reachable mesh points near
  490. const mesh_index_pair location = find_closest_mesh_point_of_type(INVALID, g29_x_pos, g29_y_pos, USE_NOZZLE_AS_REFERENCE, NULL);
  491. if (location.x_index < 0) {
  492. // No more REACHABLE INVALID mesh points to populate, so we ASSUME
  493. // user meant to populate ALL INVALID mesh points to value
  494. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  495. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  496. if (isnan(z_values[x][y]))
  497. z_values[x][y] = g29_constant;
  498. break; // No more invalid Mesh Points to populate
  499. }
  500. z_values[location.x_index][location.y_index] = g29_constant;
  501. }
  502. }
  503. }
  504. else {
  505. const float cvf = parser.value_float();
  506. switch((int)truncf(cvf * 10.0) - 30) { // 3.1 -> 1
  507. #if ENABLED(UBL_G29_P31)
  508. case 1: {
  509. // P3.1 use least squares fit to fill missing mesh values
  510. // P3.10 zero weighting for distance, all grid points equal, best fit tilted plane
  511. // P3.11 10X weighting for nearest grid points versus farthest grid points
  512. // P3.12 100X distance weighting
  513. // P3.13 1000X distance weighting, approaches simple average of nearest points
  514. const float weight_power = (cvf - 3.10) * 100.0, // 3.12345 -> 2.345
  515. weight_factor = weight_power ? POW(10.0, weight_power) : 0;
  516. smart_fill_wlsf(weight_factor);
  517. }
  518. break;
  519. #endif
  520. case 0: // P3 or P3.0
  521. default: // and anything P3.x that's not P3.1
  522. smart_fill_mesh(); // Do a 'Smart' fill using nearby known values
  523. break;
  524. }
  525. }
  526. break;
  527. }
  528. case 4: // Fine Tune (i.e., Edit) the Mesh
  529. #if ENABLED(NEWPANEL)
  530. fine_tune_mesh(g29_x_pos, g29_y_pos, parser.seen('T'));
  531. #else
  532. SERIAL_PROTOCOLLNPGM("?P4 is only available when an LCD is present.");
  533. return;
  534. #endif
  535. break;
  536. case 5: find_mean_mesh_height(); break;
  537. case 6: shift_mesh_height(); break;
  538. }
  539. }
  540. //
  541. // Much of the 'What?' command can be eliminated. But until we are fully debugged, it is
  542. // good to have the extra information. Soon... we prune this to just a few items
  543. //
  544. if (parser.seen('W')) g29_what_command();
  545. //
  546. // When we are fully debugged, this may go away. But there are some valid
  547. // use cases for the users. So we can wait and see what to do with it.
  548. //
  549. if (parser.seen('K')) // Kompare Current Mesh Data to Specified Stored Mesh
  550. g29_compare_current_mesh_to_stored_mesh();
  551. //
  552. // Load a Mesh from the EEPROM
  553. //
  554. if (parser.seen('L')) { // Load Current Mesh Data
  555. g29_storage_slot = parser.has_value() ? parser.value_int() : storage_slot;
  556. int16_t a = settings.calc_num_meshes();
  557. if (!a) {
  558. SERIAL_PROTOCOLLNPGM("?EEPROM storage not available.");
  559. return;
  560. }
  561. if (!WITHIN(g29_storage_slot, 0, a - 1)) {
  562. SERIAL_PROTOCOLLNPGM("?Invalid storage slot.");
  563. SERIAL_PROTOCOLLNPAIR("?Use 0 to ", a - 1);
  564. return;
  565. }
  566. settings.load_mesh(g29_storage_slot);
  567. storage_slot = g29_storage_slot;
  568. SERIAL_PROTOCOLLNPGM("Done.");
  569. }
  570. //
  571. // Store a Mesh in the EEPROM
  572. //
  573. if (parser.seen('S')) { // Store (or Save) Current Mesh Data
  574. g29_storage_slot = parser.has_value() ? parser.value_int() : storage_slot;
  575. if (g29_storage_slot == -1) { // Special case, we are going to 'Export' the mesh to the
  576. SERIAL_ECHOLNPGM("G29 I 999"); // host in a form it can be reconstructed on a different machine
  577. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  578. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  579. if (!isnan(z_values[x][y])) {
  580. SERIAL_ECHOPAIR("M421 I ", x);
  581. SERIAL_ECHOPAIR(" J ", y);
  582. SERIAL_ECHOPGM(" Z ");
  583. SERIAL_ECHO_F(z_values[x][y], 6);
  584. SERIAL_ECHOPAIR(" ; X ", LOGICAL_X_POSITION(mesh_index_to_xpos(x)));
  585. SERIAL_ECHOPAIR(", Y ", LOGICAL_Y_POSITION(mesh_index_to_ypos(y)));
  586. SERIAL_EOL();
  587. }
  588. return;
  589. }
  590. int16_t a = settings.calc_num_meshes();
  591. if (!a) {
  592. SERIAL_PROTOCOLLNPGM("?EEPROM storage not available.");
  593. goto LEAVE;
  594. }
  595. if (!WITHIN(g29_storage_slot, 0, a - 1)) {
  596. SERIAL_PROTOCOLLNPGM("?Invalid storage slot.");
  597. SERIAL_PROTOCOLLNPAIR("?Use 0 to ", a - 1);
  598. goto LEAVE;
  599. }
  600. settings.store_mesh(g29_storage_slot);
  601. storage_slot = g29_storage_slot;
  602. SERIAL_PROTOCOLLNPGM("Done.");
  603. }
  604. if (parser.seen('T'))
  605. display_map(g29_map_type);
  606. LEAVE:
  607. #if ENABLED(NEWPANEL)
  608. lcd_reset_alert_level();
  609. LCD_MESSAGEPGM("");
  610. lcd_quick_feedback();
  611. lcd_external_control = false;
  612. #endif
  613. return;
  614. }
  615. void unified_bed_leveling::find_mean_mesh_height() {
  616. float sum = 0.0;
  617. int n = 0;
  618. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  619. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  620. if (!isnan(z_values[x][y])) {
  621. sum += z_values[x][y];
  622. n++;
  623. }
  624. const float mean = sum / n;
  625. //
  626. // Sum the squares of difference from mean
  627. //
  628. float sum_of_diff_squared = 0.0;
  629. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  630. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  631. if (!isnan(z_values[x][y]))
  632. sum_of_diff_squared += sq(z_values[x][y] - mean);
  633. SERIAL_ECHOLNPAIR("# of samples: ", n);
  634. SERIAL_ECHOPGM("Mean Mesh Height: ");
  635. SERIAL_ECHO_F(mean, 6);
  636. SERIAL_EOL();
  637. const float sigma = SQRT(sum_of_diff_squared / (n + 1));
  638. SERIAL_ECHOPGM("Standard Deviation: ");
  639. SERIAL_ECHO_F(sigma, 6);
  640. SERIAL_EOL();
  641. if (g29_c_flag)
  642. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  643. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  644. if (!isnan(z_values[x][y]))
  645. z_values[x][y] -= mean + g29_constant;
  646. }
  647. void unified_bed_leveling::shift_mesh_height() {
  648. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  649. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  650. if (!isnan(z_values[x][y]))
  651. z_values[x][y] += g29_constant;
  652. }
  653. #if ENABLED(NEWPANEL)
  654. typedef void (*clickFunc_t)();
  655. bool click_and_hold(const clickFunc_t func=NULL) {
  656. if (is_lcd_clicked()) {
  657. lcd_quick_feedback();
  658. const millis_t nxt = millis() + 1500UL;
  659. while (is_lcd_clicked()) { // Loop while the encoder is pressed. Uses hardware flag!
  660. idle(); // idle, of course
  661. if (ELAPSED(millis(), nxt)) { // After 1.5 seconds
  662. lcd_quick_feedback();
  663. if (func) (*func)();
  664. wait_for_release();
  665. safe_delay(50); // Debounce the Encoder wheel
  666. return true;
  667. }
  668. }
  669. }
  670. return false;
  671. }
  672. #endif // NEWPANEL
  673. #if HAS_BED_PROBE
  674. /**
  675. * Probe all invalidated locations of the mesh that can be reached by the probe.
  676. * This attempts to fill in locations closest to the nozzle's start location first.
  677. */
  678. void unified_bed_leveling::probe_entire_mesh(const float &rx, const float &ry, const bool do_ubl_mesh_map, const bool stow_probe, bool close_or_far) {
  679. mesh_index_pair location;
  680. #if ENABLED(NEWPANEL)
  681. lcd_external_control = true;
  682. #endif
  683. save_ubl_active_state_and_disable(); // we don't do bed level correction because we want the raw data when we probe
  684. DEPLOY_PROBE();
  685. uint16_t max_iterations = GRID_MAX_POINTS;
  686. do {
  687. if (do_ubl_mesh_map) display_map(g29_map_type);
  688. #if ENABLED(NEWPANEL)
  689. if (is_lcd_clicked()) {
  690. SERIAL_PROTOCOLLNPGM("\nMesh only partially populated.\n");
  691. lcd_quick_feedback();
  692. STOW_PROBE();
  693. wait_for_release();
  694. lcd_external_control = false;
  695. restore_ubl_active_state_and_leave();
  696. return;
  697. }
  698. #endif
  699. if (close_or_far)
  700. location = find_furthest_invalid_mesh_point();
  701. else
  702. location = find_closest_mesh_point_of_type(INVALID, rx, ry, USE_PROBE_AS_REFERENCE, NULL);
  703. if (location.x_index >= 0) { // mesh point found and is reachable by probe
  704. const float rawx = mesh_index_to_xpos(location.x_index),
  705. rawy = mesh_index_to_ypos(location.y_index);
  706. const float measured_z = probe_pt(rawx, rawy, stow_probe, g29_verbose_level); // TODO: Needs error handling
  707. z_values[location.x_index][location.y_index] = measured_z;
  708. }
  709. } while (location.x_index >= 0 && --max_iterations);
  710. STOW_PROBE();
  711. restore_ubl_active_state_and_leave();
  712. do_blocking_move_to_xy(
  713. constrain(rx - (X_PROBE_OFFSET_FROM_EXTRUDER), MESH_MIN_X, MESH_MAX_X),
  714. constrain(ry - (Y_PROBE_OFFSET_FROM_EXTRUDER), MESH_MIN_Y, MESH_MAX_Y)
  715. );
  716. }
  717. void unified_bed_leveling::tilt_mesh_based_on_3pts(const float &z1, const float &z2, const float &z3) {
  718. matrix_3x3 rotation;
  719. vector_3 v1 = vector_3( (UBL_PROBE_PT_1_X - UBL_PROBE_PT_2_X),
  720. (UBL_PROBE_PT_1_Y - UBL_PROBE_PT_2_Y),
  721. (z1 - z2) ),
  722. v2 = vector_3( (UBL_PROBE_PT_3_X - UBL_PROBE_PT_2_X),
  723. (UBL_PROBE_PT_3_Y - UBL_PROBE_PT_2_Y),
  724. (z3 - z2) ),
  725. normal = vector_3::cross(v1, v2);
  726. normal = normal.get_normal();
  727. /**
  728. * This vector is normal to the tilted plane.
  729. * However, we don't know its direction. We need it to point up. So if
  730. * Z is negative, we need to invert the sign of all components of the vector
  731. */
  732. if (normal.z < 0.0) {
  733. normal.x = -normal.x;
  734. normal.y = -normal.y;
  735. normal.z = -normal.z;
  736. }
  737. rotation = matrix_3x3::create_look_at(vector_3(normal.x, normal.y, 1));
  738. if (g29_verbose_level > 2) {
  739. SERIAL_ECHOPGM("bed plane normal = [");
  740. SERIAL_PROTOCOL_F(normal.x, 7);
  741. SERIAL_PROTOCOLCHAR(',');
  742. SERIAL_PROTOCOL_F(normal.y, 7);
  743. SERIAL_PROTOCOLCHAR(',');
  744. SERIAL_PROTOCOL_F(normal.z, 7);
  745. SERIAL_ECHOLNPGM("]");
  746. rotation.debug(PSTR("rotation matrix:"));
  747. }
  748. //
  749. // All of 3 of these points should give us the same d constant
  750. //
  751. float t = normal.x * (UBL_PROBE_PT_1_X) + normal.y * (UBL_PROBE_PT_1_Y),
  752. d = t + normal.z * z1;
  753. if (g29_verbose_level>2) {
  754. SERIAL_ECHOPGM("D constant: ");
  755. SERIAL_PROTOCOL_F(d, 7);
  756. SERIAL_ECHOLNPGM(" ");
  757. }
  758. #if ENABLED(DEBUG_LEVELING_FEATURE)
  759. if (DEBUGGING(LEVELING)) {
  760. SERIAL_ECHOPGM("d from 1st point: ");
  761. SERIAL_ECHO_F(d, 6);
  762. SERIAL_EOL();
  763. t = normal.x * (UBL_PROBE_PT_2_X) + normal.y * (UBL_PROBE_PT_2_Y);
  764. d = t + normal.z * z2;
  765. SERIAL_ECHOPGM("d from 2nd point: ");
  766. SERIAL_ECHO_F(d, 6);
  767. SERIAL_EOL();
  768. t = normal.x * (UBL_PROBE_PT_3_X) + normal.y * (UBL_PROBE_PT_3_Y);
  769. d = t + normal.z * z3;
  770. SERIAL_ECHOPGM("d from 3rd point: ");
  771. SERIAL_ECHO_F(d, 6);
  772. SERIAL_EOL();
  773. }
  774. #endif
  775. for (uint8_t i = 0; i < GRID_MAX_POINTS_X; i++) {
  776. for (uint8_t j = 0; j < GRID_MAX_POINTS_Y; j++) {
  777. float x_tmp = mesh_index_to_xpos(i),
  778. y_tmp = mesh_index_to_ypos(j),
  779. z_tmp = z_values[i][j];
  780. #if ENABLED(DEBUG_LEVELING_FEATURE)
  781. if (DEBUGGING(LEVELING)) {
  782. SERIAL_ECHOPGM("before rotation = [");
  783. SERIAL_PROTOCOL_F(x_tmp, 7);
  784. SERIAL_PROTOCOLCHAR(',');
  785. SERIAL_PROTOCOL_F(y_tmp, 7);
  786. SERIAL_PROTOCOLCHAR(',');
  787. SERIAL_PROTOCOL_F(z_tmp, 7);
  788. SERIAL_ECHOPGM("] ---> ");
  789. safe_delay(20);
  790. }
  791. #endif
  792. apply_rotation_xyz(rotation, x_tmp, y_tmp, z_tmp);
  793. #if ENABLED(DEBUG_LEVELING_FEATURE)
  794. if (DEBUGGING(LEVELING)) {
  795. SERIAL_ECHOPGM("after rotation = [");
  796. SERIAL_PROTOCOL_F(x_tmp, 7);
  797. SERIAL_PROTOCOLCHAR(',');
  798. SERIAL_PROTOCOL_F(y_tmp, 7);
  799. SERIAL_PROTOCOLCHAR(',');
  800. SERIAL_PROTOCOL_F(z_tmp, 7);
  801. SERIAL_ECHOLNPGM("]");
  802. safe_delay(55);
  803. }
  804. #endif
  805. z_values[i][j] += z_tmp - d;
  806. }
  807. }
  808. }
  809. #endif // HAS_BED_PROBE
  810. #if ENABLED(NEWPANEL)
  811. void unified_bed_leveling::move_z_with_encoder(const float &multiplier) {
  812. wait_for_release();
  813. while (!is_lcd_clicked()) {
  814. idle();
  815. if (encoder_diff) {
  816. do_blocking_move_to_z(current_position[Z_AXIS] + float(encoder_diff) * multiplier);
  817. encoder_diff = 0;
  818. }
  819. }
  820. }
  821. float unified_bed_leveling::measure_point_with_encoder() {
  822. KEEPALIVE_STATE(PAUSED_FOR_USER);
  823. move_z_with_encoder(0.01);
  824. KEEPALIVE_STATE(IN_HANDLER);
  825. return current_position[Z_AXIS];
  826. }
  827. static void echo_and_take_a_measurement() { SERIAL_PROTOCOLLNPGM(" and take a measurement."); }
  828. float unified_bed_leveling::measure_business_card_thickness(const float &in_height) {
  829. lcd_external_control = true;
  830. save_ubl_active_state_and_disable(); // Disable bed level correction for probing
  831. do_blocking_move_to(0.5 * (MESH_MAX_X - (MESH_MIN_X)), 0.5 * (MESH_MAX_Y - (MESH_MIN_Y)), in_height);
  832. //, min(planner.max_feedrate_mm_s[X_AXIS], planner.max_feedrate_mm_s[Y_AXIS]) / 2.0);
  833. stepper.synchronize();
  834. SERIAL_PROTOCOLPGM("Place shim under nozzle");
  835. LCD_MESSAGEPGM(MSG_UBL_BC_INSERT);
  836. lcd_return_to_status();
  837. echo_and_take_a_measurement();
  838. const float z1 = measure_point_with_encoder();
  839. do_blocking_move_to_z(current_position[Z_AXIS] + SIZE_OF_LITTLE_RAISE);
  840. stepper.synchronize();
  841. SERIAL_PROTOCOLPGM("Remove shim");
  842. LCD_MESSAGEPGM(MSG_UBL_BC_REMOVE);
  843. echo_and_take_a_measurement();
  844. const float z2 = measure_point_with_encoder();
  845. do_blocking_move_to_z(current_position[Z_AXIS] + Z_CLEARANCE_BETWEEN_PROBES);
  846. const float thickness = abs(z1 - z2);
  847. if (g29_verbose_level > 1) {
  848. SERIAL_PROTOCOLPGM("Business Card is ");
  849. SERIAL_PROTOCOL_F(thickness, 4);
  850. SERIAL_PROTOCOLLNPGM("mm thick.");
  851. }
  852. lcd_external_control = false;
  853. restore_ubl_active_state_and_leave();
  854. return thickness;
  855. }
  856. void abort_manual_probe_remaining_mesh() {
  857. SERIAL_PROTOCOLLNPGM("\nMesh only partially populated.");
  858. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  859. lcd_external_control = false;
  860. KEEPALIVE_STATE(IN_HANDLER);
  861. ubl.restore_ubl_active_state_and_leave();
  862. }
  863. void unified_bed_leveling::manually_probe_remaining_mesh(const float &rx, const float &ry, const float &z_clearance, const float &thick, const bool do_ubl_mesh_map) {
  864. lcd_external_control = true;
  865. save_ubl_active_state_and_disable(); // we don't do bed level correction because we want the raw data when we probe
  866. do_blocking_move_to(rx, ry, Z_CLEARANCE_BETWEEN_PROBES);
  867. lcd_return_to_status();
  868. mesh_index_pair location;
  869. do {
  870. location = find_closest_mesh_point_of_type(INVALID, rx, ry, USE_NOZZLE_AS_REFERENCE, NULL);
  871. // It doesn't matter if the probe can't reach the NAN location. This is a manual probe.
  872. if (location.x_index < 0 && location.y_index < 0) continue;
  873. const float xProbe = mesh_index_to_xpos(location.x_index),
  874. yProbe = mesh_index_to_ypos(location.y_index);
  875. if (!position_is_reachable(xProbe, yProbe)) break; // SHOULD NOT OCCUR (find_closest_mesh_point only returns reachable points)
  876. LCD_MESSAGEPGM(MSG_UBL_MOVING_TO_NEXT);
  877. do_blocking_move_to(xProbe, yProbe, Z_CLEARANCE_BETWEEN_PROBES);
  878. do_blocking_move_to_z(z_clearance);
  879. KEEPALIVE_STATE(PAUSED_FOR_USER);
  880. lcd_external_control = true;
  881. if (do_ubl_mesh_map) display_map(g29_map_type); // show user where we're probing
  882. serialprintPGM(parser.seen('B') ? PSTR(MSG_UBL_BC_INSERT) : PSTR(MSG_UBL_BC_INSERT2));
  883. const float z_step = 0.01; // existing behavior: 0.01mm per click, occasionally step
  884. //const float z_step = 1.0 / planner.axis_steps_per_mm[Z_AXIS]; // approx one step each click
  885. move_z_with_encoder(z_step);
  886. if (click_and_hold()) {
  887. SERIAL_PROTOCOLLNPGM("\nMesh only partially populated.");
  888. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  889. lcd_external_control = false;
  890. KEEPALIVE_STATE(IN_HANDLER);
  891. restore_ubl_active_state_and_leave();
  892. return;
  893. }
  894. z_values[location.x_index][location.y_index] = current_position[Z_AXIS] - thick;
  895. if (g29_verbose_level > 2) {
  896. SERIAL_PROTOCOLPGM("Mesh Point Measured at: ");
  897. SERIAL_PROTOCOL_F(z_values[location.x_index][location.y_index], 6);
  898. SERIAL_EOL();
  899. }
  900. } while (location.x_index >= 0 && location.y_index >= 0);
  901. if (do_ubl_mesh_map) display_map(g29_map_type);
  902. restore_ubl_active_state_and_leave();
  903. KEEPALIVE_STATE(IN_HANDLER);
  904. do_blocking_move_to(rx, ry, Z_CLEARANCE_DEPLOY_PROBE);
  905. }
  906. #endif // NEWPANEL
  907. bool unified_bed_leveling::g29_parameter_parsing() {
  908. bool err_flag = false;
  909. #if ENABLED(NEWPANEL)
  910. LCD_MESSAGEPGM(MSG_UBL_DOING_G29);
  911. lcd_quick_feedback();
  912. #endif
  913. g29_constant = 0.0;
  914. g29_repetition_cnt = 0;
  915. g29_x_flag = parser.seenval('X');
  916. g29_x_pos = g29_x_flag ? parser.value_float() : current_position[X_AXIS];
  917. g29_y_flag = parser.seenval('Y');
  918. g29_y_pos = g29_y_flag ? parser.value_float() : current_position[Y_AXIS];
  919. if (parser.seen('R')) {
  920. g29_repetition_cnt = parser.has_value() ? parser.value_int() : GRID_MAX_POINTS;
  921. NOMORE(g29_repetition_cnt, GRID_MAX_POINTS);
  922. if (g29_repetition_cnt < 1) {
  923. SERIAL_PROTOCOLLNPGM("?(R)epetition count invalid (1+).\n");
  924. return UBL_ERR;
  925. }
  926. }
  927. g29_verbose_level = parser.seen('V') ? parser.value_int() : 0;
  928. if (!WITHIN(g29_verbose_level, 0, 4)) {
  929. SERIAL_PROTOCOLLNPGM("?(V)erbose level is implausible (0-4).\n");
  930. err_flag = true;
  931. }
  932. if (parser.seen('P')) {
  933. const int pv = parser.value_int();
  934. #if !HAS_BED_PROBE
  935. if (pv == 1) {
  936. SERIAL_PROTOCOLLNPGM("G29 P1 requires a probe.\n");
  937. err_flag = true;
  938. }
  939. else
  940. #endif
  941. {
  942. g29_phase_value = pv;
  943. if (!WITHIN(g29_phase_value, 0, 6)) {
  944. SERIAL_PROTOCOLLNPGM("?(P)hase value invalid (0-6).\n");
  945. err_flag = true;
  946. }
  947. }
  948. }
  949. if (parser.seen('J')) {
  950. #if HAS_BED_PROBE
  951. g29_grid_size = parser.has_value() ? parser.value_int() : 0;
  952. if (g29_grid_size && !WITHIN(g29_grid_size, 2, 9)) {
  953. SERIAL_PROTOCOLLNPGM("?Invalid grid size (J) specified (2-9).\n");
  954. err_flag = true;
  955. }
  956. #else
  957. SERIAL_PROTOCOLLNPGM("G29 J action requires a probe.\n");
  958. err_flag = true;
  959. #endif
  960. }
  961. if (g29_x_flag != g29_y_flag) {
  962. SERIAL_PROTOCOLLNPGM("Both X & Y locations must be specified.\n");
  963. err_flag = true;
  964. }
  965. // If X or Y are not valid, use center of the bed values
  966. if (!WITHIN(g29_x_pos, X_MIN_BED, X_MAX_BED)) g29_x_pos = X_CENTER;
  967. if (!WITHIN(g29_y_pos, Y_MIN_BED, Y_MAX_BED)) g29_y_pos = Y_CENTER;
  968. if (err_flag) return UBL_ERR;
  969. /**
  970. * Activate or deactivate UBL
  971. * Note: UBL's G29 restores the state set here when done.
  972. * Leveling is being enabled here with old data, possibly
  973. * none. Error handling should disable for safety...
  974. */
  975. if (parser.seen('A')) {
  976. if (parser.seen('D')) {
  977. SERIAL_PROTOCOLLNPGM("?Can't activate and deactivate at the same time.\n");
  978. return UBL_ERR;
  979. }
  980. set_bed_leveling_enabled(true);
  981. report_state();
  982. }
  983. else if (parser.seen('D')) {
  984. set_bed_leveling_enabled(false);
  985. report_state();
  986. }
  987. // Set global 'C' flag and its value
  988. if ((g29_c_flag = parser.seen('C')))
  989. g29_constant = parser.value_float();
  990. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  991. if (parser.seenval('F')) {
  992. const float fh = parser.value_float();
  993. if (!WITHIN(fh, 0.0, 100.0)) {
  994. SERIAL_PROTOCOLLNPGM("?(F)ade height for Bed Level Correction not plausible.\n");
  995. return UBL_ERR;
  996. }
  997. set_z_fade_height(fh);
  998. }
  999. #endif
  1000. g29_map_type = parser.intval('T');
  1001. if (!WITHIN(g29_map_type, 0, 2)) {
  1002. SERIAL_PROTOCOLLNPGM("Invalid map type.\n");
  1003. return UBL_ERR;
  1004. }
  1005. return UBL_OK;
  1006. }
  1007. static uint8_t ubl_state_at_invocation = 0;
  1008. #if ENABLED(UBL_DEVEL_DEBUGGING)
  1009. static uint8_t ubl_state_recursion_chk = 0;
  1010. #endif
  1011. void unified_bed_leveling::save_ubl_active_state_and_disable() {
  1012. #if ENABLED(UBL_DEVEL_DEBUGGING)
  1013. ubl_state_recursion_chk++;
  1014. if (ubl_state_recursion_chk != 1) {
  1015. SERIAL_ECHOLNPGM("save_ubl_active_state_and_disabled() called multiple times in a row.");
  1016. #if ENABLED(NEWPANEL)
  1017. LCD_MESSAGEPGM(MSG_UBL_SAVE_ERROR);
  1018. lcd_quick_feedback();
  1019. #endif
  1020. return;
  1021. }
  1022. #endif
  1023. ubl_state_at_invocation = planner.leveling_active;
  1024. set_bed_leveling_enabled(false);
  1025. }
  1026. void unified_bed_leveling::restore_ubl_active_state_and_leave() {
  1027. #if ENABLED(UBL_DEVEL_DEBUGGING)
  1028. if (--ubl_state_recursion_chk) {
  1029. SERIAL_ECHOLNPGM("restore_ubl_active_state_and_leave() called too many times.");
  1030. #if ENABLED(NEWPANEL)
  1031. LCD_MESSAGEPGM(MSG_UBL_RESTORE_ERROR);
  1032. lcd_quick_feedback();
  1033. #endif
  1034. return;
  1035. }
  1036. #endif
  1037. set_bed_leveling_enabled(ubl_state_at_invocation);
  1038. }
  1039. /**
  1040. * Much of the 'What?' command can be eliminated. But until we are fully debugged, it is
  1041. * good to have the extra information. Soon... we prune this to just a few items
  1042. */
  1043. void unified_bed_leveling::g29_what_command() {
  1044. report_state();
  1045. if (storage_slot == -1)
  1046. SERIAL_PROTOCOLPGM("No Mesh Loaded.");
  1047. else {
  1048. SERIAL_PROTOCOLPAIR("Mesh ", storage_slot);
  1049. SERIAL_PROTOCOLPGM(" Loaded.");
  1050. }
  1051. SERIAL_EOL();
  1052. safe_delay(50);
  1053. SERIAL_PROTOCOLLNPAIR("UBL object count: ", (int)ubl_cnt);
  1054. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  1055. SERIAL_PROTOCOL("planner.z_fade_height : ");
  1056. SERIAL_PROTOCOL_F(planner.z_fade_height, 4);
  1057. SERIAL_EOL();
  1058. #endif
  1059. find_mean_mesh_height();
  1060. #if HAS_BED_PROBE
  1061. SERIAL_PROTOCOLPGM("zprobe_zoffset: ");
  1062. SERIAL_PROTOCOL_F(zprobe_zoffset, 7);
  1063. SERIAL_EOL();
  1064. #endif
  1065. SERIAL_ECHOLNPAIR("MESH_MIN_X " STRINGIFY(MESH_MIN_X) "=", MESH_MIN_X);
  1066. SERIAL_ECHOLNPAIR("MESH_MIN_Y " STRINGIFY(MESH_MIN_Y) "=", MESH_MIN_Y);
  1067. safe_delay(25);
  1068. SERIAL_ECHOLNPAIR("MESH_MAX_X " STRINGIFY(MESH_MAX_X) "=", MESH_MAX_X);
  1069. SERIAL_ECHOLNPAIR("MESH_MAX_Y " STRINGIFY(MESH_MAX_Y) "=", MESH_MAX_Y);
  1070. safe_delay(25);
  1071. SERIAL_ECHOLNPAIR("GRID_MAX_POINTS_X ", GRID_MAX_POINTS_X);
  1072. SERIAL_ECHOLNPAIR("GRID_MAX_POINTS_Y ", GRID_MAX_POINTS_Y);
  1073. safe_delay(25);
  1074. SERIAL_ECHOLNPAIR("MESH_X_DIST ", MESH_X_DIST);
  1075. SERIAL_ECHOLNPAIR("MESH_Y_DIST ", MESH_Y_DIST);
  1076. safe_delay(25);
  1077. SERIAL_PROTOCOLPGM("X-Axis Mesh Points at: ");
  1078. for (uint8_t i = 0; i < GRID_MAX_POINTS_X; i++) {
  1079. SERIAL_PROTOCOL_F(LOGICAL_X_POSITION(mesh_index_to_xpos(i)), 3);
  1080. SERIAL_PROTOCOLPGM(" ");
  1081. safe_delay(25);
  1082. }
  1083. SERIAL_EOL();
  1084. SERIAL_PROTOCOLPGM("Y-Axis Mesh Points at: ");
  1085. for (uint8_t i = 0; i < GRID_MAX_POINTS_Y; i++) {
  1086. SERIAL_PROTOCOL_F(LOGICAL_Y_POSITION(mesh_index_to_ypos(i)), 3);
  1087. SERIAL_PROTOCOLPGM(" ");
  1088. safe_delay(25);
  1089. }
  1090. SERIAL_EOL();
  1091. #if HAS_KILL
  1092. SERIAL_PROTOCOLPAIR("Kill pin on :", KILL_PIN);
  1093. SERIAL_PROTOCOLLNPAIR(" state:", READ(KILL_PIN));
  1094. #endif
  1095. SERIAL_EOL();
  1096. safe_delay(50);
  1097. #if ENABLED(UBL_DEVEL_DEBUGGING)
  1098. SERIAL_PROTOCOLLNPAIR("ubl_state_at_invocation :", ubl_state_at_invocation);
  1099. SERIAL_EOL();
  1100. SERIAL_PROTOCOLLNPAIR("ubl_state_recursion_chk :", ubl_state_recursion_chk);
  1101. SERIAL_EOL();
  1102. safe_delay(50);
  1103. SERIAL_PROTOCOLPAIR("Meshes go from ", hex_address((void*)settings.get_start_of_meshes()));
  1104. SERIAL_PROTOCOLLNPAIR(" to ", hex_address((void*)settings.get_end_of_meshes()));
  1105. safe_delay(50);
  1106. SERIAL_PROTOCOLLNPAIR("sizeof(ubl) : ", (int)sizeof(ubl));
  1107. SERIAL_EOL();
  1108. SERIAL_PROTOCOLLNPAIR("z_value[][] size: ", (int)sizeof(z_values));
  1109. SERIAL_EOL();
  1110. safe_delay(25);
  1111. SERIAL_PROTOCOLLNPAIR("EEPROM free for UBL: ", hex_address((void*)(settings.get_end_of_meshes() - settings.get_start_of_meshes())));
  1112. safe_delay(50);
  1113. SERIAL_PROTOCOLPAIR("EEPROM can hold ", settings.calc_num_meshes());
  1114. SERIAL_PROTOCOLLNPGM(" meshes.\n");
  1115. safe_delay(25);
  1116. #endif // UBL_DEVEL_DEBUGGING
  1117. if (!sanity_check()) {
  1118. echo_name();
  1119. SERIAL_PROTOCOLLNPGM(" sanity checks passed.");
  1120. }
  1121. }
  1122. /**
  1123. * When we are fully debugged, the EEPROM dump command will get deleted also. But
  1124. * right now, it is good to have the extra information. Soon... we prune this.
  1125. */
  1126. void unified_bed_leveling::g29_eeprom_dump() {
  1127. unsigned char cccc;
  1128. unsigned int kkkk; // Needs to be of unspecfied size to compile clean on all platforms
  1129. SERIAL_ECHO_START();
  1130. SERIAL_ECHOLNPGM("EEPROM Dump:");
  1131. for (uint16_t i = 0; i < E2END + 1; i += 16) {
  1132. if (!(i & 0x3)) idle();
  1133. print_hex_word(i);
  1134. SERIAL_ECHOPGM(": ");
  1135. for (uint16_t j = 0; j < 16; j++) {
  1136. kkkk = i + j;
  1137. eeprom_read_block(&cccc, (const void *) kkkk, sizeof(unsigned char));
  1138. print_hex_byte(cccc);
  1139. SERIAL_ECHO(' ');
  1140. }
  1141. SERIAL_EOL();
  1142. }
  1143. SERIAL_EOL();
  1144. }
  1145. /**
  1146. * When we are fully debugged, this may go away. But there are some valid
  1147. * use cases for the users. So we can wait and see what to do with it.
  1148. */
  1149. void unified_bed_leveling::g29_compare_current_mesh_to_stored_mesh() {
  1150. int16_t a = settings.calc_num_meshes();
  1151. if (!a) {
  1152. SERIAL_PROTOCOLLNPGM("?EEPROM storage not available.");
  1153. return;
  1154. }
  1155. if (!parser.has_value()) {
  1156. SERIAL_PROTOCOLLNPGM("?Storage slot # required.");
  1157. SERIAL_PROTOCOLLNPAIR("?Use 0 to ", a - 1);
  1158. return;
  1159. }
  1160. g29_storage_slot = parser.value_int();
  1161. if (!WITHIN(g29_storage_slot, 0, a - 1)) {
  1162. SERIAL_PROTOCOLLNPGM("?Invalid storage slot.");
  1163. SERIAL_PROTOCOLLNPAIR("?Use 0 to ", a - 1);
  1164. return;
  1165. }
  1166. float tmp_z_values[GRID_MAX_POINTS_X][GRID_MAX_POINTS_Y];
  1167. settings.load_mesh(g29_storage_slot, &tmp_z_values);
  1168. SERIAL_PROTOCOLPAIR("Subtracting mesh in slot ", g29_storage_slot);
  1169. SERIAL_PROTOCOLLNPGM(" from current mesh.");
  1170. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  1171. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  1172. z_values[x][y] -= tmp_z_values[x][y];
  1173. }
  1174. mesh_index_pair unified_bed_leveling::find_furthest_invalid_mesh_point() {
  1175. bool found_a_NAN = false, found_a_real = false;
  1176. mesh_index_pair out_mesh;
  1177. out_mesh.x_index = out_mesh.y_index = -1;
  1178. out_mesh.distance = -99999.99;
  1179. for (int8_t i = 0; i < GRID_MAX_POINTS_X; i++) {
  1180. for (int8_t j = 0; j < GRID_MAX_POINTS_Y; j++) {
  1181. if (isnan(z_values[i][j])) { // Check to see if this location holds an invalid mesh point
  1182. const float mx = mesh_index_to_xpos(i),
  1183. my = mesh_index_to_ypos(j);
  1184. if (!position_is_reachable_by_probe(mx, my)) // make sure the probe can get to the mesh point
  1185. continue;
  1186. found_a_NAN = true;
  1187. int8_t closest_x=-1, closest_y=-1;
  1188. float d1, d2 = 99999.9;
  1189. for (int8_t k = 0; k < GRID_MAX_POINTS_X; k++) {
  1190. for (int8_t l = 0; l < GRID_MAX_POINTS_Y; l++) {
  1191. if (!isnan(z_values[k][l])) {
  1192. found_a_real = true;
  1193. // Add in a random weighting factor that scrambles the probing of the
  1194. // last half of the mesh (when every unprobed mesh point is one index
  1195. // from a probed location).
  1196. d1 = HYPOT(i - k, j - l) + (1.0 / ((millis() % 47) + 13));
  1197. if (d1 < d2) { // found a closer distance from invalid mesh point at (i,j) to defined mesh point at (k,l)
  1198. d2 = d1; // found a closer location with
  1199. closest_x = i; // an assigned mesh point value
  1200. closest_y = j;
  1201. }
  1202. }
  1203. }
  1204. }
  1205. //
  1206. // at this point d2 should have the closest defined mesh point to invalid mesh point (i,j)
  1207. //
  1208. if (found_a_real && (closest_x >= 0) && (d2 > out_mesh.distance)) {
  1209. out_mesh.distance = d2; // found an invalid location with a greater distance
  1210. out_mesh.x_index = closest_x; // to a defined mesh point
  1211. out_mesh.y_index = closest_y;
  1212. }
  1213. }
  1214. } // for j
  1215. } // for i
  1216. if (!found_a_real && found_a_NAN) { // if the mesh is totally unpopulated, start the probing
  1217. out_mesh.x_index = GRID_MAX_POINTS_X / 2;
  1218. out_mesh.y_index = GRID_MAX_POINTS_Y / 2;
  1219. out_mesh.distance = 1.0;
  1220. }
  1221. return out_mesh;
  1222. }
  1223. mesh_index_pair unified_bed_leveling::find_closest_mesh_point_of_type(const MeshPointType type, const float &rx, const float &ry, const bool probe_as_reference, uint16_t bits[16]) {
  1224. mesh_index_pair out_mesh;
  1225. out_mesh.x_index = out_mesh.y_index = -1;
  1226. out_mesh.distance = -99999.9;
  1227. // Get our reference position. Either the nozzle or probe location.
  1228. const float px = rx - (probe_as_reference == USE_PROBE_AS_REFERENCE ? X_PROBE_OFFSET_FROM_EXTRUDER : 0),
  1229. py = ry - (probe_as_reference == USE_PROBE_AS_REFERENCE ? Y_PROBE_OFFSET_FROM_EXTRUDER : 0);
  1230. float best_so_far = 99999.99;
  1231. for (int8_t i = 0; i < GRID_MAX_POINTS_X; i++) {
  1232. for (int8_t j = 0; j < GRID_MAX_POINTS_Y; j++) {
  1233. if ( (type == INVALID && isnan(z_values[i][j])) // Check to see if this location holds the right thing
  1234. || (type == REAL && !isnan(z_values[i][j]))
  1235. || (type == SET_IN_BITMAP && is_bitmap_set(bits, i, j))
  1236. ) {
  1237. // We only get here if we found a Mesh Point of the specified type
  1238. const float mx = mesh_index_to_xpos(i),
  1239. my = mesh_index_to_ypos(j);
  1240. // If using the probe as the reference there are some unreachable locations.
  1241. // Also for round beds, there are grid points outside the bed the nozzle can't reach.
  1242. // Prune them from the list and ignore them till the next Phase (manual nozzle probing).
  1243. if (probe_as_reference ? !position_is_reachable_by_probe(mx, my) : !position_is_reachable(mx, my))
  1244. continue;
  1245. // Reachable. Check if it's the best_so_far location to the nozzle.
  1246. float distance = HYPOT(px - mx, py - my);
  1247. // factor in the distance from the current location for the normal case
  1248. // so the nozzle isn't running all over the bed.
  1249. distance += HYPOT(current_position[X_AXIS] - mx, current_position[Y_AXIS] - my) * 0.1;
  1250. if (distance < best_so_far) {
  1251. best_so_far = distance; // We found a closer location with
  1252. out_mesh.x_index = i; // the specified type of mesh value.
  1253. out_mesh.y_index = j;
  1254. out_mesh.distance = best_so_far;
  1255. }
  1256. }
  1257. } // for j
  1258. } // for i
  1259. return out_mesh;
  1260. }
  1261. #if ENABLED(NEWPANEL)
  1262. void abort_fine_tune() {
  1263. lcd_return_to_status();
  1264. do_blocking_move_to_z(Z_CLEARANCE_BETWEEN_PROBES);
  1265. LCD_MESSAGEPGM(MSG_EDITING_STOPPED);
  1266. }
  1267. void unified_bed_leveling::fine_tune_mesh(const float &rx, const float &ry, const bool do_ubl_mesh_map) {
  1268. if (!parser.seen('R')) // fine_tune_mesh() is special. If no repetition count flag is specified
  1269. g29_repetition_cnt = 1; // do exactly one mesh location. Otherwise use what the parser decided.
  1270. #if ENABLED(UBL_MESH_EDIT_MOVES_Z)
  1271. const bool is_offset = parser.seen('H');
  1272. const float h_offset = is_offset ? parser.value_linear_units() : Z_CLEARANCE_BETWEEN_PROBES;
  1273. if (is_offset && !WITHIN(h_offset, 0, 10)) {
  1274. SERIAL_PROTOCOLLNPGM("Offset out of bounds. (0 to 10mm)\n");
  1275. return;
  1276. }
  1277. #endif
  1278. mesh_index_pair location;
  1279. if (!position_is_reachable(rx, ry)) {
  1280. SERIAL_PROTOCOLLNPGM("(X,Y) outside printable radius.");
  1281. return;
  1282. }
  1283. save_ubl_active_state_and_disable();
  1284. LCD_MESSAGEPGM(MSG_UBL_FINE_TUNE_MESH);
  1285. do_blocking_move_to(rx, ry, Z_CLEARANCE_BETWEEN_PROBES);
  1286. uint16_t not_done[16];
  1287. memset(not_done, 0xFF, sizeof(not_done));
  1288. do {
  1289. location = find_closest_mesh_point_of_type(SET_IN_BITMAP, rx, ry, USE_NOZZLE_AS_REFERENCE, not_done);
  1290. if (location.x_index < 0) break; // stop when we can't find any more reachable points.
  1291. bitmap_clear(not_done, location.x_index, location.y_index); // Mark this location as 'adjusted' so we will find a
  1292. // different location the next time through the loop
  1293. const float rawx = mesh_index_to_xpos(location.x_index),
  1294. rawy = mesh_index_to_ypos(location.y_index);
  1295. if (!position_is_reachable(rawx, rawy)) // SHOULD NOT OCCUR because find_closest_mesh_point_of_type will only return reachable
  1296. break;
  1297. do_blocking_move_to(rawx, rawy, Z_CLEARANCE_BETWEEN_PROBES); // Move the nozzle to the edit point
  1298. KEEPALIVE_STATE(PAUSED_FOR_USER);
  1299. lcd_external_control = true;
  1300. if (do_ubl_mesh_map) display_map(g29_map_type); // show the user which point is being adjusted
  1301. lcd_refresh();
  1302. float new_z = z_values[location.x_index][location.y_index];
  1303. if (isnan(new_z)) new_z = 0.0; // Set invalid mesh points to 0.0 so they can be edited
  1304. new_z = FLOOR(new_z * 1000.0) * 0.001; // Chop off digits after the 1000ths place
  1305. lcd_mesh_edit_setup(new_z);
  1306. while (!is_lcd_clicked()) {
  1307. new_z = lcd_mesh_edit();
  1308. #if ENABLED(UBL_MESH_EDIT_MOVES_Z)
  1309. do_blocking_move_to_z(h_offset + new_z); // Move the nozzle as the point is edited
  1310. #endif
  1311. idle();
  1312. }
  1313. if (!lcd_map_control) lcd_return_to_status();
  1314. // The technique used here generates a race condition for the encoder click.
  1315. // It could get detected in lcd_mesh_edit (actually _lcd_mesh_fine_tune) or here.
  1316. // Let's work on specifying a proper API for the LCD ASAP, OK?
  1317. lcd_external_control = true;
  1318. // this sequence to detect an is_lcd_clicked() debounce it and leave if it is
  1319. // a Press and Hold is repeated in a lot of places (including G26_Mesh_Validation.cpp). This
  1320. // should be redone and compressed.
  1321. if (click_and_hold(abort_fine_tune))
  1322. goto FINE_TUNE_EXIT;
  1323. safe_delay(20); // We don't want any switch noise.
  1324. z_values[location.x_index][location.y_index] = new_z;
  1325. lcd_refresh();
  1326. } while (location.x_index >= 0 && --g29_repetition_cnt > 0);
  1327. FINE_TUNE_EXIT:
  1328. lcd_external_control = false;
  1329. KEEPALIVE_STATE(IN_HANDLER);
  1330. if (do_ubl_mesh_map) display_map(g29_map_type);
  1331. restore_ubl_active_state_and_leave();
  1332. do_blocking_move_to(rx, ry, Z_CLEARANCE_BETWEEN_PROBES);
  1333. LCD_MESSAGEPGM(MSG_UBL_DONE_EDITING_MESH);
  1334. SERIAL_ECHOLNPGM("Done Editing Mesh");
  1335. if (lcd_map_control)
  1336. lcd_goto_screen(_lcd_ubl_output_map_lcd);
  1337. else
  1338. lcd_return_to_status();
  1339. }
  1340. #endif // NEWPANEL
  1341. /**
  1342. * 'Smart Fill': Scan from the outward edges of the mesh towards the center.
  1343. * If an invalid location is found, use the next two points (if valid) to
  1344. * calculate a 'reasonable' value for the unprobed mesh point.
  1345. */
  1346. bool unified_bed_leveling::smart_fill_one(const uint8_t x, const uint8_t y, const int8_t xdir, const int8_t ydir) {
  1347. const int8_t x1 = x + xdir, x2 = x1 + xdir,
  1348. y1 = y + ydir, y2 = y1 + ydir;
  1349. // A NAN next to a pair of real values?
  1350. if (isnan(z_values[x][y]) && !isnan(z_values[x1][y1]) && !isnan(z_values[x2][y2])) {
  1351. if (z_values[x1][y1] < z_values[x2][y2]) // Angled downward?
  1352. z_values[x][y] = z_values[x1][y1]; // Use nearest (maybe a little too high.)
  1353. else
  1354. z_values[x][y] = 2.0 * z_values[x1][y1] - z_values[x2][y2]; // Angled upward...
  1355. return true;
  1356. }
  1357. return false;
  1358. }
  1359. typedef struct { uint8_t sx, ex, sy, ey; bool yfirst; } smart_fill_info;
  1360. void unified_bed_leveling::smart_fill_mesh() {
  1361. static const smart_fill_info
  1362. info0 PROGMEM = { 0, GRID_MAX_POINTS_X, 0, GRID_MAX_POINTS_Y - 2, false }, // Bottom of the mesh looking up
  1363. info1 PROGMEM = { 0, GRID_MAX_POINTS_X, GRID_MAX_POINTS_Y - 1, 0, false }, // Top of the mesh looking down
  1364. info2 PROGMEM = { 0, GRID_MAX_POINTS_X - 2, 0, GRID_MAX_POINTS_Y, true }, // Left side of the mesh looking right
  1365. info3 PROGMEM = { GRID_MAX_POINTS_X - 1, 0, 0, GRID_MAX_POINTS_Y, true }; // Right side of the mesh looking left
  1366. static const smart_fill_info * const info[] PROGMEM = { &info0, &info1, &info2, &info3 };
  1367. for (uint8_t i = 0; i < COUNT(info); ++i) {
  1368. const smart_fill_info *f = (smart_fill_info*)pgm_read_ptr(&info[i]);
  1369. const int8_t sx = pgm_read_byte(&f->sx), sy = pgm_read_byte(&f->sy),
  1370. ex = pgm_read_byte(&f->ex), ey = pgm_read_byte(&f->ey);
  1371. if (pgm_read_byte(&f->yfirst)) {
  1372. const int8_t dir = ex > sx ? 1 : -1;
  1373. for (uint8_t y = sy; y != ey; ++y)
  1374. for (uint8_t x = sx; x != ex; x += dir)
  1375. if (smart_fill_one(x, y, dir, 0)) break;
  1376. }
  1377. else {
  1378. const int8_t dir = ey > sy ? 1 : -1;
  1379. for (uint8_t x = sx; x != ex; ++x)
  1380. for (uint8_t y = sy; y != ey; y += dir)
  1381. if (smart_fill_one(x, y, 0, dir)) break;
  1382. }
  1383. }
  1384. }
  1385. #if HAS_BED_PROBE
  1386. void unified_bed_leveling::tilt_mesh_based_on_probed_grid(const bool do_ubl_mesh_map) {
  1387. constexpr int16_t x_min = max(MIN_PROBE_X, MESH_MIN_X),
  1388. x_max = min(MAX_PROBE_X, MESH_MAX_X),
  1389. y_min = max(MIN_PROBE_Y, MESH_MIN_Y),
  1390. y_max = min(MAX_PROBE_Y, MESH_MAX_Y);
  1391. const float dx = float(x_max - x_min) / (g29_grid_size - 1.0),
  1392. dy = float(y_max - y_min) / (g29_grid_size - 1.0);
  1393. struct linear_fit_data lsf_results;
  1394. incremental_LSF_reset(&lsf_results);
  1395. bool zig_zag = false;
  1396. for (uint8_t ix = 0; ix < g29_grid_size; ix++) {
  1397. const float rx = float(x_min) + ix * dx;
  1398. for (int8_t iy = 0; iy < g29_grid_size; iy++) {
  1399. const float ry = float(y_min) + dy * (zig_zag ? g29_grid_size - 1 - iy : iy);
  1400. float measured_z = probe_pt(rx, ry, parser.seen('E'), g29_verbose_level); // TODO: Needs error handling
  1401. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1402. if (DEBUGGING(LEVELING)) {
  1403. SERIAL_CHAR('(');
  1404. SERIAL_PROTOCOL_F(rx, 7);
  1405. SERIAL_CHAR(',');
  1406. SERIAL_PROTOCOL_F(ry, 7);
  1407. SERIAL_ECHOPGM(") logical: ");
  1408. SERIAL_CHAR('(');
  1409. SERIAL_PROTOCOL_F(LOGICAL_X_POSITION(rx), 7);
  1410. SERIAL_CHAR(',');
  1411. SERIAL_PROTOCOL_F(LOGICAL_Y_POSITION(ry), 7);
  1412. SERIAL_ECHOPGM(") measured: ");
  1413. SERIAL_PROTOCOL_F(measured_z, 7);
  1414. SERIAL_ECHOPGM(" correction: ");
  1415. SERIAL_PROTOCOL_F(get_z_correction(rx, ry), 7);
  1416. }
  1417. #endif
  1418. measured_z -= get_z_correction(rx, ry) /* + zprobe_zoffset */ ;
  1419. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1420. if (DEBUGGING(LEVELING)) {
  1421. SERIAL_ECHOPGM(" final >>>---> ");
  1422. SERIAL_PROTOCOL_F(measured_z, 7);
  1423. SERIAL_EOL();
  1424. }
  1425. #endif
  1426. incremental_LSF(&lsf_results, rx, ry, measured_z);
  1427. }
  1428. zig_zag ^= true;
  1429. }
  1430. if (finish_incremental_LSF(&lsf_results)) {
  1431. SERIAL_ECHOPGM("Could not complete LSF!");
  1432. return;
  1433. }
  1434. if (g29_verbose_level > 3) {
  1435. SERIAL_ECHOPGM("LSF Results A=");
  1436. SERIAL_PROTOCOL_F(lsf_results.A, 7);
  1437. SERIAL_ECHOPGM(" B=");
  1438. SERIAL_PROTOCOL_F(lsf_results.B, 7);
  1439. SERIAL_ECHOPGM(" D=");
  1440. SERIAL_PROTOCOL_F(lsf_results.D, 7);
  1441. SERIAL_EOL();
  1442. }
  1443. vector_3 normal = vector_3(lsf_results.A, lsf_results.B, 1.0000).get_normal();
  1444. if (g29_verbose_level > 2) {
  1445. SERIAL_ECHOPGM("bed plane normal = [");
  1446. SERIAL_PROTOCOL_F(normal.x, 7);
  1447. SERIAL_PROTOCOLCHAR(',');
  1448. SERIAL_PROTOCOL_F(normal.y, 7);
  1449. SERIAL_PROTOCOLCHAR(',');
  1450. SERIAL_PROTOCOL_F(normal.z, 7);
  1451. SERIAL_ECHOLNPGM("]");
  1452. }
  1453. matrix_3x3 rotation = matrix_3x3::create_look_at(vector_3(lsf_results.A, lsf_results.B, 1));
  1454. for (uint8_t i = 0; i < GRID_MAX_POINTS_X; i++) {
  1455. for (uint8_t j = 0; j < GRID_MAX_POINTS_Y; j++) {
  1456. float x_tmp = mesh_index_to_xpos(i),
  1457. y_tmp = mesh_index_to_ypos(j),
  1458. z_tmp = z_values[i][j];
  1459. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1460. if (DEBUGGING(LEVELING)) {
  1461. SERIAL_ECHOPGM("before rotation = [");
  1462. SERIAL_PROTOCOL_F(x_tmp, 7);
  1463. SERIAL_PROTOCOLCHAR(',');
  1464. SERIAL_PROTOCOL_F(y_tmp, 7);
  1465. SERIAL_PROTOCOLCHAR(',');
  1466. SERIAL_PROTOCOL_F(z_tmp, 7);
  1467. SERIAL_ECHOPGM("] ---> ");
  1468. safe_delay(20);
  1469. }
  1470. #endif
  1471. apply_rotation_xyz(rotation, x_tmp, y_tmp, z_tmp);
  1472. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1473. if (DEBUGGING(LEVELING)) {
  1474. SERIAL_ECHOPGM("after rotation = [");
  1475. SERIAL_PROTOCOL_F(x_tmp, 7);
  1476. SERIAL_PROTOCOLCHAR(',');
  1477. SERIAL_PROTOCOL_F(y_tmp, 7);
  1478. SERIAL_PROTOCOLCHAR(',');
  1479. SERIAL_PROTOCOL_F(z_tmp, 7);
  1480. SERIAL_ECHOLNPGM("]");
  1481. safe_delay(55);
  1482. }
  1483. #endif
  1484. z_values[i][j] += z_tmp - lsf_results.D;
  1485. }
  1486. }
  1487. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1488. if (DEBUGGING(LEVELING)) {
  1489. rotation.debug(PSTR("rotation matrix:"));
  1490. SERIAL_ECHOPGM("LSF Results A=");
  1491. SERIAL_PROTOCOL_F(lsf_results.A, 7);
  1492. SERIAL_ECHOPGM(" B=");
  1493. SERIAL_PROTOCOL_F(lsf_results.B, 7);
  1494. SERIAL_ECHOPGM(" D=");
  1495. SERIAL_PROTOCOL_F(lsf_results.D, 7);
  1496. SERIAL_EOL();
  1497. safe_delay(55);
  1498. SERIAL_ECHOPGM("bed plane normal = [");
  1499. SERIAL_PROTOCOL_F(normal.x, 7);
  1500. SERIAL_PROTOCOLCHAR(',');
  1501. SERIAL_PROTOCOL_F(normal.y, 7);
  1502. SERIAL_PROTOCOLCHAR(',');
  1503. SERIAL_PROTOCOL_F(normal.z, 7);
  1504. SERIAL_ECHOPGM("]\n");
  1505. SERIAL_EOL();
  1506. }
  1507. #endif
  1508. if (do_ubl_mesh_map) display_map(g29_map_type);
  1509. }
  1510. #endif // HAS_BED_PROBE
  1511. #if ENABLED(UBL_G29_P31)
  1512. void unified_bed_leveling::smart_fill_wlsf(const float &weight_factor) {
  1513. // For each undefined mesh point, compute a distance-weighted least squares fit
  1514. // from all the originally populated mesh points, weighted toward the point
  1515. // being extrapolated so that nearby points will have greater influence on
  1516. // the point being extrapolated. Then extrapolate the mesh point from WLSF.
  1517. static_assert(GRID_MAX_POINTS_Y <= 16, "GRID_MAX_POINTS_Y too big");
  1518. uint16_t bitmap[GRID_MAX_POINTS_X] = { 0 };
  1519. struct linear_fit_data lsf_results;
  1520. SERIAL_ECHOPGM("Extrapolating mesh...");
  1521. const float weight_scaled = weight_factor * max(MESH_X_DIST, MESH_Y_DIST);
  1522. for (uint8_t jx = 0; jx < GRID_MAX_POINTS_X; jx++)
  1523. for (uint8_t jy = 0; jy < GRID_MAX_POINTS_Y; jy++)
  1524. if (!isnan(z_values[jx][jy]))
  1525. SBI(bitmap[jx], jy);
  1526. for (uint8_t ix = 0; ix < GRID_MAX_POINTS_X; ix++) {
  1527. const float px = mesh_index_to_xpos(ix);
  1528. for (uint8_t iy = 0; iy < GRID_MAX_POINTS_Y; iy++) {
  1529. const float py = mesh_index_to_ypos(iy);
  1530. if (isnan(z_values[ix][iy])) {
  1531. // undefined mesh point at (px,py), compute weighted LSF from original valid mesh points.
  1532. incremental_LSF_reset(&lsf_results);
  1533. for (uint8_t jx = 0; jx < GRID_MAX_POINTS_X; jx++) {
  1534. const float rx = mesh_index_to_xpos(jx);
  1535. for (uint8_t jy = 0; jy < GRID_MAX_POINTS_Y; jy++) {
  1536. if (TEST(bitmap[jx], jy)) {
  1537. const float ry = mesh_index_to_ypos(jy),
  1538. rz = z_values[jx][jy],
  1539. w = 1.0 + weight_scaled / HYPOT((rx - px), (ry - py));
  1540. incremental_WLSF(&lsf_results, rx, ry, rz, w);
  1541. }
  1542. }
  1543. }
  1544. if (finish_incremental_LSF(&lsf_results)) {
  1545. SERIAL_ECHOLNPGM("Insufficient data");
  1546. return;
  1547. }
  1548. const float ez = -lsf_results.D - lsf_results.A * px - lsf_results.B * py;
  1549. z_values[ix][iy] = ez;
  1550. idle(); // housekeeping
  1551. }
  1552. }
  1553. }
  1554. SERIAL_ECHOLNPGM("done");
  1555. }
  1556. #endif // UBL_G29_P31
  1557. #endif // AUTO_BED_LEVELING_UBL