Update TemperatureControl.cpp
[clinton/Smoothieware.git] / src / modules / robot / Robot.cpp
CommitLineData
df27a6a3 1/*
aab6cbba 2 This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl) with additions from Sungeun K. Jeon (https://github.com/chamnit/grbl)
4cff3ded
AW
3 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.
4 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.
df27a6a3 5 You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
4cff3ded
AW
6*/
7
8#include "libs/Module.h"
9#include "libs/Kernel.h"
5673fe39 10
29e809e0 11#include "Robot.h"
4cff3ded 12#include "Planner.h"
3fceb8eb 13#include "Conveyor.h"
5673fe39
MM
14#include "Pin.h"
15#include "StepperMotor.h"
16#include "Gcode.h"
5647f709 17#include "PublicDataRequest.h"
928467c0 18#include "PublicData.h"
4cff3ded
AW
19#include "arm_solutions/BaseSolution.h"
20#include "arm_solutions/CartesianSolution.h"
c41d6d95 21#include "arm_solutions/RotatableCartesianSolution.h"
2a06c415 22#include "arm_solutions/LinearDeltaSolution.h"
11a39396 23#include "arm_solutions/RotaryDeltaSolution.h"
bdaaa75d 24#include "arm_solutions/HBotSolution.h"
fff1e42d 25#include "arm_solutions/CoreXZSolution.h"
1217e470 26#include "arm_solutions/MorganSCARASolution.h"
61134a65 27#include "StepTicker.h"
7af0714f
JM
28#include "checksumm.h"
29#include "utils.h"
8d54c34c 30#include "ConfigValue.h"
5966b7d0 31#include "libs/StreamOutput.h"
dd0a7cfa 32#include "StreamOutputPool.h"
928467c0 33#include "ExtruderPublicAccess.h"
0ec2f63a 34#include "GcodeDispatch.h"
13ad7234 35#include "ActuatorCoordinates.h"
0ec2f63a 36
29e809e0
JM
37#include "mbed.h" // for us_ticker_read()
38#include "mri.h"
39
40#include <fastmath.h>
41#include <string>
42#include <algorithm>
38bf9a1c 43
78d0e16a
MM
44#define default_seek_rate_checksum CHECKSUM("default_seek_rate")
45#define default_feed_rate_checksum CHECKSUM("default_feed_rate")
46#define mm_per_line_segment_checksum CHECKSUM("mm_per_line_segment")
47#define delta_segments_per_second_checksum CHECKSUM("delta_segments_per_second")
48#define mm_per_arc_segment_checksum CHECKSUM("mm_per_arc_segment")
83c6e067 49#define mm_max_arc_error_checksum CHECKSUM("mm_max_arc_error")
78d0e16a
MM
50#define arc_correction_checksum CHECKSUM("arc_correction")
51#define x_axis_max_speed_checksum CHECKSUM("x_axis_max_speed")
52#define y_axis_max_speed_checksum CHECKSUM("y_axis_max_speed")
53#define z_axis_max_speed_checksum CHECKSUM("z_axis_max_speed")
a3e1326a 54#define segment_z_moves_checksum CHECKSUM("segment_z_moves")
3aad33c7 55#define save_g92_checksum CHECKSUM("save_g92")
39280f30 56#define set_g92_checksum CHECKSUM("set_g92")
43424972
JM
57
58// arm solutions
78d0e16a
MM
59#define arm_solution_checksum CHECKSUM("arm_solution")
60#define cartesian_checksum CHECKSUM("cartesian")
61#define rotatable_cartesian_checksum CHECKSUM("rotatable_cartesian")
62#define rostock_checksum CHECKSUM("rostock")
2a06c415 63#define linear_delta_checksum CHECKSUM("linear_delta")
11a39396 64#define rotary_delta_checksum CHECKSUM("rotary_delta")
78d0e16a
MM
65#define delta_checksum CHECKSUM("delta")
66#define hbot_checksum CHECKSUM("hbot")
67#define corexy_checksum CHECKSUM("corexy")
fff1e42d 68#define corexz_checksum CHECKSUM("corexz")
78d0e16a 69#define kossel_checksum CHECKSUM("kossel")
1217e470 70#define morgan_checksum CHECKSUM("morgan")
78d0e16a 71
78d0e16a
MM
72// new-style actuator stuff
73#define actuator_checksum CHEKCSUM("actuator")
74
75#define step_pin_checksum CHECKSUM("step_pin")
76#define dir_pin_checksum CHEKCSUM("dir_pin")
77#define en_pin_checksum CHECKSUM("en_pin")
78
79#define steps_per_mm_checksum CHECKSUM("steps_per_mm")
df6a30f2 80#define max_rate_checksum CHECKSUM("max_rate")
29e809e0
JM
81#define acceleration_checksum CHECKSUM("acceleration")
82#define z_acceleration_checksum CHECKSUM("z_acceleration")
78d0e16a
MM
83
84#define alpha_checksum CHECKSUM("alpha")
85#define beta_checksum CHECKSUM("beta")
86#define gamma_checksum CHECKSUM("gamma")
87
507b2403
JM
88#define laser_module_default_power_checksum CHECKSUM("laser_module_default_power")
89
29e809e0
JM
90#define ARC_ANGULAR_TRAVEL_EPSILON 5E-7F // Float (radians)
91#define PI 3.14159265358979323846F // force to be float, do not use M_PI
5fa0c173 92
edac9072
AW
93// The Robot converts GCodes into actual movements, and then adds them to the Planner, which passes them to the Conveyor so they can be added to the queue
94// It takes care of cutting arcs into segments, same thing for line that are too long
95
4710532a
JM
96Robot::Robot()
97{
a1b7e9f0 98 this->inch_mode = false;
0e8b102e 99 this->absolute_mode = true;
29e809e0 100 this->e_absolute_mode = true;
4cff3ded 101 this->select_plane(X_AXIS, Y_AXIS, Z_AXIS);
45ca77ec
JM
102 memset(this->machine_position, 0, sizeof machine_position);
103 memset(this->compensated_machine_position, 0, sizeof compensated_machine_position);
0b804a41 104 this->arm_solution = NULL;
da947c62 105 seconds_per_minute = 60.0F;
fae93525 106 this->clearToolOffset();
03b01bac 107 this->compensationTransform = nullptr;
121094a5 108 this->get_e_scale_fnc= nullptr;
03b01bac
JM
109 this->wcs_offsets.fill(wcs_t(0.0F, 0.0F, 0.0F));
110 this->g92_offset = wcs_t(0.0F, 0.0F, 0.0F);
a6bbe768 111 this->next_command_is_MCS = false;
778093ce 112 this->disable_segmentation= false;
84cf4071 113 this->disable_arm_solution= false;
29e809e0 114 this->n_motors= 0;
4cff3ded
AW
115}
116
117//Called when the module has just been loaded
4710532a
JM
118void Robot::on_module_loaded()
119{
4cff3ded
AW
120 this->register_for_event(ON_GCODE_RECEIVED);
121
122 // Configuration
807b9b57 123 this->load_config();
da24d6ae
AW
124}
125
807b9b57
JM
126#define ACTUATOR_CHECKSUMS(X) { \
127 CHECKSUM(X "_step_pin"), \
128 CHECKSUM(X "_dir_pin"), \
129 CHECKSUM(X "_en_pin"), \
130 CHECKSUM(X "_steps_per_mm"), \
29e809e0
JM
131 CHECKSUM(X "_max_rate"), \
132 CHECKSUM(X "_acceleration") \
807b9b57 133}
5984acdf 134
807b9b57
JM
135void Robot::load_config()
136{
edac9072
AW
137 // Arm solutions are used to convert positions in millimeters into position in steps for each stepper motor.
138 // While for a cartesian arm solution, this is a simple multiplication, in other, less simple cases, there is some serious math to be done.
139 // To make adding those solution easier, they have their own, separate object.
5984acdf 140 // Here we read the config to find out which arm solution to use
0b804a41 141 if (this->arm_solution) delete this->arm_solution;
eda9facc 142 int solution_checksum = get_checksum(THEKERNEL->config->value(arm_solution_checksum)->by_default("cartesian")->as_string());
d149c730 143 // Note checksums are not const expressions when in debug mode, so don't use switch
98761c28 144 if(solution_checksum == hbot_checksum || solution_checksum == corexy_checksum) {
314ab8f7 145 this->arm_solution = new HBotSolution(THEKERNEL->config);
bdaaa75d 146
fff1e42d
JJ
147 } else if(solution_checksum == corexz_checksum) {
148 this->arm_solution = new CoreXZSolution(THEKERNEL->config);
149
2a06c415
JM
150 } else if(solution_checksum == rostock_checksum || solution_checksum == kossel_checksum || solution_checksum == delta_checksum || solution_checksum == linear_delta_checksum) {
151 this->arm_solution = new LinearDeltaSolution(THEKERNEL->config);
73a4e3c0 152
4710532a 153 } else if(solution_checksum == rotatable_cartesian_checksum) {
314ab8f7 154 this->arm_solution = new RotatableCartesianSolution(THEKERNEL->config);
b73a756d 155
11a39396
JM
156 } else if(solution_checksum == rotary_delta_checksum) {
157 this->arm_solution = new RotaryDeltaSolution(THEKERNEL->config);
c52b8675 158
1217e470
QH
159 } else if(solution_checksum == morgan_checksum) {
160 this->arm_solution = new MorganSCARASolution(THEKERNEL->config);
161
4710532a 162 } else if(solution_checksum == cartesian_checksum) {
314ab8f7 163 this->arm_solution = new CartesianSolution(THEKERNEL->config);
73a4e3c0 164
4710532a 165 } else {
314ab8f7 166 this->arm_solution = new CartesianSolution(THEKERNEL->config);
d149c730 167 }
73a4e3c0 168
6b661ab3
DP
169 this->feed_rate = THEKERNEL->config->value(default_feed_rate_checksum )->by_default( 100.0F)->as_number();
170 this->seek_rate = THEKERNEL->config->value(default_seek_rate_checksum )->by_default( 100.0F)->as_number();
171 this->mm_per_line_segment = THEKERNEL->config->value(mm_per_line_segment_checksum )->by_default( 0.0F)->as_number();
172 this->delta_segments_per_second = THEKERNEL->config->value(delta_segments_per_second_checksum )->by_default(0.0f )->as_number();
b259f517 173 this->mm_per_arc_segment = THEKERNEL->config->value(mm_per_arc_segment_checksum )->by_default( 0.0f)->as_number();
4d0f60a9 174 this->mm_max_arc_error = THEKERNEL->config->value(mm_max_arc_error_checksum )->by_default( 0.01f)->as_number();
6b661ab3 175 this->arc_correction = THEKERNEL->config->value(arc_correction_checksum )->by_default( 5 )->as_number();
78d0e16a 176
29e809e0 177 // in mm/sec but specified in config as mm/min
6b661ab3
DP
178 this->max_speeds[X_AXIS] = THEKERNEL->config->value(x_axis_max_speed_checksum )->by_default(60000.0F)->as_number() / 60.0F;
179 this->max_speeds[Y_AXIS] = THEKERNEL->config->value(y_axis_max_speed_checksum )->by_default(60000.0F)->as_number() / 60.0F;
180 this->max_speeds[Z_AXIS] = THEKERNEL->config->value(z_axis_max_speed_checksum )->by_default( 300.0F)->as_number() / 60.0F;
feb204be 181
a3e1326a 182 this->segment_z_moves = THEKERNEL->config->value(segment_z_moves_checksum )->by_default(true)->as_bool();
3aad33c7 183 this->save_g92 = THEKERNEL->config->value(save_g92_checksum )->by_default(false)->as_bool();
39280f30
JM
184 string g92 = THEKERNEL->config->value(set_g92_checksum )->by_default("")->as_string();
185 if(!g92.empty()) {
186 // optional setting for a fixed G92 offset
187 std::vector<float> t= parse_number_list(g92.c_str());
188 if(t.size() == 3) {
189 g92_offset = wcs_t(t[0], t[1], t[2]);
190 }
191 }
a3e1326a 192
507b2403
JM
193 // default s value for laser
194 this->s_value = THEKERNEL->config->value(laser_module_default_power_checksum)->by_default(0.8F)->as_number();
195
319e12fc 196 // Make our Primary XYZ StepperMotors, and potentially A B C
29e809e0
JM
197 uint16_t const checksums[][6] = {
198 ACTUATOR_CHECKSUMS("alpha"), // X
199 ACTUATOR_CHECKSUMS("beta"), // Y
200 ACTUATOR_CHECKSUMS("gamma"), // Z
37b7b898
JM
201 #if MAX_ROBOT_ACTUATORS > 3
202 ACTUATOR_CHECKSUMS("delta"), // A
203 #if MAX_ROBOT_ACTUATORS > 4
204 ACTUATOR_CHECKSUMS("epsilon"), // B
205 #if MAX_ROBOT_ACTUATORS > 5
206 ACTUATOR_CHECKSUMS("zeta") // C
207 #endif
208 #endif
209 #endif
807b9b57 210 };
807b9b57 211
29e809e0
JM
212 // default acceleration setting, can be overriden with newer per axis settings
213 this->default_acceleration= THEKERNEL->config->value(acceleration_checksum)->by_default(100.0F )->as_number(); // Acceleration is in mm/s^2
214
215 // make each motor
37b7b898 216 for (size_t a = 0; a < MAX_ROBOT_ACTUATORS; a++) {
807b9b57
JM
217 Pin pins[3]; //step, dir, enable
218 for (size_t i = 0; i < 3; i++) {
219 pins[i].from_string(THEKERNEL->config->value(checksums[a][i])->by_default("nc")->as_string())->as_output();
96ef0809
JM
220 }
221
4d5d8050
JM
222 if(!pins[0].connected() || !pins[1].connected()) { // step and dir must be defined, but enable is optional
223 if(a <= Z_AXIS) {
224 THEKERNEL->streams->printf("FATAL: motor %c is not defined in config\n", 'X'+a);
225 n_motors= a; // we only have this number of motors
226 return;
227 }
96ef0809 228 break; // if any pin is not defined then the axis is not defined (and axis need to be defined in contiguous order)
807b9b57 229 }
37b7b898 230
29e809e0
JM
231 StepperMotor *sm = new StepperMotor(pins[0], pins[1], pins[2]);
232 // register this motor (NB This must be 0,1,2) of the actuators array
233 uint8_t n= register_motor(sm);
234 if(n != a) {
235 // this is a fatal error
236 THEKERNEL->streams->printf("FATAL: motor %d does not match index %d\n", n, a);
4d5d8050 237 return;
29e809e0 238 }
78d0e16a 239
03b01bac 240 actuators[a]->change_steps_per_mm(THEKERNEL->config->value(checksums[a][3])->by_default(a == 2 ? 2560.0F : 80.0F)->as_number());
3702f300 241 actuators[a]->set_max_rate(THEKERNEL->config->value(checksums[a][4])->by_default(30000.0F)->as_number()/60.0F); // it is in mm/min and converted to mm/sec
29e809e0 242 actuators[a]->set_acceleration(THEKERNEL->config->value(checksums[a][5])->by_default(NAN)->as_number()); // mm/secs²
807b9b57 243 }
a84f0186 244
dd0a7cfa 245 check_max_actuator_speeds(); // check the configs are sane
df6a30f2 246
29e809e0
JM
247 // if we have not specified a z acceleration see if the legacy config was set
248 if(isnan(actuators[Z_AXIS]->get_acceleration())) {
249 float acc= THEKERNEL->config->value(z_acceleration_checksum)->by_default(NAN)->as_number(); // disabled by default
250 if(!isnan(acc)) {
251 actuators[Z_AXIS]->set_acceleration(acc);
252 }
253 }
254
975469ad
MM
255 // initialise actuator positions to current cartesian position (X0 Y0 Z0)
256 // so the first move can be correct if homing is not performed
807b9b57 257 ActuatorCoordinates actuator_pos;
45ca77ec 258 arm_solution->cartesian_to_actuator(machine_position, actuator_pos);
29e809e0 259 for (size_t i = 0; i < n_motors; i++)
975469ad 260 actuators[i]->change_last_milestone(actuator_pos[i]);
5966b7d0
AT
261
262 //this->clearToolOffset();
4cff3ded
AW
263}
264
29e809e0
JM
265uint8_t Robot::register_motor(StepperMotor *motor)
266{
267 // register this motor with the step ticker
268 THEKERNEL->step_ticker->register_motor(motor);
269 if(n_motors >= k_max_actuators) {
270 // this is a fatal error
271 THEKERNEL->streams->printf("FATAL: too many motors, increase k_max_actuators\n");
272 __debugbreak();
273 }
2cd32d70 274 actuators.push_back(motor);
8e30d648 275 motor->set_motor_id(n_motors);
2cd32d70 276 return n_motors++;
29e809e0
JM
277}
278
212caccd
JM
279void Robot::push_state()
280{
03b01bac 281 bool am = this->absolute_mode;
29e809e0 282 bool em = this->e_absolute_mode;
03b01bac 283 bool im = this->inch_mode;
29e809e0 284 saved_state_t s(this->feed_rate, this->seek_rate, am, em, im, current_wcs);
212caccd
JM
285 state_stack.push(s);
286}
287
288void Robot::pop_state()
289{
03b01bac
JM
290 if(!state_stack.empty()) {
291 auto s = state_stack.top();
212caccd 292 state_stack.pop();
03b01bac
JM
293 this->feed_rate = std::get<0>(s);
294 this->seek_rate = std::get<1>(s);
295 this->absolute_mode = std::get<2>(s);
29e809e0
JM
296 this->e_absolute_mode = std::get<3>(s);
297 this->inch_mode = std::get<4>(s);
298 this->current_wcs = std::get<5>(s);
212caccd
JM
299 }
300}
301
34210908
JM
302std::vector<Robot::wcs_t> Robot::get_wcs_state() const
303{
304 std::vector<wcs_t> v;
0b8b81b6 305 v.push_back(wcs_t(current_wcs, MAX_WCS, 0));
34210908
JM
306 for(auto& i : wcs_offsets) {
307 v.push_back(i);
308 }
309 v.push_back(g92_offset);
310 v.push_back(tool_offset);
311 return v;
312}
313
fdfa00d2
JM
314void Robot::get_current_machine_position(float *pos) const
315{
316 // get real time current actuator position in mm
317 ActuatorCoordinates current_position{
318 actuators[X_AXIS]->get_current_position(),
319 actuators[Y_AXIS]->get_current_position(),
320 actuators[Z_AXIS]->get_current_position()
321 };
322
323 // get machine position from the actuator position using FK
324 arm_solution->actuator_to_cartesian(current_position, pos);
325}
326
12ce413f 327void Robot::print_position(uint8_t subcode, std::string& res, bool ignore_extruders) const
2791c829
JM
328{
329 // M114.1 is a new way to do this (similar to how GRBL does it).
330 // it returns the realtime position based on the current step position of the actuators.
331 // this does require a FK to get a machine position from the actuator position
332 // and then invert all the transforms to get a workspace position from machine position
45ca77ec 333 // M114 just does it the old way uses machine_position and does inverse transforms to get the requested position
2791c829 334 int n = 0;
cb6bfefa 335 char buf[64];
e03f2747 336 if(subcode == 0) { // M114 print WCS
45ca77ec 337 wcs_t pos= mcs2wcs(machine_position);
cb6bfefa 338 n = snprintf(buf, sizeof(buf), "C: X:%1.4f Y:%1.4f Z:%1.4f", from_millimeters(std::get<X_AXIS>(pos)), from_millimeters(std::get<Y_AXIS>(pos)), from_millimeters(std::get<Z_AXIS>(pos)));
2791c829 339
81c3ecbf
JM
340 } else if(subcode == 4) {
341 // M114.4 print last milestone
cb6bfefa 342 n = snprintf(buf, sizeof(buf), "MP: X:%1.4f Y:%1.4f Z:%1.4f", machine_position[X_AXIS], machine_position[Y_AXIS], machine_position[Z_AXIS]);
2791c829 343
81c3ecbf
JM
344 } else if(subcode == 5) {
345 // M114.5 print last machine position (which should be the same as M114.1 if axis are not moving and no level compensation)
346 // will differ from LMS by the compensation at the current position otherwise
cb6bfefa 347 n = snprintf(buf, sizeof(buf), "CMP: X:%1.4f Y:%1.4f Z:%1.4f", compensated_machine_position[X_AXIS], compensated_machine_position[Y_AXIS], compensated_machine_position[Z_AXIS]);
2791c829
JM
348
349 } else {
350 // get real time positions
2791c829 351 float mpos[3];
fdfa00d2
JM
352 get_current_machine_position(mpos);
353
8fe38353
JM
354 // current_position/mpos includes the compensation transform so we need to get the inverse to get actual position
355 if(compensationTransform) compensationTransform(mpos, true); // get inverse compensation transform
2791c829 356
e03f2747 357 if(subcode == 1) { // M114.1 print realtime WCS
2791c829 358 wcs_t pos= mcs2wcs(mpos);
cb6bfefa 359 n = snprintf(buf, sizeof(buf), "WCS: X:%1.4f Y:%1.4f Z:%1.4f", from_millimeters(std::get<X_AXIS>(pos)), from_millimeters(std::get<Y_AXIS>(pos)), from_millimeters(std::get<Z_AXIS>(pos)));
2791c829 360
df4574e0 361 } else if(subcode == 2) { // M114.2 print realtime Machine coordinate system
cb6bfefa 362 n = snprintf(buf, sizeof(buf), "MCS: X:%1.4f Y:%1.4f Z:%1.4f", mpos[X_AXIS], mpos[Y_AXIS], mpos[Z_AXIS]);
2791c829 363
df4574e0 364 } else if(subcode == 3) { // M114.3 print realtime actuator position
fdfa00d2
JM
365 // get real time current actuator position in mm
366 ActuatorCoordinates current_position{
367 actuators[X_AXIS]->get_current_position(),
368 actuators[Y_AXIS]->get_current_position(),
369 actuators[Z_AXIS]->get_current_position()
370 };
cb6bfefa 371 n = snprintf(buf, sizeof(buf), "APOS: X:%1.4f Y:%1.4f Z:%1.4f", current_position[X_AXIS], current_position[Y_AXIS], current_position[Z_AXIS]);
2791c829
JM
372 }
373 }
96ef0809 374
cb6bfefa
JM
375 res.append(buf, n);
376
96ef0809
JM
377 #if MAX_ROBOT_ACTUATORS > 3
378 // deal with the ABC axis
379 for (int i = A_AXIS; i < n_motors; ++i) {
cb6bfefa 380 n= 0;
12ce413f 381 if(ignore_extruders && actuators[i]->is_extruder()) continue; // don't show an extruder as that will be E
96ef0809 382 if(subcode == 4) { // M114.4 print last milestone
cb6bfefa 383 n= snprintf(buf, sizeof(buf), " %c:%1.4f", 'A'+i-A_AXIS, machine_position[i]);
96ef0809 384
866eaaba 385 }else if(subcode == 2 || subcode == 3) { // M114.2/M114.3 print actuator position which is the same as machine position for ABC
96ef0809 386 // current actuator position
cb6bfefa 387 n= snprintf(buf, sizeof(buf), " %c:%1.4f", 'A'+i-A_AXIS, actuators[i]->get_current_position());
96ef0809 388 }
cb6bfefa 389 if(n > 0) res.append(buf, n);
96ef0809
JM
390 }
391 #endif
2791c829
JM
392}
393
dc27139b 394// converts current last milestone (machine position without compensation transform) to work coordinate system (inverse transform)
31c6c2c2 395Robot::wcs_t Robot::mcs2wcs(const Robot::wcs_t& pos) const
dc27139b
JM
396{
397 return std::make_tuple(
31c6c2c2
JM
398 std::get<X_AXIS>(pos) - std::get<X_AXIS>(wcs_offsets[current_wcs]) + std::get<X_AXIS>(g92_offset) - std::get<X_AXIS>(tool_offset),
399 std::get<Y_AXIS>(pos) - std::get<Y_AXIS>(wcs_offsets[current_wcs]) + std::get<Y_AXIS>(g92_offset) - std::get<Y_AXIS>(tool_offset),
400 std::get<Z_AXIS>(pos) - std::get<Z_AXIS>(wcs_offsets[current_wcs]) + std::get<Z_AXIS>(g92_offset) - std::get<Z_AXIS>(tool_offset)
dc27139b
JM
401 );
402}
403
dd0a7cfa
JM
404// this does a sanity check that actuator speeds do not exceed steps rate capability
405// we will override the actuator max_rate if the combination of max_rate and steps/sec exceeds base_stepping_frequency
406void Robot::check_max_actuator_speeds()
407{
29e809e0 408 for (size_t i = 0; i < n_motors; i++) {
6a5a91e0
JM
409 if(actuators[i]->is_extruder()) continue; //extruders are not included in this check
410
807b9b57
JM
411 float step_freq = actuators[i]->get_max_rate() * actuators[i]->get_steps_per_mm();
412 if (step_freq > THEKERNEL->base_stepping_frequency) {
413 actuators[i]->set_max_rate(floorf(THEKERNEL->base_stepping_frequency / actuators[i]->get_steps_per_mm()));
ad6a77d1 414 THEKERNEL->streams->printf("WARNING: actuator %d rate exceeds base_stepping_frequency * ..._steps_per_mm: %f, setting to %f\n", i, step_freq, actuators[i]->get_max_rate());
807b9b57 415 }
dd0a7cfa
JM
416 }
417}
418
4cff3ded 419//A GCode has been received
edac9072 420//See if the current Gcode line has some orders for us
4710532a
JM
421void Robot::on_gcode_received(void *argument)
422{
423 Gcode *gcode = static_cast<Gcode *>(argument);
6bc4a00a 424
29e809e0 425 enum MOTION_MODE_T motion_mode= NONE;
4cff3ded 426
4710532a
JM
427 if( gcode->has_g) {
428 switch( gcode->g ) {
29e809e0
JM
429 case 0: motion_mode = SEEK; break;
430 case 1: motion_mode = LINEAR; break;
431 case 2: motion_mode = CW_ARC; break;
432 case 3: motion_mode = CCW_ARC; break;
df0783b7 433 case 4: { // G4 Dwell
03b01bac 434 uint32_t delay_ms = 0;
c3df978d 435 if (gcode->has_letter('P')) {
df0783b7
JM
436 if(THEKERNEL->is_grbl_mode()) {
437 // in grbl mode (and linuxcnc) P is decimal seconds
438 float f= gcode->get_value('P');
439 delay_ms= f * 1000.0F;
440
441 }else{
442 // in reprap P is milliseconds, they always have to be different!
443 delay_ms = gcode->get_int('P');
444 }
c3df978d
JM
445 }
446 if (gcode->has_letter('S')) {
447 delay_ms += gcode->get_int('S') * 1000;
448 }
03b01bac 449 if (delay_ms > 0) {
c3df978d 450 // drain queue
04782655 451 THEKERNEL->conveyor->wait_for_idle();
c3df978d 452 // wait for specified time
03b01bac
JM
453 uint32_t start = us_ticker_read(); // mbed call
454 while ((us_ticker_read() - start) < delay_ms * 1000) {
c3df978d 455 THEKERNEL->call_event(ON_IDLE, this);
c2f7c261 456 if(THEKERNEL->is_halted()) return;
c3df978d
JM
457 }
458 }
adba2978 459 }
6b661ab3 460 break;
807b9b57 461
a6bbe768 462 case 10: // G10 L2 [L20] Pn Xn Yn Zn set WCS
00e607c7 463 if(gcode->has_letter('L') && (gcode->get_int('L') == 2 || gcode->get_int('L') == 20) && gcode->has_letter('P')) {
03b01bac
JM
464 size_t n = gcode->get_uint('P');
465 if(n == 0) n = current_wcs; // set current coordinate system
807b9b57 466 else --n;
0b8b81b6 467 if(n < MAX_WCS) {
807b9b57 468 float x, y, z;
03b01bac 469 std::tie(x, y, z) = wcs_offsets[n];
00e607c7 470 if(gcode->get_int('L') == 20) {
c2f7c261 471 // this makes the current machine position (less compensation transform) the offset
dc27139b 472 // get current position in WCS
45ca77ec 473 wcs_t pos= mcs2wcs(machine_position);
dc27139b
JM
474
475 if(gcode->has_letter('X')){
476 x -= to_millimeters(gcode->get_value('X')) - std::get<X_AXIS>(pos);
477 }
478
479 if(gcode->has_letter('Y')){
480 y -= to_millimeters(gcode->get_value('Y')) - std::get<Y_AXIS>(pos);
481 }
482 if(gcode->has_letter('Z')) {
483 z -= to_millimeters(gcode->get_value('Z')) - std::get<Z_AXIS>(pos);
484 }
485
a6bbe768 486 } else {
bb4e919a
JM
487 if(absolute_mode) {
488 // the value is the offset from machine zero
489 if(gcode->has_letter('X')) x = to_millimeters(gcode->get_value('X'));
490 if(gcode->has_letter('Y')) y = to_millimeters(gcode->get_value('Y'));
491 if(gcode->has_letter('Z')) z = to_millimeters(gcode->get_value('Z'));
492 }else{
493 if(gcode->has_letter('X')) x += to_millimeters(gcode->get_value('X'));
494 if(gcode->has_letter('Y')) y += to_millimeters(gcode->get_value('Y'));
495 if(gcode->has_letter('Z')) z += to_millimeters(gcode->get_value('Z'));
496 }
00e607c7 497 }
03b01bac 498 wcs_offsets[n] = wcs_t(x, y, z);
807b9b57
JM
499 }
500 }
501 break;
502
6e92ab91
JM
503 case 17: this->select_plane(X_AXIS, Y_AXIS, Z_AXIS); break;
504 case 18: this->select_plane(X_AXIS, Z_AXIS, Y_AXIS); break;
505 case 19: this->select_plane(Y_AXIS, Z_AXIS, X_AXIS); break;
506 case 20: this->inch_mode = true; break;
507 case 21: this->inch_mode = false; break;
807b9b57
JM
508
509 case 54: case 55: case 56: case 57: case 58: case 59:
510 // select WCS 0-8: G54..G59, G59.1, G59.2, G59.3
03b01bac 511 current_wcs = gcode->g - 54;
807b9b57
JM
512 if(gcode->g == 59 && gcode->subcode > 0) {
513 current_wcs += gcode->subcode;
0b8b81b6 514 if(current_wcs >= MAX_WCS) current_wcs = MAX_WCS - 1;
807b9b57
JM
515 }
516 break;
517
29e809e0
JM
518 case 90: this->absolute_mode = true; this->e_absolute_mode = true; break;
519 case 91: this->absolute_mode = false; this->e_absolute_mode = false; break;
807b9b57 520
0b804a41 521 case 92: {
a9e8c04b 522 if(gcode->subcode == 1 || gcode->subcode == 2 || gcode->get_num_args() == 0) {
03b01bac
JM
523 // reset G92 offsets to 0
524 g92_offset = wcs_t(0, 0, 0);
525
cee8bc1d
JM
526 } else if(gcode->subcode == 3) {
527 // initialize G92 to the specified values, only used for saving it with M500
528 float x= 0, y= 0, z= 0;
529 if(gcode->has_letter('X')) x= gcode->get_value('X');
530 if(gcode->has_letter('Y')) y= gcode->get_value('Y');
531 if(gcode->has_letter('Z')) z= gcode->get_value('Z');
532 g92_offset = wcs_t(x, y, z);
533
4710532a 534 } else {
61a3fa99 535 // standard setting of the g92 offsets, making current WCS position whatever the coordinate arguments are
807b9b57 536 float x, y, z;
03b01bac 537 std::tie(x, y, z) = g92_offset;
61a3fa99 538 // get current position in WCS
45ca77ec 539 wcs_t pos= mcs2wcs(machine_position);
61a3fa99
JM
540
541 // adjust g92 offset to make the current wpos == the value requested
542 if(gcode->has_letter('X')){
543 x += to_millimeters(gcode->get_value('X')) - std::get<X_AXIS>(pos);
544 }
dc27139b
JM
545 if(gcode->has_letter('Y')){
546 y += to_millimeters(gcode->get_value('Y')) - std::get<Y_AXIS>(pos);
547 }
548 if(gcode->has_letter('Z')) {
549 z += to_millimeters(gcode->get_value('Z')) - std::get<Z_AXIS>(pos);
550 }
03b01bac 551 g92_offset = wcs_t(x, y, z);
6bc4a00a 552 }
a6bbe768 553
13ad7234
JM
554 #if MAX_ROBOT_ACTUATORS > 3
555 if(gcode->subcode == 0 && (gcode->has_letter('E') || gcode->get_num_args() == 0)){
556 // reset the E position, legacy for 3d Printers to be reprap compatible
557 // find the selected extruder
325ed08b
JM
558 int selected_extruder= get_active_extruder();
559 if(selected_extruder > 0) {
560 float e= gcode->has_letter('E') ? gcode->get_value('E') : 0;
561 machine_position[selected_extruder]= compensated_machine_position[selected_extruder]= e;
562 actuators[selected_extruder]->change_last_milestone(get_e_scale_fnc ? e*get_e_scale_fnc() : e);
13ad7234
JM
563 }
564 }
565 #endif
566
78d0e16a 567 return;
4710532a
JM
568 }
569 }
67a649dd 570
4710532a
JM
571 } else if( gcode->has_m) {
572 switch( gcode->m ) {
20ed51b7
JM
573 // case 0: // M0 feed hold, (M0.1 is release feed hold, except we are in feed hold)
574 // if(THEKERNEL->is_grbl_mode()) THEKERNEL->set_feed_hold(gcode->subcode == 0);
575 // break;
01a8d21a
JM
576
577 case 30: // M30 end of program in grbl mode (otherwise it is delete sdcard file)
578 if(!THEKERNEL->is_grbl_mode()) break;
579 // fall through to M2
807b9b57 580 case 2: // M2 end of program
03b01bac
JM
581 current_wcs = 0;
582 absolute_mode = true;
807b9b57 583 break;
9e6014a6
JM
584 case 17:
585 THEKERNEL->call_event(ON_ENABLE, (void*)1); // turn all enable pins on
586 break;
587
d01fbc6f
JM
588 case 18: // this allows individual motors to be turned off, no parameters falls through to turn all off
589 if(gcode->get_num_args() > 0) {
590 // bitmap of motors to turn off, where bit 1:X, 2:Y, 3:Z, 4:A, 5:B, 6:C
591 uint32_t bm= 0;
592 for (int i = 0; i < n_motors; ++i) {
593 char axis= (i <= Z_AXIS ? 'X'+i : 'A'+(i-3));
594 if(gcode->has_letter(axis)) bm |= (0x02<<i); // set appropriate bit
595 }
559c0e6a
JM
596 // handle E parameter as currently selected extruder ABC
597 if(gcode->has_letter('E')) {
325ed08b
JM
598 // find first selected extruder
599 int i= get_active_extruder();
600 if(i > 0) {
601 bm |= (0x02<<i); // set appropriate bit
559c0e6a
JM
602 }
603 }
604
d01fbc6f
JM
605 THEKERNEL->conveyor->wait_for_idle();
606 THEKERNEL->call_event(ON_ENABLE, (void *)bm);
607 break;
608 }
609 // fall through
9e6014a6 610 case 84:
04782655 611 THEKERNEL->conveyor->wait_for_idle();
9e6014a6
JM
612 THEKERNEL->call_event(ON_ENABLE, nullptr); // turn all enable pins off
613 break;
807b9b57 614
29e809e0
JM
615 case 82: e_absolute_mode= true; break;
616 case 83: e_absolute_mode= false; break;
617
0fb5b438 618 case 92: // M92 - set steps per mm
5acc50ad 619 for (int i = 0; i < n_motors; ++i) {
13721c6c 620 if(actuators[i]->is_extruder()) continue; //extruders handle this themselves
5acc50ad
JM
621 char axis= (i <= Z_AXIS ? 'X'+i : 'A'+(i-A_AXIS));
622 if(gcode->has_letter(axis)) {
623 actuators[i]->change_steps_per_mm(this->to_millimeters(gcode->get_value(axis)));
624 }
625 gcode->stream->printf("%c:%f ", axis, actuators[i]->get_steps_per_mm());
626 }
0fb5b438 627 gcode->add_nl = true;
dd0a7cfa 628 check_max_actuator_speeds();
0fb5b438 629 return;
562db364 630
e03f2747 631 case 114:{
cb6bfefa 632 std::string buf;
12ce413f 633 print_position(gcode->subcode, buf, true); // ignore extruders as they will print E themselves
cb6bfefa 634 gcode->txt_after_ok.append(buf);
2791c829 635 return;
e03f2747 636 }
33e4cc02 637
212caccd
JM
638 case 120: // push state
639 push_state();
640 break;
562db364
JM
641
642 case 121: // pop state
212caccd 643 pop_state();
562db364
JM
644 break;
645
125b71ce
JM
646 case 203: // M203 Set maximum feedrates in mm/sec, M203.1 set maximum actuator feedrates
647 if(gcode->get_num_args() == 0) {
648 for (size_t i = X_AXIS; i <= Z_AXIS; i++) {
55783268 649 gcode->stream->printf(" %c: %g ", 'X' + i, gcode->subcode == 0 ? this->max_speeds[i] : actuators[i]->get_max_rate());
125b71ce 650 }
5acc50ad
JM
651 if(gcode->subcode == 1) {
652 for (size_t i = A_AXIS; i < n_motors; i++) {
13721c6c 653 if(actuators[i]->is_extruder()) continue; //extruders handle this themselves
5acc50ad
JM
654 gcode->stream->printf(" %c: %g ", 'A' + i - A_AXIS, actuators[i]->get_max_rate());
655 }
656 }
657
125b71ce 658 gcode->add_nl = true;
dd0a7cfa 659
125b71ce
JM
660 }else{
661 for (size_t i = X_AXIS; i <= Z_AXIS; i++) {
662 if (gcode->has_letter('X' + i)) {
55783268
JM
663 float v= gcode->get_value('X'+i);
664 if(gcode->subcode == 0) this->max_speeds[i]= v;
665 else if(gcode->subcode == 1) actuators[i]->set_max_rate(v);
125b71ce
JM
666 }
667 }
3e1ea0e2 668
5acc50ad
JM
669 if(gcode->subcode == 1) {
670 // ABC axis only handle actuator max speeds
671 for (size_t i = A_AXIS; i < n_motors; i++) {
672 if(actuators[i]->is_extruder()) continue; //extruders handle this themselves
673 int c= 'A' + i - A_AXIS;
674 if(gcode->has_letter(c)) {
675 float v= gcode->get_value(c);
676 actuators[i]->set_max_rate(v);
677 }
678 }
679 }
680
681
3e1ea0e2
JM
682 // this format is deprecated
683 if(gcode->subcode == 0 && (gcode->has_letter('A') || gcode->has_letter('B') || gcode->has_letter('C'))) {
684 gcode->stream->printf("NOTE this format is deprecated, Use M203.1 instead\n");
be7f67cd 685 for (size_t i = X_AXIS; i <= Z_AXIS; i++) {
3e1ea0e2
JM
686 if (gcode->has_letter('A' + i)) {
687 float v= gcode->get_value('A'+i);
688 actuators[i]->set_max_rate(v);
689 }
690 }
691 }
692
55783268 693 if(gcode->subcode == 1) check_max_actuator_speeds();
807b9b57 694 }
125b71ce 695 break;
83488642 696
29e809e0 697 case 204: // M204 Snnn - set default acceleration to nnn, Xnnn Ynnn Znnn sets axis specific acceleration
4710532a 698 if (gcode->has_letter('S')) {
4710532a 699 float acc = gcode->get_value('S'); // mm/s^2
d4ee6ee2 700 // enforce minimum
29e809e0
JM
701 if (acc < 1.0F) acc = 1.0F;
702 this->default_acceleration = acc;
d4ee6ee2 703 }
5acc50ad
JM
704 for (int i = 0; i < n_motors; ++i) {
705 if(actuators[i]->is_extruder()) continue; //extruders handle this themselves
706 char axis= (i <= Z_AXIS ? 'X'+i : 'A'+(i-A_AXIS));
707 if(gcode->has_letter(axis)) {
708 float acc = gcode->get_value(axis); // mm/s^2
29e809e0
JM
709 // enforce positive
710 if (acc <= 0.0F) acc = NAN;
711 actuators[i]->set_acceleration(acc);
712 }
c5fe1787 713 }
d4ee6ee2
JM
714 break;
715
125b71ce 716 case 205: // M205 Xnnn - set junction deviation, Z - set Z junction deviation, Snnn - Set minimum planner speed
4710532a
JM
717 if (gcode->has_letter('X')) {
718 float jd = gcode->get_value('X');
d4ee6ee2 719 // enforce minimum
8b69c90d
JM
720 if (jd < 0.0F)
721 jd = 0.0F;
4710532a 722 THEKERNEL->planner->junction_deviation = jd;
d4ee6ee2 723 }
107df03f
JM
724 if (gcode->has_letter('Z')) {
725 float jd = gcode->get_value('Z');
726 // enforce minimum, -1 disables it and uses regular junction deviation
73a0eab6
JM
727 if (jd <= -1.0F)
728 jd = NAN;
107df03f
JM
729 THEKERNEL->planner->z_junction_deviation = jd;
730 }
4710532a
JM
731 if (gcode->has_letter('S')) {
732 float mps = gcode->get_value('S');
8b69c90d
JM
733 // enforce minimum
734 if (mps < 0.0F)
735 mps = 0.0F;
4710532a 736 THEKERNEL->planner->minimum_planner_speed = mps;
8b69c90d 737 }
d4ee6ee2 738 break;
98761c28 739
7369629d 740 case 220: // M220 - speed override percentage
4710532a 741 if (gcode->has_letter('S')) {
1ad23cd3 742 float factor = gcode->get_value('S');
98761c28 743 // enforce minimum 10% speed
da947c62
MM
744 if (factor < 10.0F)
745 factor = 10.0F;
746 // enforce maximum 10x speed
747 if (factor > 1000.0F)
748 factor = 1000.0F;
749
750 seconds_per_minute = 6000.0F / factor;
03b01bac 751 } else {
9ef9f45b 752 gcode->stream->printf("Speed factor at %6.2f %%\n", 6000.0F / seconds_per_minute);
7369629d 753 }
b4f56013 754 break;
ec4773e5 755
494dc541 756 case 400: // wait until all moves are done up to this point
04782655 757 THEKERNEL->conveyor->wait_for_idle();
494dc541
JM
758 break;
759
33e4cc02 760 case 500: // M500 saves some volatile settings to config override file
b7cd847e 761 case 503: { // M503 just prints the settings
5acc50ad
JM
762 gcode->stream->printf(";Steps per unit:\nM92 ");
763 for (int i = 0; i < n_motors; ++i) {
764 if(actuators[i]->is_extruder()) continue; //extruders handle this themselves
765 char axis= (i <= Z_AXIS ? 'X'+i : 'A'+(i-A_AXIS));
766 gcode->stream->printf("%c%1.5f ", axis, actuators[i]->get_steps_per_mm());
767 }
768 gcode->stream->printf("\n");
df56baf2 769
5acc50ad 770 // only print if not NAN
df56baf2 771 gcode->stream->printf(";Acceleration mm/sec^2:\nM204 S%1.5f ", default_acceleration);
5acc50ad
JM
772 for (int i = 0; i < n_motors; ++i) {
773 if(actuators[i]->is_extruder()) continue; // extruders handle this themselves
774 char axis= (i <= Z_AXIS ? 'X'+i : 'A'+(i-A_AXIS));
775 if(!isnan(actuators[i]->get_acceleration())) gcode->stream->printf("%c%1.5f ", axis, actuators[i]->get_acceleration());
df56baf2
JM
776 }
777 gcode->stream->printf("\n");
778
43fa8fd2 779 gcode->stream->printf(";X- Junction Deviation, Z- Z junction deviation, S - Minimum Planner speed mm/sec:\nM205 X%1.5f Z%1.5f S%1.5f\n", THEKERNEL->planner->junction_deviation, isnan(THEKERNEL->planner->z_junction_deviation)?-1:THEKERNEL->planner->z_junction_deviation, THEKERNEL->planner->minimum_planner_speed);
125b71ce
JM
780
781 gcode->stream->printf(";Max cartesian feedrates in mm/sec:\nM203 X%1.5f Y%1.5f Z%1.5f\n", this->max_speeds[X_AXIS], this->max_speeds[Y_AXIS], this->max_speeds[Z_AXIS]);
5acc50ad
JM
782
783 gcode->stream->printf(";Max actuator feedrates in mm/sec:\nM203.1 ");
784 for (int i = 0; i < n_motors; ++i) {
785 if(actuators[i]->is_extruder()) continue; // extruders handle this themselves
786 char axis= (i <= Z_AXIS ? 'X'+i : 'A'+(i-A_AXIS));
787 gcode->stream->printf("%c%1.5f ", axis, actuators[i]->get_max_rate());
788 }
789 gcode->stream->printf("\n");
b7cd847e
JM
790
791 // get or save any arm solution specific optional values
792 BaseSolution::arm_options_t options;
793 if(arm_solution->get_optional(options) && !options.empty()) {
794 gcode->stream->printf(";Optional arm solution specific settings:\nM665");
4710532a 795 for(auto &i : options) {
b7cd847e
JM
796 gcode->stream->printf(" %c%1.4f", i.first, i.second);
797 }
798 gcode->stream->printf("\n");
799 }
6e92ab91 800
807b9b57
JM
801 // save wcs_offsets and current_wcs
802 // TODO this may need to be done whenever they change to be compliant
803 gcode->stream->printf(";WCS settings\n");
40fd5d98 804 gcode->stream->printf("%s\n", wcs2gcode(current_wcs).c_str());
03b01bac 805 int n = 1;
807b9b57 806 for(auto &i : wcs_offsets) {
2791c829 807 if(i != wcs_t(0, 0, 0)) {
807b9b57
JM
808 float x, y, z;
809 std::tie(x, y, z) = i;
40fd5d98 810 gcode->stream->printf("G10 L2 P%d X%f Y%f Z%f ; %s\n", n, x, y, z, wcs2gcode(n-1).c_str());
2791c829 811 }
807b9b57
JM
812 ++n;
813 }
3aad33c7
JM
814 if(save_g92) {
815 // linuxcnc saves G92, so we do too if configured, default is to not save to maintain backward compatibility
816 // also it needs to be used to set Z0 on rotary deltas as M206/306 can't be used, so saving it is necessary in that case
817 if(g92_offset != wcs_t(0, 0, 0)) {
818 float x, y, z;
819 std::tie(x, y, z) = g92_offset;
820 gcode->stream->printf("G92.3 X%f Y%f Z%f\n", x, y, z); // sets G92 to the specified values
821 }
67a649dd
JM
822 }
823 }
807b9b57 824 break;
33e4cc02 825
b7cd847e 826 case 665: { // M665 set optional arm solution variables based on arm solution.
ebc75fc6 827 // the parameter args could be any letter each arm solution only accepts certain ones
03b01bac 828 BaseSolution::arm_options_t options = gcode->get_args();
ebc75fc6
JM
829 options.erase('S'); // don't include the S
830 options.erase('U'); // don't include the U
831 if(options.size() > 0) {
832 // set the specified options
833 arm_solution->set_optional(options);
834 }
835 options.clear();
b7cd847e 836 if(arm_solution->get_optional(options)) {
ebc75fc6 837 // foreach optional value
4710532a 838 for(auto &i : options) {
b7cd847e
JM
839 // print all current values of supported options
840 gcode->stream->printf("%c: %8.4f ", i.first, i.second);
5523c05d 841 gcode->add_nl = true;
ec4773e5
JM
842 }
843 }
ec4773e5 844
4a839bea 845 if(gcode->has_letter('S')) { // set delta segments per second, not saved by M500
4710532a 846 this->delta_segments_per_second = gcode->get_value('S');
4a839bea
JM
847 gcode->stream->printf("Delta segments set to %8.4f segs/sec\n", this->delta_segments_per_second);
848
03b01bac 849 } else if(gcode->has_letter('U')) { // or set mm_per_line_segment, not saved by M500
4a839bea
JM
850 this->mm_per_line_segment = gcode->get_value('U');
851 this->delta_segments_per_second = 0;
852 gcode->stream->printf("mm per line segment set to %8.4f\n", this->mm_per_line_segment);
ec29d378 853 }
4a839bea 854
ec4773e5 855 break;
b7cd847e 856 }
6989211c 857 }
494dc541
JM
858 }
859
29e809e0 860 if( motion_mode != NONE) {
e560f057 861 is_g123= motion_mode != SEEK;
29e809e0 862 process_move(gcode, motion_mode);
e560f057
JM
863
864 }else{
865 is_g123= false;
00e607c7 866 }
6bc4a00a 867
c2f7c261
JM
868 next_command_is_MCS = false; // must be on same line as G0 or G1
869}
350c8a60 870
325ed08b
JM
871int Robot::get_active_extruder() const
872{
873 for (int i = E_AXIS; i < n_motors; ++i) {
874 // find first selected extruder
aef2eec0 875 if(actuators[i]->is_extruder() && actuators[i]->is_selected()) return i;
325ed08b
JM
876 }
877 return 0;
878}
879
5d2319a9 880// process a G0/G1/G2/G3
29e809e0 881void Robot::process_move(Gcode *gcode, enum MOTION_MODE_T motion_mode)
c2f7c261 882{
2791c829 883 // we have a G0/G1/G2/G3 so extract parameters and apply offsets to get machine coordinate target
ad6a77d1 884 // get XYZ and one E (which goes to the selected extruder)
29e809e0
JM
885 float param[4]{NAN, NAN, NAN, NAN};
886
887 // process primary axis
350c8a60
JM
888 for(int i= X_AXIS; i <= Z_AXIS; ++i) {
889 char letter= 'X'+i;
890 if( gcode->has_letter(letter) ) {
891 param[i] = this->to_millimeters(gcode->get_value(letter));
350c8a60
JM
892 }
893 }
6bc4a00a 894
c2f7c261 895 float offset[3]{0,0,0};
4710532a
JM
896 for(char letter = 'I'; letter <= 'K'; letter++) {
897 if( gcode->has_letter(letter) ) {
898 offset[letter - 'I'] = this->to_millimeters(gcode->get_value(letter));
c2885de8
JM
899 }
900 }
00e607c7 901
c2f7c261 902 // calculate target in machine coordinates (less compensation transform which needs to be done after segmentation)
29e809e0 903 float target[n_motors];
45ca77ec 904 memcpy(target, machine_position, n_motors*sizeof(float));
29e809e0 905
350c8a60
JM
906 if(!next_command_is_MCS) {
907 if(this->absolute_mode) {
c2f7c261
JM
908 // apply wcs offsets and g92 offset and tool offset
909 if(!isnan(param[X_AXIS])) {
910 target[X_AXIS]= param[X_AXIS] + std::get<X_AXIS>(wcs_offsets[current_wcs]) - std::get<X_AXIS>(g92_offset) + std::get<X_AXIS>(tool_offset);
911 }
912
913 if(!isnan(param[Y_AXIS])) {
914 target[Y_AXIS]= param[Y_AXIS] + std::get<Y_AXIS>(wcs_offsets[current_wcs]) - std::get<Y_AXIS>(g92_offset) + std::get<Y_AXIS>(tool_offset);
915 }
916
917 if(!isnan(param[Z_AXIS])) {
918 target[Z_AXIS]= param[Z_AXIS] + std::get<Z_AXIS>(wcs_offsets[current_wcs]) - std::get<Z_AXIS>(g92_offset) + std::get<Z_AXIS>(tool_offset);
919 }
350c8a60
JM
920
921 }else{
45ca77ec 922 // they are deltas from the machine_position if specified
350c8a60 923 for(int i= X_AXIS; i <= Z_AXIS; ++i) {
45ca77ec 924 if(!isnan(param[i])) target[i] = param[i] + machine_position[i];
a6bbe768
JM
925 }
926 }
927
350c8a60 928 }else{
48a0fdb6 929 // already in machine coordinates, we do not add wcs or tool offset for that
c2f7c261
JM
930 for(int i= X_AXIS; i <= Z_AXIS; ++i) {
931 if(!isnan(param[i])) target[i] = param[i];
932 }
c2885de8 933 }
6bc4a00a 934
37b7b898
JM
935 float delta_e= NAN;
936
937 #if MAX_ROBOT_ACTUATORS > 3
29e809e0 938 // process extruder parameters, for active extruder only (only one active extruder at a time)
325ed08b 939 int selected_extruder= 0;
29e809e0 940 if(gcode->has_letter('E')) {
325ed08b
JM
941 selected_extruder= get_active_extruder();
942 param[E_AXIS]= gcode->get_value('E');
29e809e0
JM
943 }
944
945 // do E for the selected extruder
29e809e0
JM
946 if(selected_extruder > 0 && !isnan(param[E_AXIS])) {
947 if(this->e_absolute_mode) {
948 target[selected_extruder]= param[E_AXIS];
45ca77ec 949 delta_e= target[selected_extruder] - machine_position[selected_extruder];
29e809e0
JM
950 }else{
951 delta_e= param[E_AXIS];
45ca77ec 952 target[selected_extruder] = delta_e + machine_position[selected_extruder];
29e809e0
JM
953 }
954 }
955
37b7b898
JM
956 // process ABC axis, this is mutually exclusive to using E for an extruder, so if E is used and A then the results are undefined
957 for (int i = A_AXIS; i < n_motors; ++i) {
958 char letter= 'A'+i-A_AXIS;
959 if(gcode->has_letter(letter)) {
960 float p= gcode->get_value(letter);
961 if(this->absolute_mode) {
962 target[i]= p;
963 }else{
5acc50ad 964 target[i]= p + machine_position[i];
37b7b898
JM
965 }
966 }
967 }
968 #endif
969
4710532a 970 if( gcode->has_letter('F') ) {
29e809e0 971 if( motion_mode == SEEK )
da947c62 972 this->seek_rate = this->to_millimeters( gcode->get_value('F') );
7369629d 973 else
da947c62 974 this->feed_rate = this->to_millimeters( gcode->get_value('F') );
7369629d 975 }
6bc4a00a 976
73cc27d2 977 // S is modal When specified on a G0/1/2/3 command
e560f057
JM
978 if(gcode->has_letter('S')) s_value= gcode->get_value('S');
979
350c8a60 980 bool moved= false;
29e809e0
JM
981
982 // Perform any physical actions
983 switch(motion_mode) {
984 case NONE: break;
985
986 case SEEK:
987 moved= this->append_line(gcode, target, this->seek_rate / seconds_per_minute, delta_e );
350c8a60 988 break;
29e809e0
JM
989
990 case LINEAR:
991 moved= this->append_line(gcode, target, this->feed_rate / seconds_per_minute, delta_e );
350c8a60 992 break;
29e809e0
JM
993
994 case CW_ARC:
995 case CCW_ARC:
374d0777 996 // Note arcs are not currently supported by extruder based machines, as 3D slicers do not use arcs (G2/G3)
29e809e0 997 moved= this->compute_arc(gcode, offset, target, motion_mode);
350c8a60 998 break;
4cff3ded 999 }
13e4a3f9 1000
c2f7c261 1001 if(moved) {
45ca77ec
JM
1002 // set machine_position to the calculated target
1003 memcpy(machine_position, target, n_motors*sizeof(float));
350c8a60 1004 }
edac9072
AW
1005}
1006
a6bbe768 1007// reset the machine position for all axis. Used for homing.
fd2341bc 1008// after homing we supply the cartesian coordinates that the head is at when homed,
bccd3a3e
JM
1009// however for Z this is the compensated machine position (if enabled)
1010// So we need to apply the inverse compensation transform to the supplied coordinates to get the correct machine position
8fe38353 1011// this will make the results from M114 and ? consistent after homing.
bccd3a3e 1012// This works for cases where the Z endstop is fixed on the Z actuator and is the same regardless of where XY are.
cef9acea
JM
1013void Robot::reset_axis_position(float x, float y, float z)
1014{
fd2341bc 1015 // set both the same initially
45ca77ec
JM
1016 compensated_machine_position[X_AXIS]= machine_position[X_AXIS] = x;
1017 compensated_machine_position[Y_AXIS]= machine_position[Y_AXIS] = y;
1018 compensated_machine_position[Z_AXIS]= machine_position[Z_AXIS] = z;
cef9acea 1019
8fe38353 1020 if(compensationTransform) {
45ca77ec
JM
1021 // apply inverse transform to get machine_position
1022 compensationTransform(machine_position, true);
8fe38353
JM
1023 }
1024
fd2341bc 1025 // now set the actuator positions based on the supplied compensated position
807b9b57 1026 ActuatorCoordinates actuator_pos;
45ca77ec 1027 arm_solution->cartesian_to_actuator(this->compensated_machine_position, actuator_pos);
29e809e0 1028 for (size_t i = X_AXIS; i <= Z_AXIS; i++)
cef9acea
JM
1029 actuators[i]->change_last_milestone(actuator_pos[i]);
1030}
1031
de2ee57c 1032// Reset the position for an axis (used in homing, and to reset extruder after suspend)
4710532a
JM
1033void Robot::reset_axis_position(float position, int axis)
1034{
45ca77ec 1035 compensated_machine_position[axis] = position;
de2ee57c 1036 if(axis <= Z_AXIS) {
45ca77ec 1037 reset_axis_position(compensated_machine_position[X_AXIS], compensated_machine_position[Y_AXIS], compensated_machine_position[Z_AXIS]);
7d9e5765 1038
72420864 1039#if MAX_ROBOT_ACTUATORS > 3
96ef0809 1040 }else if(axis < n_motors) {
7d9e5765
JM
1041 // ABC and/or extruders need to be set as there is no arm solution for them
1042 machine_position[axis]= compensated_machine_position[axis]= position;
1043 actuators[axis]->change_last_milestone(machine_position[axis]);
72420864 1044#endif
de2ee57c 1045 }
4cff3ded
AW
1046}
1047
932a3995 1048// similar to reset_axis_position but directly sets the actuator positions in actuators units (eg mm for cartesian, degrees for rotary delta)
abf706e6 1049// then sets the axis positions to match. currently only called from Endstops.cpp and RotaryDeltaCalibration.cpp
93f20a8c 1050void Robot::reset_actuator_position(const ActuatorCoordinates &ac)
586cc733 1051{
fdfa00d2
JM
1052 for (size_t i = X_AXIS; i <= Z_AXIS; i++) {
1053 if(!isnan(ac[i])) actuators[i]->change_last_milestone(ac[i]);
1054 }
586cc733
JM
1055
1056 // now correct axis positions then recorrect actuator to account for rounding
1057 reset_position_from_current_actuator_position();
1058}
1059
a6bbe768 1060// Use FK to find out where actuator is and reset to match
b6187406 1061// TODO maybe we should only reset axis that are being homed unless this is due to a ON_HALT
728477c4
JM
1062void Robot::reset_position_from_current_actuator_position()
1063{
807b9b57 1064 ActuatorCoordinates actuator_pos;
9fc4679b 1065 for (size_t i = X_AXIS; i < n_motors; i++) {
45ca77ec 1066 // NOTE actuator::current_position is curently NOT the same as actuator::machine_position after an abrupt abort
807b9b57
JM
1067 actuator_pos[i] = actuators[i]->get_current_position();
1068 }
58587001
JM
1069
1070 // discover machine position from where actuators actually are
45ca77ec
JM
1071 arm_solution->actuator_to_cartesian(actuator_pos, compensated_machine_position);
1072 memcpy(machine_position, compensated_machine_position, sizeof machine_position);
cf91d4f3 1073
45ca77ec
JM
1074 // compensated_machine_position includes the compensation transform so we need to get the inverse to get actual machine_position
1075 if(compensationTransform) compensationTransform(machine_position, true); // get inverse compensation transform
cf91d4f3 1076
45ca77ec 1077 // now reset actuator::machine_position, NOTE this may lose a little precision as FK is not always entirely accurate.
58587001 1078 // NOTE This is required to sync the machine position with the actuator position, we do a somewhat redundant cartesian_to_actuator() call
932a3995 1079 // to get everything in perfect sync.
45ca77ec 1080 arm_solution->cartesian_to_actuator(compensated_machine_position, actuator_pos);
325ed08b 1081 for (size_t i = X_AXIS; i <= Z_AXIS; i++) {
7baae81a 1082 actuators[i]->change_last_milestone(actuator_pos[i]);
325ed08b
JM
1083 }
1084
1085 // Handle extruders and/or ABC axis
1086 #if MAX_ROBOT_ACTUATORS > 3
9fc4679b 1087 for (int i = A_AXIS; i < n_motors; i++) {
325ed08b
JM
1088 // ABC and/or extruders just need to set machine_position and compensated_machine_position
1089 float ap= actuator_pos[i];
aef2eec0 1090 if(actuators[i]->is_extruder() && get_e_scale_fnc) ap /= get_e_scale_fnc(); // inverse E scale if there is one and this is an extruder
325ed08b 1091 machine_position[i]= compensated_machine_position[i]= ap;
5d34cbb3 1092 actuators[i]->change_last_milestone(actuator_pos[i]); // this updates the last_milestone in the actuator
325ed08b
JM
1093 }
1094 #endif
728477c4 1095}
edac9072 1096
ad6a77d1 1097// Convert target (in machine coordinates) to machine_position, then convert to actuator position and append this to the planner
45ca77ec 1098// target is in machine coordinates without the compensation transform, however we save a compensated_machine_position that includes
c2f7c261 1099// all transforms and is what we actually convert to actuator positions
c1ebb1fe 1100bool Robot::append_milestone(const float target[], float rate_mm_s)
df6a30f2 1101{
29e809e0 1102 float deltas[n_motors];
1a936198 1103 float transformed_target[n_motors]; // adjust target for bed compensation
29e809e0 1104 float unit_vec[N_PRIMARY_AXIS];
df6a30f2 1105
3632a517 1106 // unity transform by default
29e809e0 1107 memcpy(transformed_target, target, n_motors*sizeof(float));
5e45206a 1108
350c8a60 1109 // check function pointer and call if set to transform the target to compensate for bed
c1ebb1fe 1110 if(compensationTransform) {
350c8a60 1111 // some compensation strategies can transform XYZ, some just change Z
8fe38353 1112 compensationTransform(transformed_target, false);
00e607c7 1113 }
807b9b57 1114
29e809e0 1115 bool move= false;
b5bd71f8 1116 float sos= 0; // sum of squares for just primary axis (XYZ usually)
29e809e0 1117
b84bd559 1118 // find distance moved by each axis, use transformed target from the current compensated machine position
ec45206d 1119 for (size_t i = 0; i < n_motors; i++) {
45ca77ec 1120 deltas[i] = transformed_target[i] - compensated_machine_position[i];
29e809e0
JM
1121 if(deltas[i] == 0) continue;
1122 // at least one non zero delta
1123 move = true;
b5bd71f8 1124 if(i < N_PRIMARY_AXIS) {
29e809e0 1125 sos += powf(deltas[i], 2);
121094a5 1126 }
3632a517 1127 }
aab6cbba 1128
29e809e0
JM
1129 // nothing moved
1130 if(!move) return false;
1131
850b4eeb 1132 // see if this is a primary axis move or not
b5bd71f8
JM
1133 bool auxilliary_move= true;
1134 for (int i = 0; i < N_PRIMARY_AXIS; ++i) {
1135 if(deltas[i] != 0) {
1136 auxilliary_move= false;
1137 break;
1138 }
1139 }
29e809e0 1140
850b4eeb
JM
1141 // total movement, use XYZ if a primary axis otherwise we calculate distance for E after scaling to mm
1142 float distance= auxilliary_move ? 0 : sqrtf(sos);
df6a30f2 1143
a6bbe768
JM
1144 // it is unlikely but we need to protect against divide by zero, so ignore insanely small moves here
1145 // as the last milestone won't be updated we do not actually lose any moves as they will be accounted for in the next move
850b4eeb 1146 if(!auxilliary_move && distance < 0.00001F) return false;
a6bbe768 1147
a6bbe768 1148
29e809e0 1149 if(!auxilliary_move) {
b5bd71f8 1150 for (size_t i = X_AXIS; i < N_PRIMARY_AXIS; i++) {
14a90ad5 1151 // find distance unit vector for primary axis only
850b4eeb 1152 unit_vec[i] = deltas[i] / distance;
df6a30f2 1153
14a90ad5 1154 // Do not move faster than the configured cartesian limits for XYZ
bcc06c36 1155 if ( i <= Z_AXIS && max_speeds[i] > 0 ) {
14a90ad5
JM
1156 float axis_speed = fabsf(unit_vec[i] * rate_mm_s);
1157
1158 if (axis_speed > max_speeds[i])
1159 rate_mm_s *= ( max_speeds[i] / axis_speed );
2cd32d70 1160 }
7b470506
AW
1161 }
1162 }
4cff3ded 1163
c2f7c261 1164 // find actuator position given the machine position, use actual adjusted target
29e809e0 1165 ActuatorCoordinates actuator_pos;
84cf4071
JM
1166 if(!disable_arm_solution) {
1167 arm_solution->cartesian_to_actuator( transformed_target, actuator_pos );
1168
1169 }else{
1170 // basically the same as cartesian, would be used for special homing situations like for scara
1171 for (size_t i = X_AXIS; i <= Z_AXIS; i++) {
1172 actuator_pos[i] = transformed_target[i];
1173 }
1174 }
df6a30f2 1175
13ad7234 1176#if MAX_ROBOT_ACTUATORS > 3
850b4eeb 1177 sos= 0;
ad6a77d1 1178 // for the extruders just copy the position, and possibly scale it from mm³ to mm
374d0777 1179 for (size_t i = E_AXIS; i < n_motors; i++) {
850b4eeb 1180 actuator_pos[i]= transformed_target[i];
aef2eec0 1181 if(actuators[i]->is_extruder() && get_e_scale_fnc) {
29e809e0
JM
1182 // NOTE this relies on the fact only one extruder is active at a time
1183 // scale for volumetric or flow rate
1184 // TODO is this correct? scaling the absolute target? what if the scale changes?
ec45206d 1185 // for volumetric it basically converts mm³ to mm, but what about flow rate?
121094a5 1186 actuator_pos[i] *= get_e_scale_fnc();
29e809e0 1187 }
850b4eeb
JM
1188 if(auxilliary_move) {
1189 // for E only moves we need to use the scaled E to calculate the distance
a3b16417 1190 sos += powf(actuator_pos[i] - actuators[i]->get_last_milestone(), 2);
850b4eeb
JM
1191 }
1192 }
1193 if(auxilliary_move) {
850b4eeb 1194 distance= sqrtf(sos); // distance in mm of the e move
1843a68f 1195 if(distance < 0.00001F) return false;
29e809e0
JM
1196 }
1197#endif
1198
1199 // use default acceleration to start with
1200 float acceleration = default_acceleration;
1201
850b4eeb 1202 float isecs = rate_mm_s / distance;
29e809e0 1203
df6a30f2 1204 // check per-actuator speed limits
29e809e0
JM
1205 for (size_t actuator = 0; actuator < n_motors; actuator++) {
1206 float d = fabsf(actuator_pos[actuator] - actuators[actuator]->get_last_milestone());
1207 if(d == 0 || !actuators[actuator]->is_selected()) continue; // no movement for this actuator
1208
1209 float actuator_rate= d * isecs;
03b01bac 1210 if (actuator_rate > actuators[actuator]->get_max_rate()) {
3494f3d0 1211 rate_mm_s *= (actuators[actuator]->get_max_rate() / actuator_rate);
850b4eeb 1212 isecs = rate_mm_s / distance;
928467c0 1213 }
29e809e0 1214
df56baf2 1215 // adjust acceleration to lowest found, for now just primary axis unless it is an auxiliary move
14a90ad5 1216 // TODO we may need to do all of them, check E won't limit XYZ.. it does on long E moves, but not checking it could exceed the E acceleration.
b5bd71f8 1217 if(auxilliary_move || actuator < N_PRIMARY_AXIS) {
df56baf2
JM
1218 float ma = actuators[actuator]->get_acceleration(); // in mm/sec²
1219 if(!isnan(ma)) { // if axis does not have acceleration set then it uses the default_acceleration
850b4eeb 1220 float ca = fabsf((d/distance) * acceleration);
df56baf2
JM
1221 if (ca > ma) {
1222 acceleration *= ( ma / ca );
1223 }
29e809e0 1224 }
14a90ad5 1225 }
928467c0
JM
1226 }
1227
0de4d6b0
JM
1228 // if we are in feed hold wait here until it is released, this means that even segemnted lines will pause
1229 while(THEKERNEL->get_feed_hold()) {
1230 THEKERNEL->call_event(ON_IDLE, this);
1231 // if we also got a HALT then break out of this
1232 if(THEKERNEL->is_halted()) return false;
1233 }
1234
edac9072 1235 // Append the block to the planner
850b4eeb 1236 // NOTE that distance here should be either the distance travelled by the XYZ axis, or the E mm travel if a solo E move
0de4d6b0 1237 // NOTE this call will bock until there is room in the block queue, on_idle will continue to be called
e560f057 1238 if(THEKERNEL->planner->append_block( actuator_pos, n_motors, rate_mm_s, distance, auxilliary_move ? nullptr : unit_vec, acceleration, s_value, is_g123)) {
b84bd559 1239 // this is the new compensated machine position
45ca77ec 1240 memcpy(this->compensated_machine_position, transformed_target, n_motors*sizeof(float));
07879e05 1241 return true;
6f5d947f
JM
1242 }
1243
07879e05
JM
1244 // no actual move
1245 return false;
4cff3ded
AW
1246}
1247
121094a5
JM
1248// Used to plan a single move used by things like endstops when homing, zprobe, extruder firmware retracts etc.
1249bool Robot::delta_move(const float *delta, float rate_mm_s, uint8_t naxis)
c8bac202
JM
1250{
1251 if(THEKERNEL->is_halted()) return false;
1252
121094a5 1253 // catch negative or zero feed rates
c8bac202
JM
1254 if(rate_mm_s <= 0.0F) {
1255 return false;
1256 }
1257
45ca77ec 1258 // get the absolute target position, default is current machine_position
121094a5 1259 float target[n_motors];
45ca77ec 1260 memcpy(target, machine_position, n_motors*sizeof(float));
c8bac202 1261
121094a5
JM
1262 // add in the deltas to get new target
1263 for (int i= 0; i < naxis; i++) {
1264 target[i] += delta[i];
c8bac202 1265 }
c8bac202 1266
45ca77ec 1267 // submit for planning and if moved update machine_position
c1ebb1fe 1268 if(append_milestone(target, rate_mm_s)) {
45ca77ec 1269 memcpy(machine_position, target, n_motors*sizeof(float));
121094a5 1270 return true;
29e809e0 1271 }
c8bac202 1272
121094a5 1273 return false;
c8bac202
JM
1274}
1275
edac9072 1276// Append a move to the queue ( cutting it into segments if needed )
29e809e0 1277bool Robot::append_line(Gcode *gcode, const float target[], float rate_mm_s, float delta_e)
4710532a 1278{
121094a5
JM
1279 // catch negative or zero feed rates and return the same error as GRBL does
1280 if(rate_mm_s <= 0.0F) {
1281 gcode->is_error= true;
1282 gcode->txt_after_ok= (rate_mm_s == 0 ? "Undefined feed rate" : "feed rate < 0");
1283 return false;
1284 }
29e809e0
JM
1285
1286 // Find out the distance for this move in XYZ in MCS
45ca77ec 1287 float millimeters_of_travel = sqrtf(powf( target[X_AXIS] - machine_position[X_AXIS], 2 ) + powf( target[Y_AXIS] - machine_position[Y_AXIS], 2 ) + powf( target[Z_AXIS] - machine_position[Z_AXIS], 2 ));
29e809e0 1288
374d0777 1289 if(millimeters_of_travel < 0.00001F) {
121094a5
JM
1290 // we have no movement in XYZ, probably E only extrude or retract
1291 return this->append_milestone(target, rate_mm_s);
29e809e0
JM
1292 }
1293
1294 /*
850d5f12
JM
1295 For extruders, we need to do some extra work to limit the volumetric rate if specified...
1296 If using volumetric limts we need to be using volumetric extrusion for this to work as Ennn needs to be in mm³ not mm
374d0777
JM
1297 We ask Extruder to do all the work but we need to pass in the relevant data.
1298 NOTE we need to do this before we segment the line (for deltas)
29e809e0
JM
1299 */
1300 if(!isnan(delta_e) && gcode->has_g && gcode->g == 1) {
1301 float data[2]= {delta_e, rate_mm_s / millimeters_of_travel};
d2adef5e 1302 if(PublicData::set_value(extruder_checksum, target_checksum, data)) {
29e809e0 1303 rate_mm_s *= data[1]; // adjust the feedrate
d2adef5e
JM
1304 }
1305 }
1306
c2f7c261 1307 // We cut the line into smaller segments. This is only needed on a cartesian robot for zgrid, but always necessary for robots with rotational axes like Deltas.
3b4b05b8
JM
1308 // In delta robots either mm_per_line_segment can be used OR delta_segments_per_second
1309 // The latter is more efficient and avoids splitting fast long lines into very small segments, like initial z move to 0, it is what Johanns Marlin delta port does
4a0c8e14 1310 uint16_t segments;
5984acdf 1311
a3e1326a 1312 if(this->disable_segmentation || (!segment_z_moves && !gcode->has_letter('X') && !gcode->has_letter('Y'))) {
778093ce
JM
1313 segments= 1;
1314
1315 } else if(this->delta_segments_per_second > 1.0F) {
4a0c8e14
JM
1316 // enabled if set to something > 1, it is set to 0.0 by default
1317 // segment based on current speed and requested segments per second
1318 // the faster the travel speed the fewer segments needed
1319 // NOTE rate is mm/sec and we take into account any speed override
29e809e0 1320 float seconds = millimeters_of_travel / rate_mm_s;
9502f9d5 1321 segments = max(1.0F, ceilf(this->delta_segments_per_second * seconds));
4a0c8e14 1322 // TODO if we are only moving in Z on a delta we don't really need to segment at all
5984acdf 1323
4710532a
JM
1324 } else {
1325 if(this->mm_per_line_segment == 0.0F) {
1326 segments = 1; // don't split it up
1327 } else {
29e809e0 1328 segments = ceilf( millimeters_of_travel / this->mm_per_line_segment);
4a0c8e14
JM
1329 }
1330 }
5984acdf 1331
350c8a60 1332 bool moved= false;
4710532a 1333 if (segments > 1) {
2ba859c9 1334 // A vector to keep track of the endpoint of each segment
29e809e0
JM
1335 float segment_delta[n_motors];
1336 float segment_end[n_motors];
45ca77ec 1337 memcpy(segment_end, machine_position, n_motors*sizeof(float));
2ba859c9
MM
1338
1339 // How far do we move each segment?
29e809e0 1340 for (int i = 0; i < n_motors; i++)
45ca77ec 1341 segment_delta[i] = (target[i] - machine_position[i]) / segments;
4cff3ded 1342
c8e0fb15
MM
1343 // segment 0 is already done - it's the end point of the previous move so we start at segment 1
1344 // We always add another point after this loop so we stop at segments-1, ie i < segments
4710532a 1345 for (int i = 1; i < segments; i++) {
350c8a60 1346 if(THEKERNEL->is_halted()) return false; // don't queue any more segments
bb206212
JM
1347 for (int j = 0; j < n_motors; j++)
1348 segment_end[j] += segment_delta[j];
2ba859c9
MM
1349
1350 // Append the end of this segment to the queue
0de4d6b0 1351 // this can block waiting for free block queue or if in feed hold
121094a5 1352 bool b= this->append_milestone(segment_end, rate_mm_s);
350c8a60 1353 moved= moved || b;
2ba859c9 1354 }
4cff3ded 1355 }
5984acdf
MM
1356
1357 // Append the end of this full move to the queue
121094a5 1358 if(this->append_milestone(target, rate_mm_s)) moved= true;
2134bcf2 1359
a6bbe768 1360 this->next_command_is_MCS = false; // always reset this
00e607c7 1361
350c8a60 1362 return moved;
4cff3ded
AW
1363}
1364
4cff3ded 1365
edac9072 1366// Append an arc to the queue ( cutting it into segments as needed )
850d5f12 1367// TODO does not support any E parameters so cannot be used for 3D printing.
350c8a60 1368bool Robot::append_arc(Gcode * gcode, const float target[], const float offset[], float radius, bool is_clockwise )
4710532a 1369{
121094a5
JM
1370 float rate_mm_s= this->feed_rate / seconds_per_minute;
1371 // catch negative or zero feed rates and return the same error as GRBL does
1372 if(rate_mm_s <= 0.0F) {
1373 gcode->is_error= true;
1374 gcode->txt_after_ok= (rate_mm_s == 0 ? "Undefined feed rate" : "feed rate < 0");
1375 return false;
1376 }
aab6cbba 1377
edac9072 1378 // Scary math
45ca77ec
JM
1379 float center_axis0 = this->machine_position[this->plane_axis_0] + offset[this->plane_axis_0];
1380 float center_axis1 = this->machine_position[this->plane_axis_1] + offset[this->plane_axis_1];
1381 float linear_travel = target[this->plane_axis_2] - this->machine_position[this->plane_axis_2];
1ad23cd3
MM
1382 float r_axis0 = -offset[this->plane_axis_0]; // Radius vector from center to current location
1383 float r_axis1 = -offset[this->plane_axis_1];
1384 float rt_axis0 = target[this->plane_axis_0] - center_axis0;
1385 float rt_axis1 = target[this->plane_axis_1] - center_axis1;
aab6cbba 1386
51871fb8 1387 // Patch from GRBL Firmware - Christoph Baumann 04072015
aab6cbba 1388 // CCW angle between position and target from circle center. Only one atan2() trig computation required.
fb4c9d09 1389 float angular_travel = atan2f(r_axis0 * rt_axis1 - r_axis1 * rt_axis0, r_axis0 * rt_axis0 + r_axis1 * rt_axis1);
06545e84 1390 if (plane_axis_2 == Y_AXIS) { is_clockwise = !is_clockwise; } //Math for XZ plane is revere of other 2 planes
5fa0c173 1391 if (is_clockwise) { // Correct atan2 output per direction
29e809e0 1392 if (angular_travel >= -ARC_ANGULAR_TRAVEL_EPSILON) { angular_travel -= (2 * PI); }
5fa0c173 1393 } else {
29e809e0 1394 if (angular_travel <= ARC_ANGULAR_TRAVEL_EPSILON) { angular_travel += (2 * PI); }
4710532a 1395 }
aab6cbba 1396
edac9072 1397 // Find the distance for this gcode
29e809e0 1398 float millimeters_of_travel = hypotf(angular_travel * radius, fabsf(linear_travel));
436a2cd1 1399
edac9072 1400 // We don't care about non-XYZ moves ( for example the extruder produces some of those )
29e809e0 1401 if( millimeters_of_travel < 0.00001F ) {
350c8a60 1402 return false;
4710532a 1403 }
5dcb2ff3 1404
83c6e067
RA
1405 // limit segments by maximum arc error
1406 float arc_segment = this->mm_per_arc_segment;
4d0f60a9 1407 if ((this->mm_max_arc_error > 0) && (2 * radius > this->mm_max_arc_error)) {
83c6e067
RA
1408 float min_err_segment = 2 * sqrtf((this->mm_max_arc_error * (2 * radius - this->mm_max_arc_error)));
1409 if (this->mm_per_arc_segment < min_err_segment) {
1410 arc_segment = min_err_segment;
1411 }
1412 }
5984acdf 1413 // Figure out how many segments for this gcode
f8935932 1414 // TODO for deltas we need to make sure we are at least as many segments as requested, also if mm_per_line_segment is set we need to use the
29e809e0 1415 uint16_t segments = ceilf(millimeters_of_travel / arc_segment);
aab6cbba 1416
29e809e0 1417 //printf("Radius %f - Segment Length %f - Number of Segments %d\r\n",radius,arc_segment,segments); // Testing Purposes ONLY
4710532a
JM
1418 float theta_per_segment = angular_travel / segments;
1419 float linear_per_segment = linear_travel / segments;
aab6cbba
AW
1420
1421 /* Vector rotation by transformation matrix: r is the original vector, r_T is the rotated vector,
1422 and phi is the angle of rotation. Based on the solution approach by Jens Geisler.
1423 r_T = [cos(phi) -sin(phi);
1424 sin(phi) cos(phi] * r ;
1425 For arc generation, the center of the circle is the axis of rotation and the radius vector is
1426 defined from the circle center to the initial position. Each line segment is formed by successive
1427 vector rotations. This requires only two cos() and sin() computations to form the rotation
1428 matrix for the duration of the entire arc. Error may accumulate from numerical round-off, since
1ad23cd3 1429 all float numbers are single precision on the Arduino. (True float precision will not have
aab6cbba
AW
1430 round off issues for CNC applications.) Single precision error can accumulate to be greater than
1431 tool precision in some cases. Therefore, arc path correction is implemented.
1432
1433 Small angle approximation may be used to reduce computation overhead further. This approximation
1434 holds for everything, but very small circles and large mm_per_arc_segment values. In other words,
1435 theta_per_segment would need to be greater than 0.1 rad and N_ARC_CORRECTION would need to be large
1436 to cause an appreciable drift error. N_ARC_CORRECTION~=25 is more than small enough to correct for
1437 numerical drift error. N_ARC_CORRECTION may be on the order a hundred(s) before error becomes an
1438 issue for CNC machines with the single precision Arduino calculations.
1439 This approximation also allows mc_arc to immediately insert a line segment into the planner
1440 without the initial overhead of computing cos() or sin(). By the time the arc needs to be applied
1441 a correction, the planner should have caught up to the lag caused by the initial mc_arc overhead.
1442 This is important when there are successive arc motions.
1443 */
1444 // Vector rotation matrix values
4710532a 1445 float cos_T = 1 - 0.5F * theta_per_segment * theta_per_segment; // Small angle approximation
1ad23cd3 1446 float sin_T = theta_per_segment;
aab6cbba 1447
5acc50ad 1448 // TODO we need to handle the ABC axis here by segmenting them
511ba1ad 1449 float arc_target[n_motors];
1ad23cd3
MM
1450 float sin_Ti;
1451 float cos_Ti;
1452 float r_axisi;
aab6cbba
AW
1453 uint16_t i;
1454 int8_t count = 0;
1455
511ba1ad
JM
1456 // init array for all axis
1457 memcpy(arc_target, machine_position, n_motors*sizeof(float));
1458
aab6cbba 1459 // Initialize the linear axis
45ca77ec 1460 arc_target[this->plane_axis_2] = this->machine_position[this->plane_axis_2];
aab6cbba 1461
350c8a60 1462 bool moved= false;
4710532a 1463 for (i = 1; i < segments; i++) { // Increment (segments-1)
350c8a60 1464 if(THEKERNEL->is_halted()) return false; // don't queue any more segments
aab6cbba 1465
b66fb830 1466 if (count < this->arc_correction ) {
4710532a
JM
1467 // Apply vector rotation matrix
1468 r_axisi = r_axis0 * sin_T + r_axis1 * cos_T;
1469 r_axis0 = r_axis0 * cos_T - r_axis1 * sin_T;
1470 r_axis1 = r_axisi;
1471 count++;
aab6cbba 1472 } else {
4710532a
JM
1473 // Arc correction to radius vector. Computed only every N_ARC_CORRECTION increments.
1474 // Compute exact location by applying transformation matrix from initial radius vector(=-offset).
1475 cos_Ti = cosf(i * theta_per_segment);
1476 sin_Ti = sinf(i * theta_per_segment);
1477 r_axis0 = -offset[this->plane_axis_0] * cos_Ti + offset[this->plane_axis_1] * sin_Ti;
1478 r_axis1 = -offset[this->plane_axis_0] * sin_Ti - offset[this->plane_axis_1] * cos_Ti;
1479 count = 0;
aab6cbba
AW
1480 }
1481
1482 // Update arc_target location
1483 arc_target[this->plane_axis_0] = center_axis0 + r_axis0;
1484 arc_target[this->plane_axis_1] = center_axis1 + r_axis1;
1485 arc_target[this->plane_axis_2] += linear_per_segment;
edac9072
AW
1486
1487 // Append this segment to the queue
121094a5 1488 bool b= this->append_milestone(arc_target, rate_mm_s);
350c8a60 1489 moved= moved || b;
aab6cbba 1490 }
edac9072 1491
aab6cbba 1492 // Ensure last segment arrives at target location.
121094a5 1493 if(this->append_milestone(target, rate_mm_s)) moved= true;
350c8a60
JM
1494
1495 return moved;
aab6cbba
AW
1496}
1497
edac9072 1498// Do the math for an arc and add it to the queue
29e809e0 1499bool Robot::compute_arc(Gcode * gcode, const float offset[], const float target[], enum MOTION_MODE_T motion_mode)
4710532a 1500{
aab6cbba
AW
1501
1502 // Find the radius
13addf09 1503 float radius = hypotf(offset[this->plane_axis_0], offset[this->plane_axis_1]);
aab6cbba
AW
1504
1505 // Set clockwise/counter-clockwise sign for mc_arc computations
1506 bool is_clockwise = false;
29e809e0 1507 if( motion_mode == CW_ARC ) {
4710532a
JM
1508 is_clockwise = true;
1509 }
aab6cbba
AW
1510
1511 // Append arc
350c8a60 1512 return this->append_arc(gcode, target, offset, radius, is_clockwise );
aab6cbba
AW
1513}
1514
1515
4710532a
JM
1516float Robot::theta(float x, float y)
1517{
1518 float t = atanf(x / fabs(y));
1519 if (y > 0) {
1520 return(t);
1521 } else {
1522 if (t > 0) {
29e809e0 1523 return(PI - t);
4710532a 1524 } else {
29e809e0 1525 return(-PI - t);
4710532a
JM
1526 }
1527 }
4cff3ded
AW
1528}
1529
4710532a
JM
1530void Robot::select_plane(uint8_t axis_0, uint8_t axis_1, uint8_t axis_2)
1531{
4cff3ded
AW
1532 this->plane_axis_0 = axis_0;
1533 this->plane_axis_1 = axis_1;
1534 this->plane_axis_2 = axis_2;
1535}
1536
fae93525 1537void Robot::clearToolOffset()
4710532a 1538{
c2f7c261 1539 this->tool_offset= wcs_t(0,0,0);
fae93525
JM
1540}
1541
1542void Robot::setToolOffset(const float offset[3])
1543{
c2f7c261 1544 this->tool_offset= wcs_t(offset[0], offset[1], offset[2]);
5966b7d0
AT
1545}
1546
0ec2f63a
JM
1547float Robot::get_feed_rate() const
1548{
1549 return THEKERNEL->gcode_dispatch->get_modal_command() == 0 ? seek_rate : feed_rate;
1550}