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

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