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.

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727
  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. }
  329. SERIAL_PROTOCOLLNPGM("Locations invalidated.\n");
  330. }
  331. if (code_seen('Q')) {
  332. const int test_pattern = code_has_value() ? code_value_int() : -1;
  333. if (!WITHIN(test_pattern, 0, 2)) {
  334. SERIAL_PROTOCOLLNPGM("Invalid test_pattern value. (0-2)\n");
  335. return;
  336. }
  337. SERIAL_PROTOCOLLNPGM("Loading test_pattern values.\n");
  338. switch (test_pattern) {
  339. case 0:
  340. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++) { // Create a bowl shape - similar to
  341. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++) { // a poorly calibrated Delta.
  342. const float p1 = 0.5 * (GRID_MAX_POINTS_X) - x,
  343. p2 = 0.5 * (GRID_MAX_POINTS_Y) - y;
  344. ubl.z_values[x][y] += 2.0 * HYPOT(p1, p2);
  345. }
  346. }
  347. break;
  348. case 1:
  349. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++) { // Create a diagonal line several Mesh cells thick that is raised
  350. ubl.z_values[x][x] += 9.999;
  351. ubl.z_values[x][x + (x < GRID_MAX_POINTS_Y - 1) ? 1 : -1] += 9.999; // We want the altered line several mesh points thick
  352. }
  353. break;
  354. case 2:
  355. // Allow the user to specify the height because 10mm is a little extreme in some cases.
  356. for (uint8_t x = (GRID_MAX_POINTS_X) / 3; x < 2 * (GRID_MAX_POINTS_X) / 3; x++) // Create a rectangular raised area in
  357. for (uint8_t y = (GRID_MAX_POINTS_Y) / 3; y < 2 * (GRID_MAX_POINTS_Y) / 3; y++) // the center of the bed
  358. ubl.z_values[x][y] += code_seen('C') ? ubl_constant : 9.99;
  359. break;
  360. }
  361. }
  362. if (code_seen('J')) {
  363. if (!WITHIN(grid_size, 2, 9)) {
  364. SERIAL_PROTOCOLLNPGM("ERROR - grid size must be between 2 and 9");
  365. return;
  366. }
  367. ubl.save_ubl_active_state_and_disable();
  368. ubl.tilt_mesh_based_on_probed_grid(code_seen('O') || code_seen('M'));
  369. ubl.restore_ubl_active_state_and_leave();
  370. }
  371. if (code_seen('P')) {
  372. phase_value = code_value_int();
  373. if (!WITHIN(phase_value, 0, 7)) {
  374. SERIAL_PROTOCOLLNPGM("Invalid Phase value. (0-4)\n");
  375. return;
  376. }
  377. switch (phase_value) {
  378. case 0:
  379. //
  380. // Zero Mesh Data
  381. //
  382. ubl.reset();
  383. SERIAL_PROTOCOLLNPGM("Mesh zeroed.\n");
  384. break;
  385. case 1:
  386. //
  387. // Invalidate Entire Mesh and Automatically Probe Mesh in areas that can be reached by the probe
  388. //
  389. if (!code_seen('C')) {
  390. ubl.invalidate();
  391. SERIAL_PROTOCOLLNPGM("Mesh invalidated. Probing mesh.\n");
  392. }
  393. if (g29_verbose_level > 1) {
  394. SERIAL_PROTOCOLPAIR("Probing Mesh Points Closest to (", x_pos);
  395. SERIAL_PROTOCOLCHAR(',');
  396. SERIAL_PROTOCOL(y_pos);
  397. SERIAL_PROTOCOLLNPGM(")\n");
  398. }
  399. ubl.probe_entire_mesh(x_pos + X_PROBE_OFFSET_FROM_EXTRUDER, y_pos + Y_PROBE_OFFSET_FROM_EXTRUDER,
  400. code_seen('O') || code_seen('M'), code_seen('E'), code_seen('U'));
  401. break;
  402. case 2: {
  403. //
  404. // Manually Probe Mesh in areas that can't be reached by the probe
  405. //
  406. SERIAL_PROTOCOLLNPGM("Manually probing unreachable mesh locations.\n");
  407. do_blocking_move_to_z(Z_CLEARANCE_BETWEEN_PROBES);
  408. if (!x_flag && !y_flag) { // use a good default location for the path
  409. // The flipped > and < operators on these two comparisons is
  410. // intentional. It should cause the probed points to follow a
  411. // nice path on Cartesian printers. It may make sense to
  412. // have Delta printers default to the center of the bed.
  413. // For now, until that is decided, it can be forced with the X
  414. // and Y parameters.
  415. x_pos = X_PROBE_OFFSET_FROM_EXTRUDER > 0 ? X_MAX_POS : X_MIN_POS;
  416. y_pos = Y_PROBE_OFFSET_FROM_EXTRUDER < 0 ? Y_MAX_POS : Y_MIN_POS;
  417. }
  418. if (code_seen('C')) {
  419. x_pos = current_position[X_AXIS];
  420. y_pos = current_position[Y_AXIS];
  421. }
  422. const float height = code_seen('H') && code_has_value() ? code_value_float() : Z_CLEARANCE_BETWEEN_PROBES;
  423. if (code_seen('B')) {
  424. card_thickness = code_has_value() ? code_value_float() : measure_business_card_thickness(height);
  425. if (fabs(card_thickness) > 1.5) {
  426. SERIAL_PROTOCOLLNPGM("?Error in Business Card measurement.\n");
  427. return;
  428. }
  429. }
  430. manually_probe_remaining_mesh(x_pos, y_pos, height, card_thickness, code_seen('O') || code_seen('M'));
  431. } break;
  432. case 3: {
  433. //
  434. // Populate invalid Mesh areas. Two choices are available to the user. The user can
  435. // specify the constant to be used with a C # paramter. Or the user can allow the G29 P3 command to
  436. // apply a 'reasonable' constant to the invalid mesh point. Some caution and scrutiny should be used
  437. // on either of these paths!
  438. //
  439. if (c_flag) {
  440. while (repetition_cnt--) {
  441. const mesh_index_pair location = find_closest_mesh_point_of_type(INVALID, x_pos, y_pos, USE_NOZZLE_AS_REFERENCE, NULL, false);
  442. if (location.x_index < 0) break; // No more invalid Mesh Points to populate
  443. ubl.z_values[location.x_index][location.y_index] = ubl_constant;
  444. }
  445. break;
  446. } else // The user wants to do a 'Smart' fill where we use the surrounding known
  447. smart_fill_mesh(); // values to provide a good guess of what the unprobed mesh point should be
  448. break;
  449. }
  450. case 4:
  451. //
  452. // Fine Tune (i.e., Edit) the Mesh
  453. //
  454. fine_tune_mesh(x_pos, y_pos, code_seen('O') || code_seen('M'));
  455. break;
  456. case 5:
  457. ubl.find_mean_mesh_height();
  458. break;
  459. case 6:
  460. ubl.shift_mesh_height();
  461. break;
  462. case 10:
  463. // [DEBUG] Pay no attention to this stuff. It can be removed soon.
  464. SERIAL_ECHO_START;
  465. SERIAL_ECHOLNPGM("Checking G29 has control of LCD Panel:");
  466. KEEPALIVE_STATE(PAUSED_FOR_USER);
  467. ubl.has_control_of_lcd_panel = true;
  468. while (!ubl_lcd_clicked()) {
  469. safe_delay(250);
  470. if (ubl.encoder_diff) {
  471. SERIAL_ECHOLN((int)ubl.encoder_diff);
  472. ubl.encoder_diff = 0;
  473. }
  474. }
  475. SERIAL_ECHOLNPGM("G29 giving back control of LCD Panel.");
  476. ubl.has_control_of_lcd_panel = false;
  477. KEEPALIVE_STATE(IN_HANDLER);
  478. break;
  479. case 11:
  480. // [DEBUG] wait_for_user code. Pay no attention to this stuff. It can be removed soon.
  481. SERIAL_ECHO_START;
  482. SERIAL_ECHOLNPGM("Checking G29 has control of LCD Panel:");
  483. KEEPALIVE_STATE(PAUSED_FOR_USER);
  484. wait_for_user = true;
  485. while (wait_for_user) {
  486. safe_delay(250);
  487. if (ubl.encoder_diff) {
  488. SERIAL_ECHOLN((int)ubl.encoder_diff);
  489. ubl.encoder_diff = 0;
  490. }
  491. }
  492. SERIAL_ECHOLNPGM("G29 giving back control of LCD Panel.");
  493. KEEPALIVE_STATE(IN_HANDLER);
  494. break;
  495. }
  496. }
  497. if (code_seen('T')) {
  498. float z1 = probe_pt( LOGICAL_X_POSITION(UBL_PROBE_PT_1_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_1_Y), false, g29_verbose_level),
  499. z2 = probe_pt( LOGICAL_X_POSITION(UBL_PROBE_PT_2_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_2_Y), false, g29_verbose_level),
  500. z3 = probe_pt( LOGICAL_X_POSITION(UBL_PROBE_PT_3_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_3_Y), true, g29_verbose_level);
  501. // We need to adjust z1, z2, z3 by the Mesh Height at these points. Just because they are non-zero doesn't mean
  502. // the Mesh is tilted! (We need to compensate each probe point by what the Mesh says that location's height is)
  503. ubl.save_ubl_active_state_and_disable();
  504. z1 -= ubl.get_z_correction(LOGICAL_X_POSITION(UBL_PROBE_PT_1_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_1_Y)) /* + zprobe_zoffset */ ;
  505. z2 -= ubl.get_z_correction(LOGICAL_X_POSITION(UBL_PROBE_PT_2_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_2_Y)) /* + zprobe_zoffset */ ;
  506. z3 -= ubl.get_z_correction(LOGICAL_X_POSITION(UBL_PROBE_PT_3_X), LOGICAL_Y_POSITION(UBL_PROBE_PT_3_Y)) /* + zprobe_zoffset */ ;
  507. do_blocking_move_to_xy((X_MAX_POS - (X_MIN_POS)) / 2.0, (Y_MAX_POS - (Y_MIN_POS)) / 2.0);
  508. ubl.tilt_mesh_based_on_3pts(z1, z2, z3);
  509. ubl.restore_ubl_active_state_and_leave();
  510. }
  511. //
  512. // Much of the 'What?' command can be eliminated. But until we are fully debugged, it is
  513. // good to have the extra information. Soon... we prune this to just a few items
  514. //
  515. if (code_seen('W')) g29_what_command();
  516. //
  517. // When we are fully debugged, the EEPROM dump command will get deleted also. But
  518. // right now, it is good to have the extra information. Soon... we prune this.
  519. //
  520. if (code_seen('j')) g29_eeprom_dump(); // EEPROM Dump
  521. //
  522. // When we are fully debugged, this may go away. But there are some valid
  523. // use cases for the users. So we can wait and see what to do with it.
  524. //
  525. if (code_seen('K')) // Kompare Current Mesh Data to Specified Stored Mesh
  526. g29_compare_current_mesh_to_stored_mesh();
  527. //
  528. // Load a Mesh from the EEPROM
  529. //
  530. if (code_seen('L')) { // Load Current Mesh Data
  531. storage_slot = code_has_value() ? code_value_int() : ubl.state.eeprom_storage_slot;
  532. const int16_t j = (UBL_LAST_EEPROM_INDEX - ubl.eeprom_start) / sizeof(ubl.z_values);
  533. if (!WITHIN(storage_slot, 0, j - 1) || ubl.eeprom_start <= 0) {
  534. SERIAL_PROTOCOLLNPGM("?EEPROM storage not available for use.\n");
  535. return;
  536. }
  537. ubl.load_mesh(storage_slot);
  538. ubl.state.eeprom_storage_slot = storage_slot;
  539. SERIAL_PROTOCOLLNPGM("Done.\n");
  540. }
  541. //
  542. // Store a Mesh in the EEPROM
  543. //
  544. if (code_seen('S')) { // Store (or Save) Current Mesh Data
  545. storage_slot = code_has_value() ? code_value_int() : ubl.state.eeprom_storage_slot;
  546. if (storage_slot == -1) { // Special case, we are going to 'Export' the mesh to the
  547. SERIAL_ECHOLNPGM("G29 I 999"); // host in a form it can be reconstructed on a different machine
  548. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  549. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  550. if (!isnan(ubl.z_values[x][y])) {
  551. SERIAL_ECHOPAIR("M421 I ", x);
  552. SERIAL_ECHOPAIR(" J ", y);
  553. SERIAL_ECHOPGM(" Z ");
  554. SERIAL_ECHO_F(ubl.z_values[x][y], 6);
  555. SERIAL_EOL;
  556. }
  557. return;
  558. }
  559. const int16_t j = (UBL_LAST_EEPROM_INDEX - ubl.eeprom_start) / sizeof(ubl.z_values);
  560. if (!WITHIN(storage_slot, 0, j - 1) || ubl.eeprom_start <= 0) {
  561. SERIAL_PROTOCOLLNPGM("?EEPROM storage not available for use.\n");
  562. SERIAL_PROTOCOLLNPAIR("?Use 0 to ", j - 1);
  563. goto LEAVE;
  564. }
  565. ubl.store_mesh(storage_slot);
  566. ubl.state.eeprom_storage_slot = storage_slot;
  567. SERIAL_PROTOCOLLNPGM("Done.\n");
  568. }
  569. if (code_seen('O') || code_seen('M'))
  570. ubl.display_map(code_has_value() ? code_value_int() : 0);
  571. if (code_seen('Z')) {
  572. if (code_has_value())
  573. ubl.state.z_offset = code_value_float(); // do the simple case. Just lock in the specified value
  574. else {
  575. ubl.save_ubl_active_state_and_disable();
  576. //measured_z = probe_pt(x_pos + X_PROBE_OFFSET_FROM_EXTRUDER, y_pos + Y_PROBE_OFFSET_FROM_EXTRUDER, ProbeDeployAndStow, g29_verbose_level);
  577. ubl.has_control_of_lcd_panel = true; // Grab the LCD Hardware
  578. measured_z = 1.5;
  579. do_blocking_move_to_z(measured_z); // Get close to the bed, but leave some space so we don't damage anything
  580. // The user is not going to be locking in a new Z-Offset very often so
  581. // it won't be that painful to spin the Encoder Wheel for 1.5mm
  582. lcd_implementation_clear();
  583. lcd_z_offset_edit_setup(measured_z);
  584. KEEPALIVE_STATE(PAUSED_FOR_USER);
  585. do {
  586. measured_z = lcd_z_offset_edit();
  587. idle();
  588. do_blocking_move_to_z(measured_z);
  589. } while (!ubl_lcd_clicked());
  590. ubl.has_control_of_lcd_panel = true; // There is a race condition for the Encoder Wheel getting clicked.
  591. // It could get detected in lcd_mesh_edit (actually _lcd_mesh_fine_tune)
  592. // or here. So, until we are done looking for a long Encoder Wheel Press,
  593. // we need to take control of the panel
  594. KEEPALIVE_STATE(IN_HANDLER);
  595. lcd_return_to_status();
  596. const millis_t nxt = millis() + 1500UL;
  597. while (ubl_lcd_clicked()) { // debounce and watch for abort
  598. idle();
  599. if (ELAPSED(millis(), nxt)) {
  600. SERIAL_PROTOCOLLNPGM("\nZ-Offset Adjustment Stopped.");
  601. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  602. LCD_MESSAGEPGM("Z-Offset Stopped");
  603. ubl.restore_ubl_active_state_and_leave();
  604. goto LEAVE;
  605. }
  606. }
  607. ubl.has_control_of_lcd_panel = false;
  608. safe_delay(20); // We don't want any switch noise.
  609. ubl.state.z_offset = measured_z;
  610. lcd_implementation_clear();
  611. ubl.restore_ubl_active_state_and_leave();
  612. }
  613. }
  614. LEAVE:
  615. lcd_reset_alert_level();
  616. LCD_MESSAGEPGM("");
  617. lcd_quick_feedback();
  618. ubl.has_control_of_lcd_panel = false;
  619. }
  620. void unified_bed_leveling::find_mean_mesh_height() {
  621. uint8_t x, y;
  622. int n;
  623. float sum, sum_of_diff_squared, sigma, difference, mean;
  624. sum = sum_of_diff_squared = 0.0;
  625. n = 0;
  626. for (x = 0; x < GRID_MAX_POINTS_X; x++)
  627. for (y = 0; y < GRID_MAX_POINTS_Y; y++)
  628. if (!isnan(ubl.z_values[x][y])) {
  629. sum += ubl.z_values[x][y];
  630. n++;
  631. }
  632. mean = sum / n;
  633. //
  634. // Now do the sumation of the squares of difference from mean
  635. //
  636. for (x = 0; x < GRID_MAX_POINTS_X; x++)
  637. for (y = 0; y < GRID_MAX_POINTS_Y; y++)
  638. if (!isnan(ubl.z_values[x][y])) {
  639. difference = (ubl.z_values[x][y] - mean);
  640. sum_of_diff_squared += difference * difference;
  641. }
  642. SERIAL_ECHOLNPAIR("# of samples: ", n);
  643. SERIAL_ECHOPGM("Mean Mesh Height: ");
  644. SERIAL_ECHO_F(mean, 6);
  645. SERIAL_EOL;
  646. sigma = sqrt(sum_of_diff_squared / (n + 1));
  647. SERIAL_ECHOPGM("Standard Deviation: ");
  648. SERIAL_ECHO_F(sigma, 6);
  649. SERIAL_EOL;
  650. if (c_flag)
  651. for (x = 0; x < GRID_MAX_POINTS_X; x++)
  652. for (y = 0; y < GRID_MAX_POINTS_Y; y++)
  653. if (!isnan(ubl.z_values[x][y]))
  654. ubl.z_values[x][y] -= mean + ubl_constant;
  655. }
  656. void unified_bed_leveling::shift_mesh_height() {
  657. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  658. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  659. if (!isnan(ubl.z_values[x][y]))
  660. ubl.z_values[x][y] += ubl_constant;
  661. }
  662. /**
  663. * Probe all invalidated locations of the mesh that can be reached by the probe.
  664. * This attempts to fill in locations closest to the nozzle's start location first.
  665. */
  666. 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) {
  667. mesh_index_pair location;
  668. ubl.has_control_of_lcd_panel = true;
  669. ubl.save_ubl_active_state_and_disable(); // we don't do bed level correction because we want the raw data when we probe
  670. DEPLOY_PROBE();
  671. do {
  672. if (ubl_lcd_clicked()) {
  673. SERIAL_PROTOCOLLNPGM("\nMesh only partially populated.\n");
  674. lcd_quick_feedback();
  675. STOW_PROBE();
  676. while (ubl_lcd_clicked()) idle();
  677. ubl.has_control_of_lcd_panel = false;
  678. ubl.restore_ubl_active_state_and_leave();
  679. safe_delay(50); // Debounce the Encoder wheel
  680. return;
  681. }
  682. location = find_closest_mesh_point_of_type(INVALID, lx, ly, USE_PROBE_AS_REFERENCE, NULL, do_furthest);
  683. if (location.x_index >= 0 && location.y_index >= 0) {
  684. const float rawx = pgm_read_float(&(ubl.mesh_index_to_xpos[location.x_index])),
  685. rawy = pgm_read_float(&(ubl.mesh_index_to_ypos[location.y_index]));
  686. // TODO: Change to use `position_is_reachable` (for SCARA-compatibility)
  687. if (!WITHIN(rawx, MIN_PROBE_X, MAX_PROBE_X) || !WITHIN(rawy, MIN_PROBE_Y, MAX_PROBE_Y)) {
  688. SERIAL_ERROR_START;
  689. SERIAL_ERRORLNPGM("Attempt to probe off the bed.");
  690. ubl.has_control_of_lcd_panel = false;
  691. goto LEAVE;
  692. }
  693. const float measured_z = probe_pt(LOGICAL_X_POSITION(rawx), LOGICAL_Y_POSITION(rawy), stow_probe, g29_verbose_level);
  694. ubl.z_values[location.x_index][location.y_index] = measured_z;
  695. }
  696. if (do_ubl_mesh_map) ubl.display_map(map_type);
  697. } while (location.x_index >= 0 && location.y_index >= 0);
  698. LEAVE:
  699. STOW_PROBE();
  700. ubl.restore_ubl_active_state_and_leave();
  701. do_blocking_move_to_xy(
  702. constrain(lx - (X_PROBE_OFFSET_FROM_EXTRUDER), X_MIN_POS, X_MAX_POS),
  703. constrain(ly - (Y_PROBE_OFFSET_FROM_EXTRUDER), Y_MIN_POS, Y_MAX_POS)
  704. );
  705. }
  706. void unified_bed_leveling::tilt_mesh_based_on_3pts(const float &z1, const float &z2, const float &z3) {
  707. float d, t, inv_z;
  708. int i, j;
  709. matrix_3x3 rotation;
  710. vector_3 v1 = vector_3( (UBL_PROBE_PT_1_X - UBL_PROBE_PT_2_X),
  711. (UBL_PROBE_PT_1_Y - UBL_PROBE_PT_2_Y),
  712. (z1 - z2) ),
  713. v2 = vector_3( (UBL_PROBE_PT_3_X - UBL_PROBE_PT_2_X),
  714. (UBL_PROBE_PT_3_Y - UBL_PROBE_PT_2_Y),
  715. (z3 - z2) ),
  716. normal = vector_3::cross(v1, v2);
  717. normal = normal.get_normal();
  718. /**
  719. * This vector is normal to the tilted plane.
  720. * However, we don't know its direction. We need it to point up. So if
  721. * Z is negative, we need to invert the sign of all components of the vector
  722. */
  723. if ( normal.z < 0.0 ) {
  724. normal.x = -normal.x;
  725. normal.y = -normal.y;
  726. normal.z = -normal.z;
  727. }
  728. rotation = matrix_3x3::create_look_at( vector_3( normal.x, normal.y, 1));
  729. if (g29_verbose_level>2) {
  730. SERIAL_ECHOPGM("bed plane normal = [");
  731. SERIAL_PROTOCOL_F( normal.x, 7);
  732. SERIAL_ECHOPGM(",");
  733. SERIAL_PROTOCOL_F( normal.y, 7);
  734. SERIAL_ECHOPGM(",");
  735. SERIAL_PROTOCOL_F( normal.z, 7);
  736. SERIAL_ECHOPGM("]\n");
  737. rotation.debug("rotation matrix:");
  738. }
  739. //
  740. // All of 3 of these points should give us the same d constant
  741. //
  742. t = normal.x * UBL_PROBE_PT_1_X + normal.y * UBL_PROBE_PT_1_Y;
  743. d = t + normal.z * z1;
  744. if (g29_verbose_level>2) {
  745. SERIAL_ECHOPGM("D constant: ");
  746. SERIAL_PROTOCOL_F( d, 7);
  747. SERIAL_ECHOPGM(" \n");
  748. }
  749. #if ENABLED(DEBUG_LEVELING_FEATURE)
  750. if (DEBUGGING(LEVELING)) {
  751. SERIAL_ECHOPGM("d from 1st point: ");
  752. SERIAL_ECHO_F(d, 6);
  753. SERIAL_EOL;
  754. t = normal.x * UBL_PROBE_PT_2_X + normal.y * UBL_PROBE_PT_2_Y;
  755. d = t + normal.z * z2;
  756. SERIAL_ECHOPGM("d from 2nd point: ");
  757. SERIAL_ECHO_F(d, 6);
  758. SERIAL_EOL;
  759. t = normal.x * UBL_PROBE_PT_3_X + normal.y * UBL_PROBE_PT_3_Y;
  760. d = t + normal.z * z3;
  761. SERIAL_ECHOPGM("d from 3rd point: ");
  762. SERIAL_ECHO_F(d, 6);
  763. SERIAL_EOL;
  764. }
  765. #endif
  766. for (i = 0; i < GRID_MAX_POINTS_X; i++) {
  767. for (j = 0; j < GRID_MAX_POINTS_Y; j++) {
  768. float x_tmp, y_tmp, z_tmp;
  769. x_tmp = pgm_read_float(ubl.mesh_index_to_xpos[i]);
  770. y_tmp = pgm_read_float(ubl.mesh_index_to_ypos[j]);
  771. z_tmp = ubl.z_values[i][j];
  772. #if ENABLED(DEBUG_LEVELING_FEATURE)
  773. if (DEBUGGING(LEVELING)) {
  774. SERIAL_ECHOPGM("before rotation = [");
  775. SERIAL_PROTOCOL_F( x_tmp, 7);
  776. SERIAL_ECHOPGM(",");
  777. SERIAL_PROTOCOL_F( y_tmp, 7);
  778. SERIAL_ECHOPGM(",");
  779. SERIAL_PROTOCOL_F( z_tmp, 7);
  780. SERIAL_ECHOPGM("] ---> ");
  781. safe_delay(20);
  782. }
  783. #endif
  784. apply_rotation_xyz(rotation, x_tmp, y_tmp, z_tmp);
  785. #if ENABLED(DEBUG_LEVELING_FEATURE)
  786. if (DEBUGGING(LEVELING)) {
  787. SERIAL_ECHOPGM("after rotation = [");
  788. SERIAL_PROTOCOL_F( x_tmp, 7);
  789. SERIAL_ECHOPGM(",");
  790. SERIAL_PROTOCOL_F( y_tmp, 7);
  791. SERIAL_ECHOPGM(",");
  792. SERIAL_PROTOCOL_F( z_tmp, 7);
  793. SERIAL_ECHOPGM("]\n");
  794. safe_delay(55);
  795. }
  796. #endif
  797. ubl.z_values[i][j] += z_tmp - d;
  798. }
  799. }
  800. return;
  801. }
  802. float use_encoder_wheel_to_measure_point() {
  803. KEEPALIVE_STATE(PAUSED_FOR_USER);
  804. while (!ubl_lcd_clicked()) { // we need the loop to move the nozzle based on the encoder wheel here!
  805. idle();
  806. if (ubl.encoder_diff) {
  807. do_blocking_move_to_z(current_position[Z_AXIS] + 0.01 * float(ubl.encoder_diff));
  808. ubl.encoder_diff = 0;
  809. }
  810. }
  811. KEEPALIVE_STATE(IN_HANDLER);
  812. return current_position[Z_AXIS];
  813. }
  814. float measure_business_card_thickness(const float &in_height) {
  815. ubl.has_control_of_lcd_panel = true;
  816. ubl.save_ubl_active_state_and_disable(); // we don't do bed level correction because we want the raw data when we probe
  817. SERIAL_PROTOCOLLNPGM("Place Shim Under Nozzle and Perform Measurement.");
  818. do_blocking_move_to_z(in_height);
  819. 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);
  820. //, min(planner.max_feedrate_mm_s[X_AXIS], planner.max_feedrate_mm_s[Y_AXIS])/2.0);
  821. const float z1 = use_encoder_wheel_to_measure_point();
  822. do_blocking_move_to_z(current_position[Z_AXIS] + SIZE_OF_LITTLE_RAISE);
  823. ubl.has_control_of_lcd_panel = false;
  824. SERIAL_PROTOCOLLNPGM("Remove Shim and Measure Bed Height.");
  825. const float z2 = use_encoder_wheel_to_measure_point();
  826. do_blocking_move_to_z(current_position[Z_AXIS] + SIZE_OF_LITTLE_RAISE);
  827. if (g29_verbose_level > 1) {
  828. SERIAL_PROTOCOLPGM("Business Card is: ");
  829. SERIAL_PROTOCOL_F(abs(z1 - z2), 6);
  830. SERIAL_PROTOCOLLNPGM("mm thick.");
  831. }
  832. ubl.restore_ubl_active_state_and_leave();
  833. return abs(z1 - z2);
  834. }
  835. 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) {
  836. ubl.has_control_of_lcd_panel = true;
  837. ubl.save_ubl_active_state_and_disable(); // we don't do bed level correction because we want the raw data when we probe
  838. do_blocking_move_to_z(z_clearance);
  839. do_blocking_move_to_xy(lx, ly);
  840. float last_x = -9999.99, last_y = -9999.99;
  841. mesh_index_pair location;
  842. do {
  843. location = find_closest_mesh_point_of_type(INVALID, lx, ly, USE_NOZZLE_AS_REFERENCE, NULL, false);
  844. // It doesn't matter if the probe can't reach the NAN location. This is a manual probe.
  845. if (location.x_index < 0 && location.y_index < 0) continue;
  846. const float rawx = pgm_read_float(&(ubl.mesh_index_to_xpos[location.x_index])),
  847. rawy = pgm_read_float(&(ubl.mesh_index_to_ypos[location.y_index]));
  848. // TODO: Change to use `position_is_reachable` (for SCARA-compatibility)
  849. if (!WITHIN(rawx, X_MIN_POS, X_MAX_POS) || !WITHIN(rawy, Y_MIN_POS, Y_MAX_POS)) {
  850. SERIAL_ERROR_START;
  851. SERIAL_ERRORLNPGM("Attempt to probe off the bed.");
  852. ubl.has_control_of_lcd_panel = false;
  853. goto LEAVE;
  854. }
  855. const float xProbe = LOGICAL_X_POSITION(rawx),
  856. yProbe = LOGICAL_Y_POSITION(rawy),
  857. dx = xProbe - last_x,
  858. dy = yProbe - last_y;
  859. if (HYPOT(dx, dy) < BIG_RAISE_NOT_NEEDED)
  860. do_blocking_move_to_z(current_position[Z_AXIS] + SIZE_OF_LITTLE_RAISE);
  861. else
  862. do_blocking_move_to_z(z_clearance);
  863. do_blocking_move_to_xy(xProbe, yProbe);
  864. last_x = xProbe;
  865. last_y = yProbe;
  866. KEEPALIVE_STATE(PAUSED_FOR_USER);
  867. ubl.has_control_of_lcd_panel = true;
  868. if (do_ubl_mesh_map) ubl.display_map(map_type); // show user where we're probing
  869. while (!ubl_lcd_clicked()) { // we need the loop to move the nozzle based on the encoder wheel here!
  870. idle();
  871. if (ubl.encoder_diff) {
  872. do_blocking_move_to_z(current_position[Z_AXIS] + float(ubl.encoder_diff) / 100.0);
  873. ubl.encoder_diff = 0;
  874. }
  875. }
  876. const millis_t nxt = millis() + 1500L;
  877. while (ubl_lcd_clicked()) { // debounce and watch for abort
  878. idle();
  879. if (ELAPSED(millis(), nxt)) {
  880. SERIAL_PROTOCOLLNPGM("\nMesh only partially populated.");
  881. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  882. lcd_quick_feedback();
  883. while (ubl_lcd_clicked()) idle();
  884. ubl.has_control_of_lcd_panel = false;
  885. KEEPALIVE_STATE(IN_HANDLER);
  886. ubl.restore_ubl_active_state_and_leave();
  887. return;
  888. }
  889. }
  890. ubl.z_values[location.x_index][location.y_index] = current_position[Z_AXIS] - card_thickness;
  891. if (g29_verbose_level > 2) {
  892. SERIAL_PROTOCOLPGM("Mesh Point Measured at: ");
  893. SERIAL_PROTOCOL_F(ubl.z_values[location.x_index][location.y_index], 6);
  894. SERIAL_EOL;
  895. }
  896. } while (location.x_index >= 0 && location.y_index >= 0);
  897. if (do_ubl_mesh_map) ubl.display_map(map_type);
  898. LEAVE:
  899. ubl.restore_ubl_active_state_and_leave();
  900. KEEPALIVE_STATE(IN_HANDLER);
  901. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  902. do_blocking_move_to_xy(lx, ly);
  903. }
  904. bool g29_parameter_parsing() {
  905. bool err_flag = false;
  906. LCD_MESSAGEPGM("Doing G29 UBL!");
  907. ubl_constant = 0.0;
  908. repetition_cnt = 0;
  909. lcd_quick_feedback();
  910. x_flag = code_seen('X') && code_has_value();
  911. x_pos = x_flag ? code_value_float() : current_position[X_AXIS];
  912. y_flag = code_seen('Y') && code_has_value();
  913. y_pos = y_flag ? code_value_float() : current_position[Y_AXIS];
  914. repeat_flag = code_seen('R');
  915. if (repeat_flag) {
  916. repetition_cnt = code_has_value() ? code_value_int() : (GRID_MAX_POINTS_X) * (GRID_MAX_POINTS_Y);
  917. if (repetition_cnt < 1) {
  918. SERIAL_PROTOCOLLNPGM("Invalid Repetition count.\n");
  919. return UBL_ERR;
  920. }
  921. }
  922. g29_verbose_level = code_seen('V') ? code_value_int() : 0;
  923. if (!WITHIN(g29_verbose_level, 0, 4)) {
  924. SERIAL_PROTOCOLLNPGM("Invalid Verbose Level specified. (0-4)\n");
  925. err_flag = true;
  926. }
  927. if (code_seen('J')) {
  928. grid_size = code_has_value() ? code_value_int() : 3;
  929. if (!WITHIN(grid_size, 2, 5)) {
  930. SERIAL_PROTOCOLLNPGM("Invalid grid probe points specified.\n");
  931. err_flag = true;
  932. }
  933. }
  934. if (x_flag != y_flag) {
  935. SERIAL_PROTOCOLLNPGM("Both X & Y locations must be specified.\n");
  936. err_flag = true;
  937. }
  938. if (!WITHIN(RAW_X_POSITION(x_pos), X_MIN_POS, X_MAX_POS)) {
  939. SERIAL_PROTOCOLLNPGM("Invalid X location specified.\n");
  940. err_flag = true;
  941. }
  942. if (!WITHIN(RAW_Y_POSITION(y_pos), Y_MIN_POS, Y_MAX_POS)) {
  943. SERIAL_PROTOCOLLNPGM("Invalid Y location specified.\n");
  944. err_flag = true;
  945. }
  946. if (err_flag) return UBL_ERR;
  947. if (code_seen('A')) { // Activate the Unified Bed Leveling System
  948. ubl.state.active = 1;
  949. SERIAL_PROTOCOLLNPGM("Unified Bed Leveling System activated.\n");
  950. }
  951. c_flag = code_seen('C');
  952. if (c_flag)
  953. ubl_constant = code_value_float();
  954. if (code_seen('D')) { // Disable the Unified Bed Leveling System
  955. ubl.state.active = 0;
  956. SERIAL_PROTOCOLLNPGM("Unified Bed Leveling System de-activated.\n");
  957. }
  958. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  959. if (code_seen('F') && code_has_value()) {
  960. const float fh = code_value_float();
  961. if (!WITHIN(fh, 0.0, 100.0)) {
  962. SERIAL_PROTOCOLLNPGM("?Bed Level Correction Fade Height Not Plausible.\n");
  963. return UBL_ERR;
  964. }
  965. set_z_fade_height(fh);
  966. }
  967. #endif
  968. map_type = code_seen('O') && code_has_value() ? code_value_int() : 0;
  969. if (!WITHIN(map_type, 0, 1)) {
  970. SERIAL_PROTOCOLLNPGM("Invalid map type.\n");
  971. return UBL_ERR;
  972. }
  973. if (code_seen('M')) { // Check if a map type was specified
  974. map_type = code_has_value() ? code_value_int() : 0;
  975. if (!WITHIN(map_type, 0, 1)) {
  976. SERIAL_PROTOCOLLNPGM("Invalid map type.\n");
  977. return UBL_ERR;
  978. }
  979. }
  980. return UBL_OK;
  981. }
  982. /**
  983. * This function goes away after G29 debug is complete. But for right now, it is a handy
  984. * routine to dump binary data structures.
  985. */
  986. /*
  987. void dump(char * const str, const float &f) {
  988. char *ptr;
  989. SERIAL_PROTOCOL(str);
  990. SERIAL_PROTOCOL_F(f, 8);
  991. SERIAL_PROTOCOLPGM(" ");
  992. ptr = (char*)&f;
  993. for (uint8_t i = 0; i < 4; i++)
  994. SERIAL_PROTOCOLPAIR(" ", hex_byte(*ptr++));
  995. SERIAL_PROTOCOLPAIR(" isnan()=", isnan(f));
  996. SERIAL_PROTOCOLPAIR(" isinf()=", isinf(f));
  997. if (f == -INFINITY)
  998. SERIAL_PROTOCOLPGM(" Minus Infinity detected.");
  999. SERIAL_EOL;
  1000. }
  1001. */
  1002. static int ubl_state_at_invocation = 0,
  1003. ubl_state_recursion_chk = 0;
  1004. void unified_bed_leveling::save_ubl_active_state_and_disable() {
  1005. ubl_state_recursion_chk++;
  1006. if (ubl_state_recursion_chk != 1) {
  1007. SERIAL_ECHOLNPGM("save_ubl_active_state_and_disabled() called multiple times in a row.");
  1008. LCD_MESSAGEPGM("save_UBL_active() error");
  1009. lcd_quick_feedback();
  1010. return;
  1011. }
  1012. ubl_state_at_invocation = ubl.state.active;
  1013. ubl.state.active = 0;
  1014. }
  1015. void unified_bed_leveling::restore_ubl_active_state_and_leave() {
  1016. if (--ubl_state_recursion_chk) {
  1017. SERIAL_ECHOLNPGM("restore_ubl_active_state_and_leave() called too many times.");
  1018. LCD_MESSAGEPGM("restore_UBL_active() error");
  1019. lcd_quick_feedback();
  1020. return;
  1021. }
  1022. ubl.state.active = ubl_state_at_invocation;
  1023. }
  1024. /**
  1025. * Much of the 'What?' command can be eliminated. But until we are fully debugged, it is
  1026. * good to have the extra information. Soon... we prune this to just a few items
  1027. */
  1028. void g29_what_command() {
  1029. const uint16_t k = E2END - ubl.eeprom_start;
  1030. SERIAL_PROTOCOLPGM("Unified Bed Leveling System Version " UBL_VERSION " ");
  1031. if (ubl.state.active)
  1032. SERIAL_PROTOCOLCHAR('A');
  1033. else
  1034. SERIAL_PROTOCOLPGM("Ina");
  1035. SERIAL_PROTOCOLLNPGM("ctive.\n");
  1036. safe_delay(50);
  1037. if (ubl.state.eeprom_storage_slot == -1)
  1038. SERIAL_PROTOCOLPGM("No Mesh Loaded.");
  1039. else {
  1040. SERIAL_PROTOCOLPAIR("Mesh ", ubl.state.eeprom_storage_slot);
  1041. SERIAL_PROTOCOLPGM(" Loaded.");
  1042. }
  1043. SERIAL_EOL;
  1044. safe_delay(50);
  1045. SERIAL_PROTOCOLLNPAIR("UBL object count: ", ubl_cnt);
  1046. #if ENABLED(ENABLE_LEVELING_FADE_HEIGHT)
  1047. SERIAL_PROTOCOLLNPAIR("planner.z_fade_height : ", planner.z_fade_height);
  1048. #endif
  1049. SERIAL_PROTOCOLPGM("zprobe_zoffset: ");
  1050. SERIAL_PROTOCOL_F(zprobe_zoffset, 7);
  1051. SERIAL_EOL;
  1052. SERIAL_PROTOCOLPGM("z_offset: ");
  1053. SERIAL_PROTOCOL_F(ubl.state.z_offset, 7);
  1054. SERIAL_EOL;
  1055. safe_delay(25);
  1056. SERIAL_PROTOCOLLNPAIR("ubl.eeprom_start=0x", hex_word(ubl.eeprom_start));
  1057. SERIAL_PROTOCOLPGM("X-Axis Mesh Points at: ");
  1058. for (uint8_t i = 0; i < GRID_MAX_POINTS_X; i++) {
  1059. SERIAL_PROTOCOL_F(LOGICAL_X_POSITION(pgm_read_float(&(ubl.mesh_index_to_xpos[i]))), 1);
  1060. SERIAL_PROTOCOLPGM(" ");
  1061. safe_delay(50);
  1062. }
  1063. SERIAL_EOL;
  1064. SERIAL_PROTOCOLPGM("Y-Axis Mesh Points at: ");
  1065. for (uint8_t i = 0; i < GRID_MAX_POINTS_Y; i++) {
  1066. SERIAL_PROTOCOL_F(LOGICAL_Y_POSITION(pgm_read_float(&(ubl.mesh_index_to_ypos[i]))), 1);
  1067. SERIAL_PROTOCOLPGM(" ");
  1068. safe_delay(50);
  1069. }
  1070. SERIAL_EOL;
  1071. #if HAS_KILL
  1072. SERIAL_PROTOCOLPAIR("Kill pin on :", KILL_PIN);
  1073. SERIAL_PROTOCOLLNPAIR(" state:", READ(KILL_PIN));
  1074. #endif
  1075. SERIAL_EOL;
  1076. safe_delay(50);
  1077. SERIAL_PROTOCOLLNPAIR("ubl_state_at_invocation :", ubl_state_at_invocation);
  1078. SERIAL_EOL;
  1079. SERIAL_PROTOCOLLNPAIR("ubl_state_recursion_chk :", ubl_state_recursion_chk);
  1080. SERIAL_EOL;
  1081. safe_delay(50);
  1082. SERIAL_PROTOCOLLNPAIR("Free EEPROM space starts at: ", hex_address((void*)ubl.eeprom_start));
  1083. SERIAL_PROTOCOLLNPAIR("end of EEPROM : ", hex_address((void*)E2END));
  1084. safe_delay(50);
  1085. SERIAL_PROTOCOLLNPAIR("sizeof(ubl) : ", (int)sizeof(ubl));
  1086. SERIAL_EOL;
  1087. SERIAL_PROTOCOLLNPAIR("z_value[][] size: ", (int)sizeof(ubl.z_values));
  1088. SERIAL_EOL;
  1089. safe_delay(50);
  1090. SERIAL_PROTOCOLLNPAIR("EEPROM free for UBL: ", hex_address((void*)k));
  1091. safe_delay(50);
  1092. SERIAL_PROTOCOLPAIR("EEPROM can hold ", k / sizeof(ubl.z_values));
  1093. SERIAL_PROTOCOLLNPGM(" meshes.\n");
  1094. safe_delay(50);
  1095. SERIAL_PROTOCOLPAIR("sizeof(ubl.state) : ", (int)sizeof(ubl.state));
  1096. SERIAL_PROTOCOLPAIR("\nGRID_MAX_POINTS_X ", GRID_MAX_POINTS_X);
  1097. SERIAL_PROTOCOLPAIR("\nGRID_MAX_POINTS_Y ", GRID_MAX_POINTS_Y);
  1098. safe_delay(50);
  1099. SERIAL_PROTOCOLPAIR("\nUBL_MESH_MIN_X ", UBL_MESH_MIN_X);
  1100. SERIAL_PROTOCOLPAIR("\nUBL_MESH_MIN_Y ", UBL_MESH_MIN_Y);
  1101. safe_delay(50);
  1102. SERIAL_PROTOCOLPAIR("\nUBL_MESH_MAX_X ", UBL_MESH_MAX_X);
  1103. SERIAL_PROTOCOLPAIR("\nUBL_MESH_MAX_Y ", UBL_MESH_MAX_Y);
  1104. safe_delay(50);
  1105. SERIAL_PROTOCOLPGM("\nMESH_X_DIST ");
  1106. SERIAL_PROTOCOL_F(MESH_X_DIST, 6);
  1107. SERIAL_PROTOCOLPGM("\nMESH_Y_DIST ");
  1108. SERIAL_PROTOCOL_F(MESH_Y_DIST, 6);
  1109. SERIAL_EOL;
  1110. safe_delay(50);
  1111. if (!ubl.sanity_check())
  1112. SERIAL_PROTOCOLLNPGM("Unified Bed Leveling sanity checks passed.");
  1113. }
  1114. /**
  1115. * When we are fully debugged, the EEPROM dump command will get deleted also. But
  1116. * right now, it is good to have the extra information. Soon... we prune this.
  1117. */
  1118. void g29_eeprom_dump() {
  1119. unsigned char cccc;
  1120. uint16_t kkkk;
  1121. SERIAL_ECHO_START;
  1122. SERIAL_ECHOLNPGM("EEPROM Dump:");
  1123. for (uint16_t i = 0; i < E2END + 1; i += 16) {
  1124. if (!(i & 0x3)) idle();
  1125. print_hex_word(i);
  1126. SERIAL_ECHOPGM(": ");
  1127. for (uint16_t j = 0; j < 16; j++) {
  1128. kkkk = i + j;
  1129. eeprom_read_block(&cccc, (void *)kkkk, 1);
  1130. print_hex_byte(cccc);
  1131. SERIAL_ECHO(' ');
  1132. }
  1133. SERIAL_EOL;
  1134. }
  1135. SERIAL_EOL;
  1136. }
  1137. /**
  1138. * When we are fully debugged, this may go away. But there are some valid
  1139. * use cases for the users. So we can wait and see what to do with it.
  1140. */
  1141. void g29_compare_current_mesh_to_stored_mesh() {
  1142. float tmp_z_values[GRID_MAX_POINTS_X][GRID_MAX_POINTS_Y];
  1143. if (!code_has_value()) {
  1144. SERIAL_PROTOCOLLNPGM("?Mesh # required.\n");
  1145. return;
  1146. }
  1147. storage_slot = code_value_int();
  1148. int16_t j = (UBL_LAST_EEPROM_INDEX - ubl.eeprom_start) / sizeof(tmp_z_values);
  1149. if (!WITHIN(storage_slot, 0, j - 1) || ubl.eeprom_start <= 0) {
  1150. SERIAL_PROTOCOLLNPGM("?EEPROM storage not available for use.\n");
  1151. return;
  1152. }
  1153. j = UBL_LAST_EEPROM_INDEX - (storage_slot + 1) * sizeof(tmp_z_values);
  1154. eeprom_read_block((void *)&tmp_z_values, (void *)j, sizeof(tmp_z_values));
  1155. SERIAL_ECHOPAIR("Subtracting Mesh ", storage_slot);
  1156. SERIAL_PROTOCOLLNPAIR(" loaded from EEPROM address ", hex_address((void*)j)); // Soon, we can remove the extra clutter of printing
  1157. // the address in the EEPROM where the Mesh is stored.
  1158. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++)
  1159. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++)
  1160. ubl.z_values[x][y] -= tmp_z_values[x][y];
  1161. }
  1162. 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) {
  1163. float distance, closest = far_flag ? -99999.99 : 99999.99;
  1164. mesh_index_pair return_val;
  1165. return_val.x_index = return_val.y_index = -1;
  1166. const float current_x = current_position[X_AXIS],
  1167. current_y = current_position[Y_AXIS];
  1168. // Get our reference position. Either the nozzle or probe location.
  1169. const float px = lx - (probe_as_reference==USE_PROBE_AS_REFERENCE ? X_PROBE_OFFSET_FROM_EXTRUDER : 0),
  1170. py = ly - (probe_as_reference==USE_PROBE_AS_REFERENCE ? Y_PROBE_OFFSET_FROM_EXTRUDER : 0);
  1171. for (uint8_t i = 0; i < GRID_MAX_POINTS_X; i++) {
  1172. for (uint8_t j = 0; j < GRID_MAX_POINTS_Y; j++) {
  1173. if ( (type == INVALID && isnan(ubl.z_values[i][j])) // Check to see if this location holds the right thing
  1174. || (type == REAL && !isnan(ubl.z_values[i][j]))
  1175. || (type == SET_IN_BITMAP && is_bit_set(bits, i, j))
  1176. ) {
  1177. // We only get here if we found a Mesh Point of the specified type
  1178. const float rawx = pgm_read_float(&(ubl.mesh_index_to_xpos[i])), // Check if we can probe this mesh location
  1179. rawy = pgm_read_float(&(ubl.mesh_index_to_ypos[j]));
  1180. // If using the probe as the reference there are some unreachable locations.
  1181. // Prune them from the list and ignore them till the next Phase (manual nozzle probing).
  1182. if (probe_as_reference==USE_PROBE_AS_REFERENCE &&
  1183. (!WITHIN(rawx, MIN_PROBE_X, MAX_PROBE_X) || !WITHIN(rawy, MIN_PROBE_Y, MAX_PROBE_Y))
  1184. ) continue;
  1185. // Unreachable. Check if it's the closest location to the nozzle.
  1186. // Add in a weighting factor that considers the current location of the nozzle.
  1187. const float mx = LOGICAL_X_POSITION(rawx), // Check if we can probe this mesh location
  1188. my = LOGICAL_Y_POSITION(rawy);
  1189. distance = HYPOT(px - mx, py - my) + HYPOT(current_x - mx, current_y - my) * 0.1;
  1190. if (far_flag) { // If doing the far_flag action, we want to be as far as possible
  1191. for (uint8_t k = 0; k < GRID_MAX_POINTS_X; k++) { // from the starting point and from any other probed points. We
  1192. for (uint8_t l = 0; l < GRID_MAX_POINTS_Y; l++) { // want the next point spread out and filling in any blank spaces
  1193. if (!isnan(ubl.z_values[k][l])) { // in the mesh. So we add in some of the distance to every probed
  1194. distance += sq(i - k) * (MESH_X_DIST) * .05 // point we can find.
  1195. + sq(j - l) * (MESH_Y_DIST) * .05;
  1196. }
  1197. }
  1198. }
  1199. }
  1200. if (far_flag == (distance > closest) && distance != closest) { // if far_flag, look for farthest point
  1201. closest = distance; // We found a closer/farther location with
  1202. return_val.x_index = i; // the specified type of mesh value.
  1203. return_val.y_index = j;
  1204. return_val.distance = closest;
  1205. }
  1206. }
  1207. } // for j
  1208. } // for i
  1209. return return_val;
  1210. }
  1211. void fine_tune_mesh(const float &lx, const float &ly, const bool do_ubl_mesh_map) {
  1212. if (!code_seen('R')) // fine_tune_mesh() is special. If no repetion count flag is specified
  1213. repetition_cnt = 1; // we know to do exactly one mesh location. Otherwise we use what the parser decided.
  1214. mesh_index_pair location;
  1215. uint16_t not_done[16];
  1216. int32_t round_off;
  1217. ubl.save_ubl_active_state_and_disable();
  1218. memset(not_done, 0xFF, sizeof(not_done));
  1219. LCD_MESSAGEPGM("Fine Tuning Mesh");
  1220. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  1221. do_blocking_move_to_xy(lx, ly);
  1222. do {
  1223. location = find_closest_mesh_point_of_type(SET_IN_BITMAP, lx, ly, USE_NOZZLE_AS_REFERENCE, not_done, false);
  1224. // It doesn't matter if the probe can not reach this
  1225. // location. This is a manual edit of the Mesh Point.
  1226. if (location.x_index < 0 && location.y_index < 0) continue; // abort if we can't find any more points.
  1227. bit_clear(not_done, location.x_index, location.y_index); // Mark this location as 'adjusted' so we will find a
  1228. // different location the next time through the loop
  1229. const float rawx = pgm_read_float(&(ubl.mesh_index_to_xpos[location.x_index])),
  1230. rawy = pgm_read_float(&(ubl.mesh_index_to_ypos[location.y_index]));
  1231. // TODO: Change to use `position_is_reachable` (for SCARA-compatibility)
  1232. 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.
  1233. SERIAL_ERROR_START;
  1234. SERIAL_ERRORLNPGM("Attempt to edit off the bed."); // This really can't happen, but do the check for now
  1235. ubl.has_control_of_lcd_panel = false;
  1236. goto FINE_TUNE_EXIT;
  1237. }
  1238. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE); // Move the nozzle to where we are going to edit
  1239. do_blocking_move_to_xy(LOGICAL_X_POSITION(rawx), LOGICAL_Y_POSITION(rawy));
  1240. float new_z = ubl.z_values[location.x_index][location.y_index];
  1241. round_off = (int32_t)(new_z * 1000.0); // we chop off the last digits just to be clean. We are rounding to the
  1242. new_z = float(round_off) / 1000.0;
  1243. KEEPALIVE_STATE(PAUSED_FOR_USER);
  1244. ubl.has_control_of_lcd_panel = true;
  1245. if (do_ubl_mesh_map) ubl.display_map(map_type); // show the user which point is being adjusted
  1246. lcd_implementation_clear();
  1247. lcd_mesh_edit_setup(new_z);
  1248. do {
  1249. new_z = lcd_mesh_edit();
  1250. idle();
  1251. } while (!ubl_lcd_clicked());
  1252. lcd_return_to_status();
  1253. ubl.has_control_of_lcd_panel = true; // There is a race condition for the Encoder Wheel getting clicked.
  1254. // It could get detected in lcd_mesh_edit (actually _lcd_mesh_fine_tune)
  1255. // or here.
  1256. const millis_t nxt = millis() + 1500UL;
  1257. while (ubl_lcd_clicked()) { // debounce and watch for abort
  1258. idle();
  1259. if (ELAPSED(millis(), nxt)) {
  1260. lcd_return_to_status();
  1261. //SERIAL_PROTOCOLLNPGM("\nFine Tuning of Mesh Stopped.");
  1262. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  1263. LCD_MESSAGEPGM("Mesh Editing Stopped");
  1264. while (ubl_lcd_clicked()) idle();
  1265. goto FINE_TUNE_EXIT;
  1266. }
  1267. }
  1268. safe_delay(20); // We don't want any switch noise.
  1269. ubl.z_values[location.x_index][location.y_index] = new_z;
  1270. lcd_implementation_clear();
  1271. } while (location.x_index >= 0 && location.y_index >= 0 && (--repetition_cnt>0));
  1272. FINE_TUNE_EXIT:
  1273. ubl.has_control_of_lcd_panel = false;
  1274. KEEPALIVE_STATE(IN_HANDLER);
  1275. if (do_ubl_mesh_map) ubl.display_map(map_type);
  1276. ubl.restore_ubl_active_state_and_leave();
  1277. do_blocking_move_to_z(Z_CLEARANCE_DEPLOY_PROBE);
  1278. do_blocking_move_to_xy(lx, ly);
  1279. LCD_MESSAGEPGM("Done Editing Mesh");
  1280. SERIAL_ECHOLNPGM("Done Editing Mesh");
  1281. }
  1282. //
  1283. // The routine provides the 'Smart Fill' capability. It scans from the
  1284. // outward edges of the mesh towards the center. If it finds an invalid
  1285. // location, it uses the next two points (assumming they are valid) to
  1286. // calculate a 'reasonable' value for the unprobed mesh point.
  1287. //
  1288. void smart_fill_mesh() {
  1289. float f, diff;
  1290. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++) { // Bottom of the mesh looking up
  1291. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y-2; y++) {
  1292. if (isnan(ubl.z_values[x][y])) {
  1293. if (isnan(ubl.z_values[x][y+1])) // we only deal with the first NAN next to a block of
  1294. continue; // good numbers. we want 2 good numbers to extrapolate off of.
  1295. if (isnan(ubl.z_values[x][y+2]))
  1296. continue;
  1297. 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
  1298. ubl.z_values[x][y] = ubl.z_values[x][y+1]; // use the closest value, which is probably a little too high
  1299. else {
  1300. 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
  1301. ubl.z_values[x][y] = ubl.z_values[x][y+1] + diff; // height and add in the difference between that and the next point
  1302. }
  1303. break;
  1304. }
  1305. }
  1306. }
  1307. for (uint8_t x = 0; x < GRID_MAX_POINTS_X; x++) { // Top of the mesh looking down
  1308. for (uint8_t y=GRID_MAX_POINTS_Y-1; y>=1; y--) {
  1309. if (isnan(ubl.z_values[x][y])) {
  1310. if (isnan(ubl.z_values[x][y-1])) // we only deal with the first NAN next to a block of
  1311. continue; // good numbers. we want 2 good numbers to extrapolate off of.
  1312. if (isnan(ubl.z_values[x][y-2]))
  1313. continue;
  1314. 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
  1315. ubl.z_values[x][y] = ubl.z_values[x][y-1]; // use the closest value, which is probably a little too high
  1316. else {
  1317. 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
  1318. ubl.z_values[x][y] = ubl.z_values[x][y-1] + diff; // height and add in the difference between that and the next point
  1319. }
  1320. break;
  1321. }
  1322. }
  1323. }
  1324. for (uint8_t y = 0; y < GRID_MAX_POINTS_Y; y++) {
  1325. for (uint8_t x = 0; x < GRID_MAX_POINTS_X-2; x++) { // Left side of the mesh looking right
  1326. if (isnan(ubl.z_values[x][y])) {
  1327. if (isnan(ubl.z_values[x+1][y])) // we only deal with the first NAN next to a block of
  1328. continue; // good numbers. we want 2 good numbers to extrapolate off of.
  1329. if (isnan(ubl.z_values[x+2][y]))
  1330. continue;
  1331. 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
  1332. ubl.z_values[x][y] = ubl.z_values[x][y+1]; // use the closest value, which is probably a little too high
  1333. else {
  1334. 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
  1335. ubl.z_values[x][y] = ubl.z_values[x+1][y] + diff; // height and add in the difference between that and the next point
  1336. }
  1337. break;
  1338. }
  1339. }
  1340. }
  1341. for (uint8_t y=0; y < GRID_MAX_POINTS_Y; y++) {
  1342. for (uint8_t x=GRID_MAX_POINTS_X-1; x>=1; x--) { // Right side of the mesh looking left
  1343. if (isnan(ubl.z_values[x][y])) {
  1344. if (isnan(ubl.z_values[x-1][y])) // we only deal with the first NAN next to a block of
  1345. continue; // good numbers. we want 2 good numbers to extrapolate off of.
  1346. if (isnan(ubl.z_values[x-2][y]))
  1347. continue;
  1348. 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
  1349. ubl.z_values[x][y] = ubl.z_values[x-1][y]; // use the closest value, which is probably a little too high
  1350. else {
  1351. 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
  1352. ubl.z_values[x][y] = ubl.z_values[x-1][y] + diff; // height and add in the difference between that and the next point
  1353. }
  1354. break;
  1355. }
  1356. }
  1357. }
  1358. }
  1359. void unified_bed_leveling::tilt_mesh_based_on_probed_grid(const bool do_ubl_mesh_map) {
  1360. int8_t i, j ,k, xCount, yCount, xi, yi; // counter variables
  1361. int8_t ix, iy, zig_zag=0, status;
  1362. float dx, dy, x, y, measured_z, inv_z;
  1363. struct linear_fit_data lsf_results;
  1364. matrix_3x3 rotation;
  1365. vector_3 normal;
  1366. int16_t x_min = max((MIN_PROBE_X),(UBL_MESH_MIN_X)),
  1367. x_max = min((MAX_PROBE_X),(UBL_MESH_MAX_X)),
  1368. y_min = max((MIN_PROBE_Y),(UBL_MESH_MIN_Y)),
  1369. y_max = min((MAX_PROBE_Y),(UBL_MESH_MAX_Y));
  1370. dx = ((float)(x_max-x_min)) / (grid_size-1.0);
  1371. dy = ((float)(y_max-y_min)) / (grid_size-1.0);
  1372. incremental_LSF_reset(&lsf_results);
  1373. for(ix=0; ix<grid_size; ix++) {
  1374. x = ((float)x_min) + ix*dx;
  1375. for(iy=0; iy<grid_size; iy++) {
  1376. if (zig_zag)
  1377. y = ((float)y_min) + (grid_size-iy-1)*dy;
  1378. else
  1379. y = ((float)y_min) + iy*dy;
  1380. measured_z = probe_pt(LOGICAL_X_POSITION(x), LOGICAL_Y_POSITION(y), code_seen('E'), g29_verbose_level);
  1381. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1382. if (DEBUGGING(LEVELING)) {
  1383. SERIAL_ECHOPGM("(");
  1384. SERIAL_PROTOCOL_F( x, 7);
  1385. SERIAL_ECHOPGM(",");
  1386. SERIAL_PROTOCOL_F( y, 7);
  1387. SERIAL_ECHOPGM(") logical: ");
  1388. SERIAL_ECHOPGM("(");
  1389. SERIAL_PROTOCOL_F( LOGICAL_X_POSITION(x), 7);
  1390. SERIAL_ECHOPGM(",");
  1391. SERIAL_PROTOCOL_F( LOGICAL_X_POSITION(y), 7);
  1392. SERIAL_ECHOPGM(") measured: ");
  1393. SERIAL_PROTOCOL_F( measured_z, 7);
  1394. SERIAL_ECHOPGM(" correction: ");
  1395. SERIAL_PROTOCOL_F( ubl.get_z_correction(LOGICAL_X_POSITION(x), LOGICAL_Y_POSITION(y)), 7);
  1396. }
  1397. #endif
  1398. measured_z -= ubl.get_z_correction(LOGICAL_X_POSITION(x), LOGICAL_Y_POSITION(y)) /* + zprobe_zoffset */ ;
  1399. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1400. if (DEBUGGING(LEVELING)) {
  1401. SERIAL_ECHOPGM(" final >>>---> ");
  1402. SERIAL_PROTOCOL_F( measured_z, 7);
  1403. SERIAL_ECHOPGM("\n");
  1404. }
  1405. #endif
  1406. incremental_LSF(&lsf_results, x, y, measured_z);
  1407. }
  1408. zig_zag = !zig_zag;
  1409. }
  1410. status = finish_incremental_LSF(&lsf_results);
  1411. if (g29_verbose_level>3) {
  1412. SERIAL_ECHOPGM("LSF Results A=");
  1413. SERIAL_PROTOCOL_F( lsf_results.A, 7);
  1414. SERIAL_ECHOPGM(" B=");
  1415. SERIAL_PROTOCOL_F( lsf_results.B, 7);
  1416. SERIAL_ECHOPGM(" D=");
  1417. SERIAL_PROTOCOL_F( lsf_results.D, 7);
  1418. SERIAL_CHAR('\n');
  1419. }
  1420. normal = vector_3( lsf_results.A, lsf_results.B, 1.0000);
  1421. normal = normal.get_normal();
  1422. if (g29_verbose_level>2) {
  1423. SERIAL_ECHOPGM("bed plane normal = [");
  1424. SERIAL_PROTOCOL_F( normal.x, 7);
  1425. SERIAL_ECHOPGM(",");
  1426. SERIAL_PROTOCOL_F( normal.y, 7);
  1427. SERIAL_ECHOPGM(",");
  1428. SERIAL_PROTOCOL_F( normal.z, 7);
  1429. SERIAL_ECHOPGM("]\n");
  1430. }
  1431. rotation = matrix_3x3::create_look_at( vector_3( lsf_results.A, lsf_results.B, 1));
  1432. for (i = 0; i < GRID_MAX_POINTS_X; i++) {
  1433. for (j = 0; j < GRID_MAX_POINTS_Y; j++) {
  1434. float x_tmp, y_tmp, z_tmp;
  1435. x_tmp = pgm_read_float(&(ubl.mesh_index_to_xpos[i]));
  1436. y_tmp = pgm_read_float(&(ubl.mesh_index_to_ypos[j]));
  1437. z_tmp = ubl.z_values[i][j];
  1438. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1439. if (DEBUGGING(LEVELING)) {
  1440. SERIAL_ECHOPGM("before rotation = [");
  1441. SERIAL_PROTOCOL_F( x_tmp, 7);
  1442. SERIAL_ECHOPGM(",");
  1443. SERIAL_PROTOCOL_F( y_tmp, 7);
  1444. SERIAL_ECHOPGM(",");
  1445. SERIAL_PROTOCOL_F( z_tmp, 7);
  1446. SERIAL_ECHOPGM("] ---> ");
  1447. safe_delay(20);
  1448. }
  1449. #endif
  1450. apply_rotation_xyz(rotation, x_tmp, y_tmp, z_tmp);
  1451. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1452. if (DEBUGGING(LEVELING)) {
  1453. SERIAL_ECHOPGM("after rotation = [");
  1454. SERIAL_PROTOCOL_F( x_tmp, 7);
  1455. SERIAL_ECHOPGM(",");
  1456. SERIAL_PROTOCOL_F( y_tmp, 7);
  1457. SERIAL_ECHOPGM(",");
  1458. SERIAL_PROTOCOL_F( z_tmp, 7);
  1459. SERIAL_ECHOPGM("]\n");
  1460. safe_delay(55);
  1461. }
  1462. #endif
  1463. ubl.z_values[i][j] += z_tmp - lsf_results.D;
  1464. }
  1465. }
  1466. #if ENABLED(DEBUG_LEVELING_FEATURE)
  1467. if (DEBUGGING(LEVELING)) {
  1468. rotation.debug("rotation matrix:");
  1469. SERIAL_ECHOPGM("LSF Results A=");
  1470. SERIAL_PROTOCOL_F( lsf_results.A, 7);
  1471. SERIAL_ECHOPGM(" B=");
  1472. SERIAL_PROTOCOL_F( lsf_results.B, 7);
  1473. SERIAL_ECHOPGM(" D=");
  1474. SERIAL_PROTOCOL_F( lsf_results.D, 7);
  1475. SERIAL_CHAR('\n');
  1476. safe_delay(55);
  1477. SERIAL_ECHOPGM("bed plane normal = [");
  1478. SERIAL_PROTOCOL_F( normal.x, 7);
  1479. SERIAL_ECHOPGM(",");
  1480. SERIAL_PROTOCOL_F( normal.y, 7);
  1481. SERIAL_ECHOPGM(",");
  1482. SERIAL_PROTOCOL_F( normal.z, 7);
  1483. SERIAL_ECHOPGM("]\n");
  1484. SERIAL_CHAR('\n');
  1485. }
  1486. #endif
  1487. return;
  1488. }
  1489. #endif // AUTO_BED_LEVELING_UBL