Robot: forgot to check Z axis during segmentation. Reported by merkurk2k, found by...
[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
MM
10
11#include <math.h>
4cff3ded
AW
12#include <string>
13using std::string;
5673fe39 14
4cff3ded 15#include "Planner.h"
3fceb8eb 16#include "Conveyor.h"
4cff3ded 17#include "Robot.h"
5673fe39
MM
18#include "nuts_bolts.h"
19#include "Pin.h"
20#include "StepperMotor.h"
21#include "Gcode.h"
5647f709 22#include "PublicDataRequest.h"
4cff3ded
AW
23#include "arm_solutions/BaseSolution.h"
24#include "arm_solutions/CartesianSolution.h"
c41d6d95 25#include "arm_solutions/RotatableCartesianSolution.h"
4e04bcd3 26#include "arm_solutions/RostockSolution.h"
2c7ab192 27#include "arm_solutions/JohannKosselSolution.h"
bdaaa75d 28#include "arm_solutions/HBotSolution.h"
4cff3ded 29
78d0e16a
MM
30#define default_seek_rate_checksum CHECKSUM("default_seek_rate")
31#define default_feed_rate_checksum CHECKSUM("default_feed_rate")
32#define mm_per_line_segment_checksum CHECKSUM("mm_per_line_segment")
33#define delta_segments_per_second_checksum CHECKSUM("delta_segments_per_second")
34#define mm_per_arc_segment_checksum CHECKSUM("mm_per_arc_segment")
35#define arc_correction_checksum CHECKSUM("arc_correction")
36#define x_axis_max_speed_checksum CHECKSUM("x_axis_max_speed")
37#define y_axis_max_speed_checksum CHECKSUM("y_axis_max_speed")
38#define z_axis_max_speed_checksum CHECKSUM("z_axis_max_speed")
43424972
JM
39
40// arm solutions
78d0e16a
MM
41#define arm_solution_checksum CHECKSUM("arm_solution")
42#define cartesian_checksum CHECKSUM("cartesian")
43#define rotatable_cartesian_checksum CHECKSUM("rotatable_cartesian")
44#define rostock_checksum CHECKSUM("rostock")
45#define delta_checksum CHECKSUM("delta")
46#define hbot_checksum CHECKSUM("hbot")
47#define corexy_checksum CHECKSUM("corexy")
48#define kossel_checksum CHECKSUM("kossel")
49
50// stepper motor stuff
51#define alpha_step_pin_checksum CHECKSUM("alpha_step_pin")
52#define beta_step_pin_checksum CHECKSUM("beta_step_pin")
53#define gamma_step_pin_checksum CHECKSUM("gamma_step_pin")
54#define alpha_dir_pin_checksum CHECKSUM("alpha_dir_pin")
55#define beta_dir_pin_checksum CHECKSUM("beta_dir_pin")
56#define gamma_dir_pin_checksum CHECKSUM("gamma_dir_pin")
57#define alpha_en_pin_checksum CHECKSUM("alpha_en_pin")
58#define beta_en_pin_checksum CHECKSUM("beta_en_pin")
59#define gamma_en_pin_checksum CHECKSUM("gamma_en_pin")
a84f0186 60
78d0e16a
MM
61#define alpha_steps_per_mm_checksum CHECKSUM("alpha_steps_per_mm")
62#define beta_steps_per_mm_checksum CHECKSUM("beta_steps_per_mm")
63#define gamma_steps_per_mm_checksum CHECKSUM("gamma_steps_per_mm")
64
df6a30f2
MM
65#define alpha_max_rate_checksum CHECKSUM("alpha_max_rate")
66#define beta_max_rate_checksum CHECKSUM("beta_max_rate")
67#define gamma_max_rate_checksum CHECKSUM("gamma_max_rate")
68
69
78d0e16a
MM
70// new-style actuator stuff
71#define actuator_checksum CHEKCSUM("actuator")
72
73#define step_pin_checksum CHECKSUM("step_pin")
74#define dir_pin_checksum CHEKCSUM("dir_pin")
75#define en_pin_checksum CHECKSUM("en_pin")
76
77#define steps_per_mm_checksum CHECKSUM("steps_per_mm")
df6a30f2 78#define max_rate_checksum CHECKSUM("max_rate")
78d0e16a
MM
79
80#define alpha_checksum CHECKSUM("alpha")
81#define beta_checksum CHECKSUM("beta")
82#define gamma_checksum CHECKSUM("gamma")
83
43424972 84
edac9072
AW
85// 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
86// It takes care of cutting arcs into segments, same thing for line that are too long
41fd89e0 87#define max(a,b) (((a) > (b)) ? (a) : (b))
edac9072 88
4cff3ded 89Robot::Robot(){
a1b7e9f0 90 this->inch_mode = false;
0e8b102e 91 this->absolute_mode = true;
df27a6a3 92 this->motion_mode = MOTION_MODE_SEEK;
4cff3ded 93 this->select_plane(X_AXIS, Y_AXIS, Z_AXIS);
df27a6a3 94 clear_vector(this->last_milestone);
0b804a41 95 this->arm_solution = NULL;
da947c62 96 seconds_per_minute = 60.0F;
4cff3ded
AW
97}
98
99//Called when the module has just been loaded
100void Robot::on_module_loaded() {
476dcb96 101 register_for_event(ON_CONFIG_RELOAD);
4cff3ded 102 this->register_for_event(ON_GCODE_RECEIVED);
b55cfff1
JM
103 this->register_for_event(ON_GET_PUBLIC_DATA);
104 this->register_for_event(ON_SET_PUBLIC_DATA);
4cff3ded
AW
105
106 // Configuration
da24d6ae
AW
107 this->on_config_reload(this);
108}
109
110void Robot::on_config_reload(void* argument){
5984acdf 111
edac9072
AW
112 // Arm solutions are used to convert positions in millimeters into position in steps for each stepper motor.
113 // While for a cartesian arm solution, this is a simple multiplication, in other, less simple cases, there is some serious math to be done.
114 // To make adding those solution easier, they have their own, separate object.
5984acdf 115 // Here we read the config to find out which arm solution to use
0b804a41 116 if (this->arm_solution) delete this->arm_solution;
314ab8f7 117 int solution_checksum = get_checksum(THEKERNEL->config->value(arm_solution_checksum)->by_default("cartesian")->as_string());
d149c730 118 // Note checksums are not const expressions when in debug mode, so don't use switch
98761c28 119 if(solution_checksum == hbot_checksum || solution_checksum == corexy_checksum) {
314ab8f7 120 this->arm_solution = new HBotSolution(THEKERNEL->config);
bdaaa75d
L
121
122 }else if(solution_checksum == rostock_checksum) {
314ab8f7 123 this->arm_solution = new RostockSolution(THEKERNEL->config);
73a4e3c0 124
2c7ab192 125 }else if(solution_checksum == kossel_checksum) {
314ab8f7 126 this->arm_solution = new JohannKosselSolution(THEKERNEL->config);
2c7ab192 127
d149c730 128 }else if(solution_checksum == delta_checksum) {
4a0c8e14 129 // place holder for now
314ab8f7 130 this->arm_solution = new RostockSolution(THEKERNEL->config);
73a4e3c0 131
b73a756d 132 }else if(solution_checksum == rotatable_cartesian_checksum) {
314ab8f7 133 this->arm_solution = new RotatableCartesianSolution(THEKERNEL->config);
b73a756d 134
d149c730 135 }else if(solution_checksum == cartesian_checksum) {
314ab8f7 136 this->arm_solution = new CartesianSolution(THEKERNEL->config);
73a4e3c0 137
d149c730 138 }else{
314ab8f7 139 this->arm_solution = new CartesianSolution(THEKERNEL->config);
d149c730 140 }
73a4e3c0 141
0b804a41 142
da947c62
MM
143 this->feed_rate = THEKERNEL->config->value(default_feed_rate_checksum )->by_default( 100.0F)->as_number();
144 this->seek_rate = THEKERNEL->config->value(default_seek_rate_checksum )->by_default( 100.0F)->as_number();
145 this->mm_per_line_segment = THEKERNEL->config->value(mm_per_line_segment_checksum )->by_default( 0.0F)->as_number();
1ad23cd3 146 this->delta_segments_per_second = THEKERNEL->config->value(delta_segments_per_second_checksum )->by_default(0.0f )->as_number();
da947c62
MM
147 this->mm_per_arc_segment = THEKERNEL->config->value(mm_per_arc_segment_checksum )->by_default( 0.5f)->as_number();
148 this->arc_correction = THEKERNEL->config->value(arc_correction_checksum )->by_default( 5 )->as_number();
78d0e16a 149
c9ed779d
MM
150 this->max_speeds[X_AXIS] = THEKERNEL->config->value(x_axis_max_speed_checksum )->by_default(60000.0F)->as_number() / 60.0F;
151 this->max_speeds[Y_AXIS] = THEKERNEL->config->value(y_axis_max_speed_checksum )->by_default(60000.0F)->as_number() / 60.0F;
152 this->max_speeds[Z_AXIS] = THEKERNEL->config->value(z_axis_max_speed_checksum )->by_default( 300.0F)->as_number() / 60.0F;
feb204be 153
78d0e16a
MM
154 Pin alpha_step_pin;
155 Pin alpha_dir_pin;
156 Pin alpha_en_pin;
157 Pin beta_step_pin;
158 Pin beta_dir_pin;
159 Pin beta_en_pin;
160 Pin gamma_step_pin;
161 Pin gamma_dir_pin;
162 Pin gamma_en_pin;
163
164 alpha_step_pin.from_string( THEKERNEL->config->value(alpha_step_pin_checksum )->by_default("2.0" )->as_string())->as_output();
165 alpha_dir_pin.from_string( THEKERNEL->config->value(alpha_dir_pin_checksum )->by_default("0.5" )->as_string())->as_output();
166 alpha_en_pin.from_string( THEKERNEL->config->value(alpha_en_pin_checksum )->by_default("0.4" )->as_string())->as_output();
167 beta_step_pin.from_string( THEKERNEL->config->value(beta_step_pin_checksum )->by_default("2.1" )->as_string())->as_output();
9c5fa39a
MM
168 beta_dir_pin.from_string( THEKERNEL->config->value(beta_dir_pin_checksum )->by_default("0.11" )->as_string())->as_output();
169 beta_en_pin.from_string( THEKERNEL->config->value(beta_en_pin_checksum )->by_default("0.10" )->as_string())->as_output();
78d0e16a
MM
170 gamma_step_pin.from_string( THEKERNEL->config->value(gamma_step_pin_checksum )->by_default("2.2" )->as_string())->as_output();
171 gamma_dir_pin.from_string( THEKERNEL->config->value(gamma_dir_pin_checksum )->by_default("0.20" )->as_string())->as_output();
172 gamma_en_pin.from_string( THEKERNEL->config->value(gamma_en_pin_checksum )->by_default("0.19" )->as_string())->as_output();
78d0e16a 173
a84f0186
MM
174 float steps_per_mm[3] = {
175 THEKERNEL->config->value(alpha_steps_per_mm_checksum)->by_default( 80.0F)->as_number(),
176 THEKERNEL->config->value(beta_steps_per_mm_checksum )->by_default( 80.0F)->as_number(),
177 THEKERNEL->config->value(gamma_steps_per_mm_checksum)->by_default(2560.0F)->as_number(),
178 };
179
78d0e16a
MM
180 // TODO: delete or detect old steppermotors
181 // Make our 3 StepperMotors
9c5fa39a
MM
182 this->alpha_stepper_motor = THEKERNEL->step_ticker->add_stepper_motor( new StepperMotor(alpha_step_pin, alpha_dir_pin, alpha_en_pin) );
183 this->beta_stepper_motor = THEKERNEL->step_ticker->add_stepper_motor( new StepperMotor(beta_step_pin, beta_dir_pin, beta_en_pin ) );
184 this->gamma_stepper_motor = THEKERNEL->step_ticker->add_stepper_motor( new StepperMotor(gamma_step_pin, gamma_dir_pin, gamma_en_pin) );
78d0e16a 185
a84f0186
MM
186 alpha_stepper_motor->change_steps_per_mm(steps_per_mm[0]);
187 beta_stepper_motor->change_steps_per_mm(steps_per_mm[1]);
188 gamma_stepper_motor->change_steps_per_mm(steps_per_mm[2]);
189
df6a30f2
MM
190 alpha_stepper_motor->max_rate = THEKERNEL->config->value(alpha_max_rate_checksum)->by_default(30000.0F)->as_number() / 60.0F;
191 beta_stepper_motor->max_rate = THEKERNEL->config->value(beta_max_rate_checksum )->by_default(30000.0F)->as_number() / 60.0F;
192 gamma_stepper_motor->max_rate = THEKERNEL->config->value(gamma_max_rate_checksum)->by_default(30000.0F)->as_number() / 60.0F;
193
78d0e16a
MM
194 actuators.clear();
195 actuators.push_back(alpha_stepper_motor);
196 actuators.push_back(beta_stepper_motor);
197 actuators.push_back(gamma_stepper_motor);
4cff3ded
AW
198}
199
5647f709 200void Robot::on_get_public_data(void* argument){
b55cfff1
JM
201 PublicDataRequest* pdr = static_cast<PublicDataRequest*>(argument);
202
203 if(!pdr->starts_with(robot_checksum)) return;
204
205 if(pdr->second_element_is(speed_override_percent_checksum)) {
1ad23cd3 206 static float return_data;
da947c62 207 return_data = 100.0F * 60.0F / seconds_per_minute;
b55cfff1
JM
208 pdr->set_data_ptr(&return_data);
209 pdr->set_taken();
98761c28 210
b55cfff1 211 }else if(pdr->second_element_is(current_position_checksum)) {
1ad23cd3 212 static float return_data[3];
2ba859c9
MM
213 return_data[0]= from_millimeters(this->last_milestone[0]);
214 return_data[1]= from_millimeters(this->last_milestone[1]);
215 return_data[2]= from_millimeters(this->last_milestone[2]);
b55cfff1
JM
216
217 pdr->set_data_ptr(&return_data);
98761c28 218 pdr->set_taken();
b55cfff1 219 }
5647f709
JM
220}
221
222void Robot::on_set_public_data(void* argument){
b55cfff1 223 PublicDataRequest* pdr = static_cast<PublicDataRequest*>(argument);
5647f709 224
b55cfff1 225 if(!pdr->starts_with(robot_checksum)) return;
5647f709 226
b55cfff1 227 if(pdr->second_element_is(speed_override_percent_checksum)) {
7a522ccc 228 // NOTE do not use this while printing!
1ad23cd3 229 float t= *static_cast<float*>(pdr->get_data_ptr());
98761c28 230 // enforce minimum 10% speed
da947c62 231 if (t < 10.0F) t= 10.0F;
98761c28 232
da947c62 233 this->seconds_per_minute = t / 0.6F; // t * 60 / 100
b55cfff1
JM
234 pdr->set_taken();
235 }
5647f709
JM
236}
237
4cff3ded 238//A GCode has been received
edac9072 239//See if the current Gcode line has some orders for us
4cff3ded
AW
240void Robot::on_gcode_received(void * argument){
241 Gcode* gcode = static_cast<Gcode*>(argument);
6bc4a00a 242
4cff3ded
AW
243 //Temp variables, constant properties are stored in the object
244 uint8_t next_action = NEXT_ACTION_DEFAULT;
23c90ba6 245 this->motion_mode = -1;
4cff3ded
AW
246
247 //G-letter Gcodes are mostly what the Robot module is interrested in, other modules also catch the gcode event and do stuff accordingly
3c4f2dd8
AW
248 if( gcode->has_g){
249 switch( gcode->g ){
74b6303c
DD
250 case 0: this->motion_mode = MOTION_MODE_SEEK; gcode->mark_as_taken(); break;
251 case 1: this->motion_mode = MOTION_MODE_LINEAR; gcode->mark_as_taken(); break;
252 case 2: this->motion_mode = MOTION_MODE_CW_ARC; gcode->mark_as_taken(); break;
253 case 3: this->motion_mode = MOTION_MODE_CCW_ARC; gcode->mark_as_taken(); break;
254 case 17: this->select_plane(X_AXIS, Y_AXIS, Z_AXIS); gcode->mark_as_taken(); break;
255 case 18: this->select_plane(X_AXIS, Z_AXIS, Y_AXIS); gcode->mark_as_taken(); break;
256 case 19: this->select_plane(Y_AXIS, Z_AXIS, X_AXIS); gcode->mark_as_taken(); break;
257 case 20: this->inch_mode = true; gcode->mark_as_taken(); break;
258 case 21: this->inch_mode = false; gcode->mark_as_taken(); break;
259 case 90: this->absolute_mode = true; gcode->mark_as_taken(); break;
260 case 91: this->absolute_mode = false; gcode->mark_as_taken(); break;
0b804a41 261 case 92: {
6bc4a00a 262 if(gcode->get_num_args() == 0){
8a23b271 263 clear_vector(this->last_milestone);
6bc4a00a 264 }else{
eaf8a8a8
BG
265 for (char letter = 'X'; letter <= 'Z'; letter++){
266 if ( gcode->has_letter(letter) )
6bc4a00a 267 this->last_milestone[letter-'X'] = this->to_millimeters(gcode->get_value(letter));
eaf8a8a8 268 }
6bc4a00a 269 }
78d0e16a
MM
270
271 // TODO: handle any number of actuators
272 float actuator_pos[3];
2ba859c9 273 arm_solution->cartesian_to_actuator(last_milestone, actuator_pos);
78d0e16a
MM
274
275 for (int i = 0; i < 3; i++)
276 actuators[i]->change_last_milestone(actuator_pos[i]);
277
74b6303c 278 gcode->mark_as_taken();
78d0e16a 279 return;
6bc4a00a
MM
280 }
281 }
3c4f2dd8 282 }else if( gcode->has_m){
33e4cc02 283 switch( gcode->m ){
0fb5b438 284 case 92: // M92 - set steps per mm
0fb5b438 285 if (gcode->has_letter('X'))
78d0e16a 286 actuators[0]->change_steps_per_mm(this->to_millimeters(gcode->get_value('X')));
0fb5b438 287 if (gcode->has_letter('Y'))
78d0e16a 288 actuators[1]->change_steps_per_mm(this->to_millimeters(gcode->get_value('Y')));
0fb5b438 289 if (gcode->has_letter('Z'))
78d0e16a 290 actuators[2]->change_steps_per_mm(this->to_millimeters(gcode->get_value('Z')));
7369629d
MM
291 if (gcode->has_letter('F'))
292 seconds_per_minute = gcode->get_value('F');
78d0e16a
MM
293
294 gcode->stream->printf("X:%g Y:%g Z:%g F:%g ", actuators[0]->steps_per_mm, actuators[1]->steps_per_mm, actuators[2]->steps_per_mm, seconds_per_minute);
0fb5b438 295 gcode->add_nl = true;
74b6303c 296 gcode->mark_as_taken();
0fb5b438 297 return;
58d6d841 298 case 114: gcode->stream->printf("C: X:%1.3f Y:%1.3f Z:%1.3f ",
2ba859c9
MM
299 from_millimeters(this->last_milestone[0]),
300 from_millimeters(this->last_milestone[1]),
301 from_millimeters(this->last_milestone[2]));
6989211c 302 gcode->add_nl = true;
74b6303c 303 gcode->mark_as_taken();
6989211c 304 return;
33e4cc02 305
83488642
JM
306 case 203: // M203 Set maximum feedrates in mm/sec
307 if (gcode->has_letter('X'))
308 this->max_speeds[X_AXIS]= gcode->get_value('X');
309 if (gcode->has_letter('Y'))
310 this->max_speeds[Y_AXIS]= gcode->get_value('Y');
311 if (gcode->has_letter('Z'))
312 this->max_speeds[Z_AXIS]= gcode->get_value('Z');
313 if (gcode->has_letter('A'))
314 alpha_stepper_motor->max_rate= gcode->get_value('A');
315 if (gcode->has_letter('B'))
316 beta_stepper_motor->max_rate= gcode->get_value('B');
317 if (gcode->has_letter('C'))
318 gamma_stepper_motor->max_rate= gcode->get_value('C');
319
320 gcode->stream->printf("X:%g Y:%g Z:%g A:%g B:%g C:%g ",
321 this->max_speeds[X_AXIS], this->max_speeds[Y_AXIS], this->max_speeds[Z_AXIS],
322 alpha_stepper_motor->max_rate, beta_stepper_motor->max_rate, gamma_stepper_motor->max_rate);
323 gcode->add_nl = true;
324 gcode->mark_as_taken();
325 break;
326
d4ee6ee2
JM
327 case 204: // M204 Snnn - set acceleration to nnn, NB only Snnn is currently supported
328 gcode->mark_as_taken();
83488642 329
d4ee6ee2
JM
330 if (gcode->has_letter('S'))
331 {
83488642
JM
332 // TODO for safety so it applies only to following gcodes, maybe a better way to do this?
333 THEKERNEL->conveyor->wait_for_empty_queue();
da947c62 334 float acc= gcode->get_value('S'); // mm/s^2
d4ee6ee2 335 // enforce minimum
da947c62
MM
336 if (acc < 1.0F)
337 acc = 1.0F;
314ab8f7 338 THEKERNEL->planner->acceleration= acc;
d4ee6ee2
JM
339 }
340 break;
341
8b69c90d 342 case 205: // M205 Xnnn - set junction deviation Snnn - Set minimum planner speed
d4ee6ee2
JM
343 gcode->mark_as_taken();
344 if (gcode->has_letter('X'))
345 {
1ad23cd3 346 float jd= gcode->get_value('X');
d4ee6ee2 347 // enforce minimum
8b69c90d
JM
348 if (jd < 0.0F)
349 jd = 0.0F;
314ab8f7 350 THEKERNEL->planner->junction_deviation= jd;
d4ee6ee2 351 }
8b69c90d
JM
352 if (gcode->has_letter('S'))
353 {
354 float mps= gcode->get_value('S');
355 // enforce minimum
356 if (mps < 0.0F)
357 mps = 0.0F;
358 THEKERNEL->planner->minimum_planner_speed= mps;
359 }
d4ee6ee2 360 break;
98761c28 361
7369629d 362 case 220: // M220 - speed override percentage
74b6303c 363 gcode->mark_as_taken();
7369629d
MM
364 if (gcode->has_letter('S'))
365 {
1ad23cd3 366 float factor = gcode->get_value('S');
98761c28 367 // enforce minimum 10% speed
da947c62
MM
368 if (factor < 10.0F)
369 factor = 10.0F;
370 // enforce maximum 10x speed
371 if (factor > 1000.0F)
372 factor = 1000.0F;
373
374 seconds_per_minute = 6000.0F / factor;
7369629d 375 }
b4f56013 376 break;
ec4773e5 377
494dc541
JM
378 case 400: // wait until all moves are done up to this point
379 gcode->mark_as_taken();
314ab8f7 380 THEKERNEL->conveyor->wait_for_empty_queue();
494dc541
JM
381 break;
382
33e4cc02
JM
383 case 500: // M500 saves some volatile settings to config override file
384 case 503: // M503 just prints the settings
78d0e16a 385 gcode->stream->printf(";Steps per unit:\nM92 X%1.5f Y%1.5f Z%1.5f\n", actuators[0]->steps_per_mm, actuators[1]->steps_per_mm, actuators[2]->steps_per_mm);
da947c62 386 gcode->stream->printf(";Acceleration mm/sec^2:\nM204 S%1.5f\n", THEKERNEL->planner->acceleration);
8b69c90d 387 gcode->stream->printf(";X- Junction Deviation, S - Minimum Planner speed:\nM205 X%1.5f S%1.5f\n", THEKERNEL->planner->junction_deviation, THEKERNEL->planner->minimum_planner_speed);
83488642
JM
388 gcode->stream->printf(";Max feedrates in mm/sec, XYZ cartesian, ABC actuator:\nM203 X%1.5f Y%1.5f Z%1.5f A%1.5f B%1.5f C%1.5f\n",
389 this->max_speeds[X_AXIS], this->max_speeds[Y_AXIS], this->max_speeds[Z_AXIS],
390 alpha_stepper_motor->max_rate, beta_stepper_motor->max_rate, gamma_stepper_motor->max_rate);
33e4cc02
JM
391 gcode->mark_as_taken();
392 break;
393
ec4773e5
JM
394 case 665: // M665 set optional arm solution variables based on arm solution
395 gcode->mark_as_taken();
396 // the parameter args could be any letter so try each one
397 for(char c='A';c<='Z';c++) {
1ad23cd3 398 float v;
ec4773e5
JM
399 bool supported= arm_solution->get_optional(c, &v); // retrieve current value if supported
400
401 if(supported && gcode->has_letter(c)) { // set new value if supported
402 v= gcode->get_value(c);
403 arm_solution->set_optional(c, v);
404 }
405 if(supported) { // print all current values of supported options
5523c05d
JM
406 gcode->stream->printf("%c %8.3f ", c, v);
407 gcode->add_nl = true;
ec4773e5
JM
408 }
409 }
410 break;
411
6989211c 412 }
494dc541
JM
413 }
414
c83887ea
MM
415 if( this->motion_mode < 0)
416 return;
6bc4a00a 417
4cff3ded 418 //Get parameters
1ad23cd3 419 float target[3], offset[3];
c2885de8 420 clear_vector(offset);
6bc4a00a 421
2ba859c9 422 memcpy(target, this->last_milestone, sizeof(target)); //default to last target
6bc4a00a 423
c2885de8
JM
424 for(char letter = 'I'; letter <= 'K'; letter++){
425 if( gcode->has_letter(letter) ){
426 offset[letter-'I'] = this->to_millimeters(gcode->get_value(letter));
427 }
428 }
429 for(char letter = 'X'; letter <= 'Z'; letter++){
430 if( gcode->has_letter(letter) ){
431 target[letter-'X'] = this->to_millimeters(gcode->get_value(letter)) + ( this->absolute_mode ? 0 : target[letter-'X']);
432 }
433 }
6bc4a00a 434
7369629d
MM
435 if( gcode->has_letter('F') )
436 {
437 if( this->motion_mode == MOTION_MODE_SEEK )
da947c62 438 this->seek_rate = this->to_millimeters( gcode->get_value('F') );
7369629d 439 else
da947c62 440 this->feed_rate = this->to_millimeters( gcode->get_value('F') );
7369629d 441 }
6bc4a00a 442
4cff3ded
AW
443 //Perform any physical actions
444 switch( next_action ){
445 case NEXT_ACTION_DEFAULT:
446 switch(this->motion_mode){
447 case MOTION_MODE_CANCEL: break;
da947c62
MM
448 case MOTION_MODE_SEEK : this->append_line(gcode, target, this->seek_rate / seconds_per_minute ); break;
449 case MOTION_MODE_LINEAR: this->append_line(gcode, target, this->feed_rate / seconds_per_minute ); break;
df27a6a3 450 case MOTION_MODE_CW_ARC: case MOTION_MODE_CCW_ARC: this->compute_arc(gcode, offset, target ); break;
4cff3ded
AW
451 }
452 break;
453 }
13e4a3f9 454
4cff3ded
AW
455 // As far as the parser is concerned, the position is now == target. In reality the
456 // motion control system might still be processing the action and the real tool position
457 // in any intermediate location.
2ba859c9 458 memcpy(this->last_milestone, target, sizeof(this->last_milestone)); // this->position[] = target[];
4cff3ded 459
edac9072
AW
460}
461
5984acdf 462// We received a new gcode, and one of the functions
edac9072
AW
463// determined the distance for that given gcode. So now we can attach this gcode to the right block
464// and continue
465void Robot::distance_in_gcode_is_known(Gcode* gcode){
466
467 //If the queue is empty, execute immediatly, otherwise attach to the last added block
e0ee24ed 468 THEKERNEL->conveyor->append_gcode(gcode);
edac9072
AW
469}
470
471// Reset the position for all axes ( used in homing and G92 stuff )
1ad23cd3 472void Robot::reset_axis_position(float position, int axis) {
2ba859c9 473 this->last_milestone[axis] = position;
29c28822
MM
474
475 float actuator_pos[3];
476 arm_solution->cartesian_to_actuator(last_milestone, actuator_pos);
477
478 for (int i = 0; i < 3; i++)
479 actuators[i]->change_last_milestone(actuator_pos[i]);
4cff3ded
AW
480}
481
edac9072 482
4cff3ded 483// Convert target from millimeters to steps, and append this to the planner
da947c62 484void Robot::append_milestone( float target[], float rate_mm_s )
df6a30f2 485{
1ad23cd3 486 float deltas[3];
df6a30f2
MM
487 float unit_vec[3];
488 float actuator_pos[3];
489 float millimeters_of_travel;
490
491 // find distance moved by each axis
492 for (int axis = X_AXIS; axis <= Z_AXIS; axis++)
493 deltas[axis] = target[axis] - last_milestone[axis];
aab6cbba 494
edac9072 495 // Compute how long this move moves, so we can attach it to the block for later use
df6a30f2
MM
496 millimeters_of_travel = sqrtf( pow( deltas[X_AXIS], 2 ) + pow( deltas[Y_AXIS], 2 ) + pow( deltas[Z_AXIS], 2 ) );
497
498 // find distance unit vector
499 for (int i = 0; i < 3; i++)
500 unit_vec[i] = deltas[i] / millimeters_of_travel;
501
502 // Do not move faster than the configured cartesian limits
503 for (int axis = X_AXIS; axis <= Z_AXIS; axis++)
504 {
505 if ( max_speeds[axis] > 0 )
506 {
da947c62 507 float axis_speed = fabs(unit_vec[axis] * rate_mm_s);
df6a30f2
MM
508
509 if (axis_speed > max_speeds[axis])
da947c62 510 rate_mm_s *= ( max_speeds[axis] / axis_speed );
7b470506
AW
511 }
512 }
4cff3ded 513
df6a30f2
MM
514 // find actuator position given cartesian position
515 arm_solution->cartesian_to_actuator( target, actuator_pos );
516
517 // check per-actuator speed limits
518 for (int actuator = 0; actuator <= 2; actuator++)
519 {
da947c62 520 float actuator_rate = fabs(actuator_pos[actuator] - actuators[actuator]->last_milestone_mm) * rate_mm_s / millimeters_of_travel;
df6a30f2
MM
521
522 if (actuator_rate > actuators[actuator]->max_rate)
da947c62 523 rate_mm_s *= (actuators[actuator]->max_rate / actuator_rate);
df6a30f2
MM
524 }
525
edac9072 526 // Append the block to the planner
da947c62 527 THEKERNEL->planner->append_block( actuator_pos, rate_mm_s, millimeters_of_travel, unit_vec );
4cff3ded 528
edac9072 529 // Update the last_milestone to the current target for the next time we use last_milestone
c2885de8 530 memcpy(this->last_milestone, target, sizeof(this->last_milestone)); // this->last_milestone[] = target[];
4cff3ded
AW
531
532}
533
edac9072 534// Append a move to the queue ( cutting it into segments if needed )
da947c62 535void Robot::append_line(Gcode* gcode, float target[], float rate_mm_s ){
4cff3ded 536
edac9072 537 // Find out the distance for this gcode
2ba859c9 538 gcode->millimeters_of_travel = pow( target[X_AXIS]-this->last_milestone[X_AXIS], 2 ) + pow( target[Y_AXIS]-this->last_milestone[Y_AXIS], 2 ) + pow( target[Z_AXIS]-this->last_milestone[Z_AXIS], 2 );
4cff3ded 539
edac9072 540 // We ignore non-moves ( for example, extruder moves are not XYZ moves )
c2885de8 541 if( gcode->millimeters_of_travel < 0.0001F ){
95b4885b
JM
542 return;
543 }
436a2cd1 544
2ba859c9
MM
545 gcode->millimeters_of_travel = sqrtf(gcode->millimeters_of_travel);
546
edac9072 547 // Mark the gcode as having a known distance
5dcb2ff3 548 this->distance_in_gcode_is_known( gcode );
436a2cd1 549
4a0c8e14
JM
550 // We cut the line into smaller segments. This is not usefull in a cartesian robot, but necessary for robots with rotational axes.
551 // In cartesian robot, a high "mm_per_line_segment" setting will prevent waste.
552 // In delta robots either mm_per_line_segment can be used OR delta_segments_per_second 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 553 uint16_t segments;
5984acdf 554
c2885de8 555 if(this->delta_segments_per_second > 1.0F) {
4a0c8e14
JM
556 // enabled if set to something > 1, it is set to 0.0 by default
557 // segment based on current speed and requested segments per second
558 // the faster the travel speed the fewer segments needed
559 // NOTE rate is mm/sec and we take into account any speed override
da947c62 560 float seconds = gcode->millimeters_of_travel / rate_mm_s;
4a0c8e14
JM
561 segments= max(1, ceil(this->delta_segments_per_second * seconds));
562 // TODO if we are only moving in Z on a delta we don't really need to segment at all
5984acdf 563
4a0c8e14 564 }else{
c2885de8 565 if(this->mm_per_line_segment == 0.0F){
4a0c8e14
JM
566 segments= 1; // don't split it up
567 }else{
568 segments = ceil( gcode->millimeters_of_travel/ this->mm_per_line_segment);
569 }
570 }
5984acdf 571
2ba859c9
MM
572 if (segments > 1)
573 {
574 // A vector to keep track of the endpoint of each segment
575 float segment_delta[3];
576 float segment_end[3];
577
578 // How far do we move each segment?
9fff6045 579 for (int i = X_AXIS; i <= Z_AXIS; i++)
2ba859c9 580 segment_delta[i] = (target[i] - last_milestone[i]) / segments;
4cff3ded 581
2ba859c9
MM
582 //For each segment
583 for (int i = 1; i < segments; i++)
584 {
585 for(int axis=X_AXIS; axis <= Z_AXIS; axis++ )
586 segment_end[axis] = last_milestone[axis] + segment_delta[axis];
587
588 // Append the end of this segment to the queue
589 this->append_milestone(segment_end, rate_mm_s);
590 }
4cff3ded 591 }
5984acdf
MM
592
593 // Append the end of this full move to the queue
da947c62 594 this->append_milestone(target, rate_mm_s);
2134bcf2
MM
595
596 // if adding these blocks didn't start executing, do that now
597 THEKERNEL->conveyor->ensure_running();
4cff3ded
AW
598}
599
4cff3ded 600
edac9072 601// Append an arc to the queue ( cutting it into segments as needed )
1ad23cd3 602void Robot::append_arc(Gcode* gcode, float target[], float offset[], float radius, bool is_clockwise ){
aab6cbba 603
edac9072 604 // Scary math
2ba859c9
MM
605 float center_axis0 = this->last_milestone[this->plane_axis_0] + offset[this->plane_axis_0];
606 float center_axis1 = this->last_milestone[this->plane_axis_1] + offset[this->plane_axis_1];
607 float linear_travel = target[this->plane_axis_2] - this->last_milestone[this->plane_axis_2];
1ad23cd3
MM
608 float r_axis0 = -offset[this->plane_axis_0]; // Radius vector from center to current location
609 float r_axis1 = -offset[this->plane_axis_1];
610 float rt_axis0 = target[this->plane_axis_0] - center_axis0;
611 float rt_axis1 = target[this->plane_axis_1] - center_axis1;
aab6cbba
AW
612
613 // CCW angle between position and target from circle center. Only one atan2() trig computation required.
1ad23cd3 614 float angular_travel = atan2(r_axis0*rt_axis1-r_axis1*rt_axis0, r_axis0*rt_axis0+r_axis1*rt_axis1);
aab6cbba
AW
615 if (angular_travel < 0) { angular_travel += 2*M_PI; }
616 if (is_clockwise) { angular_travel -= 2*M_PI; }
617
edac9072 618 // Find the distance for this gcode
13addf09 619 gcode->millimeters_of_travel = hypotf(angular_travel*radius, fabs(linear_travel));
436a2cd1 620
edac9072 621 // We don't care about non-XYZ moves ( for example the extruder produces some of those )
c2885de8 622 if( gcode->millimeters_of_travel < 0.0001F ){ return; }
5dcb2ff3 623
edac9072 624 // Mark the gcode as having a known distance
d149c730 625 this->distance_in_gcode_is_known( gcode );
5984acdf
MM
626
627 // Figure out how many segments for this gcode
436a2cd1 628 uint16_t segments = floor(gcode->millimeters_of_travel/this->mm_per_arc_segment);
aab6cbba 629
1ad23cd3
MM
630 float theta_per_segment = angular_travel/segments;
631 float linear_per_segment = linear_travel/segments;
aab6cbba
AW
632
633 /* Vector rotation by transformation matrix: r is the original vector, r_T is the rotated vector,
634 and phi is the angle of rotation. Based on the solution approach by Jens Geisler.
635 r_T = [cos(phi) -sin(phi);
636 sin(phi) cos(phi] * r ;
637 For arc generation, the center of the circle is the axis of rotation and the radius vector is
638 defined from the circle center to the initial position. Each line segment is formed by successive
639 vector rotations. This requires only two cos() and sin() computations to form the rotation
640 matrix for the duration of the entire arc. Error may accumulate from numerical round-off, since
1ad23cd3 641 all float numbers are single precision on the Arduino. (True float precision will not have
aab6cbba
AW
642 round off issues for CNC applications.) Single precision error can accumulate to be greater than
643 tool precision in some cases. Therefore, arc path correction is implemented.
644
645 Small angle approximation may be used to reduce computation overhead further. This approximation
646 holds for everything, but very small circles and large mm_per_arc_segment values. In other words,
647 theta_per_segment would need to be greater than 0.1 rad and N_ARC_CORRECTION would need to be large
648 to cause an appreciable drift error. N_ARC_CORRECTION~=25 is more than small enough to correct for
649 numerical drift error. N_ARC_CORRECTION may be on the order a hundred(s) before error becomes an
650 issue for CNC machines with the single precision Arduino calculations.
651 This approximation also allows mc_arc to immediately insert a line segment into the planner
652 without the initial overhead of computing cos() or sin(). By the time the arc needs to be applied
653 a correction, the planner should have caught up to the lag caused by the initial mc_arc overhead.
654 This is important when there are successive arc motions.
655 */
656 // Vector rotation matrix values
c2885de8 657 float cos_T = 1-0.5F*theta_per_segment*theta_per_segment; // Small angle approximation
1ad23cd3 658 float sin_T = theta_per_segment;
aab6cbba 659
1ad23cd3
MM
660 float arc_target[3];
661 float sin_Ti;
662 float cos_Ti;
663 float r_axisi;
aab6cbba
AW
664 uint16_t i;
665 int8_t count = 0;
666
667 // Initialize the linear axis
2ba859c9 668 arc_target[this->plane_axis_2] = this->last_milestone[this->plane_axis_2];
aab6cbba
AW
669
670 for (i = 1; i<segments; i++) { // Increment (segments-1)
671
b66fb830 672 if (count < this->arc_correction ) {
aab6cbba
AW
673 // Apply vector rotation matrix
674 r_axisi = r_axis0*sin_T + r_axis1*cos_T;
675 r_axis0 = r_axis0*cos_T - r_axis1*sin_T;
676 r_axis1 = r_axisi;
677 count++;
678 } else {
679 // Arc correction to radius vector. Computed only every N_ARC_CORRECTION increments.
680 // Compute exact location by applying transformation matrix from initial radius vector(=-offset).
13addf09
MM
681 cos_Ti = cosf(i*theta_per_segment);
682 sin_Ti = sinf(i*theta_per_segment);
aab6cbba
AW
683 r_axis0 = -offset[this->plane_axis_0]*cos_Ti + offset[this->plane_axis_1]*sin_Ti;
684 r_axis1 = -offset[this->plane_axis_0]*sin_Ti - offset[this->plane_axis_1]*cos_Ti;
685 count = 0;
686 }
687
688 // Update arc_target location
689 arc_target[this->plane_axis_0] = center_axis0 + r_axis0;
690 arc_target[this->plane_axis_1] = center_axis1 + r_axis1;
691 arc_target[this->plane_axis_2] += linear_per_segment;
edac9072
AW
692
693 // Append this segment to the queue
da947c62 694 this->append_milestone(arc_target, this->feed_rate / seconds_per_minute);
aab6cbba
AW
695
696 }
edac9072 697
aab6cbba 698 // Ensure last segment arrives at target location.
da947c62 699 this->append_milestone(target, this->feed_rate / seconds_per_minute);
aab6cbba
AW
700}
701
edac9072 702// Do the math for an arc and add it to the queue
1ad23cd3 703void Robot::compute_arc(Gcode* gcode, float offset[], float target[]){
aab6cbba
AW
704
705 // Find the radius
13addf09 706 float radius = hypotf(offset[this->plane_axis_0], offset[this->plane_axis_1]);
aab6cbba
AW
707
708 // Set clockwise/counter-clockwise sign for mc_arc computations
709 bool is_clockwise = false;
df27a6a3 710 if( this->motion_mode == MOTION_MODE_CW_ARC ){ is_clockwise = true; }
aab6cbba
AW
711
712 // Append arc
436a2cd1 713 this->append_arc(gcode, target, offset, radius, is_clockwise );
aab6cbba
AW
714
715}
716
717
1ad23cd3 718float Robot::theta(float x, float y){
71c21c73 719 float t = atanf(x/fabs(y));
4cff3ded
AW
720 if (y>0) {return(t);} else {if (t>0){return(M_PI-t);} else {return(-M_PI-t);}}
721}
722
723void Robot::select_plane(uint8_t axis_0, uint8_t axis_1, uint8_t axis_2){
724 this->plane_axis_0 = axis_0;
725 this->plane_axis_1 = axis_1;
726 this->plane_axis_2 = axis_2;
727}
728
729