My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

planner.h 12KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. /**
  23. * planner.h
  24. *
  25. * Buffer movement commands and manage the acceleration profile plan
  26. *
  27. * Derived from Grbl
  28. * Copyright (c) 2009-2011 Simen Svale Skogsrud
  29. */
  30. #ifndef PLANNER_H
  31. #define PLANNER_H
  32. #include "types.h"
  33. #include "MarlinConfig.h"
  34. #if ENABLED(AUTO_BED_LEVELING_FEATURE)
  35. #include "vector_3.h"
  36. #endif
  37. class Planner;
  38. extern Planner planner;
  39. /**
  40. * struct block_t
  41. *
  42. * A single entry in the planner buffer.
  43. * Tracks linear movement over multiple axes.
  44. *
  45. * The "nominal" values are as-specified by gcode, and
  46. * may never actually be reached due to acceleration limits.
  47. */
  48. typedef struct {
  49. unsigned char active_extruder; // The extruder to move (if E move)
  50. // Fields used by the bresenham algorithm for tracing the line
  51. long steps[NUM_AXIS]; // Step count along each axis
  52. unsigned long step_event_count; // The number of step events required to complete this block
  53. #if ENABLED(MIXING_EXTRUDER)
  54. unsigned long mix_event_count[MIXING_STEPPERS]; // Scaled step_event_count for the mixing steppers
  55. #endif
  56. long accelerate_until, // The index of the step event on which to stop acceleration
  57. decelerate_after, // The index of the step event on which to start decelerating
  58. acceleration_rate; // The acceleration rate used for acceleration calculation
  59. unsigned char direction_bits; // The direction bit set for this block (refers to *_DIRECTION_BIT in config.h)
  60. // Advance extrusion
  61. #if ENABLED(LIN_ADVANCE)
  62. bool use_advance_lead;
  63. int e_speed_multiplier8; // Factorised by 2^8 to avoid float
  64. #elif ENABLED(ADVANCE)
  65. long advance_rate;
  66. volatile long initial_advance;
  67. volatile long final_advance;
  68. float advance;
  69. #endif
  70. // Fields used by the motion planner to manage acceleration
  71. float nominal_speed, // The nominal speed for this block in mm/sec
  72. entry_speed, // Entry speed at previous-current junction in mm/sec
  73. max_entry_speed, // Maximum allowable junction entry speed in mm/sec
  74. millimeters, // The total travel of this block in mm
  75. acceleration; // acceleration mm/sec^2
  76. unsigned char recalculate_flag, // Planner flag to recalculate trapezoids on entry junction
  77. nominal_length_flag; // Planner flag for nominal speed always reached
  78. // Settings for the trapezoid generator
  79. unsigned long nominal_rate, // The nominal step rate for this block in step_events/sec
  80. initial_rate, // The jerk-adjusted step rate at start of block
  81. final_rate, // The minimal rate at exit
  82. acceleration_steps_per_s2; // acceleration steps/sec^2
  83. #if FAN_COUNT > 0
  84. unsigned long fan_speed[FAN_COUNT];
  85. #endif
  86. #if ENABLED(BARICUDA)
  87. unsigned long valve_pressure, e_to_p_pressure;
  88. #endif
  89. volatile char busy;
  90. } block_t;
  91. #define BLOCK_MOD(n) ((n)&(BLOCK_BUFFER_SIZE-1))
  92. class Planner {
  93. public:
  94. /**
  95. * A ring buffer of moves described in steps
  96. */
  97. static block_t block_buffer[BLOCK_BUFFER_SIZE];
  98. static volatile uint8_t block_buffer_head; // Index of the next block to be pushed
  99. static volatile uint8_t block_buffer_tail;
  100. static float max_feedrate_mm_s[NUM_AXIS]; // Max speeds in mm per second
  101. static float axis_steps_per_mm[NUM_AXIS];
  102. static float steps_to_mm[NUM_AXIS];
  103. static unsigned long max_acceleration_steps_per_s2[NUM_AXIS];
  104. static unsigned long max_acceleration_mm_per_s2[NUM_AXIS]; // Use M201 to override by software
  105. static millis_t min_segment_time;
  106. static float min_feedrate_mm_s;
  107. static float acceleration; // Normal acceleration mm/s^2 DEFAULT ACCELERATION for all printing moves. M204 SXXXX
  108. static float retract_acceleration; // Retract acceleration mm/s^2 filament pull-back and push-forward while standing still in the other axes M204 TXXXX
  109. static float travel_acceleration; // Travel acceleration mm/s^2 DEFAULT ACCELERATION for all NON printing moves. M204 MXXXX
  110. static float max_xy_jerk; // The largest speed change requiring no acceleration
  111. static float max_z_jerk;
  112. static float max_e_jerk;
  113. static float min_travel_feedrate_mm_s;
  114. #if ENABLED(AUTO_BED_LEVELING_FEATURE)
  115. static bool abl_enabled; // Flag that bed leveling is enabled
  116. static matrix_3x3 bed_level_matrix; // Transform to compensate for bed level
  117. #endif
  118. private:
  119. /**
  120. * The current position of the tool in absolute steps
  121. * Recalculated if any axis_steps_per_mm are changed by gcode
  122. */
  123. static long position[NUM_AXIS];
  124. /**
  125. * Speed of previous path line segment
  126. */
  127. static float previous_speed[NUM_AXIS];
  128. /**
  129. * Nominal speed of previous path line segment
  130. */
  131. static float previous_nominal_speed;
  132. #if ENABLED(DISABLE_INACTIVE_EXTRUDER)
  133. /**
  134. * Counters to manage disabling inactive extruders
  135. */
  136. static uint8_t g_uc_extruder_last_move[EXTRUDERS];
  137. #endif // DISABLE_INACTIVE_EXTRUDER
  138. #ifdef XY_FREQUENCY_LIMIT
  139. // Used for the frequency limit
  140. #define MAX_FREQ_TIME long(1000000.0/XY_FREQUENCY_LIMIT)
  141. // Old direction bits. Used for speed calculations
  142. static unsigned char old_direction_bits;
  143. // Segment times (in µs). Used for speed calculations
  144. static long axis_segment_time[2][3];
  145. #endif
  146. public:
  147. /**
  148. * Instance Methods
  149. */
  150. Planner();
  151. void init();
  152. /**
  153. * Static (class) Methods
  154. */
  155. static void reset_acceleration_rates();
  156. static void refresh_positioning();
  157. // Manage fans, paste pressure, etc.
  158. static void check_axes_activity();
  159. /**
  160. * Number of moves currently in the planner
  161. */
  162. static uint8_t movesplanned() { return BLOCK_MOD(block_buffer_head - block_buffer_tail + BLOCK_BUFFER_SIZE); }
  163. static bool is_full() { return (block_buffer_tail == BLOCK_MOD(block_buffer_head + 1)); }
  164. #if ENABLED(AUTO_BED_LEVELING_FEATURE) || ENABLED(MESH_BED_LEVELING)
  165. #define ARG_X float lx
  166. #define ARG_Y float ly
  167. #define ARG_Z float lz
  168. #else
  169. #define ARG_X const float &lx
  170. #define ARG_Y const float &ly
  171. #define ARG_Z const float &lz
  172. #endif
  173. #if PLANNER_LEVELING
  174. /**
  175. * Apply leveling to transform a cartesian position
  176. * as it will be given to the planner and steppers.
  177. */
  178. static void apply_leveling(float &lx, float &ly, float &lz);
  179. static void unapply_leveling(float logical[XYZ]);
  180. #endif
  181. /**
  182. * Add a new linear movement to the buffer.
  183. *
  184. * x,y,z,e - target position in mm
  185. * fr_mm_s - (target) speed of the move (mm/s)
  186. * extruder - target extruder
  187. */
  188. static void buffer_line(ARG_X, ARG_Y, ARG_Z, const float& e, float fr_mm_s, const uint8_t extruder);
  189. /**
  190. * Set the planner.position and individual stepper positions.
  191. * Used by G92, G28, G29, and other procedures.
  192. *
  193. * Multiplies by axis_steps_per_mm[] and does necessary conversion
  194. * for COREXY / COREXZ / COREYZ to set the corresponding stepper positions.
  195. *
  196. * Clears previous speed values.
  197. */
  198. static void set_position_mm(ARG_X, ARG_Y, ARG_Z, const float& e);
  199. /**
  200. * Sync from the stepper positions. (e.g., after an interrupted move)
  201. */
  202. static void sync_from_steppers();
  203. /**
  204. * Set the E position (mm) of the planner (and the E stepper)
  205. */
  206. static void set_e_position_mm(const float& e);
  207. /**
  208. * Does the buffer have any blocks queued?
  209. */
  210. static bool blocks_queued() { return (block_buffer_head != block_buffer_tail); }
  211. /**
  212. * "Discards" the block and "releases" the memory.
  213. * Called when the current block is no longer needed.
  214. */
  215. static void discard_current_block() {
  216. if (blocks_queued())
  217. block_buffer_tail = BLOCK_MOD(block_buffer_tail + 1);
  218. }
  219. /**
  220. * The current block. NULL if the buffer is empty.
  221. * This also marks the block as busy.
  222. */
  223. static block_t* get_current_block() {
  224. if (blocks_queued()) {
  225. block_t* block = &block_buffer[block_buffer_tail];
  226. block->busy = true;
  227. return block;
  228. }
  229. else
  230. return NULL;
  231. }
  232. #if ENABLED(AUTOTEMP)
  233. static float autotemp_max;
  234. static float autotemp_min;
  235. static float autotemp_factor;
  236. static bool autotemp_enabled;
  237. static void getHighESpeed();
  238. static void autotemp_M109();
  239. #endif
  240. private:
  241. /**
  242. * Get the index of the next / previous block in the ring buffer
  243. */
  244. static int8_t next_block_index(int8_t block_index) { return BLOCK_MOD(block_index + 1); }
  245. static int8_t prev_block_index(int8_t block_index) { return BLOCK_MOD(block_index - 1); }
  246. /**
  247. * Calculate the distance (not time) it takes to accelerate
  248. * from initial_rate to target_rate using the given acceleration:
  249. */
  250. static float estimate_acceleration_distance(float initial_rate, float target_rate, float accel) {
  251. if (accel == 0) return 0; // accel was 0, set acceleration distance to 0
  252. return (sq(target_rate) - sq(initial_rate)) / (accel * 2);
  253. }
  254. /**
  255. * Return the point at which you must start braking (at the rate of -'acceleration') if
  256. * you start at 'initial_rate', accelerate (until reaching the point), and want to end at
  257. * 'final_rate' after traveling 'distance'.
  258. *
  259. * This is used to compute the intersection point between acceleration and deceleration
  260. * in cases where the "trapezoid" has no plateau (i.e., never reaches maximum speed)
  261. */
  262. static float intersection_distance(float initial_rate, float final_rate, float accel, float distance) {
  263. if (accel == 0) return 0; // accel was 0, set intersection distance to 0
  264. return (accel * 2 * distance - sq(initial_rate) + sq(final_rate)) / (accel * 4);
  265. }
  266. /**
  267. * Calculate the maximum allowable speed at this point, in order
  268. * to reach 'target_velocity' using 'acceleration' within a given
  269. * 'distance'.
  270. */
  271. static float max_allowable_speed(float accel, float target_velocity, float distance) {
  272. return sqrt(sq(target_velocity) - 2 * accel * distance);
  273. }
  274. static void calculate_trapezoid_for_block(block_t* block, float entry_factor, float exit_factor);
  275. static void reverse_pass_kernel(block_t* current, block_t* next);
  276. static void forward_pass_kernel(block_t* previous, block_t* current);
  277. static void reverse_pass();
  278. static void forward_pass();
  279. static void recalculate_trapezoids();
  280. static void recalculate();
  281. };
  282. #endif // PLANNER_H