planner.cpp 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385
  1. /*
  2. planner.c - buffers movement commands and manages the acceleration profile plan
  3. Part of Grbl
  4. Copyright (c) 2009-2011 Simen Svale Skogsrud
  5. Grbl is free software: you can redistribute it and/or modify
  6. it under the terms of the GNU General Public License as published by
  7. the Free Software Foundation, either version 3 of the License, or
  8. (at your option) any later version.
  9. Grbl is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. GNU General Public License for more details.
  13. You should have received a copy of the GNU General Public License
  14. along with Grbl. If not, see <http://www.gnu.org/licenses/>.
  15. */
  16. /* The ring buffer implementation gleaned from the wiring_serial library by David A. Mellis. */
  17. /*
  18. Reasoning behind the mathematics in this module (in the key of 'Mathematica'):
  19. s == speed, a == acceleration, t == time, d == distance
  20. Basic definitions:
  21. Speed[s_, a_, t_] := s + (a*t)
  22. Travel[s_, a_, t_] := Integrate[Speed[s, a, t], t]
  23. Distance to reach a specific speed with a constant acceleration:
  24. Solve[{Speed[s, a, t] == m, Travel[s, a, t] == d}, d, t]
  25. d -> (m^2 - s^2)/(2 a) --> estimate_acceleration_distance()
  26. Speed after a given distance of travel with constant acceleration:
  27. Solve[{Speed[s, a, t] == m, Travel[s, a, t] == d}, m, t]
  28. m -> Sqrt[2 a d + s^2]
  29. DestinationSpeed[s_, a_, d_] := Sqrt[2 a d + s^2]
  30. When to start braking (di) to reach a specified destionation speed (s2) after accelerating
  31. from initial speed s1 without ever stopping at a plateau:
  32. Solve[{DestinationSpeed[s1, a, di] == DestinationSpeed[s2, a, d - di]}, di]
  33. di -> (2 a d - s1^2 + s2^2)/(4 a) --> intersection_distance()
  34. IntersectionDistance[s1_, s2_, a_, d_] := (2 a d - s1^2 + s2^2)/(4 a)
  35. */
  36. #include "Marlin.h"
  37. #include "planner.h"
  38. #include "stepper.h"
  39. #include "temperature.h"
  40. #include "ultralcd.h"
  41. #include "language.h"
  42. #ifdef MESH_BED_LEVELING
  43. #include "mesh_bed_leveling.h"
  44. #include "mesh_bed_calibration.h"
  45. #endif
  46. #ifdef TMC2130
  47. #include "tmc2130.h"
  48. #endif //TMC2130
  49. //===========================================================================
  50. //=============================public variables ============================
  51. //===========================================================================
  52. unsigned long minsegmenttime;
  53. float max_feedrate[NUM_AXIS]; // set the max speeds
  54. float axis_steps_per_unit[NUM_AXIS];
  55. unsigned long max_acceleration_units_per_sq_second[NUM_AXIS]; // Use M201 to override by software
  56. float minimumfeedrate;
  57. float acceleration; // Normal acceleration mm/s^2 THIS IS THE DEFAULT ACCELERATION for all moves. M204 SXXXX
  58. float retract_acceleration; // mm/s^2 filament pull-pack and push-forward while standing still in the other axis M204 TXXXX
  59. // Jerk is a maximum immediate velocity change.
  60. float max_jerk[NUM_AXIS];
  61. float mintravelfeedrate;
  62. unsigned long axis_steps_per_sqr_second[NUM_AXIS];
  63. #ifdef ENABLE_AUTO_BED_LEVELING
  64. // this holds the required transform to compensate for bed level
  65. matrix_3x3 plan_bed_level_matrix = {
  66. 1.0, 0.0, 0.0,
  67. 0.0, 1.0, 0.0,
  68. 0.0, 0.0, 1.0,
  69. };
  70. #endif // #ifdef ENABLE_AUTO_BED_LEVELING
  71. // The current position of the tool in absolute steps
  72. long position[NUM_AXIS]; //rescaled from extern when axis_steps_per_unit are changed by gcode
  73. static float previous_speed[NUM_AXIS]; // Speed of previous path line segment
  74. static float previous_nominal_speed; // Nominal speed of previous path line segment
  75. static float previous_safe_speed; // Exit speed limited by a jerk to full halt of a previous last segment.
  76. #ifdef AUTOTEMP
  77. float autotemp_max=250;
  78. float autotemp_min=210;
  79. float autotemp_factor=0.1;
  80. bool autotemp_enabled=false;
  81. #endif
  82. unsigned char g_uc_extruder_last_move[3] = {0,0,0};
  83. //===========================================================================
  84. //=================semi-private variables, used in inline functions =====
  85. //===========================================================================
  86. block_t block_buffer[BLOCK_BUFFER_SIZE]; // A ring buffer for motion instfructions
  87. volatile unsigned char block_buffer_head; // Index of the next block to be pushed
  88. volatile unsigned char block_buffer_tail; // Index of the block to process now
  89. #ifdef PLANNER_DIAGNOSTICS
  90. // Diagnostic function: Minimum number of planned moves since the last
  91. static uint8_t g_cntr_planner_queue_min = 0;
  92. #endif /* PLANNER_DIAGNOSTICS */
  93. //===========================================================================
  94. //=============================private variables ============================
  95. //===========================================================================
  96. #ifdef PREVENT_DANGEROUS_EXTRUDE
  97. float extrude_min_temp=EXTRUDE_MINTEMP;
  98. #endif
  99. #ifdef LIN_ADVANCE
  100. float extruder_advance_k = LIN_ADVANCE_K,
  101. advance_ed_ratio = LIN_ADVANCE_E_D_RATIO,
  102. position_float[NUM_AXIS] = { 0 };
  103. #endif
  104. // Returns the index of the next block in the ring buffer
  105. // NOTE: Removed modulo (%) operator, which uses an expensive divide and multiplication.
  106. static inline int8_t next_block_index(int8_t block_index) {
  107. if (++ block_index == BLOCK_BUFFER_SIZE)
  108. block_index = 0;
  109. return block_index;
  110. }
  111. // Returns the index of the previous block in the ring buffer
  112. static inline int8_t prev_block_index(int8_t block_index) {
  113. if (block_index == 0)
  114. block_index = BLOCK_BUFFER_SIZE;
  115. -- block_index;
  116. return block_index;
  117. }
  118. //===========================================================================
  119. //=============================functions ============================
  120. //===========================================================================
  121. // Calculates the distance (not time) it takes to accelerate from initial_rate to target_rate using the
  122. // given acceleration:
  123. FORCE_INLINE float estimate_acceleration_distance(float initial_rate, float target_rate, float acceleration)
  124. {
  125. if (acceleration!=0) {
  126. return((target_rate*target_rate-initial_rate*initial_rate)/
  127. (2.0*acceleration));
  128. }
  129. else {
  130. return 0.0; // acceleration was 0, set acceleration distance to 0
  131. }
  132. }
  133. // This function gives you the point at which you must start braking (at the rate of -acceleration) if
  134. // you started at speed initial_rate and accelerated until this point and want to end at the final_rate after
  135. // a total travel of distance. This can be used to compute the intersection point between acceleration and
  136. // deceleration in the cases where the trapezoid has no plateau (i.e. never reaches maximum speed)
  137. FORCE_INLINE float intersection_distance(float initial_rate, float final_rate, float acceleration, float distance)
  138. {
  139. if (acceleration!=0) {
  140. return((2.0*acceleration*distance-initial_rate*initial_rate+final_rate*final_rate)/
  141. (4.0*acceleration) );
  142. }
  143. else {
  144. return 0.0; // acceleration was 0, set intersection distance to 0
  145. }
  146. }
  147. // Minimum stepper rate 120Hz.
  148. #define MINIMAL_STEP_RATE 120
  149. // Calculates trapezoid parameters so that the entry- and exit-speed is compensated by the provided factors.
  150. void calculate_trapezoid_for_block(block_t *block, float entry_speed, float exit_speed)
  151. {
  152. // These two lines are the only floating point calculations performed in this routine.
  153. // initial_rate, final_rate in Hz.
  154. // Minimum stepper rate 120Hz, maximum 40kHz. If the stepper rate goes above 10kHz,
  155. // the stepper interrupt routine groups the pulses by 2 or 4 pulses per interrupt tick.
  156. uint32_t initial_rate = ceil(entry_speed * block->speed_factor); // (step/min)
  157. uint32_t final_rate = ceil(exit_speed * block->speed_factor); // (step/min)
  158. // Limit minimal step rate (Otherwise the timer will overflow.)
  159. if (initial_rate < MINIMAL_STEP_RATE)
  160. initial_rate = MINIMAL_STEP_RATE;
  161. if (initial_rate > block->nominal_rate)
  162. initial_rate = block->nominal_rate;
  163. if (final_rate < MINIMAL_STEP_RATE)
  164. final_rate = MINIMAL_STEP_RATE;
  165. if (final_rate > block->nominal_rate)
  166. final_rate = block->nominal_rate;
  167. uint32_t acceleration = block->acceleration_st;
  168. if (acceleration == 0)
  169. // Don't allow zero acceleration.
  170. acceleration = 1;
  171. // estimate_acceleration_distance(float initial_rate, float target_rate, float acceleration)
  172. // (target_rate*target_rate-initial_rate*initial_rate)/(2.0*acceleration));
  173. uint32_t initial_rate_sqr = initial_rate*initial_rate;
  174. //FIXME assert that this result fits a 64bit unsigned int.
  175. uint32_t nominal_rate_sqr = block->nominal_rate*block->nominal_rate;
  176. uint32_t final_rate_sqr = final_rate*final_rate;
  177. uint32_t acceleration_x2 = acceleration << 1;
  178. // ceil(estimate_acceleration_distance(initial_rate, block->nominal_rate, acceleration));
  179. uint32_t accelerate_steps = (nominal_rate_sqr - initial_rate_sqr + acceleration_x2 - 1) / acceleration_x2;
  180. // floor(estimate_acceleration_distance(block->nominal_rate, final_rate, -acceleration));
  181. uint32_t decelerate_steps = (nominal_rate_sqr - final_rate_sqr) / acceleration_x2;
  182. uint32_t accel_decel_steps = accelerate_steps + decelerate_steps;
  183. // Size of Plateau of Nominal Rate.
  184. uint32_t plateau_steps = 0;
  185. // Is the Plateau of Nominal Rate smaller than nothing? That means no cruising, and we will
  186. // have to use intersection_distance() to calculate when to abort acceleration and start braking
  187. // in order to reach the final_rate exactly at the end of this block.
  188. if (accel_decel_steps < block->step_event_count.wide) {
  189. plateau_steps = block->step_event_count.wide - accel_decel_steps;
  190. } else {
  191. uint32_t acceleration_x4 = acceleration << 2;
  192. // Avoid negative numbers
  193. if (final_rate_sqr >= initial_rate_sqr) {
  194. // accelerate_steps = ceil(intersection_distance(initial_rate, final_rate, acceleration, block->step_event_count));
  195. // intersection_distance(float initial_rate, float final_rate, float acceleration, float distance)
  196. // (2.0*acceleration*distance-initial_rate*initial_rate+final_rate*final_rate)/(4.0*acceleration);
  197. #if 0
  198. accelerate_steps = (block->step_event_count >> 1) + (final_rate_sqr - initial_rate_sqr + acceleration_x4 - 1 + (block->step_event_count & 1) * acceleration_x2) / acceleration_x4;
  199. #else
  200. accelerate_steps = final_rate_sqr - initial_rate_sqr + acceleration_x4 - 1;
  201. if (block->step_event_count.wide & 1)
  202. accelerate_steps += acceleration_x2;
  203. accelerate_steps /= acceleration_x4;
  204. accelerate_steps += (block->step_event_count.wide >> 1);
  205. #endif
  206. if (accelerate_steps > block->step_event_count.wide)
  207. accelerate_steps = block->step_event_count.wide;
  208. } else {
  209. #if 0
  210. decelerate_steps = (block->step_event_count >> 1) + (initial_rate_sqr - final_rate_sqr + (block->step_event_count & 1) * acceleration_x2) / acceleration_x4;
  211. #else
  212. decelerate_steps = initial_rate_sqr - final_rate_sqr;
  213. if (block->step_event_count.wide & 1)
  214. decelerate_steps += acceleration_x2;
  215. decelerate_steps /= acceleration_x4;
  216. decelerate_steps += (block->step_event_count.wide >> 1);
  217. #endif
  218. if (decelerate_steps > block->step_event_count.wide)
  219. decelerate_steps = block->step_event_count.wide;
  220. accelerate_steps = block->step_event_count.wide - decelerate_steps;
  221. }
  222. }
  223. CRITICAL_SECTION_START; // Fill variables used by the stepper in a critical section
  224. // This block locks the interrupts globally for 4.38 us,
  225. // which corresponds to a maximum repeat frequency of 228.57 kHz.
  226. // This blocking is safe in the context of a 10kHz stepper driver interrupt
  227. // or a 115200 Bd serial line receive interrupt, which will not trigger faster than 12kHz.
  228. if (! block->busy) { // Don't update variables if block is busy.
  229. block->accelerate_until = accelerate_steps;
  230. block->decelerate_after = accelerate_steps+plateau_steps;
  231. block->initial_rate = initial_rate;
  232. block->final_rate = final_rate;
  233. }
  234. CRITICAL_SECTION_END;
  235. }
  236. // Calculates the maximum allowable entry speed, when you must be able to reach target_velocity using the
  237. // decceleration within the allotted distance.
  238. FORCE_INLINE float max_allowable_entry_speed(float decceleration, float target_velocity, float distance)
  239. {
  240. // assert(decceleration < 0);
  241. return sqrt(target_velocity*target_velocity-2*decceleration*distance);
  242. }
  243. // Recalculates the motion plan according to the following algorithm:
  244. //
  245. // 1. Go over every block in reverse order and calculate a junction speed reduction (i.e. block_t.entry_factor)
  246. // so that:
  247. // a. The junction jerk is within the set limit
  248. // b. No speed reduction within one block requires faster deceleration than the one, true constant
  249. // acceleration.
  250. // 2. Go over every block in chronological order and dial down junction speed reduction values if
  251. // a. The speed increase within one block would require faster accelleration than the one, true
  252. // constant acceleration.
  253. //
  254. // When these stages are complete all blocks have an entry_factor that will allow all speed changes to
  255. // be performed using only the one, true constant acceleration, and where no junction jerk is jerkier than
  256. // the set limit. Finally it will:
  257. //
  258. // 3. Recalculate trapezoids for all blocks.
  259. //
  260. //FIXME This routine is called 15x every time a new line is added to the planner,
  261. // therefore it is a bottle neck and it shall be rewritten into a Fixed Point arithmetics,
  262. // if the CPU is found lacking computational power.
  263. //
  264. // Following sources may be used to optimize the 8-bit AVR code:
  265. // http://www.mikrocontroller.net/articles/AVR_Arithmetik
  266. // http://darcy.rsgc.on.ca/ACES/ICE4M/FixedPoint/avrfix.pdf
  267. //
  268. // https://github.com/gcc-mirror/gcc/blob/master/libgcc/config/avr/lib1funcs-fixed.S
  269. // https://gcc.gnu.org/onlinedocs/gcc/Fixed-Point.html
  270. // https://gcc.gnu.org/onlinedocs/gccint/Fixed-point-fractional-library-routines.html
  271. //
  272. // https://ucexperiment.wordpress.com/2015/04/04/arduino-s15-16-fixed-point-math-routines/
  273. // https://mekonik.wordpress.com/2009/03/18/arduino-avr-gcc-multiplication/
  274. // https://github.com/rekka/avrmultiplication
  275. //
  276. // https://people.ece.cornell.edu/land/courses/ece4760/Math/Floating_point/
  277. // https://courses.cit.cornell.edu/ee476/Math/
  278. // https://courses.cit.cornell.edu/ee476/Math/GCC644/fixedPt/multASM.S
  279. //
  280. void planner_recalculate(const float &safe_final_speed)
  281. {
  282. // Reverse pass
  283. // Make a local copy of block_buffer_tail, because the interrupt can alter it
  284. // by consuming the blocks, therefore shortening the queue.
  285. unsigned char tail = block_buffer_tail;
  286. uint8_t block_index;
  287. block_t *prev, *current, *next;
  288. // SERIAL_ECHOLNPGM("planner_recalculate - 1");
  289. // At least three blocks are in the queue?
  290. unsigned char n_blocks = (block_buffer_head + BLOCK_BUFFER_SIZE - tail) & (BLOCK_BUFFER_SIZE - 1);
  291. if (n_blocks >= 3) {
  292. // Initialize the last tripple of blocks.
  293. block_index = prev_block_index(block_buffer_head);
  294. next = block_buffer + block_index;
  295. current = block_buffer + (block_index = prev_block_index(block_index));
  296. // No need to recalculate the last block, it has already been set by the plan_buffer_line() function.
  297. // Vojtech thinks, that one shall not touch the entry speed of the very first block as well, because
  298. // 1) it may already be running at the stepper interrupt,
  299. // 2) there is no way to limit it when going in the forward direction.
  300. while (block_index != tail) {
  301. if (current->flag & BLOCK_FLAG_START_FROM_FULL_HALT) {
  302. // Don't modify the entry velocity of the starting block.
  303. // Also don't modify the trapezoids before this block, they are finalized already, prepared
  304. // for the stepper interrupt routine to use them.
  305. tail = block_index;
  306. // Update the number of blocks to process.
  307. n_blocks = (block_buffer_head + BLOCK_BUFFER_SIZE - tail) & (BLOCK_BUFFER_SIZE - 1);
  308. // SERIAL_ECHOLNPGM("START");
  309. break;
  310. }
  311. // If entry speed is already at the maximum entry speed, no need to recheck. Block is cruising.
  312. // If not, block in state of acceleration or deceleration. Reset entry speed to maximum and
  313. // check for maximum allowable speed reductions to ensure maximum possible planned speed.
  314. if (current->entry_speed != current->max_entry_speed) {
  315. // assert(current->entry_speed < current->max_entry_speed);
  316. // Entry speed could be increased up to the max_entry_speed, limited by the length of the current
  317. // segment and the maximum acceleration allowed for this segment.
  318. // If nominal length true, max junction speed is guaranteed to be reached even if decelerating to a jerk-from-zero velocity.
  319. // Only compute for max allowable speed if block is decelerating and nominal length is false.
  320. // entry_speed is uint16_t, 24 bits would be sufficient for block->acceleration and block->millimiteres, if scaled to um.
  321. // therefore an optimized assembly 24bit x 24bit -> 32bit multiply would be more than sufficient
  322. // together with an assembly 32bit->16bit sqrt function.
  323. current->entry_speed = ((current->flag & BLOCK_FLAG_NOMINAL_LENGTH) || current->max_entry_speed <= next->entry_speed) ?
  324. current->max_entry_speed :
  325. // min(current->max_entry_speed, sqrt(next->entry_speed*next->entry_speed+2*current->acceleration*current->millimeters));
  326. min(current->max_entry_speed, max_allowable_entry_speed(-current->acceleration,next->entry_speed,current->millimeters));
  327. current->flag |= BLOCK_FLAG_RECALCULATE;
  328. }
  329. next = current;
  330. current = block_buffer + (block_index = prev_block_index(block_index));
  331. }
  332. }
  333. // SERIAL_ECHOLNPGM("planner_recalculate - 2");
  334. // Forward pass and recalculate the trapezoids.
  335. if (n_blocks >= 2) {
  336. // Better to limit the velocities using the already processed block, if it is available, so rather use the saved tail.
  337. block_index = tail;
  338. prev = block_buffer + block_index;
  339. current = block_buffer + (block_index = next_block_index(block_index));
  340. do {
  341. // If the previous block is an acceleration block, but it is not long enough to complete the
  342. // full speed change within the block, we need to adjust the entry speed accordingly. Entry
  343. // speeds have already been reset, maximized, and reverse planned by reverse planner.
  344. // If nominal length is true, max junction speed is guaranteed to be reached. No need to recheck.
  345. if (! (prev->flag & BLOCK_FLAG_NOMINAL_LENGTH) && prev->entry_speed < current->entry_speed) {
  346. float entry_speed = min(current->entry_speed, max_allowable_entry_speed(-prev->acceleration,prev->entry_speed,prev->millimeters));
  347. // Check for junction speed change
  348. if (current->entry_speed != entry_speed) {
  349. current->entry_speed = entry_speed;
  350. current->flag |= BLOCK_FLAG_RECALCULATE;
  351. }
  352. }
  353. // Recalculate if current block entry or exit junction speed has changed.
  354. if ((prev->flag | current->flag) & BLOCK_FLAG_RECALCULATE) {
  355. // NOTE: Entry and exit factors always > 0 by all previous logic operations.
  356. calculate_trapezoid_for_block(prev, prev->entry_speed, current->entry_speed);
  357. // Reset current only to ensure next trapezoid is computed.
  358. prev->flag &= ~BLOCK_FLAG_RECALCULATE;
  359. }
  360. prev = current;
  361. current = block_buffer + (block_index = next_block_index(block_index));
  362. } while (block_index != block_buffer_head);
  363. }
  364. // SERIAL_ECHOLNPGM("planner_recalculate - 3");
  365. // Last/newest block in buffer. Exit speed is set with safe_final_speed. Always recalculated.
  366. current = block_buffer + prev_block_index(block_buffer_head);
  367. calculate_trapezoid_for_block(current, current->entry_speed, safe_final_speed);
  368. current->flag &= ~BLOCK_FLAG_RECALCULATE;
  369. // SERIAL_ECHOLNPGM("planner_recalculate - 4");
  370. }
  371. void plan_init() {
  372. block_buffer_head = 0;
  373. block_buffer_tail = 0;
  374. memset(position, 0, sizeof(position)); // clear position
  375. #ifdef LIN_ADVANCE
  376. memset(position_float, 0, sizeof(position)); // clear position
  377. #endif
  378. previous_speed[0] = 0.0;
  379. previous_speed[1] = 0.0;
  380. previous_speed[2] = 0.0;
  381. previous_speed[3] = 0.0;
  382. previous_nominal_speed = 0.0;
  383. }
  384. #ifdef AUTOTEMP
  385. void getHighESpeed()
  386. {
  387. static float oldt=0;
  388. if(!autotemp_enabled){
  389. return;
  390. }
  391. if(degTargetHotend0()+2<autotemp_min) { //probably temperature set to zero.
  392. return; //do nothing
  393. }
  394. float high=0.0;
  395. uint8_t block_index = block_buffer_tail;
  396. while(block_index != block_buffer_head) {
  397. if((block_buffer[block_index].steps_x.wide != 0) ||
  398. (block_buffer[block_index].steps_y.wide != 0) ||
  399. (block_buffer[block_index].steps_z.wide != 0)) {
  400. float se=(float(block_buffer[block_index].steps_e.wide)/float(block_buffer[block_index].step_event_count.wide))*block_buffer[block_index].nominal_speed;
  401. //se; mm/sec;
  402. if(se>high)
  403. {
  404. high=se;
  405. }
  406. }
  407. block_index = (block_index+1) & (BLOCK_BUFFER_SIZE - 1);
  408. }
  409. float g=autotemp_min+high*autotemp_factor;
  410. float t=g;
  411. if(t<autotemp_min)
  412. t=autotemp_min;
  413. if(t>autotemp_max)
  414. t=autotemp_max;
  415. if(oldt>t)
  416. {
  417. t=AUTOTEMP_OLDWEIGHT*oldt+(1-AUTOTEMP_OLDWEIGHT)*t;
  418. }
  419. oldt=t;
  420. setTargetHotend0(t);
  421. }
  422. #endif
  423. void check_axes_activity()
  424. {
  425. unsigned char x_active = 0;
  426. unsigned char y_active = 0;
  427. unsigned char z_active = 0;
  428. unsigned char e_active = 0;
  429. unsigned char tail_fan_speed = fanSpeed;
  430. block_t *block;
  431. if(block_buffer_tail != block_buffer_head)
  432. {
  433. uint8_t block_index = block_buffer_tail;
  434. tail_fan_speed = block_buffer[block_index].fan_speed;
  435. while(block_index != block_buffer_head)
  436. {
  437. block = &block_buffer[block_index];
  438. if(block->steps_x.wide != 0) x_active++;
  439. if(block->steps_y.wide != 0) y_active++;
  440. if(block->steps_z.wide != 0) z_active++;
  441. if(block->steps_e.wide != 0) e_active++;
  442. block_index = (block_index+1) & (BLOCK_BUFFER_SIZE - 1);
  443. }
  444. }
  445. if((DISABLE_X) && (x_active == 0)) disable_x();
  446. if((DISABLE_Y) && (y_active == 0)) disable_y();
  447. if((DISABLE_Z) && (z_active == 0)) disable_z();
  448. if((DISABLE_E) && (e_active == 0))
  449. {
  450. disable_e0();
  451. disable_e1();
  452. disable_e2();
  453. }
  454. #if defined(FAN_PIN) && FAN_PIN > -1
  455. #ifdef FAN_KICKSTART_TIME
  456. static unsigned long fan_kick_end;
  457. if (tail_fan_speed) {
  458. if (fan_kick_end == 0) {
  459. // Just starting up fan - run at full power.
  460. fan_kick_end = millis() + FAN_KICKSTART_TIME;
  461. tail_fan_speed = 255;
  462. } else if (fan_kick_end > millis())
  463. // Fan still spinning up.
  464. tail_fan_speed = 255;
  465. } else {
  466. fan_kick_end = 0;
  467. }
  468. #endif//FAN_KICKSTART_TIME
  469. #ifdef FAN_SOFT_PWM
  470. fanSpeedSoftPwm = tail_fan_speed;
  471. #else
  472. analogWrite(FAN_PIN,tail_fan_speed);
  473. #endif//!FAN_SOFT_PWM
  474. #endif//FAN_PIN > -1
  475. #ifdef AUTOTEMP
  476. getHighESpeed();
  477. #endif
  478. }
  479. bool waiting_inside_plan_buffer_line_print_aborted = false;
  480. /*
  481. void planner_abort_soft()
  482. {
  483. // Empty the queue.
  484. while (blocks_queued()) plan_discard_current_block();
  485. // Relay to planner wait routine, that the current line shall be canceled.
  486. waiting_inside_plan_buffer_line_print_aborted = true;
  487. //current_position[i]
  488. }
  489. */
  490. #ifdef PLANNER_DIAGNOSTICS
  491. static inline void planner_update_queue_min_counter()
  492. {
  493. uint8_t new_counter = moves_planned();
  494. if (new_counter < g_cntr_planner_queue_min)
  495. g_cntr_planner_queue_min = new_counter;
  496. }
  497. #endif /* PLANNER_DIAGNOSTICS */
  498. extern volatile uint32_t step_events_completed; // The number of step events executed in the current block
  499. void planner_abort_hard()
  500. {
  501. // Abort the stepper routine and flush the planner queue.
  502. DISABLE_STEPPER_DRIVER_INTERRUPT();
  503. // Now the front-end (the Marlin_main.cpp with its current_position) is out of sync.
  504. // First update the planner's current position in the physical motor steps.
  505. position[X_AXIS] = st_get_position(X_AXIS);
  506. position[Y_AXIS] = st_get_position(Y_AXIS);
  507. position[Z_AXIS] = st_get_position(Z_AXIS);
  508. position[E_AXIS] = st_get_position(E_AXIS);
  509. // Second update the current position of the front end.
  510. current_position[X_AXIS] = st_get_position_mm(X_AXIS);
  511. current_position[Y_AXIS] = st_get_position_mm(Y_AXIS);
  512. current_position[Z_AXIS] = st_get_position_mm(Z_AXIS);
  513. current_position[E_AXIS] = st_get_position_mm(E_AXIS);
  514. // Apply the mesh bed leveling correction to the Z axis.
  515. #ifdef MESH_BED_LEVELING
  516. if (mbl.active) {
  517. #if 1
  518. // Undo the bed level correction so the current Z position is reversible wrt. the machine coordinates.
  519. // This does not necessary mean that the Z position will be the same as linearly interpolated from the source G-code line.
  520. current_position[Z_AXIS] -= mbl.get_z(current_position[X_AXIS], current_position[Y_AXIS]);
  521. #else
  522. // Undo the bed level correction so that the current Z position is the same as linearly interpolated from the source G-code line.
  523. if (current_block == NULL || (current_block->steps_x == 0 && current_block->steps_y == 0))
  524. current_position[Z_AXIS] -= mbl.get_z(current_position[X_AXIS], current_position[Y_AXIS]);
  525. else {
  526. float t = float(step_events_completed) / float(current_block->step_event_count);
  527. float vec[3] = {
  528. current_block->steps_x / axis_steps_per_unit[X_AXIS],
  529. current_block->steps_y / axis_steps_per_unit[Y_AXIS],
  530. current_block->steps_z / axis_steps_per_unit[Z_AXIS]
  531. };
  532. float pos1[3], pos2[3];
  533. for (int8_t i = 0; i < 3; ++ i) {
  534. if (current_block->direction_bits & (1<<i))
  535. vec[i] = - vec[i];
  536. pos1[i] = current_position[i] - vec[i] * t;
  537. pos2[i] = current_position[i] + vec[i] * (1.f - t);
  538. }
  539. pos1[Z_AXIS] -= mbl.get_z(pos1[X_AXIS], pos1[Y_AXIS]);
  540. pos2[Z_AXIS] -= mbl.get_z(pos2[X_AXIS], pos2[Y_AXIS]);
  541. current_position[Z_AXIS] = pos1[Z_AXIS] * t + pos2[Z_AXIS] * (1.f - t);
  542. }
  543. #endif
  544. }
  545. #endif
  546. // Clear the planner queue, reset and re-enable the stepper timer.
  547. quickStop();
  548. // Apply inverse world correction matrix.
  549. machine2world(current_position[X_AXIS], current_position[Y_AXIS]);
  550. memcpy(destination, current_position, sizeof(destination));
  551. // Resets planner junction speeds. Assumes start from rest.
  552. previous_nominal_speed = 0.0;
  553. previous_speed[0] = 0.0;
  554. previous_speed[1] = 0.0;
  555. previous_speed[2] = 0.0;
  556. previous_speed[3] = 0.0;
  557. // Relay to planner wait routine, that the current line shall be canceled.
  558. waiting_inside_plan_buffer_line_print_aborted = true;
  559. }
  560. float junction_deviation = 0.1;
  561. // Add a new linear movement to the buffer. steps_x, _y and _z is the absolute position in
  562. // mm. Microseconds specify how many microseconds the move should take to perform. To aid acceleration
  563. // calculation the caller must also provide the physical length of the line in millimeters.
  564. void plan_buffer_line(float x, float y, float z, const float &e, float feed_rate, const uint8_t &extruder)
  565. {
  566. // Calculate the buffer head after we push this byte
  567. int next_buffer_head = next_block_index(block_buffer_head);
  568. // If the buffer is full: good! That means we are well ahead of the robot.
  569. // Rest here until there is room in the buffer.
  570. if (block_buffer_tail == next_buffer_head) {
  571. waiting_inside_plan_buffer_line_print_aborted = false;
  572. do {
  573. manage_heater();
  574. // Vojtech: Don't disable motors inside the planner!
  575. manage_inactivity(false);
  576. lcd_update();
  577. } while (block_buffer_tail == next_buffer_head);
  578. if (waiting_inside_plan_buffer_line_print_aborted) {
  579. // Inside the lcd_update() routine the print has been aborted.
  580. // Cancel the print, do not plan the current line this routine is waiting on.
  581. #ifdef PLANNER_DIAGNOSTICS
  582. planner_update_queue_min_counter();
  583. #endif /* PLANNER_DIAGNOSTICS */
  584. return;
  585. }
  586. }
  587. #ifdef PLANNER_DIAGNOSTICS
  588. planner_update_queue_min_counter();
  589. #endif /* PLANNER_DIAGNOSTICS */
  590. #ifdef ENABLE_AUTO_BED_LEVELING
  591. apply_rotation_xyz(plan_bed_level_matrix, x, y, z);
  592. #endif // ENABLE_AUTO_BED_LEVELING
  593. // Apply the machine correction matrix.
  594. {
  595. #if 0
  596. SERIAL_ECHOPGM("Planner, current position - servos: ");
  597. MYSERIAL.print(st_get_position_mm(X_AXIS), 5);
  598. SERIAL_ECHOPGM(", ");
  599. MYSERIAL.print(st_get_position_mm(Y_AXIS), 5);
  600. SERIAL_ECHOPGM(", ");
  601. MYSERIAL.print(st_get_position_mm(Z_AXIS), 5);
  602. SERIAL_ECHOLNPGM("");
  603. SERIAL_ECHOPGM("Planner, target position, initial: ");
  604. MYSERIAL.print(x, 5);
  605. SERIAL_ECHOPGM(", ");
  606. MYSERIAL.print(y, 5);
  607. SERIAL_ECHOLNPGM("");
  608. SERIAL_ECHOPGM("Planner, world2machine: ");
  609. MYSERIAL.print(world2machine_rotation_and_skew[0][0], 5);
  610. SERIAL_ECHOPGM(", ");
  611. MYSERIAL.print(world2machine_rotation_and_skew[0][1], 5);
  612. SERIAL_ECHOPGM(", ");
  613. MYSERIAL.print(world2machine_rotation_and_skew[1][0], 5);
  614. SERIAL_ECHOPGM(", ");
  615. MYSERIAL.print(world2machine_rotation_and_skew[1][1], 5);
  616. SERIAL_ECHOLNPGM("");
  617. SERIAL_ECHOPGM("Planner, offset: ");
  618. MYSERIAL.print(world2machine_shift[0], 5);
  619. SERIAL_ECHOPGM(", ");
  620. MYSERIAL.print(world2machine_shift[1], 5);
  621. SERIAL_ECHOLNPGM("");
  622. #endif
  623. world2machine(x, y);
  624. #if 0
  625. SERIAL_ECHOPGM("Planner, target position, corrected: ");
  626. MYSERIAL.print(x, 5);
  627. SERIAL_ECHOPGM(", ");
  628. MYSERIAL.print(y, 5);
  629. SERIAL_ECHOLNPGM("");
  630. #endif
  631. }
  632. // The target position of the tool in absolute steps
  633. // Calculate target position in absolute steps
  634. //this should be done after the wait, because otherwise a M92 code within the gcode disrupts this calculation somehow
  635. long target[4];
  636. target[X_AXIS] = lround(x*axis_steps_per_unit[X_AXIS]);
  637. target[Y_AXIS] = lround(y*axis_steps_per_unit[Y_AXIS]);
  638. #ifdef MESH_BED_LEVELING
  639. if (mbl.active){
  640. target[Z_AXIS] = lround((z+mbl.get_z(x, y))*axis_steps_per_unit[Z_AXIS]);
  641. }else{
  642. target[Z_AXIS] = lround(z*axis_steps_per_unit[Z_AXIS]);
  643. }
  644. #else
  645. target[Z_AXIS] = lround(z*axis_steps_per_unit[Z_AXIS]);
  646. #endif // ENABLE_MESH_BED_LEVELING
  647. target[E_AXIS] = lround(e*axis_steps_per_unit[E_AXIS]);
  648. #ifdef LIN_ADVANCE
  649. const float mm_D_float = sqrt(sq(x - position_float[X_AXIS]) + sq(y - position_float[Y_AXIS]));
  650. float de_float = e - position_float[E_AXIS];
  651. #endif
  652. #ifdef PREVENT_DANGEROUS_EXTRUDE
  653. if(target[E_AXIS]!=position[E_AXIS])
  654. {
  655. if(degHotend(active_extruder)<extrude_min_temp)
  656. {
  657. position[E_AXIS]=target[E_AXIS]; //behave as if the move really took place, but ignore E part
  658. #ifdef LIN_ADVANCE
  659. position_float[E_AXIS] = e;
  660. de_float = 0;
  661. #endif
  662. SERIAL_ECHO_START;
  663. SERIAL_ECHOLNRPGM(_i(" cold extrusion prevented"));////MSG_ERR_COLD_EXTRUDE_STOP c=0 r=0
  664. }
  665. #ifdef PREVENT_LENGTHY_EXTRUDE
  666. if(labs(target[E_AXIS]-position[E_AXIS])>axis_steps_per_unit[E_AXIS]*EXTRUDE_MAXLENGTH)
  667. {
  668. position[E_AXIS]=target[E_AXIS]; //behave as if the move really took place, but ignore E part
  669. #ifdef LIN_ADVANCE
  670. position_float[E_AXIS] = e;
  671. de_float = 0;
  672. #endif
  673. SERIAL_ECHO_START;
  674. SERIAL_ECHOLNRPGM(_n(" too long extrusion prevented"));////MSG_ERR_LONG_EXTRUDE_STOP c=0 r=0
  675. }
  676. #endif
  677. }
  678. #endif
  679. // Prepare to set up new block
  680. block_t *block = &block_buffer[block_buffer_head];
  681. // Set sdlen for calculating sd position
  682. block->sdlen = 0;
  683. // Mark block as not busy (Not executed by the stepper interrupt, could be still tinkered with.)
  684. block->busy = false;
  685. // Number of steps for each axis
  686. #ifndef COREXY
  687. // default non-h-bot planning
  688. block->steps_x.wide = labs(target[X_AXIS]-position[X_AXIS]);
  689. block->steps_y.wide = labs(target[Y_AXIS]-position[Y_AXIS]);
  690. #else
  691. // corexy planning
  692. // these equations follow the form of the dA and dB equations on http://www.corexy.com/theory.html
  693. block->steps_x.wide = labs((target[X_AXIS]-position[X_AXIS]) + (target[Y_AXIS]-position[Y_AXIS]));
  694. block->steps_y.wide = labs((target[X_AXIS]-position[X_AXIS]) - (target[Y_AXIS]-position[Y_AXIS]));
  695. #endif
  696. block->steps_z.wide = labs(target[Z_AXIS]-position[Z_AXIS]);
  697. block->steps_e.wide = labs(target[E_AXIS]-position[E_AXIS]);
  698. block->step_event_count.wide = max(block->steps_x.wide, max(block->steps_y.wide, max(block->steps_z.wide, block->steps_e.wide)));
  699. // Bail if this is a zero-length block
  700. if (block->step_event_count.wide <= dropsegments)
  701. {
  702. #ifdef PLANNER_DIAGNOSTICS
  703. planner_update_queue_min_counter();
  704. #endif /* PLANNER_DIAGNOSTICS */
  705. return;
  706. }
  707. block->fan_speed = fanSpeed;
  708. // Compute direction bits for this block
  709. block->direction_bits = 0;
  710. #ifndef COREXY
  711. if (target[X_AXIS] < position[X_AXIS])
  712. {
  713. block->direction_bits |= (1<<X_AXIS);
  714. }
  715. if (target[Y_AXIS] < position[Y_AXIS])
  716. {
  717. block->direction_bits |= (1<<Y_AXIS);
  718. }
  719. #else
  720. if ((target[X_AXIS]-position[X_AXIS]) + (target[Y_AXIS]-position[Y_AXIS]) < 0)
  721. {
  722. block->direction_bits |= (1<<X_AXIS);
  723. }
  724. if ((target[X_AXIS]-position[X_AXIS]) - (target[Y_AXIS]-position[Y_AXIS]) < 0)
  725. {
  726. block->direction_bits |= (1<<Y_AXIS);
  727. }
  728. #endif
  729. if (target[Z_AXIS] < position[Z_AXIS])
  730. {
  731. block->direction_bits |= (1<<Z_AXIS);
  732. }
  733. if (target[E_AXIS] < position[E_AXIS])
  734. {
  735. block->direction_bits |= (1<<E_AXIS);
  736. }
  737. block->active_extruder = extruder;
  738. //enable active axes
  739. #ifdef COREXY
  740. if((block->steps_x.wide != 0) || (block->steps_y.wide != 0))
  741. {
  742. enable_x();
  743. enable_y();
  744. }
  745. #else
  746. if(block->steps_x.wide != 0) enable_x();
  747. if(block->steps_y.wide != 0) enable_y();
  748. #endif
  749. if(block->steps_z.wide != 0) enable_z();
  750. // Enable extruder(s)
  751. if(block->steps_e.wide != 0)
  752. {
  753. if (DISABLE_INACTIVE_EXTRUDER) //enable only selected extruder
  754. {
  755. if(g_uc_extruder_last_move[0] > 0) g_uc_extruder_last_move[0]--;
  756. if(g_uc_extruder_last_move[1] > 0) g_uc_extruder_last_move[1]--;
  757. if(g_uc_extruder_last_move[2] > 0) g_uc_extruder_last_move[2]--;
  758. switch(extruder)
  759. {
  760. case 0:
  761. enable_e0();
  762. g_uc_extruder_last_move[0] = BLOCK_BUFFER_SIZE*2;
  763. if(g_uc_extruder_last_move[1] == 0) disable_e1();
  764. if(g_uc_extruder_last_move[2] == 0) disable_e2();
  765. break;
  766. case 1:
  767. enable_e1();
  768. g_uc_extruder_last_move[1] = BLOCK_BUFFER_SIZE*2;
  769. if(g_uc_extruder_last_move[0] == 0) disable_e0();
  770. if(g_uc_extruder_last_move[2] == 0) disable_e2();
  771. break;
  772. case 2:
  773. enable_e2();
  774. g_uc_extruder_last_move[2] = BLOCK_BUFFER_SIZE*2;
  775. if(g_uc_extruder_last_move[0] == 0) disable_e0();
  776. if(g_uc_extruder_last_move[1] == 0) disable_e1();
  777. break;
  778. }
  779. }
  780. else //enable all
  781. {
  782. enable_e0();
  783. enable_e1();
  784. enable_e2();
  785. }
  786. }
  787. if (block->steps_e.wide == 0)
  788. {
  789. if(feed_rate<mintravelfeedrate) feed_rate=mintravelfeedrate;
  790. }
  791. else
  792. {
  793. if(feed_rate<minimumfeedrate) feed_rate=minimumfeedrate;
  794. }
  795. /* This part of the code calculates the total length of the movement.
  796. For cartesian bots, the X_AXIS is the real X movement and same for Y_AXIS.
  797. But for corexy bots, that is not true. The "X_AXIS" and "Y_AXIS" motors (that should be named to A_AXIS
  798. and B_AXIS) cannot be used for X and Y length, because A=X+Y and B=X-Y.
  799. So we need to create other 2 "AXIS", named X_HEAD and Y_HEAD, meaning the real displacement of the Head.
  800. Having the real displacement of the head, we can calculate the total movement length and apply the desired speed.
  801. */
  802. #ifndef COREXY
  803. float delta_mm[4];
  804. delta_mm[X_AXIS] = (target[X_AXIS]-position[X_AXIS])/axis_steps_per_unit[X_AXIS];
  805. delta_mm[Y_AXIS] = (target[Y_AXIS]-position[Y_AXIS])/axis_steps_per_unit[Y_AXIS];
  806. #else
  807. float delta_mm[6];
  808. delta_mm[X_HEAD] = (target[X_AXIS]-position[X_AXIS])/axis_steps_per_unit[X_AXIS];
  809. delta_mm[Y_HEAD] = (target[Y_AXIS]-position[Y_AXIS])/axis_steps_per_unit[Y_AXIS];
  810. delta_mm[X_AXIS] = ((target[X_AXIS]-position[X_AXIS]) + (target[Y_AXIS]-position[Y_AXIS]))/axis_steps_per_unit[X_AXIS];
  811. delta_mm[Y_AXIS] = ((target[X_AXIS]-position[X_AXIS]) - (target[Y_AXIS]-position[Y_AXIS]))/axis_steps_per_unit[Y_AXIS];
  812. #endif
  813. delta_mm[Z_AXIS] = (target[Z_AXIS]-position[Z_AXIS])/axis_steps_per_unit[Z_AXIS];
  814. delta_mm[E_AXIS] = (target[E_AXIS]-position[E_AXIS])/axis_steps_per_unit[E_AXIS];
  815. if ( block->steps_x.wide <=dropsegments && block->steps_y.wide <=dropsegments && block->steps_z.wide <=dropsegments )
  816. {
  817. block->millimeters = fabs(delta_mm[E_AXIS]);
  818. }
  819. else
  820. {
  821. #ifndef COREXY
  822. block->millimeters = sqrt(square(delta_mm[X_AXIS]) + square(delta_mm[Y_AXIS]) + square(delta_mm[Z_AXIS]));
  823. #else
  824. block->millimeters = sqrt(square(delta_mm[X_HEAD]) + square(delta_mm[Y_HEAD]) + square(delta_mm[Z_AXIS]));
  825. #endif
  826. }
  827. float inverse_millimeters = 1.0/block->millimeters; // Inverse millimeters to remove multiple divides
  828. // Calculate speed in mm/second for each axis. No divide by zero due to previous checks.
  829. float inverse_second = feed_rate * inverse_millimeters;
  830. int moves_queued = moves_planned();
  831. // slow down when de buffer starts to empty, rather than wait at the corner for a buffer refill
  832. #ifdef SLOWDOWN
  833. //FIXME Vojtech: Why moves_queued > 1? Why not >=1?
  834. // Can we somehow differentiate the filling of the buffer at the start of a g-code from a buffer draining situation?
  835. if (moves_queued > 1 && moves_queued < (BLOCK_BUFFER_SIZE >> 1)) {
  836. // segment time in micro seconds
  837. unsigned long segment_time = lround(1000000.0/inverse_second);
  838. if (segment_time < minsegmenttime)
  839. // buffer is draining, add extra time. The amount of time added increases if the buffer is still emptied more.
  840. inverse_second=1000000.0/(segment_time+lround(2*(minsegmenttime-segment_time)/moves_queued));
  841. }
  842. #endif // SLOWDOWN
  843. block->nominal_speed = block->millimeters * inverse_second; // (mm/sec) Always > 0
  844. block->nominal_rate = ceil(block->step_event_count.wide * inverse_second); // (step/sec) Always > 0
  845. // Calculate and limit speed in mm/sec for each axis
  846. float current_speed[4];
  847. float speed_factor = 1.0; //factor <=1 do decrease speed
  848. for(int i=0; i < 4; i++)
  849. {
  850. current_speed[i] = delta_mm[i] * inverse_second;
  851. #ifdef TMC2130
  852. float max_fr = max_feedrate[i];
  853. if (i < 2) // X, Y
  854. {
  855. if (tmc2130_mode == TMC2130_MODE_SILENT)
  856. {
  857. if (max_fr > SILENT_MAX_FEEDRATE)
  858. max_fr = SILENT_MAX_FEEDRATE;
  859. }
  860. else
  861. {
  862. if (max_fr > NORMAL_MAX_FEEDRATE)
  863. max_fr = NORMAL_MAX_FEEDRATE;
  864. }
  865. }
  866. if(fabs(current_speed[i]) > max_fr)
  867. speed_factor = min(speed_factor, max_fr / fabs(current_speed[i]));
  868. #else //TMC2130
  869. if(fabs(current_speed[i]) > max_feedrate[i])
  870. speed_factor = min(speed_factor, max_feedrate[i] / fabs(current_speed[i]));
  871. #endif //TMC2130
  872. }
  873. // Correct the speed
  874. if( speed_factor < 1.0)
  875. {
  876. for(unsigned char i=0; i < 4; i++)
  877. {
  878. current_speed[i] *= speed_factor;
  879. }
  880. block->nominal_speed *= speed_factor;
  881. block->nominal_rate *= speed_factor;
  882. }
  883. // Compute and limit the acceleration rate for the trapezoid generator.
  884. // block->step_event_count ... event count of the fastest axis
  885. // block->millimeters ... Euclidian length of the XYZ movement or the E length, if no XYZ movement.
  886. float steps_per_mm = block->step_event_count.wide/block->millimeters;
  887. if(block->steps_x.wide == 0 && block->steps_y.wide == 0 && block->steps_z.wide == 0)
  888. {
  889. block->acceleration_st = ceil(retract_acceleration * steps_per_mm); // convert to: acceleration steps/sec^2
  890. }
  891. else
  892. {
  893. block->acceleration_st = ceil(acceleration * steps_per_mm); // convert to: acceleration steps/sec^2
  894. #ifdef TMC2130
  895. #ifdef SIMPLE_ACCEL_LIMIT // in some cases can be acceleration limited inproperly
  896. if (tmc2130_mode == TMC2130_MODE_SILENT)
  897. {
  898. if (block->steps_x.wide || block->steps_y.wide)
  899. if (block->acceleration_st > SILENT_MAX_ACCEL_ST) block->acceleration_st = SILENT_MAX_ACCEL_ST;
  900. }
  901. else
  902. {
  903. if (block->steps_x.wide || block->steps_y.wide)
  904. if (block->acceleration_st > NORMAL_MAX_ACCEL_ST) block->acceleration_st = NORMAL_MAX_ACCEL_ST;
  905. }
  906. if (block->steps_x.wide && (block->acceleration_st > axis_steps_per_sqr_second[X_AXIS])) block->acceleration_st = axis_steps_per_sqr_second[X_AXIS];
  907. if (block->steps_y.wide && (block->acceleration_st > axis_steps_per_sqr_second[Y_AXIS])) block->acceleration_st = axis_steps_per_sqr_second[Y_AXIS];
  908. if (block->steps_z.wide && (block->acceleration_st > axis_steps_per_sqr_second[Z_AXIS])) block->acceleration_st = axis_steps_per_sqr_second[Z_AXIS];
  909. if (block->steps_e.wide && (block->acceleration_st > axis_steps_per_sqr_second[E_AXIS])) block->acceleration_st = axis_steps_per_sqr_second[E_AXIS];
  910. #else // SIMPLE_ACCEL_LIMIT
  911. if (tmc2130_mode == TMC2130_MODE_SILENT)
  912. {
  913. if ((block->steps_x.wide > block->step_event_count.wide / 2) || (block->steps_y.wide > block->step_event_count.wide / 2))
  914. if (block->acceleration_st > SILENT_MAX_ACCEL_ST) block->acceleration_st = SILENT_MAX_ACCEL_ST;
  915. }
  916. else
  917. {
  918. if ((block->steps_x.wide > block->step_event_count.wide / 2) || (block->steps_y.wide > block->step_event_count.wide / 2))
  919. if (block->acceleration_st > NORMAL_MAX_ACCEL_ST) block->acceleration_st = NORMAL_MAX_ACCEL_ST;
  920. }
  921. if(((float)block->acceleration_st * (float)block->steps_x.wide / (float)block->step_event_count.wide) > axis_steps_per_sqr_second[X_AXIS])
  922. block->acceleration_st = axis_steps_per_sqr_second[X_AXIS];
  923. if(((float)block->acceleration_st * (float)block->steps_y.wide / (float)block->step_event_count.wide) > axis_steps_per_sqr_second[Y_AXIS])
  924. block->acceleration_st = axis_steps_per_sqr_second[Y_AXIS];
  925. if(((float)block->acceleration_st * (float)block->steps_z.wide / (float)block->step_event_count.wide) > axis_steps_per_sqr_second[Z_AXIS])
  926. block->acceleration_st = axis_steps_per_sqr_second[Z_AXIS];
  927. if(((float)block->acceleration_st * (float)block->steps_e.wide / (float)block->step_event_count.wide) > axis_steps_per_sqr_second[E_AXIS])
  928. block->acceleration_st = axis_steps_per_sqr_second[E_AXIS];
  929. #endif // SIMPLE_ACCEL_LIMIT
  930. #else //TMC2130
  931. // Limit acceleration per axis
  932. //FIXME Vojtech: One shall rather limit a projection of the acceleration vector instead of using the limit.
  933. if(((float)block->acceleration_st * (float)block->steps_x.wide / (float)block->step_event_count.wide) > axis_steps_per_sqr_second[X_AXIS])
  934. block->acceleration_st = axis_steps_per_sqr_second[X_AXIS];
  935. if(((float)block->acceleration_st * (float)block->steps_y.wide / (float)block->step_event_count.wide) > axis_steps_per_sqr_second[Y_AXIS])
  936. block->acceleration_st = axis_steps_per_sqr_second[Y_AXIS];
  937. if(((float)block->acceleration_st * (float)block->steps_e.wide / (float)block->step_event_count.wide) > axis_steps_per_sqr_second[E_AXIS])
  938. block->acceleration_st = axis_steps_per_sqr_second[E_AXIS];
  939. if(((float)block->acceleration_st * (float)block->steps_z.wide / (float)block->step_event_count.wide ) > axis_steps_per_sqr_second[Z_AXIS])
  940. block->acceleration_st = axis_steps_per_sqr_second[Z_AXIS];
  941. #endif //TMC2130
  942. }
  943. // Acceleration of the segment, in mm/sec^2
  944. block->acceleration = block->acceleration_st / steps_per_mm;
  945. #if 0
  946. // Oversample diagonal movements by a power of 2 up to 8x
  947. // to achieve more accurate diagonal movements.
  948. uint8_t bresenham_oversample = 1;
  949. for (uint8_t i = 0; i < 3; ++ i) {
  950. if (block->nominal_rate >= 5000) // 5kHz
  951. break;
  952. block->nominal_rate << 1;
  953. bresenham_oversample << 1;
  954. block->step_event_count << 1;
  955. }
  956. if (bresenham_oversample > 1)
  957. // Lower the acceleration steps/sec^2 to account for the oversampling.
  958. block->acceleration_st = (block->acceleration_st + (bresenham_oversample >> 1)) / bresenham_oversample;
  959. #endif
  960. block->acceleration_rate = (long)((float)block->acceleration_st * (16777216.0 / (F_CPU / 8.0)));
  961. // Start with a safe speed.
  962. // Safe speed is the speed, from which the machine may halt to stop immediately.
  963. float safe_speed = block->nominal_speed;
  964. bool limited = false;
  965. for (uint8_t axis = 0; axis < 4; ++ axis) {
  966. float jerk = fabs(current_speed[axis]);
  967. if (jerk > max_jerk[axis]) {
  968. // The actual jerk is lower, if it has been limited by the XY jerk.
  969. if (limited) {
  970. // Spare one division by a following gymnastics:
  971. // Instead of jerk *= safe_speed / block->nominal_speed,
  972. // multiply max_jerk[axis] by the divisor.
  973. jerk *= safe_speed;
  974. float mjerk = max_jerk[axis] * block->nominal_speed;
  975. if (jerk > mjerk) {
  976. safe_speed *= mjerk / jerk;
  977. limited = true;
  978. }
  979. } else {
  980. safe_speed = max_jerk[axis];
  981. limited = true;
  982. }
  983. }
  984. }
  985. // Reset the block flag.
  986. block->flag = 0;
  987. // Initial limit on the segment entry velocity.
  988. float vmax_junction;
  989. //FIXME Vojtech: Why only if at least two lines are planned in the queue?
  990. // Is it because we don't want to tinker with the first buffer line, which
  991. // is likely to be executed by the stepper interrupt routine soon?
  992. if (moves_queued > 1 && previous_nominal_speed > 0.0001f) {
  993. // Estimate a maximum velocity allowed at a joint of two successive segments.
  994. // If this maximum velocity allowed is lower than the minimum of the entry / exit safe velocities,
  995. // then the machine is not coasting anymore and the safe entry / exit velocities shall be used.
  996. // The junction velocity will be shared between successive segments. Limit the junction velocity to their minimum.
  997. bool prev_speed_larger = previous_nominal_speed > block->nominal_speed;
  998. float smaller_speed_factor = prev_speed_larger ? (block->nominal_speed / previous_nominal_speed) : (previous_nominal_speed / block->nominal_speed);
  999. // Pick the smaller of the nominal speeds. Higher speed shall not be achieved at the junction during coasting.
  1000. vmax_junction = prev_speed_larger ? block->nominal_speed : previous_nominal_speed;
  1001. // Factor to multiply the previous / current nominal velocities to get componentwise limited velocities.
  1002. float v_factor = 1.f;
  1003. limited = false;
  1004. // Now limit the jerk in all axes.
  1005. for (uint8_t axis = 0; axis < 4; ++ axis) {
  1006. // Limit an axis. We have to differentiate coasting from the reversal of an axis movement, or a full stop.
  1007. float v_exit = previous_speed[axis];
  1008. float v_entry = current_speed [axis];
  1009. if (prev_speed_larger)
  1010. v_exit *= smaller_speed_factor;
  1011. if (limited) {
  1012. v_exit *= v_factor;
  1013. v_entry *= v_factor;
  1014. }
  1015. // Calculate the jerk depending on whether the axis is coasting in the same direction or reversing a direction.
  1016. float jerk =
  1017. (v_exit > v_entry) ?
  1018. ((v_entry > 0.f || v_exit < 0.f) ?
  1019. // coasting
  1020. (v_exit - v_entry) :
  1021. // axis reversal
  1022. max(v_exit, - v_entry)) :
  1023. // v_exit <= v_entry
  1024. ((v_entry < 0.f || v_exit > 0.f) ?
  1025. // coasting
  1026. (v_entry - v_exit) :
  1027. // axis reversal
  1028. max(- v_exit, v_entry));
  1029. if (jerk > max_jerk[axis]) {
  1030. v_factor *= max_jerk[axis] / jerk;
  1031. limited = true;
  1032. }
  1033. }
  1034. if (limited)
  1035. vmax_junction *= v_factor;
  1036. // Now the transition velocity is known, which maximizes the shared exit / entry velocity while
  1037. // respecting the jerk factors, it may be possible, that applying separate safe exit / entry velocities will achieve faster prints.
  1038. float vmax_junction_threshold = vmax_junction * 0.99f;
  1039. if (previous_safe_speed > vmax_junction_threshold && safe_speed > vmax_junction_threshold) {
  1040. // Not coasting. The machine will stop and start the movements anyway,
  1041. // better to start the segment from start.
  1042. block->flag |= BLOCK_FLAG_START_FROM_FULL_HALT;
  1043. vmax_junction = safe_speed;
  1044. }
  1045. } else {
  1046. block->flag |= BLOCK_FLAG_START_FROM_FULL_HALT;
  1047. vmax_junction = safe_speed;
  1048. }
  1049. // Max entry speed of this block equals the max exit speed of the previous block.
  1050. block->max_entry_speed = vmax_junction;
  1051. // Initialize block entry speed. Compute based on deceleration to safe_speed.
  1052. double v_allowable = max_allowable_entry_speed(-block->acceleration,safe_speed,block->millimeters);
  1053. block->entry_speed = min(vmax_junction, v_allowable);
  1054. // Initialize planner efficiency flags
  1055. // Set flag if block will always reach maximum junction speed regardless of entry/exit speeds.
  1056. // If a block can de/ac-celerate from nominal speed to zero within the length of the block, then
  1057. // the current block and next block junction speeds are guaranteed to always be at their maximum
  1058. // junction speeds in deceleration and acceleration, respectively. This is due to how the current
  1059. // block nominal speed limits both the current and next maximum junction speeds. Hence, in both
  1060. // the reverse and forward planners, the corresponding block junction speed will always be at the
  1061. // the maximum junction speed and may always be ignored for any speed reduction checks.
  1062. // Always calculate trapezoid for new block
  1063. block->flag |= (block->nominal_speed <= v_allowable) ? (BLOCK_FLAG_NOMINAL_LENGTH | BLOCK_FLAG_RECALCULATE) : BLOCK_FLAG_RECALCULATE;
  1064. // Update previous path unit_vector and nominal speed
  1065. memcpy(previous_speed, current_speed, sizeof(previous_speed)); // previous_speed[] = current_speed[]
  1066. previous_nominal_speed = block->nominal_speed;
  1067. previous_safe_speed = safe_speed;
  1068. #ifdef LIN_ADVANCE
  1069. //
  1070. // Use LIN_ADVANCE for blocks if all these are true:
  1071. //
  1072. // esteps : We have E steps todo (a printing move)
  1073. //
  1074. // block->steps[X_AXIS] || block->steps[Y_AXIS] : We have a movement in XY direction (i.e., not retract / prime).
  1075. //
  1076. // extruder_advance_k : There is an advance factor set.
  1077. //
  1078. // block->steps[E_AXIS] != block->step_event_count : A problem occurs if the move before a retract is too small.
  1079. // In that case, the retract and move will be executed together.
  1080. // This leads to too many advance steps due to a huge e_acceleration.
  1081. // The math is good, but we must avoid retract moves with advance!
  1082. // de_float > 0.0 : Extruder is running forward (e.g., for "Wipe while retracting" (Slic3r) or "Combing" (Cura) moves)
  1083. //
  1084. block->use_advance_lead = block->steps_e.wide
  1085. && (block->steps_x.wide || block->steps_y.wide)
  1086. && extruder_advance_k
  1087. && (uint32_t)block->steps_e.wide != block->step_event_count.wide
  1088. && de_float > 0.0;
  1089. if (block->use_advance_lead)
  1090. block->abs_adv_steps_multiplier8 = lround(
  1091. extruder_advance_k
  1092. * ((advance_ed_ratio < 0.000001) ? de_float / mm_D_float : advance_ed_ratio) // Use the fixed ratio, if set
  1093. * (block->nominal_speed / (float)block->nominal_rate)
  1094. * axis_steps_per_unit[E_AXIS] * 256.0
  1095. );
  1096. #endif
  1097. // Precalculate the division, so when all the trapezoids in the planner queue get recalculated, the division is not repeated.
  1098. block->speed_factor = block->nominal_rate / block->nominal_speed;
  1099. calculate_trapezoid_for_block(block, block->entry_speed, safe_speed);
  1100. if (block->step_event_count.wide <= 32767)
  1101. block->flag |= BLOCK_FLAG_DDA_LOWRES;
  1102. // Move the buffer head. From now the block may be picked up by the stepper interrupt controller.
  1103. block_buffer_head = next_buffer_head;
  1104. // Update position
  1105. memcpy(position, target, sizeof(target)); // position[] = target[]
  1106. #ifdef LIN_ADVANCE
  1107. position_float[X_AXIS] = x;
  1108. position_float[Y_AXIS] = y;
  1109. position_float[Z_AXIS] = z;
  1110. position_float[E_AXIS] = e;
  1111. #endif
  1112. // Recalculate the trapezoids to maximize speed at the segment transitions while respecting
  1113. // the machine limits (maximum acceleration and maximum jerk).
  1114. // This runs asynchronously with the stepper interrupt controller, which may
  1115. // interfere with the process.
  1116. planner_recalculate(safe_speed);
  1117. // SERIAL_ECHOPGM("Q");
  1118. // SERIAL_ECHO(int(moves_planned()));
  1119. // SERIAL_ECHOLNPGM("");
  1120. #ifdef PLANNER_DIAGNOSTICS
  1121. planner_update_queue_min_counter();
  1122. #endif /* PLANNER_DIAGNOSTIC */
  1123. // The stepper timer interrupt will run continuously from now on.
  1124. // If there are no planner blocks to be executed by the stepper routine,
  1125. // the stepper interrupt ticks at 1kHz to wake up and pick a block
  1126. // from the planner queue if available.
  1127. ENABLE_STEPPER_DRIVER_INTERRUPT();
  1128. }
  1129. #ifdef ENABLE_AUTO_BED_LEVELING
  1130. vector_3 plan_get_position() {
  1131. vector_3 position = vector_3(st_get_position_mm(X_AXIS), st_get_position_mm(Y_AXIS), st_get_position_mm(Z_AXIS));
  1132. //position.debug("in plan_get position");
  1133. //plan_bed_level_matrix.debug("in plan_get bed_level");
  1134. matrix_3x3 inverse = matrix_3x3::transpose(plan_bed_level_matrix);
  1135. //inverse.debug("in plan_get inverse");
  1136. position.apply_rotation(inverse);
  1137. //position.debug("after rotation");
  1138. return position;
  1139. }
  1140. #endif // ENABLE_AUTO_BED_LEVELING
  1141. void plan_set_position(float x, float y, float z, const float &e)
  1142. {
  1143. #ifdef ENABLE_AUTO_BED_LEVELING
  1144. apply_rotation_xyz(plan_bed_level_matrix, x, y, z);
  1145. #endif // ENABLE_AUTO_BED_LEVELING
  1146. // Apply the machine correction matrix.
  1147. if (world2machine_correction_mode != WORLD2MACHINE_CORRECTION_NONE)
  1148. {
  1149. float tmpx = x;
  1150. float tmpy = y;
  1151. x = world2machine_rotation_and_skew[0][0] * tmpx + world2machine_rotation_and_skew[0][1] * tmpy + world2machine_shift[0];
  1152. y = world2machine_rotation_and_skew[1][0] * tmpx + world2machine_rotation_and_skew[1][1] * tmpy + world2machine_shift[1];
  1153. }
  1154. position[X_AXIS] = lround(x*axis_steps_per_unit[X_AXIS]);
  1155. position[Y_AXIS] = lround(y*axis_steps_per_unit[Y_AXIS]);
  1156. #ifdef MESH_BED_LEVELING
  1157. position[Z_AXIS] = mbl.active ?
  1158. lround((z+mbl.get_z(x, y))*axis_steps_per_unit[Z_AXIS]) :
  1159. lround(z*axis_steps_per_unit[Z_AXIS]);
  1160. #else
  1161. position[Z_AXIS] = lround(z*axis_steps_per_unit[Z_AXIS]);
  1162. #endif // ENABLE_MESH_BED_LEVELING
  1163. position[E_AXIS] = lround(e*axis_steps_per_unit[E_AXIS]);
  1164. #ifdef LIN_ADVANCE
  1165. position_float[X_AXIS] = x;
  1166. position_float[Y_AXIS] = y;
  1167. position_float[Z_AXIS] = z;
  1168. position_float[E_AXIS] = e;
  1169. #endif
  1170. st_set_position(position[X_AXIS], position[Y_AXIS], position[Z_AXIS], position[E_AXIS]);
  1171. previous_nominal_speed = 0.0; // Resets planner junction speeds. Assumes start from rest.
  1172. previous_speed[0] = 0.0;
  1173. previous_speed[1] = 0.0;
  1174. previous_speed[2] = 0.0;
  1175. previous_speed[3] = 0.0;
  1176. }
  1177. // Only useful in the bed leveling routine, when the mesh bed leveling is off.
  1178. void plan_set_z_position(const float &z)
  1179. {
  1180. #ifdef LIN_ADVANCE
  1181. position_float[Z_AXIS] = z;
  1182. #endif
  1183. position[Z_AXIS] = lround(z*axis_steps_per_unit[Z_AXIS]);
  1184. st_set_position(position[X_AXIS], position[Y_AXIS], position[Z_AXIS], position[E_AXIS]);
  1185. }
  1186. void plan_set_e_position(const float &e)
  1187. {
  1188. #ifdef LIN_ADVANCE
  1189. position_float[E_AXIS] = e;
  1190. #endif
  1191. position[E_AXIS] = lround(e*axis_steps_per_unit[E_AXIS]);
  1192. st_set_e_position(position[E_AXIS]);
  1193. }
  1194. #ifdef PREVENT_DANGEROUS_EXTRUDE
  1195. void set_extrude_min_temp(float temp)
  1196. {
  1197. extrude_min_temp=temp;
  1198. }
  1199. #endif
  1200. // Calculate the steps/s^2 acceleration rates, based on the mm/s^s
  1201. void reset_acceleration_rates()
  1202. {
  1203. for(int8_t i=0; i < NUM_AXIS; i++)
  1204. {
  1205. axis_steps_per_sqr_second[i] = max_acceleration_units_per_sq_second[i] * axis_steps_per_unit[i];
  1206. }
  1207. }
  1208. unsigned char number_of_blocks() {
  1209. return (block_buffer_head + BLOCK_BUFFER_SIZE - block_buffer_tail) & (BLOCK_BUFFER_SIZE - 1);
  1210. }
  1211. #ifdef PLANNER_DIAGNOSTICS
  1212. uint8_t planner_queue_min()
  1213. {
  1214. return g_cntr_planner_queue_min;
  1215. }
  1216. void planner_queue_min_reset()
  1217. {
  1218. g_cntr_planner_queue_min = moves_planned();
  1219. }
  1220. #endif /* PLANNER_DIAGNOSTICS */
  1221. void planner_add_sd_length(uint16_t sdlen)
  1222. {
  1223. if (block_buffer_head != block_buffer_tail) {
  1224. // The planner buffer is not empty. Get the index of the last buffer line entered,
  1225. // which is (block_buffer_head - 1) modulo BLOCK_BUFFER_SIZE.
  1226. block_buffer[prev_block_index(block_buffer_head)].sdlen += sdlen;
  1227. } else {
  1228. // There is no line stored in the planner buffer, which means the last command does not need to be revertible,
  1229. // at a power panic, so the length of this command may be forgotten.
  1230. }
  1231. }
  1232. uint16_t planner_calc_sd_length()
  1233. {
  1234. unsigned char _block_buffer_head = block_buffer_head;
  1235. unsigned char _block_buffer_tail = block_buffer_tail;
  1236. uint16_t sdlen = 0;
  1237. while (_block_buffer_head != _block_buffer_tail)
  1238. {
  1239. sdlen += block_buffer[_block_buffer_tail].sdlen;
  1240. _block_buffer_tail = (_block_buffer_tail + 1) & (BLOCK_BUFFER_SIZE - 1);
  1241. }
  1242. return sdlen;
  1243. }