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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728
  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 "vector_3.h"
  25. //#include "qr_solve.h"
  26. #include "ubl.h"
  27. #include "Marlin.h"
  28. #include "hex_print_routines.h"
  29. #include "configuration_store.h"
  30. #include "ultralcd.h"
  31. #include <math.h>
  32. #include "least_squares_fit.h"
  33. void lcd_return_to_status();
  34. bool lcd_clicked();
  35. void lcd_implementation_clear();
  36. void lcd_mesh_edit_setup(float initial);
  37. float lcd_mesh_edit();
  38. void lcd_z_offset_edit_setup(float);
  39. float lcd_z_offset_edit();
  40. extern float meshedit_done;
  41. extern long babysteps_done;
  42. extern float code_value_float();
  43. extern uint8_t code_value_byte();
  44. extern bool code_value_bool();
  45. extern bool code_has_value();
  46. extern float probe_pt(float x, float y, bool, int);
  47. extern bool set_probe_deployed(bool);
  48. void smart_fill_mesh();
  49. bool ProbeStay = true;
  50. #define SIZE_OF_LITTLE_RAISE 0
  51. #define BIG_RAISE_NOT_NEEDED 0
  52. extern void lcd_quick_feedback();
  53. /**
  54. * G29: Unified Bed Leveling by Roxy
  55. *
  56. * Parameters understood by this leveling system:
  57. *
  58. * A Activate Activate the Unified Bed Leveling system.
  59. *
  60. * B # Business Use the 'Business Card' mode of the Manual Probe subsystem. This is invoked as
  61. * G29 P2 B The mode of G29 P2 allows you to use a bussiness card or recipe card
  62. * as a shim that the nozzle will pinch as it is lowered. The idea is that you
  63. * can easily feel the nozzle getting to the same height by the amount of resistance
  64. * the business card exhibits to movement. You should try to achieve the same amount
  65. * of resistance on each probed point to facilitate accurate and repeatable measurements.
  66. * You should be very careful not to drive the nozzle into the bussiness card with a
  67. * lot of force as it is very possible to cause damage to your printer if your are
  68. * careless. If you use the B option with G29 P2 B you can leave the number parameter off
  69. * on its first use to enable measurement of the business card thickness. Subsequent usage
  70. * of the B parameter can have the number previously measured supplied to the command.
  71. * Incidently, you are much better off using something like a Spark Gap feeler gauge than
  72. * something that compresses like a Business Card.
  73. *
  74. * C Continue Continue, Constant, Current Location. This is not a primary command. C is used to
  75. * further refine the behaviour of several other commands. Issuing a G29 P1 C will
  76. * continue the generation of a partially constructed Mesh without invalidating what has
  77. * been done. Issuing a G29 P2 C will tell the Manual Probe subsystem to use the current
  78. * location in its search for the closest unmeasured Mesh Point. When used with a G29 Z C
  79. * it indicates to use the current location instead of defaulting to the center of the print bed.
  80. *
  81. * D Disable Disable the Unified Bed Leveling system.
  82. *
  83. * E Stow_probe Stow the probe after each sampled point.
  84. *
  85. * F # Fade * Fade the amount of Mesh Based Compensation over a specified height. At the
  86. * specified height, no correction is applied and natural printer kenimatics take over. If no
  87. * number is specified for the command, 10mm is assumed to be reasonable.
  88. *
  89. * H # Height Specify the Height to raise the nozzle after each manual probe of the bed. The
  90. * default is 5mm.
  91. *
  92. * I # Invalidate Invalidate specified number of Mesh Points. The nozzle location is used unless
  93. * the X and Y parameter are used. If no number is specified, only the closest Mesh
  94. * point to the location is invalidated. The M parameter is available as well to produce
  95. * a map after the operation. This command is useful to invalidate a portion of the
  96. * Mesh so it can be adjusted using other tools in the Unified Bed Leveling System. When
  97. * attempting to invalidate an isolated bad point in the mesh, the M option will indicate
  98. * where the nozzle is positioned in the Mesh with (#). You can move the nozzle around on
  99. * the bed and use this feature to select the center of the area (or cell) you want to
  100. * invalidate.
  101. *
  102. * J # Grid * Perform a Grid Based Leveling of the current Mesh using a grid with n points on a side.
  103. *
  104. * j EEPROM Dump This function probably goes away after debug is complete.
  105. *
  106. * K # Kompare Kompare current Mesh with stored Mesh # replacing current Mesh with the result. This
  107. * command literally performs a diff between two Meshes.
  108. *
  109. * L Load * Load Mesh from the previously activated location in the EEPROM.
  110. *
  111. * L # Load * Load Mesh from the specified location in the EEPROM. Set this location as activated
  112. * for subsequent Load and Store operations.
  113. *
  114. * O Map * Display the Mesh Map Topology.
  115. * The parameter can be specified alone (ie. G29 O) or in combination with many of the
  116. * other commands. The Mesh Map option works with all of the Phase
  117. * commands (ie. G29 P4 R 5 X 50 Y100 C -.1 O) The Map parameter can also of a Map Type
  118. * specified. A map type of 0 is the default is user readable. A map type of 1 can
  119. * be specified and is suitable to Cut & Paste into Excel to allow graphing of the user's
  120. * mesh.
  121. *
  122. * The P or Phase commands are used for the bulk of the work to setup a Mesh. In general, your Mesh will
  123. * start off being initialized with a G29 P0 or a G29 P1. Further refinement of the Mesh happens with
  124. * each additional Phase that processes it.
  125. *
  126. * P0 Phase 0 Zero Mesh Data and turn off the Mesh Compensation System. This reverts the
  127. * 3D Printer to the same state it was in before the Unified Bed Leveling Compensation
  128. * was turned on. Setting the entire Mesh to Zero is a special case that allows
  129. * a subsequent G or T leveling operation for backward compatibility.
  130. *
  131. * P1 Phase 1 Invalidate entire Mesh and continue with automatic generation of the Mesh data using
  132. * the Z-Probe. Depending upon the values of DELTA_PROBEABLE_RADIUS and
  133. * DELTA_PRINTABLE_RADIUS some area of the bed will not have Mesh Data automatically
  134. * generated. This will be handled in Phase 2. If the Phase 1 command is given the
  135. * C (Continue) parameter it does not invalidate the Mesh prior to automatically
  136. * probing needed locations. This allows you to invalidate portions of the Mesh but still
  137. * use the automatic probing capabilities of the Unified Bed Leveling System. An X and Y
  138. * parameter can be given to prioritize where the command should be trying to measure points.
  139. * If the X and Y parameters are not specified the current probe position is used. Phase 1
  140. * allows you to specify the M (Map) parameter so you can watch the generation of the Mesh.
  141. * Phase 1 also watches for the LCD Panel's Encoder Switch being held in a depressed state.
  142. * It will suspend generation of the Mesh if it sees the user request that. (This check is
  143. * only done between probe points. You will need to press and hold the switch until the
  144. * Phase 1 command can detect it.)
  145. *
  146. * P2 Phase 2 Probe areas of the Mesh that can't be automatically handled. Phase 2 respects an H
  147. * parameter to control the height between Mesh points. The default height for movement
  148. * between Mesh points is 5mm. A smaller number can be used to make this part of the
  149. * calibration less time consuming. You will be running the nozzle down until it just barely
  150. * touches the glass. You should have the nozzle clean with no plastic obstructing your view.
  151. * Use caution and move slowly. It is possible to damage your printer if you are careless.
  152. * Note that this command will use the configuration #define SIZE_OF_LITTLE_RAISE if the
  153. * nozzle is moving a distance of less than BIG_RAISE_NOT_NEEDED.
  154. *
  155. * The H parameter can be set negative if your Mesh dips in a large area. You can press
  156. * and hold the LCD Panel's encoder wheel to terminate the current Phase 2 command. You
  157. * can then re-issue the G29 P 2 command with an H parameter that is more suitable for the
  158. * area you are manually probing. Note that the command tries to start you in a corner
  159. * of the bed where movement will be predictable. You can force the location to be used in
  160. * the distance calculations by using the X and Y parameters. You may find it is helpful to
  161. * print out a Mesh Map (G29 O) to understand where the mesh is invalidated and where
  162. * the nozzle will need to move in order to complete the command. The C parameter is
  163. * available on the Phase 2 command also and indicates the search for points to measure should
  164. * be done based on the current location of the nozzle.
  165. *
  166. * A B parameter is also available for this command and described up above. It places the
  167. * manual probe subsystem into Business Card mode where the thickness of a business care is
  168. * measured and then used to accurately set the nozzle height in all manual probing for the
  169. * duration of the command. (S for Shim mode would be a better parameter name, but S is needed
  170. * for Save or Store of the Mesh to EEPROM) A Business card can be used, but you will have
  171. * better results if you use a flexible Shim that does not compress very much. That makes it
  172. * easier for you to get the nozzle to press with similar amounts of force against the shim so you
  173. * can get accurate measurements. As you are starting to touch the nozzle against the shim try
  174. * to get it to grasp the shim with the same force as when you measured the thickness of the
  175. * shim at the start of the command.
  176. *
  177. * Phase 2 allows the O (Map) parameter to be specified. This helps the user see the progression
  178. * of the Mesh being built.
  179. *
  180. * P3 Phase 3 Fill the unpopulated regions of the Mesh with a fixed value. There are two different paths the
  181. * user can go down. If the user specifies the value using the C parameter, the closest invalid
  182. * mesh points to the nozzle will be filled. The user can specify a repeat count using the R
  183. * parameter with the C version of the command.
  184. *
  185. * A second version of the fill command is available if no C constant is specified. Not
  186. * specifying a C constant will invoke the 'Smart Fill' algorithm. The G29 P3 command will search
  187. * from the edges of the mesh inward looking for invalid mesh points. It will look at the next
  188. * several mesh points to determine if the print bed is sloped up or down. If the bed is sloped
  189. * upward from the invalid mesh point, it will be replaced with the value of the nearest mesh point.
  190. * If the bed is sloped downward from the invalid mesh point, it will be replaced with a value that
  191. * puts all three points in a line. The second version of the G29 P3 command is a quick, easy and
  192. * usually safe way to populate the unprobed regions of your mesh so you can continue to the G26
  193. * Mesh Validation Pattern phase. Please note that you are populating your mesh with unverified
  194. * numbers. You should use some scrutiny and caution.
  195. *
  196. * P4 Phase 4 Fine tune the Mesh. The Delta Mesh Compensation System assume the existance of
  197. * an LCD Panel. It is possible to fine tune the mesh without the use of an LCD Panel.
  198. * (More work and details on doing this later!)
  199. * The System will search for the closest Mesh Point to the nozzle. It will move the
  200. * nozzle to this location. The user can use the LCD Panel to carefully adjust the nozzle
  201. * so it is just barely touching the bed. When the user clicks the control, the System
  202. * will lock in that height for that point in the Mesh Compensation System.
  203. *
  204. * Phase 4 has several additional parameters that the user may find helpful. Phase 4
  205. * can be started at a specific location by specifying an X and Y parameter. Phase 4
  206. * can be requested to continue the adjustment of Mesh Points by using the R(epeat)
  207. * parameter. If the Repetition count is not specified, it is assumed the user wishes
  208. * to adjust the entire matrix. The nozzle is moved to the Mesh Point being edited.
  209. * The command can be terminated early (or after the area of interest has been edited) by
  210. * pressing and holding the encoder wheel until the system recognizes the exit request.
  211. * Phase 4's general form is G29 P4 [R # of points] [X position] [Y position]
  212. *
  213. * Phase 4 is intended to be used with the G26 Mesh Validation Command. Using the
  214. * information left on the printer's bed from the G26 command it is very straight forward
  215. * and easy to fine tune the Mesh. One concept that is important to remember and that
  216. * will make using the Phase 4 command easy to use is this: You are editing the Mesh Points.
  217. * If you have too little clearance and not much plastic was extruded in an area, you want to
  218. * LOWER the Mesh Point at the location. If you did not get good adheasion, you want to
  219. * RAISE the Mesh Point at that location.
  220. *
  221. *
  222. * P5 Phase 5 Find Mean Mesh Height and Standard Deviation. Typically, it is easier to use and
  223. * work with the Mesh if it is Mean Adjusted. You can specify a C parameter to
  224. * Correct the Mesh to a 0.00 Mean Height. Adding a C parameter will automatically
  225. * execute a G29 P6 C <mean height>.
  226. *
  227. * P6 Phase 6 Shift Mesh height. The entire Mesh's height is adjusted by the height specified
  228. * with the C parameter. Being able to adjust the height of a Mesh is useful tool. It
  229. * can be used to compensate for poorly calibrated Z-Probes and other errors. Ideally,
  230. * you should have the Mesh adjusted for a Mean Height of 0.00 and the Z-Probe measuring
  231. * 0.000 at the Z Home location.
  232. *
  233. * Q Test * Load specified Test Pattern to assist in checking correct operation of system. This
  234. * command is not anticipated to be of much value to the typical user. It is intended
  235. * for developers to help them verify correct operation of the Unified Bed Leveling System.
  236. *
  237. * R # Repeat Repeat this command the specified number of times. If no number is specified the
  238. * command will be repeated GRID_MAX_POINTS_X * GRID_MAX_POINTS_Y times.
  239. *
  240. * S Store Store the current Mesh in the Activated area of the EEPROM. It will also store the
  241. * current state of the Unified Bed Leveling system in the EEPROM.
  242. *
  243. * S # Store Store the current Mesh at the specified location in EEPROM. Activate this location
  244. * for subsequent Load and Store operations. Valid storage slot numbers begin at 0 and
  245. * extend to a limit related to the available EEPROM storage.
  246. *
  247. * S -1 Store Store the current Mesh as a print out that is suitable to be feed back into the system
  248. * at a later date. The GCode output can be saved and later replayed by the host software
  249. * to reconstruct the current mesh on another machine.
  250. *
  251. * T 3-Point Perform a 3 Point Bed Leveling on the current Mesh
  252. *
  253. * U Unlevel Perform a probe of the outer perimeter to assist in physically leveling unlevel beds.
  254. * Only used for G29 P1 O U It will speed up the probing of the edge of the bed. This
  255. * is useful when the entire bed does not need to be probed because it will be adjusted.
  256. *
  257. * W What? Display valuable data the Unified Bed Leveling System knows.
  258. *
  259. * X # * * X Location for this line of commands
  260. *
  261. * Y # * * Y Location for this line of commands
  262. *
  263. * Z Zero * Probes to set the Z Height of the nozzle. The entire Mesh can be raised or lowered
  264. * by just doing a G29 Z
  265. *
  266. * Z # Zero * The entire Mesh can be raised or lowered to conform with the specified difference.
  267. * zprobe_zoffset is added to the calculation.
  268. *
  269. *
  270. * Release Notes:
  271. * You MUST do M502, M500 to initialize the storage. Failure to do this will cause all
  272. * kinds of problems. Enabling EEPROM Storage is highly recommended. With EEPROM Storage
  273. * of the mesh, you are limited to 3-Point and Grid Leveling. (G29 P0 T and G29 P0 G
  274. * respectively.)
  275. *
  276. * When you do a G28 and then a G29 P1 to automatically build your first mesh, you are going to notice
  277. * the Unified Bed Leveling probes points further and further away from the starting location. (The
  278. * starting location defaults to the center of the bed.) The original Grid and Mesh leveling used
  279. * a Zig Zag pattern. The new pattern is better, especially for people with Delta printers. This
  280. * allows you to get the center area of the Mesh populated (and edited) quicker. This allows you to
  281. * perform a small print and check out your settings quicker. You do not need to populate the
  282. * entire mesh to use it. (You don't want to spend a lot of time generating a mesh only to realize
  283. * you don't have the resolution or zprobe_zoffset set correctly. The Mesh generation
  284. * gathers points closest to where the nozzle is located unless you specify an (X,Y) coordinate pair.
  285. *
  286. * The Unified Bed Leveling uses a lot of EEPROM storage to hold its data. And it takes some effort
  287. * to get this Mesh data correct for a user's printer. We do not want this data destroyed as
  288. * new versions of Marlin add or subtract to the items stored in EEPROM. So, for the benefit of
  289. * the users, we store the Mesh data at the end of the EEPROM and do not keep it contiguous with the
  290. * other data stored in the EEPROM. (For sure the developers are going to complain about this, but
  291. * this is going to be helpful to the users!)
  292. *
  293. * The foundation of this Bed Leveling System is built on Epatel's Mesh Bed Leveling code. A big
  294. * 'Thanks!' to him and the creators of 3-Point and Grid Based leveling. Combining their contributions
  295. * we now have the functionality and features of all three systems combined.
  296. */
  297. #define USE_NOZZLE_AS_REFERENCE 0
  298. #define USE_PROBE_AS_REFERENCE 1
  299. // The simple parameter flags and values are 'static' so parameter parsing can be in a support routine.
  300. static int g29_verbose_level, phase_value = -1, repetition_cnt,
  301. storage_slot = 0, map_type, grid_size;
  302. static bool repeat_flag, c_flag, x_flag, y_flag;
  303. static float x_pos, y_pos, measured_z, card_thickness = 0.0, ubl_constant = 0.0;
  304. extern void lcd_setstatus(const char* message, const bool persist);
  305. extern void lcd_setstatuspgm(const char* message, const uint8_t level);
  306. void __attribute__((optimize("O0"))) gcode_G29() {
  307. if (ubl.eeprom_start < 0) {
  308. SERIAL_PROTOCOLLNPGM("?You need to enable your EEPROM and initialize it");
  309. SERIAL_PROTOCOLLNPGM("with M502, M500, M501 in that order.\n");
  310. return;
  311. }
  312. if (!code_seen('N') && axis_unhomed_error(true, true, true)) // Don't allow auto-leveling without homing first
  313. gcode_G28();
  314. if (g29_parameter_parsing()) return; // abort if parsing the simple parameters causes a problem,
  315. // Invalidate Mesh Points. This command is a little bit asymetrical because
  316. // it directly specifies the repetition count and does not use the 'R' parameter.
  317. if (code_seen('I')) {
  318. uint8_t cnt = 0;
  319. repetition_cnt = code_has_value() ? code_value_int() : 1;
  320. while (repetition_cnt--) {
  321. if (cnt > 20) { cnt = 0; idle(); }
  322. const mesh_index_pair location = find_closest_mesh_point_of_type(REAL, x_pos, y_pos, USE_NOZZLE_AS_REFERENCE, NULL, false);
  323. if (location.x_index < 0) {
  324. SERIAL_PROTOCOLLNPGM("Entire Mesh invalidated.\n");
  325. break; // No more invalid Mesh Points to populate
  326. }
  327. ubl.z_values[location.x_index][location.y_index] = NAN;
  328. cnt++;
  329. }
  330. SERIAL_PROTOCOLLNPGM("Locations invalidated.\n");
  331. }
  332. if (code_seen('Q')) {
  333. const int test_pattern = code_has_value() ? code_value_int() : -1;
  334. if (!WITHIN(test_pattern, 0, 2)) {
  335. SERIAL_PROTOCOLLNPGM("Invalid test_pattern value. (0-2)\n");
  336. return;
  337. }
  338. SERIAL_PROTOCOLLNPGM("Loading test_pattern values.\n");
  339. switch (test_pattern) {
  340. case 0:
  341. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++) { // Create a bowl shape - similar to
  342. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++) { // a poorly calibrated Delta.
  343. const float p1 = 0.5 * (GRID_MAX_POINTS_X) - x,
  344. p2 = 0.5 * (GRID_MAX_POINTS_Y) - y;
  345. ubl.z_values[x][y] += 2.0 * HYPOT(p1, p2);
  346. }
  347. }
  348. break;
  349. case 1:
  350. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++) { // Create a diagonal line several Mesh cells thick that is raised
  351. ubl.z_values[x][x] += 9.999;
  352. ubl.z_values[x][x + (x < GRID_MAX_POINTS_Y - 1) ? 1 : -1] += 9.999; // We want the altered line several mesh points thick
  353. }
  354. break;
  355. case 2:
  356. // Allow the user to specify the height because 10mm is a little extreme in some cases.
  357. for (uint8_t x = (GRID_MAX_POINTS_X) / 3; x < 2 * (GRID_MAX_POINTS_X) / 3; x++) // Create a rectangular raised area in
  358. for (uint8_t y = (GRID_MAX_POINTS_Y) / 3; y < 2 * (GRID_MAX_POINTS_Y) / 3; y++) // the center of the bed
  359. ubl.z_values[x][y] += code_seen('C') ? ubl_constant : 9.99;
  360. break;
  361. }
  362. }
  363. if (code_seen('J')) {
  364. if (!WITHIN(grid_size, 2, 9)) {
  365. SERIAL_PROTOCOLLNPGM("ERROR - grid size must be between 2 and 9");
  366. return;
  367. }
  368. ubl.save_ubl_active_state_and_disable();
  369. ubl.tilt_mesh_based_on_probed_grid(code_seen('O') || code_seen('M'));
  370. ubl.restore_ubl_active_state_and_leave();
  371. }
  372. if (code_seen('P')) {
  373. phase_value = code_value_int();
  374. if (!WITHIN(phase_value, 0, 7)) {
  375. SERIAL_PROTOCOLLNPGM("Invalid Phase value. (0-4)\n");
  376. return;
  377. }
  378. switch (phase_value) {
  379. case 0:
  380. //
  381. // Zero Mesh Data
  382. //
  383. ubl.reset();
  384. SERIAL_PROTOCOLLNPGM("Mesh zeroed.\n");
  385. break;
  386. case 1:
  387. //
  388. // Invalidate Entire Mesh and Automatically Probe Mesh in areas that can be reached by the probe
  389. //
  390. if (!code_seen('C')) {
  391. ubl.invalidate();
  392. SERIAL_PROTOCOLLNPGM("Mesh invalidated. Probing mesh.\n");
  393. }
  394. if (g29_verbose_level > 1) {
  395. SERIAL_PROTOCOLPAIR("Probing Mesh Points Closest to (", x_pos);
  396. SERIAL_PROTOCOLCHAR(',');
  397. SERIAL_PROTOCOL(y_pos);
  398. SERIAL_PROTOCOLLNPGM(")\n");
  399. }
  400. ubl.probe_entire_mesh(x_pos + X_PROBE_OFFSET_FROM_EXTRUDER, y_pos + Y_PROBE_OFFSET_FROM_EXTRUDER,
  401. code_seen('O') || code_seen('M'), code_seen('E'), code_seen('U'));
  402. break;
  403. case 2: {
  404. //
  405. // Manually Probe Mesh in areas that can't be reached by the probe
  406. //
  407. SERIAL_PROTOCOLLNPGM("Manually probing unreachable mesh locations.\n");
  408. do_blocking_move_to_z(Z_CLEARANCE_BETWEEN_PROBES);
  409. if (!x_flag && !y_flag) { // use a good default location for the path
  410. // The flipped > and < operators on these two comparisons is
  411. // intentional. It should cause the probed points to follow a
  412. // nice path on Cartesian printers. It may make sense to
  413. // have Delta printers default to the center of the bed.
  414. // For now, until that is decided, it can be forced with the X
  415. // and Y parameters.
  416. x_pos = X_PROBE_OFFSET_FROM_EXTRUDER > 0 ? X_MAX_POS : X_MIN_POS;
  417. y_pos = Y_PROBE_OFFSET_FROM_EXTRUDER < 0 ? Y_MAX_POS : Y_MIN_POS;
  418. }
  419. if (code_seen('C')) {
  420. x_pos = current_position[X_AXIS];
  421. y_pos = current_position[Y_AXIS];
  422. }
  423. const float height = code_seen('H') && code_has_value() ? code_value_float() : Z_CLEARANCE_BETWEEN_PROBES;
  424. if (code_seen('B')) {
  425. card_thickness = code_has_value() ? code_value_float() : measure_business_card_thickness(height);
  426. if (fabs(card_thickness) > 1.5) {
  427. SERIAL_PROTOCOLLNPGM("?Error in Business Card measurement.\n");
  428. return;
  429. }
  430. }
  431. manually_probe_remaining_mesh(x_pos, y_pos, height, card_thickness, code_seen('O') || code_seen('M'));
  432. } break;
  433. case 3: {
  434. //
  435. // Populate invalid Mesh areas. Two choices are available to the user. The user can
  436. // specify the constant to be used with a C # paramter. Or the user can allow the G29 P3 command to
  437. // apply a 'reasonable' constant to the invalid mesh point. Some caution and scrutiny should be used
  438. // on either of these paths!
  439. //
  440. if (c_flag) {
  441. while (repetition_cnt--) {
  442. const mesh_index_pair location = find_closest_mesh_point_of_type(INVALID, x_pos, y_pos, USE_NOZZLE_AS_REFERENCE, NULL, false);
  443. if (location.x_index < 0) break; // No more invalid Mesh Points to populate
  444. ubl.z_values[location.x_index][location.y_index] = ubl_constant;
  445. }
  446. break;
  447. } else // The user wants to do a 'Smart' fill where we use the surrounding known
  448. smart_fill_mesh(); // values to provide a good guess of what the unprobed mesh point should be
  449. break;
  450. }
  451. case 4:
  452. //
  453. // Fine Tune (i.e., Edit) the Mesh
  454. //
  455. fine_tune_mesh(x_pos, y_pos, code_seen('O') || code_seen('M'));
  456. break;
  457. case 5:
  458. ubl.find_mean_mesh_height();
  459. break;
  460. case 6:
  461. ubl.shift_mesh_height();
  462. break;
  463. case 10:
  464. // [DEBUG] Pay no attention to this stuff. It can be removed soon.
  465. SERIAL_ECHO_START;
  466. SERIAL_ECHOLNPGM("Checking G29 has control of LCD Panel:");
  467. KEEPALIVE_STATE(PAUSED_FOR_USER);
  468. ubl.has_control_of_lcd_panel = true;
  469. while (!ubl_lcd_clicked()) {
  470. safe_delay(250);
  471. if (ubl.encoder_diff) {
  472. SERIAL_ECHOLN((int)ubl.encoder_diff);
  473. ubl.encoder_diff = 0;
  474. }
  475. }
  476. SERIAL_ECHOLNPGM("G29 giving back control of LCD Panel.");
  477. ubl.has_control_of_lcd_panel = false;
  478. KEEPALIVE_STATE(IN_HANDLER);
  479. break;
  480. case 11:
  481. // [DEBUG] wait_for_user code. Pay no attention to this stuff. It can be removed soon.
  482. SERIAL_ECHO_START;
  483. SERIAL_ECHOLNPGM("Checking G29 has control of LCD Panel:");
  484. KEEPALIVE_STATE(PAUSED_FOR_USER);
  485. wait_for_user = true;
  486. while (wait_for_user) {
  487. safe_delay(250);
  488. if (ubl.encoder_diff) {
  489. SERIAL_ECHOLN((int)ubl.encoder_diff);
  490. ubl.encoder_diff = 0;
  491. }
  492. }
  493. SERIAL_ECHOLNPGM("G29 giving back control of LCD Panel.");
  494. KEEPALIVE_STATE(IN_HANDLER);
  495. break;
  496. }
  497. }
  498. if (code_seen('T')) {
  499. float z1 = probe_pt( LOGICAL_X_POSITION(UBL_PROBE_PT_1_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_1_Y), false, g29_verbose_level),
  500. z2 = probe_pt( LOGICAL_X_POSITION(UBL_PROBE_PT_2_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_2_Y), false, g29_verbose_level),
  501. z3 = probe_pt( LOGICAL_X_POSITION(UBL_PROBE_PT_3_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_3_Y), true, g29_verbose_level);
  502. // We need to adjust z1, z2, z3 by the Mesh Height at these points. Just because they are non-zero doesn't mean
  503. // the Mesh is tilted! (We need to compensate each probe point by what the Mesh says that location's height is)
  504. ubl.save_ubl_active_state_and_disable();
  505. z1 -= ubl.get_z_correction(LOGICAL_X_POSITION(UBL_PROBE_PT_1_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_1_Y)) /* + zprobe_zoffset */ ;
  506. z2 -= ubl.get_z_correction(LOGICAL_X_POSITION(UBL_PROBE_PT_2_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_2_Y)) /* + zprobe_zoffset */ ;
  507. z3 -= ubl.get_z_correction(LOGICAL_X_POSITION(UBL_PROBE_PT_3_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_3_Y)) /* + zprobe_zoffset */ ;
  508. do_blocking_move_to_xy((X_MAX_POS - (X_MIN_POS)) / 2.0, (Y_MAX_POS - (Y_MIN_POS)) / 2.0);
  509. ubl.tilt_mesh_based_on_3pts(z1, z2, z3);
  510. ubl.restore_ubl_active_state_and_leave();
  511. }
  512. //
  513. // Much of the 'What?' command can be eliminated. But until we are fully debugged, it is
  514. // good to have the extra information. Soon... we prune this to just a few items
  515. //
  516. if (code_seen('W')) g29_what_command();
  517. //
  518. // When we are fully debugged, the EEPROM dump command will get deleted also. But
  519. // right now, it is good to have the extra information. Soon... we prune this.
  520. //
  521. if (code_seen('j')) g29_eeprom_dump(); // EEPROM Dump
  522. //
  523. // When we are fully debugged, this may go away. But there are some valid
  524. // use cases for the users. So we can wait and see what to do with it.
  525. //
  526. if (code_seen('K')) // Kompare Current Mesh Data to Specified Stored Mesh
  527. g29_compare_current_mesh_to_stored_mesh();
  528. //
  529. // Load a Mesh from the EEPROM
  530. //
  531. if (code_seen('L')) { // Load Current Mesh Data
  532. storage_slot = code_has_value() ? code_value_int() : ubl.state.eeprom_storage_slot;
  533. const int16_t j = (UBL_LAST_EEPROM_INDEX - ubl.eeprom_start) / sizeof(ubl.z_values);
  534. if (!WITHIN(storage_slot, 0, j - 1) || ubl.eeprom_start <= 0) {
  535. SERIAL_PROTOCOLLNPGM("?EEPROM storage not available for use.\n");
  536. return;
  537. }
  538. ubl.load_mesh(storage_slot);
  539. ubl.state.eeprom_storage_slot = storage_slot;
  540. SERIAL_PROTOCOLLNPGM("Done.\n");
  541. }
  542. //
  543. // Store a Mesh in the EEPROM
  544. //
  545. if (code_seen('S')) { // Store (or Save) Current Mesh Data
  546. storage_slot = code_has_value() ? code_value_int() : ubl.state.eeprom_storage_slot;
  547. if (storage_slot == -1) { // Special case, we are going to 'Export' the mesh to the
  548. SERIAL_ECHOLNPGM("G29 I 999"); // host in a form it can be reconstructed on a different machine
  549. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  550. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  551. if (!isnan(ubl.z_values[x][y])) {
  552. SERIAL_ECHOPAIR("M421 I ", x);
  553. SERIAL_ECHOPAIR(" J ", y);
  554. SERIAL_ECHOPGM(" Z ");
  555. SERIAL_ECHO_F(ubl.z_values[x][y], 6);
  556. SERIAL_EOL;
  557. }
  558. return;
  559. }
  560. const int16_t j = (UBL_LAST_EEPROM_INDEX - ubl.eeprom_start) / sizeof(ubl.z_values);
  561. if (!WITHIN(storage_slot, 0, j - 1) || ubl.eeprom_start <= 0) {
  562. SERIAL_PROTOCOLLNPGM("?EEPROM storage not available for use.\n");
  563. SERIAL_PROTOCOLLNPAIR("?Use 0 to ", j - 1);
  564. goto LEAVE;
  565. }
  566. ubl.store_mesh(storage_slot);
  567. ubl.state.eeprom_storage_slot = storage_slot;
  568. SERIAL_PROTOCOLLNPGM("Done.\n");
  569. }
  570. if (code_seen('O') || code_seen('M'))
  571. ubl.display_map(code_has_value() ? code_value_int() : 0);
  572. if (code_seen('Z')) {
  573. if (code_has_value())
  574. ubl.state.z_offset = code_value_float(); // do the simple case. Just lock in the specified value
  575. else {
  576. ubl.save_ubl_active_state_and_disable();
  577. //measured_z = probe_pt(x_pos + X_PROBE_OFFSET_FROM_EXTRUDER, y_pos + Y_PROBE_OFFSET_FROM_EXTRUDER, ProbeDeployAndStow, g29_verbose_level);
  578. ubl.has_control_of_lcd_panel = true; // Grab the LCD Hardware
  579. measured_z = 1.5;
  580. do_blocking_move_to_z(measured_z); // Get close to the bed, but leave some space so we don't damage anything
  581. // The user is not going to be locking in a new Z-Offset very often so
  582. // it won't be that painful to spin the Encoder Wheel for 1.5mm
  583. lcd_implementation_clear();
  584. lcd_z_offset_edit_setup(measured_z);
  585. KEEPALIVE_STATE(PAUSED_FOR_USER);
  586. do {
  587. measured_z = lcd_z_offset_edit();
  588. idle();
  589. do_blocking_move_to_z(measured_z);
  590. } while (!ubl_lcd_clicked());
  591. ubl.has_control_of_lcd_panel = true; // There is a race condition for the Encoder Wheel getting clicked.
  592. // It could get detected in lcd_mesh_edit (actually _lcd_mesh_fine_tune)
  593. // or here. So, until we are done looking for a long Encoder Wheel Press,
  594. // we need to take control of the panel
  595. KEEPALIVE_STATE(IN_HANDLER);
  596. lcd_return_to_status();
  597. const millis_t nxt = millis() + 1500UL;
  598. while (ubl_lcd_clicked()) { // debounce and watch for abort
  599. idle();
  600. if (ELAPSED(millis(), nxt)) {
  601. SERIAL_PROTOCOLLNPGM("\nZ-Offset Adjustment Stopped.");
  602. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  603. LCD_MESSAGEPGM("Z-Offset Stopped");
  604. ubl.restore_ubl_active_state_and_leave();
  605. goto LEAVE;
  606. }
  607. }
  608. ubl.has_control_of_lcd_panel = false;
  609. safe_delay(20); // We don't want any switch noise.
  610. ubl.state.z_offset = measured_z;
  611. lcd_implementation_clear();
  612. ubl.restore_ubl_active_state_and_leave();
  613. }
  614. }
  615. LEAVE:
  616. lcd_reset_alert_level();
  617. LCD_MESSAGEPGM("");
  618. lcd_quick_feedback();
  619. ubl.has_control_of_lcd_panel = false;
  620. }
  621. void unified_bed_leveling::find_mean_mesh_height() {
  622. uint8_t x, y;
  623. int n;
  624. float sum, sum_of_diff_squared, sigma, difference, mean;
  625. sum = sum_of_diff_squared = 0.0;
  626. n = 0;
  627. for (x = 0; x < GRID_MAX_POINTS_X; x++)
  628. for (y = 0; y < GRID_MAX_POINTS_Y; y++)
  629. if (!isnan(ubl.z_values[x][y])) {
  630. sum += ubl.z_values[x][y];
  631. n++;
  632. }
  633. mean = sum / n;
  634. //
  635. // Now do the sumation of the squares of difference from mean
  636. //
  637. for (x = 0; x < GRID_MAX_POINTS_X; x++)
  638. for (y = 0; y < GRID_MAX_POINTS_Y; y++)
  639. if (!isnan(ubl.z_values[x][y])) {
  640. difference = (ubl.z_values[x][y] - mean);
  641. sum_of_diff_squared += difference * difference;
  642. }
  643. SERIAL_ECHOLNPAIR("# of samples: ", n);
  644. SERIAL_ECHOPGM("Mean Mesh Height: ");
  645. SERIAL_ECHO_F(mean, 6);
  646. SERIAL_EOL;
  647. sigma = sqrt(sum_of_diff_squared / (n + 1));
  648. SERIAL_ECHOPGM("Standard Deviation: ");
  649. SERIAL_ECHO_F(sigma, 6);
  650. SERIAL_EOL;
  651. if (c_flag)
  652. for (x = 0; x < GRID_MAX_POINTS_X; x++)
  653. for (y = 0; y < GRID_MAX_POINTS_Y; y++)
  654. if (!isnan(ubl.z_values[x][y]))
  655. ubl.z_values[x][y] -= mean + ubl_constant;
  656. }
  657. void unified_bed_leveling::shift_mesh_height() {
  658. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  659. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  660. if (!isnan(ubl.z_values[x][y]))
  661. ubl.z_values[x][y] += ubl_constant;
  662. }
  663. /**
  664. * Probe all invalidated locations of the mesh that can be reached by the probe.
  665. * This attempts to fill in locations closest to the nozzle's start location first.
  666. */
  667. void unified_bed_leveling::probe_entire_mesh(const float &lx, const float &ly, const bool do_ubl_mesh_map, const bool stow_probe, bool do_furthest) {
  668. mesh_index_pair location;
  669. ubl.has_control_of_lcd_panel = true;
  670. ubl.save_ubl_active_state_and_disable(); // we don't do bed level correction because we want the raw data when we probe
  671. DEPLOY_PROBE();
  672. do {
  673. if (ubl_lcd_clicked()) {
  674. SERIAL_PROTOCOLLNPGM("\nMesh only partially populated.\n");
  675. lcd_quick_feedback();
  676. STOW_PROBE();
  677. while (ubl_lcd_clicked()) idle();
  678. ubl.has_control_of_lcd_panel = false;
  679. ubl.restore_ubl_active_state_and_leave();
  680. safe_delay(50); // Debounce the Encoder wheel
  681. return;
  682. }
  683. location = find_closest_mesh_point_of_type(INVALID, lx, ly, USE_PROBE_AS_REFERENCE, NULL, do_furthest);
  684. if (location.x_index >= 0 && location.y_index >= 0) {
  685. const float rawx = pgm_read_float(&(ubl.mesh_index_to_xpos[location.x_index])),
  686. rawy = pgm_read_float(&(ubl.mesh_index_to_ypos[location.y_index]));
  687. // TODO: Change to use `position_is_reachable` (for SCARA-compatibility)
  688. if (!WITHIN(rawx, MIN_PROBE_X, MAX_PROBE_X) || !WITHIN(rawy, MIN_PROBE_Y, MAX_PROBE_Y)) {
  689. SERIAL_ERROR_START;
  690. SERIAL_ERRORLNPGM("Attempt to probe off the bed.");
  691. ubl.has_control_of_lcd_panel = false;
  692. goto LEAVE;
  693. }
  694. const float measured_z = probe_pt(LOGICAL_X_POSITION(rawx), LOGICAL_Y_POSITION(rawy), stow_probe, g29_verbose_level);
  695. ubl.z_values[location.x_index][location.y_index] = measured_z;
  696. }
  697. if (do_ubl_mesh_map) ubl.display_map(map_type);
  698. } while (location.x_index >= 0 && location.y_index >= 0);
  699. LEAVE:
  700. STOW_PROBE();
  701. ubl.restore_ubl_active_state_and_leave();
  702. do_blocking_move_to_xy(
  703. constrain(lx - (X_PROBE_OFFSET_FROM_EXTRUDER), X_MIN_POS, X_MAX_POS),
  704. constrain(ly - (Y_PROBE_OFFSET_FROM_EXTRUDER), Y_MIN_POS, Y_MAX_POS)
  705. );
  706. }
  707. void unified_bed_leveling::tilt_mesh_based_on_3pts(const float &z1, const float &z2, const float &z3) {
  708. float d, t, inv_z;
  709. int i, j;
  710. matrix_3x3 rotation;
  711. vector_3 v1 = vector_3( (UBL_PROBE_PT_1_X - UBL_PROBE_PT_2_X),
  712. (UBL_PROBE_PT_1_Y - UBL_PROBE_PT_2_Y),
  713. (z1 - z2) ),
  714. v2 = vector_3( (UBL_PROBE_PT_3_X - UBL_PROBE_PT_2_X),
  715. (UBL_PROBE_PT_3_Y - UBL_PROBE_PT_2_Y),
  716. (z3 - z2) ),
  717. normal = vector_3::cross(v1, v2);
  718. normal = normal.get_normal();
  719. /**
  720. * This vector is normal to the tilted plane.
  721. * However, we don't know its direction. We need it to point up. So if
  722. * Z is negative, we need to invert the sign of all components of the vector
  723. */
  724. if ( normal.z < 0.0 ) {
  725. normal.x = -normal.x;
  726. normal.y = -normal.y;
  727. normal.z = -normal.z;
  728. }
  729. rotation = matrix_3x3::create_look_at( vector_3( normal.x, normal.y, 1));
  730. if (g29_verbose_level>2) {
  731. SERIAL_ECHOPGM("bed plane normal = [");
  732. SERIAL_PROTOCOL_F( normal.x, 7);
  733. SERIAL_ECHOPGM(",");
  734. SERIAL_PROTOCOL_F( normal.y, 7);
  735. SERIAL_ECHOPGM(",");
  736. SERIAL_PROTOCOL_F( normal.z, 7);
  737. SERIAL_ECHOPGM("]\n");
  738. rotation.debug("rotation matrix:");
  739. }
  740. //
  741. // All of 3 of these points should give us the same d constant
  742. //
  743. t = normal.x * UBL_PROBE_PT_1_X + normal.y * UBL_PROBE_PT_1_Y;
  744. d = t + normal.z * z1;
  745. if (g29_verbose_level>2) {
  746. SERIAL_ECHOPGM("D constant: ");
  747. SERIAL_PROTOCOL_F( d, 7);
  748. SERIAL_ECHOPGM(" \n");
  749. }
  750. #if ENABLED(DEBUG_LEVELING_FEATURE)
  751. if (DEBUGGING(LEVELING)) {
  752. SERIAL_ECHOPGM("d from 1st point: ");
  753. SERIAL_ECHO_F(d, 6);
  754. SERIAL_EOL;
  755. t = normal.x * UBL_PROBE_PT_2_X + normal.y * UBL_PROBE_PT_2_Y;
  756. d = t + normal.z * z2;
  757. SERIAL_ECHOPGM("d from 2nd point: ");
  758. SERIAL_ECHO_F(d, 6);
  759. SERIAL_EOL;
  760. t = normal.x * UBL_PROBE_PT_3_X + normal.y * UBL_PROBE_PT_3_Y;
  761. d = t + normal.z * z3;
  762. SERIAL_ECHOPGM("d from 3rd point: ");
  763. SERIAL_ECHO_F(d, 6);
  764. SERIAL_EOL;
  765. }
  766. #endif
  767. for (i = 0; i < GRID_MAX_POINTS_X; i++) {
  768. for (j = 0; j < GRID_MAX_POINTS_Y; j++) {
  769. float x_tmp, y_tmp, z_tmp;
  770. x_tmp = pgm_read_float(ubl.mesh_index_to_xpos[i]);
  771. y_tmp = pgm_read_float(ubl.mesh_index_to_ypos[j]);
  772. z_tmp = ubl.z_values[i][j];
  773. #if ENABLED(DEBUG_LEVELING_FEATURE)
  774. if (DEBUGGING(LEVELING)) {
  775. SERIAL_ECHOPGM("before rotation = [");
  776. SERIAL_PROTOCOL_F( x_tmp, 7);
  777. SERIAL_ECHOPGM(",");
  778. SERIAL_PROTOCOL_F( y_tmp, 7);
  779. SERIAL_ECHOPGM(",");
  780. SERIAL_PROTOCOL_F( z_tmp, 7);
  781. SERIAL_ECHOPGM("] ---> ");
  782. safe_delay(20);
  783. }
  784. #endif
  785. apply_rotation_xyz(rotation, x_tmp, y_tmp, z_tmp);
  786. #if ENABLED(DEBUG_LEVELING_FEATURE)
  787. if (DEBUGGING(LEVELING)) {
  788. SERIAL_ECHOPGM("after rotation = [");
  789. SERIAL_PROTOCOL_F( x_tmp, 7);
  790. SERIAL_ECHOPGM(",");
  791. SERIAL_PROTOCOL_F( y_tmp, 7);
  792. SERIAL_ECHOPGM(",");
  793. SERIAL_PROTOCOL_F( z_tmp, 7);
  794. SERIAL_ECHOPGM("]\n");
  795. safe_delay(55);
  796. }
  797. #endif
  798. ubl.z_values[i][j] += z_tmp - d;
  799. }
  800. }
  801. return;
  802. }
  803. float use_encoder_wheel_to_measure_point() {
  804. KEEPALIVE_STATE(PAUSED_FOR_USER);
  805. while (!ubl_lcd_clicked()) { // we need the loop to move the nozzle based on the encoder wheel here!
  806. idle();
  807. if (ubl.encoder_diff) {
  808. do_blocking_move_to_z(current_position[Z_AXIS] + 0.01 * float(ubl.encoder_diff));
  809. ubl.encoder_diff = 0;
  810. }
  811. }
  812. KEEPALIVE_STATE(IN_HANDLER);
  813. return current_position[Z_AXIS];
  814. }
  815. float measure_business_card_thickness(const float &in_height) {
  816. ubl.has_control_of_lcd_panel = true;
  817. ubl.save_ubl_active_state_and_disable(); // we don't do bed level correction because we want the raw data when we probe
  818. SERIAL_PROTOCOLLNPGM("Place Shim Under Nozzle and Perform Measurement.");
  819. do_blocking_move_to_z(in_height);
  820. do_blocking_move_to_xy((float(X_MAX_POS) - float(X_MIN_POS)) / 2.0, (float(Y_MAX_POS) - float(Y_MIN_POS)) / 2.0);
  821. //, min(planner.max_feedrate_mm_s[X_AXIS], planner.max_feedrate_mm_s[Y_AXIS])/2.0);
  822. const float z1 = use_encoder_wheel_to_measure_point();
  823. do_blocking_move_to_z(current_position[Z_AXIS] + SIZE_OF_LITTLE_RAISE);
  824. ubl.has_control_of_lcd_panel = false;
  825. SERIAL_PROTOCOLLNPGM("Remove Shim and Measure Bed Height.");
  826. const float z2 = use_encoder_wheel_to_measure_point();
  827. do_blocking_move_to_z(current_position[Z_AXIS] + SIZE_OF_LITTLE_RAISE);
  828. if (g29_verbose_level > 1) {
  829. SERIAL_PROTOCOLPGM("Business Card is: ");
  830. SERIAL_PROTOCOL_F(abs(z1 - z2), 6);
  831. SERIAL_PROTOCOLLNPGM("mm thick.");
  832. }
  833. ubl.restore_ubl_active_state_and_leave();
  834. return abs(z1 - z2);
  835. }
  836. void manually_probe_remaining_mesh(const float &lx, const float &ly, const float &z_clearance, const float &card_thickness, const bool do_ubl_mesh_map) {
  837. ubl.has_control_of_lcd_panel = true;
  838. ubl.save_ubl_active_state_and_disable(); // we don't do bed level correction because we want the raw data when we probe
  839. do_blocking_move_to_z(z_clearance);
  840. do_blocking_move_to_xy(lx, ly);
  841. float last_x = -9999.99, last_y = -9999.99;
  842. mesh_index_pair location;
  843. do {
  844. location = find_closest_mesh_point_of_type(INVALID, lx, ly, USE_NOZZLE_AS_REFERENCE, NULL, false);
  845. // It doesn't matter if the probe can't reach the NAN location. This is a manual probe.
  846. if (location.x_index < 0 && location.y_index < 0) continue;
  847. const float rawx = pgm_read_float(&(ubl.mesh_index_to_xpos[location.x_index])),
  848. rawy = pgm_read_float(&(ubl.mesh_index_to_ypos[location.y_index]));
  849. // TODO: Change to use `position_is_reachable` (for SCARA-compatibility)
  850. if (!WITHIN(rawx, X_MIN_POS, X_MAX_POS) || !WITHIN(rawy, Y_MIN_POS, Y_MAX_POS)) {
  851. SERIAL_ERROR_START;
  852. SERIAL_ERRORLNPGM("Attempt to probe off the bed.");
  853. ubl.has_control_of_lcd_panel = false;
  854. goto LEAVE;
  855. }
  856. const float xProbe = LOGICAL_X_POSITION(rawx),
  857. yProbe = LOGICAL_Y_POSITION(rawy),
  858. dx = xProbe - last_x,
  859. dy = yProbe - last_y;
  860. if (HYPOT(dx, dy) < BIG_RAISE_NOT_NEEDED)
  861. do_blocking_move_to_z(current_position[Z_AXIS] + SIZE_OF_LITTLE_RAISE);
  862. else
  863. do_blocking_move_to_z(z_clearance);
  864. do_blocking_move_to_xy(xProbe, yProbe);
  865. last_x = xProbe;
  866. last_y = yProbe;
  867. KEEPALIVE_STATE(PAUSED_FOR_USER);
  868. ubl.has_control_of_lcd_panel = true;
  869. if (do_ubl_mesh_map) ubl.display_map(map_type); // show user where we're probing
  870. while (!ubl_lcd_clicked()) { // we need the loop to move the nozzle based on the encoder wheel here!
  871. idle();
  872. if (ubl.encoder_diff) {
  873. do_blocking_move_to_z(current_position[Z_AXIS] + float(ubl.encoder_diff) / 100.0);
  874. ubl.encoder_diff = 0;
  875. }
  876. }
  877. const millis_t nxt = millis() + 1500L;
  878. while (ubl_lcd_clicked()) { // debounce and watch for abort
  879. idle();
  880. if (ELAPSED(millis(), nxt)) {
  881. SERIAL_PROTOCOLLNPGM("\nMesh only partially populated.");
  882. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  883. lcd_quick_feedback();
  884. while (ubl_lcd_clicked()) idle();
  885. ubl.has_control_of_lcd_panel = false;
  886. KEEPALIVE_STATE(IN_HANDLER);
  887. ubl.restore_ubl_active_state_and_leave();
  888. return;
  889. }
  890. }
  891. ubl.z_values[location.x_index][location.y_index] = current_position[Z_AXIS] - card_thickness;
  892. if (g29_verbose_level > 2) {
  893. SERIAL_PROTOCOLPGM("Mesh Point Measured at: ");
  894. SERIAL_PROTOCOL_F(ubl.z_values[location.x_index][location.y_index], 6);
  895. SERIAL_EOL;
  896. }
  897. } while (location.x_index >= 0 && location.y_index >= 0);
  898. if (do_ubl_mesh_map) ubl.display_map(map_type);
  899. LEAVE:
  900. ubl.restore_ubl_active_state_and_leave();
  901. KEEPALIVE_STATE(IN_HANDLER);
  902. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  903. do_blocking_move_to_xy(lx, ly);
  904. }
  905. bool g29_parameter_parsing() {
  906. bool err_flag = false;
  907. LCD_MESSAGEPGM("Doing G29 UBL!");
  908. ubl_constant = 0.0;
  909. repetition_cnt = 0;
  910. lcd_quick_feedback();
  911. x_flag = code_seen('X') && code_has_value();
  912. x_pos = x_flag ? code_value_float() : current_position[X_AXIS];
  913. y_flag = code_seen('Y') && code_has_value();
  914. y_pos = y_flag ? code_value_float() : current_position[Y_AXIS];
  915. repeat_flag = code_seen('R');
  916. if (repeat_flag) {
  917. repetition_cnt = code_has_value() ? code_value_int() : (GRID_MAX_POINTS_X) * (GRID_MAX_POINTS_Y);
  918. if (repetition_cnt < 1) {
  919. SERIAL_PROTOCOLLNPGM("Invalid Repetition count.\n");
  920. return UBL_ERR;
  921. }
  922. }
  923. g29_verbose_level = code_seen('V') ? code_value_int() : 0;
  924. if (!WITHIN(g29_verbose_level, 0, 4)) {
  925. SERIAL_PROTOCOLLNPGM("Invalid Verbose Level specified. (0-4)\n");
  926. err_flag = true;
  927. }
  928. if (code_seen('J')) {
  929. grid_size = code_has_value() ? code_value_int() : 3;
  930. if (!WITHIN(grid_size, 2, 5)) {
  931. SERIAL_PROTOCOLLNPGM("Invalid grid probe points specified.\n");
  932. err_flag = true;
  933. }
  934. }
  935. if (x_flag != y_flag) {
  936. SERIAL_PROTOCOLLNPGM("Both X & Y locations must be specified.\n");
  937. err_flag = true;
  938. }
  939. if (!WITHIN(RAW_X_POSITION(x_pos), X_MIN_POS, X_MAX_POS)) {
  940. SERIAL_PROTOCOLLNPGM("Invalid X location specified.\n");
  941. err_flag = true;
  942. }
  943. if (!WITHIN(RAW_Y_POSITION(y_pos), Y_MIN_POS, Y_MAX_POS)) {
  944. SERIAL_PROTOCOLLNPGM("Invalid Y location specified.\n");
  945. err_flag = true;
  946. }
  947. if (err_flag) return UBL_ERR;
  948. if (code_seen('A')) { // Activate the Unified Bed Leveling System
  949. ubl.state.active = 1;
  950. SERIAL_PROTOCOLLNPGM("Unified Bed Leveling System activated.\n");
  951. }
  952. c_flag = code_seen('C');
  953. if (c_flag)
  954. ubl_constant = code_value_float();
  955. if (code_seen('D')) { // Disable the Unified Bed Leveling System
  956. ubl.state.active = 0;
  957. SERIAL_PROTOCOLLNPGM("Unified Bed Leveling System de-activated.\n");
  958. }
  959. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  960. if (code_seen('F') && code_has_value()) {
  961. const float fh = code_value_float();
  962. if (!WITHIN(fh, 0.0, 100.0)) {
  963. SERIAL_PROTOCOLLNPGM("?Bed Level Correction Fade Height Not Plausible.\n");
  964. return UBL_ERR;
  965. }
  966. set_z_fade_height(fh);
  967. }
  968. #endif
  969. map_type = code_seen('O') && code_has_value() ? code_value_int() : 0;
  970. if (!WITHIN(map_type, 0, 1)) {
  971. SERIAL_PROTOCOLLNPGM("Invalid map type.\n");
  972. return UBL_ERR;
  973. }
  974. if (code_seen('M')) { // Check if a map type was specified
  975. map_type = code_has_value() ? code_value_int() : 0;
  976. if (!WITHIN(map_type, 0, 1)) {
  977. SERIAL_PROTOCOLLNPGM("Invalid map type.\n");
  978. return UBL_ERR;
  979. }
  980. }
  981. return UBL_OK;
  982. }
  983. /**
  984. * This function goes away after G29 debug is complete. But for right now, it is a handy
  985. * routine to dump binary data structures.
  986. */
  987. /*
  988. void dump(char * const str, const float &f) {
  989. char *ptr;
  990. SERIAL_PROTOCOL(str);
  991. SERIAL_PROTOCOL_F(f, 8);
  992. SERIAL_PROTOCOLPGM(" ");
  993. ptr = (char*)&f;
  994. for (uint8_t i = 0; i < 4; i++)
  995. SERIAL_PROTOCOLPAIR(" ", hex_byte(*ptr++));
  996. SERIAL_PROTOCOLPAIR(" isnan()=", isnan(f));
  997. SERIAL_PROTOCOLPAIR(" isinf()=", isinf(f));
  998. if (f == -INFINITY)
  999. SERIAL_PROTOCOLPGM(" Minus Infinity detected.");
  1000. SERIAL_EOL;
  1001. }
  1002. */
  1003. static int ubl_state_at_invocation = 0,
  1004. ubl_state_recursion_chk = 0;
  1005. void unified_bed_leveling::save_ubl_active_state_and_disable() {
  1006. ubl_state_recursion_chk++;
  1007. if (ubl_state_recursion_chk != 1) {
  1008. SERIAL_ECHOLNPGM("save_ubl_active_state_and_disabled() called multiple times in a row.");
  1009. LCD_MESSAGEPGM("save_UBL_active() error");
  1010. lcd_quick_feedback();
  1011. return;
  1012. }
  1013. ubl_state_at_invocation = ubl.state.active;
  1014. ubl.state.active = 0;
  1015. }
  1016. void unified_bed_leveling::restore_ubl_active_state_and_leave() {
  1017. if (--ubl_state_recursion_chk) {
  1018. SERIAL_ECHOLNPGM("restore_ubl_active_state_and_leave() called too many times.");
  1019. LCD_MESSAGEPGM("restore_UBL_active() error");
  1020. lcd_quick_feedback();
  1021. return;
  1022. }
  1023. ubl.state.active = ubl_state_at_invocation;
  1024. }
  1025. /**
  1026. * Much of the 'What?' command can be eliminated. But until we are fully debugged, it is
  1027. * good to have the extra information. Soon... we prune this to just a few items
  1028. */
  1029. void g29_what_command() {
  1030. const uint16_t k = E2END - ubl.eeprom_start;
  1031. SERIAL_PROTOCOLPGM("Unified Bed Leveling System Version " UBL_VERSION " ");
  1032. if (ubl.state.active)
  1033. SERIAL_PROTOCOLCHAR('A');
  1034. else
  1035. SERIAL_PROTOCOLPGM("Ina");
  1036. SERIAL_PROTOCOLLNPGM("ctive.\n");
  1037. safe_delay(50);
  1038. if (ubl.state.eeprom_storage_slot == -1)
  1039. SERIAL_PROTOCOLPGM("No Mesh Loaded.");
  1040. else {
  1041. SERIAL_PROTOCOLPAIR("Mesh ", ubl.state.eeprom_storage_slot);
  1042. SERIAL_PROTOCOLPGM(" Loaded.");
  1043. }
  1044. SERIAL_EOL;
  1045. safe_delay(50);
  1046. SERIAL_PROTOCOLLNPAIR("UBL object count: ", ubl_cnt);
  1047. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  1048. SERIAL_PROTOCOLLNPAIR("planner.z_fade_height : ", planner.z_fade_height);
  1049. #endif
  1050. SERIAL_PROTOCOLPGM("zprobe_zoffset: ");
  1051. SERIAL_PROTOCOL_F(zprobe_zoffset, 7);
  1052. SERIAL_EOL;
  1053. SERIAL_PROTOCOLPGM("z_offset: ");
  1054. SERIAL_PROTOCOL_F(ubl.state.z_offset, 7);
  1055. SERIAL_EOL;
  1056. safe_delay(25);
  1057. SERIAL_PROTOCOLLNPAIR("ubl.eeprom_start=0x", hex_word(ubl.eeprom_start));
  1058. SERIAL_PROTOCOLPGM("X-Axis Mesh Points at: ");
  1059. for (uint8_t i = 0; i < GRID_MAX_POINTS_X; i++) {
  1060. SERIAL_PROTOCOL_F(LOGICAL_X_POSITION(pgm_read_float(&(ubl.mesh_index_to_xpos[i]))), 1);
  1061. SERIAL_PROTOCOLPGM(" ");
  1062. safe_delay(50);
  1063. }
  1064. SERIAL_EOL;
  1065. SERIAL_PROTOCOLPGM("Y-Axis Mesh Points at: ");
  1066. for (uint8_t i = 0; i < GRID_MAX_POINTS_Y; i++) {
  1067. SERIAL_PROTOCOL_F(LOGICAL_Y_POSITION(pgm_read_float(&(ubl.mesh_index_to_ypos[i]))), 1);
  1068. SERIAL_PROTOCOLPGM(" ");
  1069. safe_delay(50);
  1070. }
  1071. SERIAL_EOL;
  1072. #if HAS_KILL
  1073. SERIAL_PROTOCOLPAIR("Kill pin on :", KILL_PIN);
  1074. SERIAL_PROTOCOLLNPAIR(" state:", READ(KILL_PIN));
  1075. #endif
  1076. SERIAL_EOL;
  1077. safe_delay(50);
  1078. SERIAL_PROTOCOLLNPAIR("ubl_state_at_invocation :", ubl_state_at_invocation);
  1079. SERIAL_EOL;
  1080. SERIAL_PROTOCOLLNPAIR("ubl_state_recursion_chk :", ubl_state_recursion_chk);
  1081. SERIAL_EOL;
  1082. safe_delay(50);
  1083. SERIAL_PROTOCOLLNPAIR("Free EEPROM space starts at: ", hex_address((void*)ubl.eeprom_start));
  1084. SERIAL_PROTOCOLLNPAIR("end of EEPROM : ", hex_address((void*)E2END));
  1085. safe_delay(50);
  1086. SERIAL_PROTOCOLLNPAIR("sizeof(ubl) : ", (int)sizeof(ubl));
  1087. SERIAL_EOL;
  1088. SERIAL_PROTOCOLLNPAIR("z_value[][] size: ", (int)sizeof(ubl.z_values));
  1089. SERIAL_EOL;
  1090. safe_delay(50);
  1091. SERIAL_PROTOCOLLNPAIR("EEPROM free for UBL: ", hex_address((void*)k));
  1092. safe_delay(50);
  1093. SERIAL_PROTOCOLPAIR("EEPROM can hold ", k / sizeof(ubl.z_values));
  1094. SERIAL_PROTOCOLLNPGM(" meshes.\n");
  1095. safe_delay(50);
  1096. SERIAL_PROTOCOLPAIR("sizeof(ubl.state) : ", (int)sizeof(ubl.state));
  1097. SERIAL_PROTOCOLPAIR("\nGRID_MAX_POINTS_X ", GRID_MAX_POINTS_X);
  1098. SERIAL_PROTOCOLPAIR("\nGRID_MAX_POINTS_Y ", GRID_MAX_POINTS_Y);
  1099. safe_delay(50);
  1100. SERIAL_PROTOCOLPAIR("\nUBL_MESH_MIN_X ", UBL_MESH_MIN_X);
  1101. SERIAL_PROTOCOLPAIR("\nUBL_MESH_MIN_Y ", UBL_MESH_MIN_Y);
  1102. safe_delay(50);
  1103. SERIAL_PROTOCOLPAIR("\nUBL_MESH_MAX_X ", UBL_MESH_MAX_X);
  1104. SERIAL_PROTOCOLPAIR("\nUBL_MESH_MAX_Y ", UBL_MESH_MAX_Y);
  1105. safe_delay(50);
  1106. SERIAL_PROTOCOLPGM("\nMESH_X_DIST ");
  1107. SERIAL_PROTOCOL_F(MESH_X_DIST, 6);
  1108. SERIAL_PROTOCOLPGM("\nMESH_Y_DIST ");
  1109. SERIAL_PROTOCOL_F(MESH_Y_DIST, 6);
  1110. SERIAL_EOL;
  1111. safe_delay(50);
  1112. if (!ubl.sanity_check())
  1113. SERIAL_PROTOCOLLNPGM("Unified Bed Leveling sanity checks passed.");
  1114. }
  1115. /**
  1116. * When we are fully debugged, the EEPROM dump command will get deleted also. But
  1117. * right now, it is good to have the extra information. Soon... we prune this.
  1118. */
  1119. void g29_eeprom_dump() {
  1120. unsigned char cccc;
  1121. uint16_t kkkk;
  1122. SERIAL_ECHO_START;
  1123. SERIAL_ECHOLNPGM("EEPROM Dump:");
  1124. for (uint16_t i = 0; i < E2END + 1; i += 16) {
  1125. if (!(i & 0x3)) idle();
  1126. print_hex_word(i);
  1127. SERIAL_ECHOPGM(": ");
  1128. for (uint16_t j = 0; j < 16; j++) {
  1129. kkkk = i + j;
  1130. eeprom_read_block(&cccc, (void *)kkkk, 1);
  1131. print_hex_byte(cccc);
  1132. SERIAL_ECHO(' ');
  1133. }
  1134. SERIAL_EOL;
  1135. }
  1136. SERIAL_EOL;
  1137. }
  1138. /**
  1139. * When we are fully debugged, this may go away. But there are some valid
  1140. * use cases for the users. So we can wait and see what to do with it.
  1141. */
  1142. void g29_compare_current_mesh_to_stored_mesh() {
  1143. float tmp_z_values[GRID_MAX_POINTS_X][GRID_MAX_POINTS_Y];
  1144. if (!code_has_value()) {
  1145. SERIAL_PROTOCOLLNPGM("?Mesh # required.\n");
  1146. return;
  1147. }
  1148. storage_slot = code_value_int();
  1149. int16_t j = (UBL_LAST_EEPROM_INDEX - ubl.eeprom_start) / sizeof(tmp_z_values);
  1150. if (!WITHIN(storage_slot, 0, j - 1) || ubl.eeprom_start <= 0) {
  1151. SERIAL_PROTOCOLLNPGM("?EEPROM storage not available for use.\n");
  1152. return;
  1153. }
  1154. j = UBL_LAST_EEPROM_INDEX - (storage_slot + 1) * sizeof(tmp_z_values);
  1155. eeprom_read_block((void *)&tmp_z_values, (void *)j, sizeof(tmp_z_values));
  1156. SERIAL_ECHOPAIR("Subtracting Mesh ", storage_slot);
  1157. SERIAL_PROTOCOLLNPAIR(" loaded from EEPROM address ", hex_address((void*)j)); // Soon, we can remove the extra clutter of printing
  1158. // the address in the EEPROM where the Mesh is stored.
  1159. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  1160. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  1161. ubl.z_values[x][y] -= tmp_z_values[x][y];
  1162. }
  1163. mesh_index_pair find_closest_mesh_point_of_type(const MeshPointType type, const float &lx, const float &ly, const bool probe_as_reference, unsigned int bits[16], bool far_flag) {
  1164. float distance, closest = far_flag ? -99999.99 : 99999.99;
  1165. mesh_index_pair return_val;
  1166. return_val.x_index = return_val.y_index = -1;
  1167. const float current_x = current_position[X_AXIS],
  1168. current_y = current_position[Y_AXIS];
  1169. // Get our reference position. Either the nozzle or probe location.
  1170. const float px = lx - (probe_as_reference==USE_PROBE_AS_REFERENCE ? X_PROBE_OFFSET_FROM_EXTRUDER : 0),
  1171. py = ly - (probe_as_reference==USE_PROBE_AS_REFERENCE ? Y_PROBE_OFFSET_FROM_EXTRUDER : 0);
  1172. for (uint8_t i = 0; i < GRID_MAX_POINTS_X; i++) {
  1173. for (uint8_t j = 0; j < GRID_MAX_POINTS_Y; j++) {
  1174. if ( (type == INVALID && isnan(ubl.z_values[i][j])) // Check to see if this location holds the right thing
  1175. || (type == REAL && !isnan(ubl.z_values[i][j]))
  1176. || (type == SET_IN_BITMAP && is_bit_set(bits, i, j))
  1177. ) {
  1178. // We only get here if we found a Mesh Point of the specified type
  1179. const float rawx = pgm_read_float(&(ubl.mesh_index_to_xpos[i])), // Check if we can probe this mesh location
  1180. rawy = pgm_read_float(&(ubl.mesh_index_to_ypos[j]));
  1181. // If using the probe as the reference there are some unreachable locations.
  1182. // Prune them from the list and ignore them till the next Phase (manual nozzle probing).
  1183. if (probe_as_reference==USE_PROBE_AS_REFERENCE &&
  1184. (!WITHIN(rawx, MIN_PROBE_X, MAX_PROBE_X) || !WITHIN(rawy, MIN_PROBE_Y, MAX_PROBE_Y))
  1185. ) continue;
  1186. // Unreachable. Check if it's the closest location to the nozzle.
  1187. // Add in a weighting factor that considers the current location of the nozzle.
  1188. const float mx = LOGICAL_X_POSITION(rawx), // Check if we can probe this mesh location
  1189. my = LOGICAL_Y_POSITION(rawy);
  1190. distance = HYPOT(px - mx, py - my) + HYPOT(current_x - mx, current_y - my) * 0.1;
  1191. if (far_flag) { // If doing the far_flag action, we want to be as far as possible
  1192. for (uint8_t k = 0; k < GRID_MAX_POINTS_X; k++) { // from the starting point and from any other probed points. We
  1193. for (uint8_t l = 0; l < GRID_MAX_POINTS_Y; l++) { // want the next point spread out and filling in any blank spaces
  1194. if (!isnan(ubl.z_values[k][l])) { // in the mesh. So we add in some of the distance to every probed
  1195. distance += sq(i - k) * (MESH_X_DIST) * .05 // point we can find.
  1196. + sq(j - l) * (MESH_Y_DIST) * .05;
  1197. }
  1198. }
  1199. }
  1200. }
  1201. if (far_flag == (distance > closest) && distance != closest) { // if far_flag, look for farthest point
  1202. closest = distance; // We found a closer/farther location with
  1203. return_val.x_index = i; // the specified type of mesh value.
  1204. return_val.y_index = j;
  1205. return_val.distance = closest;
  1206. }
  1207. }
  1208. } // for j
  1209. } // for i
  1210. return return_val;
  1211. }
  1212. void fine_tune_mesh(const float &lx, const float &ly, const bool do_ubl_mesh_map) {
  1213. if (!code_seen('R')) // fine_tune_mesh() is special. If no repetion count flag is specified
  1214. repetition_cnt = 1; // we know to do exactly one mesh location. Otherwise we use what the parser decided.
  1215. mesh_index_pair location;
  1216. uint16_t not_done[16];
  1217. int32_t round_off;
  1218. ubl.save_ubl_active_state_and_disable();
  1219. memset(not_done, 0xFF, sizeof(not_done));
  1220. LCD_MESSAGEPGM("Fine Tuning Mesh");
  1221. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  1222. do_blocking_move_to_xy(lx, ly);
  1223. do {
  1224. location = find_closest_mesh_point_of_type(SET_IN_BITMAP, lx, ly, USE_NOZZLE_AS_REFERENCE, not_done, false);
  1225. // It doesn't matter if the probe can not reach this
  1226. // location. This is a manual edit of the Mesh Point.
  1227. if (location.x_index < 0 && location.y_index < 0) continue; // abort if we can't find any more points.
  1228. bit_clear(not_done, location.x_index, location.y_index); // Mark this location as 'adjusted' so we will find a
  1229. // different location the next time through the loop
  1230. const float rawx = pgm_read_float(&(ubl.mesh_index_to_xpos[location.x_index])),
  1231. rawy = pgm_read_float(&(ubl.mesh_index_to_ypos[location.y_index]));
  1232. // TODO: Change to use `position_is_reachable` (for SCARA-compatibility)
  1233. if (!WITHIN(rawx, X_MIN_POS, X_MAX_POS) || !WITHIN(rawy, Y_MIN_POS, Y_MAX_POS)) { // In theory, we don't need this check.
  1234. SERIAL_ERROR_START;
  1235. SERIAL_ERRORLNPGM("Attempt to edit off the bed."); // This really can't happen, but do the check for now
  1236. ubl.has_control_of_lcd_panel = false;
  1237. goto FINE_TUNE_EXIT;
  1238. }
  1239. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE); // Move the nozzle to where we are going to edit
  1240. do_blocking_move_to_xy(LOGICAL_X_POSITION(rawx), LOGICAL_Y_POSITION(rawy));
  1241. float new_z = ubl.z_values[location.x_index][location.y_index];
  1242. round_off = (int32_t)(new_z * 1000.0); // we chop off the last digits just to be clean. We are rounding to the
  1243. new_z = float(round_off) / 1000.0;
  1244. KEEPALIVE_STATE(PAUSED_FOR_USER);
  1245. ubl.has_control_of_lcd_panel = true;
  1246. if (do_ubl_mesh_map) ubl.display_map(map_type); // show the user which point is being adjusted
  1247. lcd_implementation_clear();
  1248. lcd_mesh_edit_setup(new_z);
  1249. do {
  1250. new_z = lcd_mesh_edit();
  1251. idle();
  1252. } while (!ubl_lcd_clicked());
  1253. lcd_return_to_status();
  1254. ubl.has_control_of_lcd_panel = true; // There is a race condition for the Encoder Wheel getting clicked.
  1255. // It could get detected in lcd_mesh_edit (actually _lcd_mesh_fine_tune)
  1256. // or here.
  1257. const millis_t nxt = millis() + 1500UL;
  1258. while (ubl_lcd_clicked()) { // debounce and watch for abort
  1259. idle();
  1260. if (ELAPSED(millis(), nxt)) {
  1261. lcd_return_to_status();
  1262. //SERIAL_PROTOCOLLNPGM("\nFine Tuning of Mesh Stopped.");
  1263. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  1264. LCD_MESSAGEPGM("Mesh Editing Stopped");
  1265. while (ubl_lcd_clicked()) idle();
  1266. goto FINE_TUNE_EXIT;
  1267. }
  1268. }
  1269. safe_delay(20); // We don't want any switch noise.
  1270. ubl.z_values[location.x_index][location.y_index] = new_z;
  1271. lcd_implementation_clear();
  1272. } while (location.x_index >= 0 && location.y_index >= 0 && (--repetition_cnt>0));
  1273. FINE_TUNE_EXIT:
  1274. ubl.has_control_of_lcd_panel = false;
  1275. KEEPALIVE_STATE(IN_HANDLER);
  1276. if (do_ubl_mesh_map) ubl.display_map(map_type);
  1277. ubl.restore_ubl_active_state_and_leave();
  1278. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  1279. do_blocking_move_to_xy(lx, ly);
  1280. LCD_MESSAGEPGM("Done Editing Mesh");
  1281. SERIAL_ECHOLNPGM("Done Editing Mesh");
  1282. }
  1283. //
  1284. // The routine provides the 'Smart Fill' capability. It scans from the
  1285. // outward edges of the mesh towards the center. If it finds an invalid
  1286. // location, it uses the next two points (assumming they are valid) to
  1287. // calculate a 'reasonable' value for the unprobed mesh point.
  1288. //
  1289. void smart_fill_mesh() {
  1290. float f, diff;
  1291. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++) { // Bottom of the mesh looking up
  1292. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y-2; y++) {
  1293. if (isnan(ubl.z_values[x][y])) {
  1294. if (isnan(ubl.z_values[x][y+1])) // we only deal with the first NAN next to a block of
  1295. continue; // good numbers. we want 2 good numbers to extrapolate off of.
  1296. if (isnan(ubl.z_values[x][y+2]))
  1297. continue;
  1298. if (ubl.z_values[x][y+1] < ubl.z_values[x][y+2]) // The bed is angled down near this edge. So to be safe, we
  1299. ubl.z_values[x][y] = ubl.z_values[x][y+1]; // use the closest value, which is probably a little too high
  1300. else {
  1301. diff = ubl.z_values[x][y+1] - ubl.z_values[x][y+2]; // The bed is angled up near this edge. So we will use the closest
  1302. ubl.z_values[x][y] = ubl.z_values[x][y+1] + diff; // height and add in the difference between that and the next point
  1303. }
  1304. break;
  1305. }
  1306. }
  1307. }
  1308. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++) { // Top of the mesh looking down
  1309. for (uint8_t y=GRID_MAX_POINTS_Y-1; y>=1; y--) {
  1310. if (isnan(ubl.z_values[x][y])) {
  1311. if (isnan(ubl.z_values[x][y-1])) // we only deal with the first NAN next to a block of
  1312. continue; // good numbers. we want 2 good numbers to extrapolate off of.
  1313. if (isnan(ubl.z_values[x][y-2]))
  1314. continue;
  1315. if (ubl.z_values[x][y-1] < ubl.z_values[x][y-2]) // The bed is angled down near this edge. So to be safe, we
  1316. ubl.z_values[x][y] = ubl.z_values[x][y-1]; // use the closest value, which is probably a little too high
  1317. else {
  1318. diff = ubl.z_values[x][y-1] - ubl.z_values[x][y-2]; // The bed is angled up near this edge. So we will use the closest
  1319. ubl.z_values[x][y] = ubl.z_values[x][y-1] + diff; // height and add in the difference between that and the next point
  1320. }
  1321. break;
  1322. }
  1323. }
  1324. }
  1325. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++) {
  1326. for (uint8_t x = 0; x < GRID_MAX_POINTS_X-2; x++) { // Left side of the mesh looking right
  1327. if (isnan(ubl.z_values[x][y])) {
  1328. if (isnan(ubl.z_values[x+1][y])) // we only deal with the first NAN next to a block of
  1329. continue; // good numbers. we want 2 good numbers to extrapolate off of.
  1330. if (isnan(ubl.z_values[x+2][y]))
  1331. continue;
  1332. if (ubl.z_values[x+1][y] < ubl.z_values[x+2][y]) // The bed is angled down near this edge. So to be safe, we
  1333. ubl.z_values[x][y] = ubl.z_values[x][y+1]; // use the closest value, which is probably a little too high
  1334. else {
  1335. diff = ubl.z_values[x+1][y] - ubl.z_values[x+2][y]; // The bed is angled up near this edge. So we will use the closest
  1336. ubl.z_values[x][y] = ubl.z_values[x+1][y] + diff; // height and add in the difference between that and the next point
  1337. }
  1338. break;
  1339. }
  1340. }
  1341. }
  1342. for (uint8_t y=0; y < GRID_MAX_POINTS_Y; y++) {
  1343. for (uint8_t x=GRID_MAX_POINTS_X-1; x>=1; x--) { // Right side of the mesh looking left
  1344. if (isnan(ubl.z_values[x][y])) {
  1345. if (isnan(ubl.z_values[x-1][y])) // we only deal with the first NAN next to a block of
  1346. continue; // good numbers. we want 2 good numbers to extrapolate off of.
  1347. if (isnan(ubl.z_values[x-2][y]))
  1348. continue;
  1349. if (ubl.z_values[x-1][y] < ubl.z_values[x-2][y]) // The bed is angled down near this edge. So to be safe, we
  1350. ubl.z_values[x][y] = ubl.z_values[x-1][y]; // use the closest value, which is probably a little too high
  1351. else {
  1352. diff = ubl.z_values[x-1][y] - ubl.z_values[x-2][y]; // The bed is angled up near this edge. So we will use the closest
  1353. ubl.z_values[x][y] = ubl.z_values[x-1][y] + diff; // height and add in the difference between that and the next point
  1354. }
  1355. break;
  1356. }
  1357. }
  1358. }
  1359. }
  1360. void unified_bed_leveling::tilt_mesh_based_on_probed_grid(const bool do_ubl_mesh_map) {
  1361. int8_t i, j ,k, xCount, yCount, xi, yi; // counter variables
  1362. int8_t ix, iy, zig_zag=0, status;
  1363. float dx, dy, x, y, measured_z, inv_z;
  1364. struct linear_fit_data lsf_results;
  1365. matrix_3x3 rotation;
  1366. vector_3 normal;
  1367. int16_t x_min = max((MIN_PROBE_X),(UBL_MESH_MIN_X)),
  1368. x_max = min((MAX_PROBE_X),(UBL_MESH_MAX_X)),
  1369. y_min = max((MIN_PROBE_Y),(UBL_MESH_MIN_Y)),
  1370. y_max = min((MAX_PROBE_Y),(UBL_MESH_MAX_Y));
  1371. dx = ((float)(x_max-x_min)) / (grid_size-1.0);
  1372. dy = ((float)(y_max-y_min)) / (grid_size-1.0);
  1373. incremental_LSF_reset(&lsf_results);
  1374. for(ix=0; ix<grid_size; ix++) {
  1375. x = ((float)x_min) + ix*dx;
  1376. for(iy=0; iy<grid_size; iy++) {
  1377. if (zig_zag)
  1378. y = ((float)y_min) + (grid_size-iy-1)*dy;
  1379. else
  1380. y = ((float)y_min) + iy*dy;
  1381. measured_z = probe_pt(LOGICAL_X_POSITION(x), LOGICAL_Y_POSITION(y), code_seen('E'), g29_verbose_level);
  1382. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1383. if (DEBUGGING(LEVELING)) {
  1384. SERIAL_ECHOPGM("(");
  1385. SERIAL_PROTOCOL_F( x, 7);
  1386. SERIAL_ECHOPGM(",");
  1387. SERIAL_PROTOCOL_F( y, 7);
  1388. SERIAL_ECHOPGM(") logical: ");
  1389. SERIAL_ECHOPGM("(");
  1390. SERIAL_PROTOCOL_F( LOGICAL_X_POSITION(x), 7);
  1391. SERIAL_ECHOPGM(",");
  1392. SERIAL_PROTOCOL_F( LOGICAL_X_POSITION(y), 7);
  1393. SERIAL_ECHOPGM(") measured: ");
  1394. SERIAL_PROTOCOL_F( measured_z, 7);
  1395. SERIAL_ECHOPGM(" correction: ");
  1396. SERIAL_PROTOCOL_F( ubl.get_z_correction(LOGICAL_X_POSITION(x), LOGICAL_Y_POSITION(y)), 7);
  1397. }
  1398. #endif
  1399. measured_z -= ubl.get_z_correction(LOGICAL_X_POSITION(x), LOGICAL_Y_POSITION(y)) /* + zprobe_zoffset */ ;
  1400. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1401. if (DEBUGGING(LEVELING)) {
  1402. SERIAL_ECHOPGM(" final >>>---> ");
  1403. SERIAL_PROTOCOL_F( measured_z, 7);
  1404. SERIAL_ECHOPGM("\n");
  1405. }
  1406. #endif
  1407. incremental_LSF(&lsf_results, x, y, measured_z);
  1408. }
  1409. zig_zag = !zig_zag;
  1410. }
  1411. status = finish_incremental_LSF(&lsf_results);
  1412. if (g29_verbose_level>3) {
  1413. SERIAL_ECHOPGM("LSF Results A=");
  1414. SERIAL_PROTOCOL_F( lsf_results.A, 7);
  1415. SERIAL_ECHOPGM(" B=");
  1416. SERIAL_PROTOCOL_F( lsf_results.B, 7);
  1417. SERIAL_ECHOPGM(" D=");
  1418. SERIAL_PROTOCOL_F( lsf_results.D, 7);
  1419. SERIAL_CHAR('\n');
  1420. }
  1421. normal = vector_3( lsf_results.A, lsf_results.B, 1.0000);
  1422. normal = normal.get_normal();
  1423. if (g29_verbose_level>2) {
  1424. SERIAL_ECHOPGM("bed plane normal = [");
  1425. SERIAL_PROTOCOL_F( normal.x, 7);
  1426. SERIAL_ECHOPGM(",");
  1427. SERIAL_PROTOCOL_F( normal.y, 7);
  1428. SERIAL_ECHOPGM(",");
  1429. SERIAL_PROTOCOL_F( normal.z, 7);
  1430. SERIAL_ECHOPGM("]\n");
  1431. }
  1432. rotation = matrix_3x3::create_look_at( vector_3( lsf_results.A, lsf_results.B, 1));
  1433. for (i = 0; i < GRID_MAX_POINTS_X; i++) {
  1434. for (j = 0; j < GRID_MAX_POINTS_Y; j++) {
  1435. float x_tmp, y_tmp, z_tmp;
  1436. x_tmp = pgm_read_float(&(ubl.mesh_index_to_xpos[i]));
  1437. y_tmp = pgm_read_float(&(ubl.mesh_index_to_ypos[j]));
  1438. z_tmp = ubl.z_values[i][j];
  1439. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1440. if (DEBUGGING(LEVELING)) {
  1441. SERIAL_ECHOPGM("before rotation = [");
  1442. SERIAL_PROTOCOL_F( x_tmp, 7);
  1443. SERIAL_ECHOPGM(",");
  1444. SERIAL_PROTOCOL_F( y_tmp, 7);
  1445. SERIAL_ECHOPGM(",");
  1446. SERIAL_PROTOCOL_F( z_tmp, 7);
  1447. SERIAL_ECHOPGM("] ---> ");
  1448. safe_delay(20);
  1449. }
  1450. #endif
  1451. apply_rotation_xyz(rotation, x_tmp, y_tmp, z_tmp);
  1452. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1453. if (DEBUGGING(LEVELING)) {
  1454. SERIAL_ECHOPGM("after rotation = [");
  1455. SERIAL_PROTOCOL_F( x_tmp, 7);
  1456. SERIAL_ECHOPGM(",");
  1457. SERIAL_PROTOCOL_F( y_tmp, 7);
  1458. SERIAL_ECHOPGM(",");
  1459. SERIAL_PROTOCOL_F( z_tmp, 7);
  1460. SERIAL_ECHOPGM("]\n");
  1461. safe_delay(55);
  1462. }
  1463. #endif
  1464. ubl.z_values[i][j] += z_tmp - lsf_results.D;
  1465. }
  1466. }
  1467. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1468. if (DEBUGGING(LEVELING)) {
  1469. rotation.debug("rotation matrix:");
  1470. SERIAL_ECHOPGM("LSF Results A=");
  1471. SERIAL_PROTOCOL_F( lsf_results.A, 7);
  1472. SERIAL_ECHOPGM(" B=");
  1473. SERIAL_PROTOCOL_F( lsf_results.B, 7);
  1474. SERIAL_ECHOPGM(" D=");
  1475. SERIAL_PROTOCOL_F( lsf_results.D, 7);
  1476. SERIAL_CHAR('\n');
  1477. safe_delay(55);
  1478. SERIAL_ECHOPGM("bed plane normal = [");
  1479. SERIAL_PROTOCOL_F( normal.x, 7);
  1480. SERIAL_ECHOPGM(",");
  1481. SERIAL_PROTOCOL_F( normal.y, 7);
  1482. SERIAL_ECHOPGM(",");
  1483. SERIAL_PROTOCOL_F( normal.z, 7);
  1484. SERIAL_ECHOPGM("]\n");
  1485. SERIAL_CHAR('\n');
  1486. }
  1487. #endif
  1488. return;
  1489. }
  1490. #endif // AUTO_BED_LEVELING_UBL