-
Notifications
You must be signed in to change notification settings - Fork 995
/
Block.cpp
333 lines (276 loc) · 15.8 KB
/
Block.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
/*
This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
Smoothie is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Smoothie is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
*/
#include "libs/Module.h"
#include "libs/Kernel.h"
#include "libs/nuts_bolts.h"
#include <math.h>
#include <string>
#include "Block.h"
#include "Planner.h"
#include "Conveyor.h"
#include "Gcode.h"
#include "libs/StreamOutputPool.h"
#include "StepTicker.h"
#include "mri.h"
using std::string;
#include <vector>
#define STEP_TICKER_FREQUENCY THEKERNEL->step_ticker->get_frequency()
#define STEP_TICKER_FREQUENCY_2 (STEP_TICKER_FREQUENCY*STEP_TICKER_FREQUENCY)
uint8_t Block::n_actuators= 0;
// A block represents a movement, it's length for each stepper motor, and the corresponding acceleration curves.
// It's stacked on a queue, and that queue is then executed in order, to move the motors.
// Most of the accel math is also done in this class
// And GCode objects for use in on_gcode_execute are also help in here
Block::Block()
{
clear();
}
void Block::clear()
{
is_ready = false;
this->steps.fill(0);
steps_event_count = 0;
nominal_rate = 0.0F;
nominal_speed = 0.0F;
millimeters = 0.0F;
entry_speed = 0.0F;
exit_speed = 0.0F;
acceleration = 100.0F; // we don't want to get divide by zeroes if this is not set
initial_rate = 0.0F;
accelerate_until = 0;
decelerate_after = 0;
direction_bits = 0;
recalculate_flag = false;
nominal_length_flag = false;
max_entry_speed = 0.0F;
is_ticking = false;
is_g123 = false;
locked = false;
s_value = 0.0F;
acceleration_per_tick= 0;
deceleration_per_tick= 0;
total_move_ticks= 0;
if(tick_info.size() != n_actuators) {
tick_info.resize(n_actuators);
}
for(auto &i : tick_info) {
i.steps_per_tick= 0;
i.counter= 0;
i.acceleration_change= 0;
i.deceleration_change= 0;
i.plateau_rate= 0;
i.steps_to_move= 0;
i.step_count= 0;
i.next_accel_event= 0;
}
}
void Block::debug() const
{
THEKERNEL->streams->printf("%p: steps-X:%lu Y:%lu Z:%lu ", this, this->steps[0], this->steps[1], this->steps[2]);
for (size_t i = E_AXIS; i < n_actuators; ++i) {
THEKERNEL->streams->printf("E%d:%lu ", i-E_AXIS, this->steps[i]);
}
THEKERNEL->streams->printf("(max:%lu) nominal:r%1.4f/s%1.4f mm:%1.4f acc:%1.2f accu:%lu decu:%lu ticks:%lu rates:%1.4f entry/max:%1.4f/%1.4f exit:%1.4f primary:%d ready:%d locked:%d ticking:%d recalc:%d nomlen:%d time:%f\r\n",
this->steps_event_count,
this->nominal_rate,
this->nominal_speed,
this->millimeters,
this->acceleration,
this->accelerate_until,
this->decelerate_after,
this->total_move_ticks,
this->initial_rate,
this->entry_speed,
this->max_entry_speed,
this->exit_speed,
this->primary_axis,
this->is_ready,
this->locked,
this->is_ticking,
recalculate_flag ? 1 : 0,
nominal_length_flag ? 1 : 0,
total_move_ticks/STEP_TICKER_FREQUENCY
);
}
/* Calculates trapezoid parameters so that the entry- and exit-speed is compensated by the provided factors.
// The factors represent a factor of braking and must be in the range 0.0-1.0.
// +--------+ <- nominal_rate
// / \
// nominal_rate*entry_factor -> + \
// | + <- nominal_rate*exit_factor
// +-------------+
// time -->
*/
void Block::calculate_trapezoid( float entryspeed, float exitspeed )
{
// if block is currently executing, don't touch anything!
if (is_ticking) return;
float initial_rate = this->nominal_rate * (entryspeed / this->nominal_speed); // steps/sec
float final_rate = this->nominal_rate * (exitspeed / this->nominal_speed);
//printf("Initial rate: %f, final_rate: %f\n", initial_rate, final_rate);
// How many steps ( can be fractions of steps, we need very precise values ) to accelerate and decelerate
// This is a simplification to get rid of rate_delta and get the steps/s² accel directly from the mm/s² accel
float acceleration_per_second = (this->acceleration * this->steps_event_count) / this->millimeters;
float maximum_possible_rate = sqrtf( ( this->steps_event_count * acceleration_per_second ) + ( ( powf(initial_rate, 2) + powf(final_rate, 2) ) / 2.0F ) );
//printf("id %d: acceleration_per_second: %f, maximum_possible_rate: %f steps/sec, %f mm/sec\n", this->id, acceleration_per_second, maximum_possible_rate, maximum_possible_rate/100);
// Now this is the maximum rate we'll achieve this move, either because
// it's the higher we can achieve, or because it's the higher we are
// allowed to achieve
this->maximum_rate = std::min(maximum_possible_rate, this->nominal_rate);
// Now figure out how long it takes to accelerate in seconds
float time_to_accelerate = ( this->maximum_rate - initial_rate ) / acceleration_per_second;
// Now figure out how long it takes to decelerate
float time_to_decelerate = ( final_rate - this->maximum_rate ) / -acceleration_per_second;
// Now we know how long it takes to accelerate and decelerate, but we must
// also know how long the entire move takes so we can figure out how long
// is the plateau if there is one
float plateau_time = 0;
// Only if there is actually a plateau ( we are limited by nominal_rate )
if(maximum_possible_rate > this->nominal_rate) {
// Figure out the acceleration and deceleration distances ( in steps )
float acceleration_distance = ( ( initial_rate + this->maximum_rate ) / 2.0F ) * time_to_accelerate;
float deceleration_distance = ( ( this->maximum_rate + final_rate ) / 2.0F ) * time_to_decelerate;
// Figure out the plateau steps
float plateau_distance = this->steps_event_count - acceleration_distance - deceleration_distance;
// Figure out the plateau time in seconds
plateau_time = plateau_distance / this->maximum_rate;
}
// Figure out how long the move takes total ( in seconds )
float total_move_time = time_to_accelerate + time_to_decelerate + plateau_time;
//puts "total move time: #{total_move_time}s time to accelerate: #{time_to_accelerate}, time to decelerate: #{time_to_decelerate}"
// We now have the full timing for acceleration, plateau and deceleration,
// yay \o/ Now this is very important these are in seconds, and we need to
// round them into ticks. This means instead of accelerating in 100.23
// ticks we'll accelerate in 100 ticks. Which means to reach the exact
// speed we want to reach, we must figure out a new/slightly different
// acceleration/deceleration to be sure we accelerate and decelerate at
// the exact rate we want
// First off round total time, acceleration time and deceleration time in ticks
uint32_t acceleration_ticks = floorf( time_to_accelerate * STEP_TICKER_FREQUENCY );
uint32_t deceleration_ticks = floorf( time_to_decelerate * STEP_TICKER_FREQUENCY );
uint32_t total_move_ticks = floorf( total_move_time * STEP_TICKER_FREQUENCY );
// Now deduce the plateau time for those new values expressed in tick
//uint32_t plateau_ticks = total_move_ticks - acceleration_ticks - deceleration_ticks;
// Now we figure out the acceleration value to reach EXACTLY maximum_rate(steps/s) in EXACTLY acceleration_ticks(ticks) amount of time in seconds
float acceleration_time = acceleration_ticks / STEP_TICKER_FREQUENCY; // This can be moved into the operation below, separated for clarity, note we need to do this instead of using time_to_accelerate(seconds) directly because time_to_accelerate(seconds) and acceleration_ticks(seconds) do not have the same value anymore due to the rounding
float deceleration_time = deceleration_ticks / STEP_TICKER_FREQUENCY;
float acceleration_in_steps = (acceleration_time > 0.0F ) ? ( this->maximum_rate - initial_rate ) / acceleration_time : 0;
float deceleration_in_steps = (deceleration_time > 0.0F ) ? ( this->maximum_rate - final_rate ) / deceleration_time : 0;
// we have a potential race condition here as we could get interrupted anywhere in the middle of this call, we need to lock
// the updates to the blocks to get around it
this->locked= true;
// Now figure out the two acceleration ramp change events in ticks
this->accelerate_until = acceleration_ticks;
this->decelerate_after = total_move_ticks - deceleration_ticks;
// Now figure out the acceleration PER TICK, this should ideally be held as a float, even a double if possible as it's very critical to the block timing
// steps/tick^2
this->acceleration_per_tick = acceleration_in_steps / STEP_TICKER_FREQUENCY_2;
this->deceleration_per_tick = deceleration_in_steps / STEP_TICKER_FREQUENCY_2;
// We now have everything we need for this block to call a Steppermotor->move method !!!!
// Theorically, if accel is done per tick, the speed curve should be perfect.
this->total_move_ticks = total_move_ticks;
//puts "accelerate_until: #{this->accelerate_until}, decelerate_after: #{this->decelerate_after}, acceleration_per_tick: #{this->acceleration_per_tick}, total_move_ticks: #{this->total_move_ticks}"
this->initial_rate = initial_rate;
this->exit_speed = exitspeed;
// prepare the block for stepticker
this->prepare();
this->locked= false;
}
// Calculates the maximum allowable speed at this point when you must be able to reach target_velocity using the
// acceleration within the allotted distance.
float Block::max_allowable_speed(float acceleration, float target_velocity, float distance)
{
return sqrtf(target_velocity * target_velocity - 2.0F * acceleration * distance);
}
// Called by Planner::recalculate() when scanning the plan from last to first entry.
float Block::reverse_pass(float exit_speed)
{
// If entry speed is already at the maximum entry speed, no need to recheck. Block is cruising.
// If not, block in state of acceleration or deceleration. Reset entry speed to maximum and
// check for maximum allowable speed reductions to ensure maximum possible planned speed.
if (this->entry_speed != this->max_entry_speed) {
// If nominal length true, max junction speed is guaranteed to be reached. Only compute
// for max allowable speed if block is decelerating and nominal length is false.
if ((!this->nominal_length_flag) && (this->max_entry_speed > exit_speed)) {
float max_entry_speed = max_allowable_speed(-this->acceleration, exit_speed, this->millimeters);
this->entry_speed = min(max_entry_speed, this->max_entry_speed);
return this->entry_speed;
} else
this->entry_speed = this->max_entry_speed;
}
return this->entry_speed;
}
// Called by Planner::recalculate() when scanning the plan from first to last entry.
// returns maximum exit speed of this block
float Block::forward_pass(float prev_max_exit_speed)
{
// If the previous block is an acceleration block, but it is not long enough to complete the
// full speed change within the block, we need to adjust the entry speed accordingly. Entry
// speeds have already been reset, maximized, and reverse planned by reverse planner.
// If nominal length is true, max junction speed is guaranteed to be reached. No need to recheck.
// TODO: find out if both of these checks are necessary
if (prev_max_exit_speed > nominal_speed)
prev_max_exit_speed = nominal_speed;
if (prev_max_exit_speed > max_entry_speed)
prev_max_exit_speed = max_entry_speed;
if (prev_max_exit_speed <= entry_speed) {
// accel limited
entry_speed = prev_max_exit_speed;
// since we're now acceleration or cruise limited
// we don't need to recalculate our entry speed anymore
recalculate_flag = false;
}
// else
// // decel limited, do nothing
return max_exit_speed();
}
float Block::max_exit_speed()
{
// if block is currently executing, return cached exit speed from calculate_trapezoid
// this ensures that a block following a currently executing block will have correct entry speed
if(is_ticking)
return this->exit_speed;
// if nominal_length_flag is asserted
// we are guaranteed to reach nominal speed regardless of entry speed
// thus, max exit will always be nominal
if (nominal_length_flag)
return nominal_speed;
// otherwise, we have to work out max exit speed based on entry and acceleration
float max = max_allowable_speed(-this->acceleration, this->entry_speed, this->millimeters);
return min(max, nominal_speed);
}
// prepare block for the step ticker, called everytime the block changes
// this is done during planning so does not delay tick generation and step ticker can simply grab the next block during the interrupt
void Block::prepare()
{
float inv = 1.0F / this->steps_event_count;
for (uint8_t m = 0; m < n_actuators; m++) {
uint32_t steps = this->steps[m];
this->tick_info[m].steps_to_move = steps;
if(steps == 0) continue;
float aratio = inv * steps;
this->tick_info[m].steps_per_tick = STEPTICKER_TOFP((this->initial_rate * aratio) / STEP_TICKER_FREQUENCY); // steps/sec / tick frequency to get steps per tick in 2.30 fixed point
this->tick_info[m].counter = 0; // 2.30 fixed point
this->tick_info[m].step_count = 0;
this->tick_info[m].next_accel_event = this->total_move_ticks + 1;
float acceleration_change = 0;
if(this->accelerate_until != 0) { // If the next accel event is the end of accel
this->tick_info[m].next_accel_event = this->accelerate_until;
acceleration_change = this->acceleration_per_tick;
} else if(this->decelerate_after == 0 /*&& this->accelerate_until == 0*/) {
// we start off decelerating
acceleration_change = -this->deceleration_per_tick;
} else if(this->decelerate_after != this->total_move_ticks /*&& this->accelerate_until == 0*/) {
// If the next event is the start of decel ( don't set this if the next accel event is accel end )
this->tick_info[m].next_accel_event = this->decelerate_after;
}
// convert to fixed point after scaling
this->tick_info[m].acceleration_change= STEPTICKER_TOFP(acceleration_change * aratio);
this->tick_info[m].deceleration_change= -STEPTICKER_TOFP(this->deceleration_per_tick * aratio);
this->tick_info[m].plateau_rate= STEPTICKER_TOFP((this->maximum_rate * aratio) / STEP_TICKER_FREQUENCY);
}
}