planner.cpp 52 KB

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