planner.cpp 55 KB

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