2 This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
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.
5 You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
8 #include "libs/Module.h"
9 #include "libs/Kernel.h"
10 #include "modules/communication/utils/Gcode.h"
11 #include "modules/robot/Conveyor.h"
12 #include "modules/robot/ActuatorCoordinates.h"
14 #include "libs/nuts_bolts.h"
16 #include "libs/StepperMotor.h"
17 #include "wait_api.h" // mbed.h lib
20 #include "SlowTicker.h"
22 #include "checksumm.h"
24 #include "ConfigValue.h"
25 #include "libs/StreamOutput.h"
26 #include "PublicDataRequest.h"
27 #include "EndstopsPublicAccess.h"
28 #include "StreamOutputPool.h"
29 #include "StepTicker.h"
30 #include "BaseSolution.h"
31 #include "SerialMessage.h"
36 // OLD deprecated syntax
37 #define endstops_module_enable_checksum CHECKSUM("endstops_enable")
39 #define ENDSTOP_CHECKSUMS(X) { \
40 CHECKSUM(X "_min_endstop"), \
41 CHECKSUM(X "_max_endstop"), \
42 CHECKSUM(X "_max_travel"), \
43 CHECKSUM(X "_fast_homing_rate_mm_s"), \
44 CHECKSUM(X "_slow_homing_rate_mm_s"), \
45 CHECKSUM(X "_homing_retract_mm"), \
46 CHECKSUM(X "_homing_direction"), \
49 CHECKSUM(X "_limit_enable"), \
53 enum DEFNS
{MIN_PIN
, MAX_PIN
, MAX_TRAVEL
, FAST_RATE
, SLOW_RATE
, RETRACT
, DIRECTION
, MIN
, MAX
, LIMIT
, NDEFNS
};
55 // global config settings
56 #define corexy_homing_checksum CHECKSUM("corexy_homing")
57 #define delta_homing_checksum CHECKSUM("delta_homing")
58 #define rdelta_homing_checksum CHECKSUM("rdelta_homing")
59 #define scara_homing_checksum CHECKSUM("scara_homing")
61 #define endstop_debounce_count_checksum CHECKSUM("endstop_debounce_count")
62 #define endstop_debounce_ms_checksum CHECKSUM("endstop_debounce_ms")
64 #define home_z_first_checksum CHECKSUM("home_z_first")
65 #define homing_order_checksum CHECKSUM("homing_order")
66 #define move_to_origin_checksum CHECKSUM("move_to_origin_after_home")
68 #define alpha_trim_checksum CHECKSUM("alpha_trim_mm")
69 #define beta_trim_checksum CHECKSUM("beta_trim_mm")
70 #define gamma_trim_checksum CHECKSUM("gamma_trim_mm")
73 // endstop.xmin.enable true
74 // endstop.xmin.pin 1.29
75 // endstop.xmin.axis X
76 // endstop.xmin.homing_direction home_to_min
78 #define endstop_checksum CHECKSUM("endstop")
79 #define enable_checksum CHECKSUM("enable")
80 #define pin_checksum CHECKSUM("pin")
81 #define axis_checksum CHECKSUM("axis")
82 #define direction_checksum CHECKSUM("homing_direction")
83 #define position_checksum CHECKSUM("homing_position")
84 #define fast_rate_checksum CHECKSUM("fast_rate")
85 #define slow_rate_checksum CHECKSUM("slow_rate")
86 #define max_travel_checksum CHECKSUM("max_travel")
87 #define retract_checksum CHECKSUM("retract")
88 #define limit_checksum CHECKSUM("limit_enable")
90 #define STEPPER THEROBOT->actuators
91 #define STEPS_PER_MM(a) (STEPPER[a]->get_steps_per_mm())
97 MOVING_TO_ENDSTOP_FAST
, // homing move
98 MOVING_TO_ENDSTOP_SLOW
, // homing move
99 MOVING_BACK
, // homing move
108 this->status
= NOT_HOMING
;
111 void Endstops::on_module_loaded()
113 // Do not do anything if not enabled or if no pins are defined
114 if (THEKERNEL
->config
->value( endstops_module_enable_checksum
)->by_default(false)->as_bool()) {
115 if(!load_old_config()) {
121 // check for new config syntax
128 register_for_event(ON_GCODE_RECEIVED
);
129 register_for_event(ON_GET_PUBLIC_DATA
);
130 register_for_event(ON_SET_PUBLIC_DATA
);
133 THEKERNEL
->slow_ticker
->attach(1000, this, &Endstops::read_endstops
);
136 // Get config using old deprecated syntax Does not support ABC
137 bool Endstops::load_old_config()
139 uint16_t const checksums
[][NDEFNS
] = {
140 ENDSTOP_CHECKSUMS("alpha"), // X
141 ENDSTOP_CHECKSUMS("beta"), // Y
142 ENDSTOP_CHECKSUMS("gamma") // Z
145 bool limit_enabled
= false;
146 for (int i
= X_AXIS
; i
<= Z_AXIS
; ++i
) { // X_AXIS to Z_AXIS
149 // init homing struct
150 hinfo
.home_offset
= 0;
154 hinfo
.pin_info
= nullptr;
157 hinfo
.fast_rate
= THEKERNEL
->config
->value(checksums
[i
][FAST_RATE
])->by_default(100)->as_number();
158 hinfo
.slow_rate
= THEKERNEL
->config
->value(checksums
[i
][SLOW_RATE
])->by_default(10)->as_number();
161 hinfo
.retract
= THEKERNEL
->config
->value(checksums
[i
][RETRACT
])->by_default(5)->as_number();
163 // get homing direction and convert to boolean where true is home to min, and false is home to max
164 hinfo
.home_direction
= THEKERNEL
->config
->value(checksums
[i
][DIRECTION
])->by_default("home_to_min")->as_string() != "home_to_max";
166 // homing cartesian position
167 hinfo
.homing_position
= hinfo
.home_direction
? THEKERNEL
->config
->value(checksums
[i
][MIN
])->by_default(0)->as_number() : THEKERNEL
->config
->value(checksums
[i
][MAX
])->by_default(200)->as_number();
169 // used to set maximum movement on homing, set by alpha_max_travel if defined
170 hinfo
.max_travel
= THEKERNEL
->config
->value(checksums
[i
][MAX_TRAVEL
])->by_default(500)->as_number();
173 // pin definitions for endstop pins
174 for (int j
= MIN_PIN
; j
<= MAX_PIN
; ++j
) {
175 endstop_info_t
*info
= new endstop_info_t
;
176 info
->pin
.from_string(THEKERNEL
->config
->value(checksums
[i
][j
])->by_default("nc" )->as_string())->as_input();
177 if(!info
->pin
.connected()){
178 // no pin defined try next
183 // enter into endstop array
184 endstops
.push_back(info
);
186 // add index to the homing struct if this is the one used for homing
187 if((hinfo
.home_direction
&& j
== MIN_PIN
) || (!hinfo
.home_direction
&& j
== MAX_PIN
)) hinfo
.pin_info
= info
;
195 info
->limit_enable
= THEKERNEL
->config
->value(checksums
[i
][LIMIT
])->by_default(false)->as_bool();
196 limit_enabled
|= info
->limit_enable
;
199 homing_axis
.push_back(hinfo
);
202 // if no pins defined then disable the module
203 if(endstops
.empty()) return false;
205 get_global_configs();
208 register_for_event(ON_IDLE
);
211 // sanity check for deltas
213 if(this->is_delta || this->is_rdelta) {
214 // some things must be the same or they will die, so force it here to avoid config errors
215 this->fast_rates[1] = this->fast_rates[2] = this->fast_rates[0];
216 this->slow_rates[1] = this->slow_rates[2] = this->slow_rates[0];
217 this->retract_mm[1] = this->retract_mm[2] = this->retract_mm[0];
218 this->home_direction[1] = this->home_direction[2] = this->home_direction[0];
219 // NOTE homing_position for rdelta is the angle of the actuator not the cartesian position
220 if(!this->is_rdelta) this->homing_position[0] = this->homing_position[1] = 0;
227 // Get config using new syntax supports ABC
228 bool Endstops::load_config()
230 bool limit_enabled
= false;
232 std::array
<homing_info_t
, k_max_actuators
> temp_axis_array
; // needs to be at least XYZ, but allow for ABC
239 temp_axis_array
.fill(t
);
242 // iterate over all endstop.*.*
243 std::vector
<uint16_t> modules
;
244 THEKERNEL
->config
->get_module_list(&modules
, endstop_checksum
);
245 for(auto cs
: modules
) {
246 if(!THEKERNEL
->config
->value(endstop_checksum
, cs
, enable_checksum
)->as_bool()) continue;
248 endstop_info_t
*pin_info
= new endstop_info_t
;
249 pin_info
->pin
.from_string(THEKERNEL
->config
->value(endstop_checksum
, cs
, pin_checksum
)->by_default("nc" )->as_string())->as_input();
250 if(!pin_info
->pin
.connected()){
251 // no pin defined try next
256 string axis
= THEKERNEL
->config
->value(endstop_checksum
, cs
, axis_checksum
)->by_default("")->as_string();
264 switch(toupper(axis
[0])) {
265 case 'X': i
= X_AXIS
; break;
266 case 'Y': i
= Y_AXIS
; break;
267 case 'Z': i
= Z_AXIS
; break;
268 case 'A': i
= A_AXIS
; break;
269 case 'B': i
= B_AXIS
; break;
270 case 'C': i
= C_AXIS
; break;
271 default: // not a recognized axis
277 pin_info
->debounce
= 0;
278 pin_info
->axis
= toupper(axis
[0]);
279 pin_info
->axis_index
= i
;
281 // are limits enabled
282 pin_info
->limit_enable
= THEKERNEL
->config
->value(endstop_checksum
, cs
, limit_checksum
)->by_default(false)->as_bool();
283 limit_enabled
|= pin_info
->limit_enable
;
285 // enter into endstop array
286 endstops
.push_back(pin_info
);
288 // check we are not going above the number of defined actuators/axis
289 if(i
>= k_max_actuators
) {
290 // too many axis we only have configured k_max_actuators
294 // if set to none it means not used for homing (maybe limit only) so do not add to the homing array
295 string direction
= THEKERNEL
->config
->value(endstop_checksum
, cs
, direction_checksum
)->by_default("none")->as_string();
296 if(direction
== "none") {
300 // setup the homing array
303 // init homing struct
304 hinfo
.home_offset
= 0;
306 hinfo
.axis
= toupper(axis
[0]);
308 hinfo
.pin_info
= pin_info
;
311 hinfo
.fast_rate
= THEKERNEL
->config
->value(endstop_checksum
, cs
, fast_rate_checksum
)->by_default(100)->as_number();
312 hinfo
.slow_rate
= THEKERNEL
->config
->value(endstop_checksum
, cs
, slow_rate_checksum
)->by_default(10)->as_number();
315 hinfo
.retract
= THEKERNEL
->config
->value(endstop_checksum
, cs
, retract_checksum
)->by_default(5)->as_number();
317 // homing direction and convert to boolean where true is home to min, and false is home to max
318 hinfo
.home_direction
= direction
== "home_to_min";
320 // homing cartesian position
321 hinfo
.homing_position
= THEKERNEL
->config
->value(endstop_checksum
, cs
, position_checksum
)->by_default(hinfo
.home_direction
? 0 : 200)->as_number();
323 // used to set maximum movement on homing, set by max_travel if defined
324 hinfo
.max_travel
= THEKERNEL
->config
->value(endstop_checksum
, cs
, max_travel_checksum
)->by_default(500)->as_number();
326 // stick into array in correct place
327 temp_axis_array
[hinfo
.axis_index
]= hinfo
;
330 // if no pins defined then disable the module
331 if(endstops
.empty()) return false;
333 // copy to the homing_axis array
334 for (size_t i
= 0; i
< temp_axis_array
.size(); ++i
) {
335 if(temp_axis_array
[i
].axis
== 0) {
336 // was not configured above, if it is XYZ then we need to force a dummy entry
341 t
.pin_info
= nullptr; // this tells it that it cannot be used for homing
342 homing_axis
.push_back(t
);
346 homing_axis
.push_back(temp_axis_array
[i
]);
350 // sets some endstop global configs applicable to all endstops
351 get_global_configs();
354 register_for_event(ON_IDLE
);
360 void Endstops::get_global_configs()
362 // NOTE the debounce count is in milliseconds so probably does not need to beset anymore
363 this->debounce_ms
= THEKERNEL
->config
->value(endstop_debounce_ms_checksum
)->by_default(0)->as_number();
364 this->debounce_count
= THEKERNEL
->config
->value(endstop_debounce_count_checksum
)->by_default(100)->as_number();
366 this->is_corexy
= THEKERNEL
->config
->value(corexy_homing_checksum
)->by_default(false)->as_bool();
367 this->is_delta
= THEKERNEL
->config
->value(delta_homing_checksum
)->by_default(false)->as_bool();
368 this->is_rdelta
= THEKERNEL
->config
->value(rdelta_homing_checksum
)->by_default(false)->as_bool();
369 this->is_scara
= THEKERNEL
->config
->value(scara_homing_checksum
)->by_default(false)->as_bool();
371 this->home_z_first
= THEKERNEL
->config
->value(home_z_first_checksum
)->by_default(false)->as_bool();
373 this->trim_mm
[0] = THEKERNEL
->config
->value(alpha_trim_checksum
)->by_default(0)->as_number();
374 this->trim_mm
[1] = THEKERNEL
->config
->value(beta_trim_checksum
)->by_default(0)->as_number();
375 this->trim_mm
[2] = THEKERNEL
->config
->value(gamma_trim_checksum
)->by_default(0)->as_number();
377 // see if an order has been specified, must be three characters, XYZ or YXZ etc
378 string order
= THEKERNEL
->config
->value(homing_order_checksum
)->by_default("")->as_string();
379 this->homing_order
= 0;
380 if(order
.size() == 3 && !(this->is_delta
|| this->is_rdelta
)) {
382 for(auto c
: order
) {
383 uint8_t i
= toupper(c
) - 'X';
384 if(i
> 2) { // bad value
385 this->homing_order
= 0;
388 homing_order
|= (i
<< shift
);
393 // set to true by default for deltas due to trim, false on cartesians
394 this->move_to_origin_after_home
= THEKERNEL
->config
->value(move_to_origin_checksum
)->by_default(is_delta
)->as_bool();
397 bool Endstops::debounced_get(Pin
*pin
)
399 if(pin
== nullptr) return false;
400 uint8_t debounce
= 0;
402 if ( ++debounce
>= this->debounce_count
) {
410 // only called if limits are enabled
411 void Endstops::on_idle(void *argument
)
413 if(this->status
== LIMIT_TRIGGERED
) {
414 // if we were in limit triggered see if it has been cleared
415 for(auto& i
: endstops
) {
416 if(i
->limit_enable
) {
418 // still triggered, so exit
423 if(i
->debounce
++ > debounce_count
) { // can use less as it calls on_idle in between
425 this->status
= NOT_HOMING
;
431 } else if(this->status
!= NOT_HOMING
) {
432 // don't check while homing
436 for(auto& i
: endstops
) {
437 if(i
->limit_enable
&& STEPPER
[i
->axis_index
]->is_moving()) {
438 // check min and max endstops
439 if(debounced_get(&i
->pin
)) {
441 THEKERNEL
->streams
->printf("Limit switch %c was hit - reset or M999 required\n", i
->axis
);
442 this->status
= LIMIT_TRIGGERED
;
444 // disables heaters and motors, ignores incoming Gcode and flushes block queue
445 THEKERNEL
->call_event(ON_HALT
, nullptr);
452 // if limit switches are enabled, then we must move off of the endstop otherwise we won't be able to move
453 // checks if triggered and only backs off if triggered
454 void Endstops::back_off_home(axis_bitmap_t axis
)
456 std::vector
<std::pair
<char, float>> params
;
457 this->status
= BACK_OFF_HOME
;
459 float slow_rate
= NAN
; // default mm/sec
461 // these are handled differently
463 // Move off of the endstop using a regular relative move in Z only
464 params
.push_back({'Z', homing_axis
[Z_AXIS
].retract
* (homing_axis
[Z_AXIS
].home_direction
? 1 : -1)});
465 slow_rate
= homing_axis
[Z_AXIS
].slow_rate
;
468 // cartesians, concatenate all the moves we need to do into one gcode
469 for( auto& e
: homing_axis
) {
470 if(!axis
[e
.axis_index
]) continue; // only for axes we asked to move
472 // if not triggered no need to move off
473 if(e
.pin_info
!= nullptr && e
.pin_info
->limit_enable
&& debounced_get(&e
.pin_info
->pin
)) {
475 params
.push_back({ax
, e
.retract
* (e
.home_direction
? 1 : -1)});
476 // select slowest of them all
477 slow_rate
= isnan(slow_rate
) ? e
.slow_rate
: std::min(slow_rate
, e
.slow_rate
);
482 if(!params
.empty()) {
483 // Move off of the endstop using a regular relative move
484 params
.insert(params
.begin(), {'G', 0});
485 // use X slow rate to move, Z should have a max speed set anyway
486 params
.push_back({'F', slow_rate
* 60.0F
});
488 append_parameters(gcode_buf
, params
, sizeof(gcode_buf
));
489 Gcode
gc(gcode_buf
, &(StreamOutput::NullStream
));
490 THEROBOT
->push_state();
491 THEROBOT
->inch_mode
= false; // needs to be in mm
492 THEROBOT
->absolute_mode
= false; // needs to be relative mode
493 THEROBOT
->on_gcode_received(&gc
); // send to robot directly
494 // Wait for above to finish
495 THECONVEYOR
->wait_for_idle();
496 THEROBOT
->pop_state();
499 this->status
= NOT_HOMING
;
502 // If enabled will move the head to 0,0 after homing, but only if X and Y were set to home
503 void Endstops::move_to_origin(axis_bitmap_t axis
)
505 if(!is_delta
&& (!axis
[X_AXIS
] || !axis
[Y_AXIS
])) return; // ignore if X and Y not homing, unless delta
507 // Do we need to check if we are already at 0,0? probably not as the G0 will not do anything if we are
508 // float pos[3]; THEROBOT->get_axis_position(pos); if(pos[0] == 0 && pos[1] == 0) return;
510 this->status
= MOVE_TO_ORIGIN
;
511 // Move to center using a regular move, use slower of X and Y fast rate
512 //float rate = std::min(this->fast_rates[0], this->fast_rates[1]) * 60.0F;
514 THEROBOT
->push_state();
515 THEROBOT
->inch_mode
= false; // needs to be in mm
516 THEROBOT
->absolute_mode
= true;
517 //snprintf(buf, sizeof(buf), "G53 G0 X0 Y0 F%1.4f", rate); // must use machine coordinates in case G92 or WCS is in effect
518 snprintf(buf
, sizeof(buf
), "G53 G0 X0 Y0"); // must use machine coordinates in case G92 or WCS is in effect
519 struct SerialMessage message
;
520 message
.message
= buf
;
521 message
.stream
= &(StreamOutput::NullStream
);
522 THEKERNEL
->call_event(ON_CONSOLE_LINE_RECEIVED
, &message
); // as it is a multi G code command
523 // Wait for above to finish
524 THECONVEYOR
->wait_for_idle();
525 THEROBOT
->pop_state();
526 this->status
= NOT_HOMING
;
529 // Called every millisecond in an ISR
530 uint32_t Endstops::read_endstops(uint32_t dummy
)
532 if(this->status
!= MOVING_TO_ENDSTOP_SLOW
&& this->status
!= MOVING_TO_ENDSTOP_FAST
) return 0; // not doing anything we need to monitor for
534 // check each homing endstop
535 for(auto& e
: homing_axis
) { // check all axis homing endstops
536 if(e
.pin_info
== nullptr) continue; // ignore if not a homing endstop
539 // for corexy homing in X or Y we must only check the associated endstop, works as we only home one axis at a time for corexy
540 if(is_corexy
&& (m
== X_AXIS
|| m
== Y_AXIS
) && !axis_to_home
[m
]) continue;
542 if(STEPPER
[m
]->is_moving()) {
543 // if it is moving then we check the associated endstop, and debounce it
544 if(e
.pin_info
->pin
.get()) {
545 if(e
.pin_info
->debounce
< debounce_ms
) {
546 e
.pin_info
->debounce
++;
549 if(is_corexy
&& (m
== X_AXIS
|| m
== Y_AXIS
)) {
550 // corexy when moving in X or Y we need to stop both the X and Y motors
551 STEPPER
[X_AXIS
]->stop_moving();
552 STEPPER
[Y_AXIS
]->stop_moving();
555 // we signal the motor to stop, which will preempt any moves on that axis
556 STEPPER
[m
]->stop_moving();
561 // The endstop was not hit yet
562 e
.pin_info
->debounce
= 0;
570 void Endstops::home_xy()
572 if(axis_to_home
[X_AXIS
] && axis_to_home
[Y_AXIS
]) {
573 // Home XY first so as not to slow them down by homing Z at the same time
574 float delta
[3] {homing_axis
[X_AXIS
].max_travel
, homing_axis
[Y_AXIS
].max_travel
, 0};
575 if(homing_axis
[X_AXIS
].home_direction
) delta
[X_AXIS
]= -delta
[X_AXIS
];
576 if(homing_axis
[Y_AXIS
].home_direction
) delta
[Y_AXIS
]= -delta
[Y_AXIS
];
577 float feed_rate
= std::min(homing_axis
[X_AXIS
].fast_rate
, homing_axis
[Y_AXIS
].fast_rate
);
578 THEROBOT
->delta_move(delta
, feed_rate
, 3);
580 } else if(axis_to_home
[X_AXIS
]) {
582 float delta
[3] {homing_axis
[X_AXIS
].max_travel
, 0, 0};
583 if(homing_axis
[X_AXIS
].home_direction
) delta
[X_AXIS
]= -delta
[X_AXIS
];
584 THEROBOT
->delta_move(delta
, homing_axis
[X_AXIS
].fast_rate
, 3);
586 } else if(axis_to_home
[Y_AXIS
]) {
588 float delta
[3] {0, homing_axis
[Y_AXIS
].max_travel
, 0};
589 if(homing_axis
[Y_AXIS
].home_direction
) delta
[Y_AXIS
]= -delta
[Y_AXIS
];
590 THEROBOT
->delta_move(delta
, homing_axis
[Y_AXIS
].fast_rate
, 3);
593 // Wait for axis to have homed
594 THECONVEYOR
->wait_for_idle();
597 void Endstops::home(axis_bitmap_t a
)
599 // reset debounce counts for all endstops
600 for(auto& e
: endstops
) {
604 this->axis_to_home
= a
;
606 // Start moving the axes to the origin
607 this->status
= MOVING_TO_ENDSTOP_FAST
;
609 THEROBOT
->disable_segmentation
= true; // we must disable segmentation as this won't work with it enabled
611 if(!home_z_first
) home_xy();
613 if(axis_to_home
[Z_AXIS
]) {
615 float delta
[3] {0, 0, homing_axis
[Z_AXIS
].max_travel
}; // we go the max z
616 if(homing_axis
[Z_AXIS
].home_direction
) delta
[Z_AXIS
]= -delta
[Z_AXIS
];
617 THEROBOT
->delta_move(delta
, homing_axis
[Z_AXIS
].fast_rate
, 3);
619 THECONVEYOR
->wait_for_idle();
622 if(home_z_first
) home_xy();
624 // potentially home A B and C individually
625 if(homing_axis
.size() > 3){
626 for (size_t i
= A_AXIS
; i
< homing_axis
.size(); ++i
) {
627 if(axis_to_home
[i
]) {
630 for (size_t j
= 0; j
<= i
; ++j
) delta
[j
]= 0;
631 delta
[i
]= homing_axis
[i
].max_travel
; // we go the max
632 if(homing_axis
[i
].home_direction
) delta
[i
]= -delta
[i
];
633 THEROBOT
->delta_move(delta
, homing_axis
[i
].fast_rate
, i
+1);
635 THECONVEYOR
->wait_for_idle();
641 // TODO: should check that the endstops were hit and it did not stop short for some reason
642 // we did not complete movement the full distance if we hit the endstops
643 THEROBOT
->reset_position_from_current_actuator_position();
645 // Move back a small distance for all homing axis
646 this->status
= MOVING_BACK
;
647 float delta
[homing_axis
.size()];
648 for (size_t i
= 0; i
< homing_axis
.size(); ++i
) delta
[i
]= 0;
650 // use minimum feed rate of all axes that are being homed (sub optimal, but necessary)
651 float feed_rate
= homing_axis
[X_AXIS
].slow_rate
;
652 for (auto& i
: homing_axis
) {
654 if(axis_to_home
[c
]) {
656 if(!i
.home_direction
) delta
[c
]= -delta
[c
];
657 feed_rate
= std::min(i
.slow_rate
, feed_rate
);
661 THEROBOT
->delta_move(delta
, feed_rate
, homing_axis
.size());
662 // wait until finished
663 THECONVEYOR
->wait_for_idle();
665 // Start moving the axes towards the endstops slowly
666 this->status
= MOVING_TO_ENDSTOP_SLOW
;
667 for (auto& i
: homing_axis
) {
669 if(axis_to_home
[c
]) {
670 delta
[c
]= i
.retract
*2; // move further than we moved off to make sure we hit it cleanly
671 if(i
.home_direction
) delta
[c
]= -delta
[c
];
676 THEROBOT
->delta_move(delta
, feed_rate
, homing_axis
.size());
677 // wait until finished
678 THECONVEYOR
->wait_for_idle();
680 // TODO: should check that the endstops were hit and it did not stop short for some reason
681 // we did not complete movement the full distance if we hit the endstops
682 THEROBOT
->reset_position_from_current_actuator_position();
684 THEROBOT
->disable_segmentation
= false;
686 this->status
= NOT_HOMING
;
689 void Endstops::process_home_command(Gcode
* gcode
)
691 // First wait for the queue to be empty
692 THECONVEYOR
->wait_for_idle();
694 // turn off any compensation transform so Z does not move as XY home
695 auto savect
= THEROBOT
->compensationTransform
;
696 THEROBOT
->compensationTransform
= nullptr;
698 // deltas always home Z axis only, which moves all three actuators
699 bool home_in_z
= this->is_delta
|| this->is_rdelta
;
701 // figure out which axis to home
705 if(!home_in_z
) { // ie not a delta
706 bool axis_speced
= (gcode
->has_letter('X') || gcode
->has_letter('Y') || gcode
->has_letter('Z') ||
707 gcode
->has_letter('A') || gcode
->has_letter('B') || gcode
->has_letter('C'));
709 for (auto &p
: homing_axis
) {
710 // only enable homing if the endstop is defined,
711 if(p
.pin_info
== nullptr) continue;
712 if(!axis_speced
|| gcode
->has_letter(p
.axis
)) {
713 haxis
.set(p
.axis_index
);
714 // now reset axis to 0 as we do not know what state we are in
715 THEROBOT
->reset_axis_position(0, p
.axis_index
);
720 // Only Z axis homes (even though all actuators move this is handled by arm solution)
722 // we also set the kinematics to a known good position, this is necessary for a rotary delta, but doesn't hurt for linear delta
723 THEROBOT
->reset_axis_position(0, 0, 0);
726 // do the actual homing
727 if(homing_order
!= 0) {
728 // if an order has been specified do it in the specified order
729 // homing order is 0b00ccbbaa where aa is 0,1,2 to specify the first axis, bb is the second and cc is the third
730 // eg 0b00100001 would be Y X Z, 0b00100100 would be X Y Z
731 for (uint8_t m
= homing_order
; m
!= 0; m
>>= 2) {
732 int a
= (m
& 0x03); // axis to home
733 if(haxis
[a
]) { // if axis is selected to home
738 // check if on_halt (eg kill)
739 if(THEKERNEL
->is_halted()) break;
742 } else if(is_corexy
) {
743 // corexy must home each axis individually
744 for (auto &p
: homing_axis
) {
745 if(haxis
[p
.axis_index
]) {
747 bs
.set(p
.axis_index
);
750 // check if on_halt (eg kill)
751 if(THEKERNEL
->is_halted()) break;
755 // they could all home at the same time
759 // restore compensationTransform
760 THEROBOT
->compensationTransform
= savect
;
762 // check if on_halt (eg kill)
763 if(THEKERNEL
->is_halted()) {
764 if(!THEKERNEL
->is_grbl_mode()) {
765 THEKERNEL
->streams
->printf("Homing cycle aborted by kill\n");
767 // clear all the homed flags
768 for (auto &p
: homing_axis
) p
.homed
= false;
772 if(home_in_z
) { // deltas only
773 // Here's where we would have been if the endstops were perfectly trimmed
774 // NOTE on a rotary delta home_offset is actuator position in degrees when homed and
775 // home_offset is the theta offset for each actuator, so M206 is used to set theta offset for each actuator in degrees
776 // FIXME not sure this will work with compensation transforms on.
777 float ideal_position
[3] = {
778 homing_axis
[X_AXIS
].homing_position
+ homing_axis
[X_AXIS
].home_offset
,
779 homing_axis
[Y_AXIS
].homing_position
+ homing_axis
[Y_AXIS
].home_offset
,
780 homing_axis
[Z_AXIS
].homing_position
+ homing_axis
[Z_AXIS
].home_offset
783 bool has_endstop_trim
= this->is_delta
;
784 if (has_endstop_trim
) {
785 ActuatorCoordinates ideal_actuator_position
;
786 THEROBOT
->arm_solution
->cartesian_to_actuator(ideal_position
, ideal_actuator_position
);
788 // We are actually not at the ideal position, but a trim away
789 ActuatorCoordinates real_actuator_position
= {
790 ideal_actuator_position
[X_AXIS
] - this->trim_mm
[X_AXIS
],
791 ideal_actuator_position
[Y_AXIS
] - this->trim_mm
[Y_AXIS
],
792 ideal_actuator_position
[Z_AXIS
] - this->trim_mm
[Z_AXIS
]
795 float real_position
[3];
796 THEROBOT
->arm_solution
->actuator_to_cartesian(real_actuator_position
, real_position
);
797 // Reset the actuator positions to correspond our real position
798 THEROBOT
->reset_axis_position(real_position
[0], real_position
[1], real_position
[2]);
801 // without endstop trim, real_position == ideal_position
803 // with a rotary delta we set the actuators angle then use the FK to calculate the resulting cartesian coordinates
804 ActuatorCoordinates real_actuator_position
= {ideal_position
[0], ideal_position
[1], ideal_position
[2]};
805 THEROBOT
->reset_actuator_position(real_actuator_position
);
808 // Reset the actuator positions to correspond our real position
809 THEROBOT
->reset_axis_position(ideal_position
[0], ideal_position
[1], ideal_position
[2]);
813 // for deltas we say all axis are homed even though it was only Z
814 for (auto &p
: homing_axis
) p
.homed
= true;
817 // Zero the ax(i/e)s position, add in the home offset
818 // NOTE that if compensation is active the Z will be set based on where XY are, so make sure XY are homed first then Z
819 // so XY are at a known consistent position. (especially true if using a proximity probe)
820 for (auto &p
: homing_axis
) {
821 if (haxis
[p
.axis_index
]) { // if we requested this axis to home
822 THEROBOT
->reset_axis_position(p
.homing_position
+ p
.home_offset
, p
.axis_index
);
823 // set flag indicating axis was homed, it stays set once set until H/W reset or unhomed
829 // on some systems where 0,0 is bed center it is nice to have home goto 0,0 after homing
830 // default is off for cartesian on for deltas
832 // NOTE a rotary delta usually has optical or hall-effect endstops so it is safe to go past them a little bit
833 if(this->move_to_origin_after_home
) move_to_origin(haxis
);
834 // if limit switches are enabled we must back off endstop after setting home
835 back_off_home(haxis
);
837 } else if(this->move_to_origin_after_home
|| homing_axis
[X_AXIS
].pin_info
->limit_enable
) {
838 // deltas are not left at 0,0 because of the trim settings, so move to 0,0 if requested, but we need to back off endstops first
839 // also need to back off endstops if limits are enabled
840 back_off_home(haxis
);
841 if(this->move_to_origin_after_home
) move_to_origin(haxis
);
845 void Endstops::set_homing_offset(Gcode
*gcode
)
847 // M306 Similar to M206 but sets Homing offsets based on current MCS position
848 // Basically it finds the delta between the current MCS position and the requested position and adds it to the homing offset
849 // then will not let it be set again until that axis is homed.
851 THEROBOT
->get_axis_position(pos
);
853 if (gcode
->has_letter('X')) {
854 if(!homing_axis
[X_AXIS
].homed
) {
855 gcode
->stream
->printf("error: Axis X must be homed before setting Homing offset\n");
858 homing_axis
[X_AXIS
].home_offset
+= (THEROBOT
->to_millimeters(gcode
->get_value('X')) - pos
[X_AXIS
]);
859 homing_axis
[X_AXIS
].homed
= false; // force it to be homed
861 if (gcode
->has_letter('Y')) {
862 if(!homing_axis
[Y_AXIS
].homed
) {
863 gcode
->stream
->printf("error: Axis Y must be homed before setting Homing offset\n");
866 homing_axis
[Y_AXIS
].home_offset
+= (THEROBOT
->to_millimeters(gcode
->get_value('Y')) - pos
[Y_AXIS
]);
867 homing_axis
[Y_AXIS
].homed
= false; // force it to be homed
869 if (gcode
->has_letter('Z')) {
870 if(!homing_axis
[Z_AXIS
].homed
) {
871 gcode
->stream
->printf("error: Axis Z must be homed before setting Homing offset\n");
874 homing_axis
[Z_AXIS
].home_offset
+= (THEROBOT
->to_millimeters(gcode
->get_value('Z')) - pos
[Z_AXIS
]);
875 homing_axis
[Z_AXIS
].homed
= false; // force it to be homed
878 gcode
->stream
->printf("Homing Offset: X %5.3f Y %5.3f Z %5.3f will take effect next home\n", homing_axis
[X_AXIS
].home_offset
, homing_axis
[Y_AXIS
].home_offset
, homing_axis
[Z_AXIS
].home_offset
);
881 void Endstops::handle_park(Gcode
* gcode
)
883 // TODO: spec says if XYZ specified move to them first then move to MCS of specifed axis
884 THEROBOT
->push_state();
885 THEROBOT
->inch_mode
= false; // needs to be in mm
886 THEROBOT
->absolute_mode
= true;
888 snprintf(buf
, sizeof(buf
), "G53 G0 X%f Y%f", saved_position
[X_AXIS
], saved_position
[Y_AXIS
]); // must use machine coordinates in case G92 or WCS is in effect
889 struct SerialMessage message
;
890 message
.message
= buf
;
891 message
.stream
= &(StreamOutput::NullStream
);
892 THEKERNEL
->call_event(ON_CONSOLE_LINE_RECEIVED
, &message
); // as it is a multi G code command
893 // Wait for above to finish
894 THECONVEYOR
->wait_for_idle();
895 THEROBOT
->pop_state();
899 void Endstops::on_gcode_received(void *argument
)
901 Gcode
*gcode
= static_cast<Gcode
*>(argument
);
903 if ( gcode
->has_g
&& gcode
->g
== 28) {
904 switch(gcode
->subcode
) {
905 case 0: // G28 in grbl mode will do a rapid to the predefined position otherwise it is home command
906 if(THEKERNEL
->is_grbl_mode()){
909 process_home_command(gcode
);
913 case 1: // G28.1 set pre defined park position
914 // saves current position in absolute machine coordinates
915 THEROBOT
->get_axis_position(saved_position
); // Only XY are used
916 // Note the following is only meant to be used for recovering a saved position from config-override
917 // Not a standard Gcode and not to be relied on
918 if (gcode
->has_letter('X')) saved_position
[X_AXIS
] = gcode
->get_value('X');
919 if (gcode
->has_letter('Y')) saved_position
[Y_AXIS
] = gcode
->get_value('Y');
922 case 2: // G28.2 in grbl mode does homing (triggered by $H), otherwise it moves to the park position
923 if(THEKERNEL
->is_grbl_mode()) {
924 process_home_command(gcode
);
930 case 3: // G28.3 is a smoothie special it sets manual homing
931 if(gcode
->get_num_args() == 0) {
932 for (auto &p
: homing_axis
) {
934 THEROBOT
->reset_axis_position(0, p
.axis_index
);
937 // do a manual homing based on given coordinates, no endstops required
938 if(gcode
->has_letter('X')){ THEROBOT
->reset_axis_position(gcode
->get_value('X'), X_AXIS
); homing_axis
[X_AXIS
].homed
= true; }
939 if(gcode
->has_letter('Y')){ THEROBOT
->reset_axis_position(gcode
->get_value('Y'), Y_AXIS
); homing_axis
[Y_AXIS
].homed
= true; }
940 if(gcode
->has_letter('Z')){ THEROBOT
->reset_axis_position(gcode
->get_value('Z'), Z_AXIS
); homing_axis
[Z_AXIS
].homed
= true; }
941 if(homing_axis
.size() > A_AXIS
&& gcode
->has_letter('A')){ THEROBOT
->reset_axis_position(gcode
->get_value('A'), A_AXIS
); homing_axis
[A_AXIS
].homed
= true; }
942 if(homing_axis
.size() > B_AXIS
&& gcode
->has_letter('B')){ THEROBOT
->reset_axis_position(gcode
->get_value('B'), B_AXIS
); homing_axis
[B_AXIS
].homed
= true; }
943 if(homing_axis
.size() > C_AXIS
&& gcode
->has_letter('C')){ THEROBOT
->reset_axis_position(gcode
->get_value('C'), C_AXIS
); homing_axis
[C_AXIS
].homed
= true; }
947 case 4: { // G28.4 is a smoothie special it sets manual homing based on the actuator position (used for rotary delta)
948 // do a manual homing based on given coordinates, no endstops required
949 ActuatorCoordinates ac
{NAN
, NAN
, NAN
};
950 if(gcode
->has_letter('X')){ ac
[0] = gcode
->get_value('X'); homing_axis
[X_AXIS
].homed
= true; }
951 if(gcode
->has_letter('Y')){ ac
[1] = gcode
->get_value('Y'); homing_axis
[Y_AXIS
].homed
= true; }
952 if(gcode
->has_letter('Z')){ ac
[2] = gcode
->get_value('Z'); homing_axis
[Z_AXIS
].homed
= true; }
953 THEROBOT
->reset_actuator_position(ac
);
957 case 5: // G28.5 is a smoothie special it clears the homed flag for the specified axis, or all if not specifed
958 if(gcode
->get_num_args() == 0) {
959 for (auto &p
: homing_axis
) p
.homed
= false;
961 if(gcode
->has_letter('X')) homing_axis
[X_AXIS
].homed
= false;
962 if(gcode
->has_letter('Y')) homing_axis
[Y_AXIS
].homed
= false;
963 if(gcode
->has_letter('Z')) homing_axis
[Z_AXIS
].homed
= false;
964 if(homing_axis
.size() > A_AXIS
&& gcode
->has_letter('A')) homing_axis
[A_AXIS
].homed
= false;
965 if(homing_axis
.size() > B_AXIS
&& gcode
->has_letter('B')) homing_axis
[B_AXIS
].homed
= false;
966 if(homing_axis
.size() > C_AXIS
&& gcode
->has_letter('C')) homing_axis
[C_AXIS
].homed
= false;
970 case 6: // G28.6 is a smoothie special it shows the homing status of each axis
971 for (auto &p
: homing_axis
) {
972 gcode
->stream
->printf("%c:%d ", p
.axis
, p
.homed
);
978 if(THEKERNEL
->is_grbl_mode()) {
979 gcode
->stream
->printf("error:Unsupported command\n");
984 } else if (gcode
->has_m
) {
988 for(auto& h
: homing_axis
) {
990 name
.append(1, h
.axis
).append(h
.home_direction
? "_min" : "_max");
991 gcode
->stream
->printf("%s:%d ", name
.c_str(), h
.pin_info
->pin
.get());
993 gcode
->stream
->printf("pins- ");
994 for(auto& p
: endstops
) {
995 string
str(1, p
->axis
);
996 if(p
->limit_enable
) str
.append("L");
997 gcode
->stream
->printf("(%s)P%d.%d:%d ", str
.c_str(), p
->pin
.port_number
, p
->pin
.pin
, p
->pin
.get());
999 gcode
->add_nl
= true;
1003 case 206: // M206 - set homing offset
1004 if(is_rdelta
) return; // RotaryDeltaCalibration module will handle this
1005 for (auto &p
: homing_axis
) {
1006 if (gcode
->has_letter(p
.axis
)) p
.home_offset
= gcode
->get_value(p
.axis
);
1009 for (auto &p
: homing_axis
) {
1010 gcode
->stream
->printf("%c: %5.3f ", p
.axis
, p
.home_offset
);
1013 gcode
->stream
->printf(" will take effect next home\n");
1016 case 306: // set homing offset based on current position
1017 if(is_rdelta
) return; // RotaryDeltaCalibration module will handle this
1019 set_homing_offset(gcode
);
1022 case 500: // save settings
1023 case 503: // print settings
1025 gcode
->stream
->printf(";Home offset (mm):\nM206 ");
1026 for (auto &p
: homing_axis
) {
1027 gcode
->stream
->printf("%c%1.2f ", p
.axis
, p
.home_offset
);
1029 gcode
->stream
->printf("\n");
1032 gcode
->stream
->printf(";Theta offset (degrees):\nM206 A%1.5f B%1.5f C%1.5f\n",
1033 homing_axis
[X_AXIS
].home_offset
, homing_axis
[Y_AXIS
].home_offset
, homing_axis
[Z_AXIS
].home_offset
);
1036 if (this->is_delta
|| this->is_scara
) {
1037 gcode
->stream
->printf(";Trim (mm):\nM666 X%1.3f Y%1.3f Z%1.3f\n", trim_mm
[0], trim_mm
[1], trim_mm
[2]);
1038 gcode
->stream
->printf(";Max Z\nM665 Z%1.3f\n", homing_axis
[Z_AXIS
].homing_position
);
1040 if(saved_position
[X_AXIS
] != 0 || saved_position
[Y_AXIS
] != 0) {
1041 gcode
->stream
->printf(";predefined position:\nG28.1 X%1.4f Y%1.4f\n", saved_position
[X_AXIS
], saved_position
[Y_AXIS
]);
1046 if (this->is_delta
|| this->is_scara
) { // M665 - set max gamma/z height
1047 float gamma_max
= homing_axis
[Z_AXIS
].homing_position
;
1048 if (gcode
->has_letter('Z')) {
1049 homing_axis
[Z_AXIS
].homing_position
= gamma_max
= gcode
->get_value('Z');
1051 gcode
->stream
->printf("Max Z %8.3f ", gamma_max
);
1052 gcode
->add_nl
= true;
1057 if(this->is_delta
|| this->is_scara
) { // M666 - set trim for each axis in mm, NB negative mm trim is down
1058 if (gcode
->has_letter('X')) trim_mm
[0] = gcode
->get_value('X');
1059 if (gcode
->has_letter('Y')) trim_mm
[1] = gcode
->get_value('Y');
1060 if (gcode
->has_letter('Z')) trim_mm
[2] = gcode
->get_value('Z');
1062 // print the current trim values in mm
1063 gcode
->stream
->printf("X: %5.3f Y: %5.3f Z: %5.3f\n", trim_mm
[0], trim_mm
[1], trim_mm
[2]);
1072 void Endstops::on_get_public_data(void* argument
)
1074 PublicDataRequest
* pdr
= static_cast<PublicDataRequest
*>(argument
);
1076 if(!pdr
->starts_with(endstops_checksum
)) return;
1078 if(pdr
->second_element_is(trim_checksum
)) {
1079 pdr
->set_data_ptr(&this->trim_mm
);
1082 } else if(pdr
->second_element_is(home_offset_checksum
)) {
1083 // provided by caller
1084 float *data
= static_cast<float *>(pdr
->get_data_ptr());
1085 for (int i
= 0; i
< 3; ++i
) {
1086 data
[i
]= homing_axis
[i
].home_offset
;
1090 } else if(pdr
->second_element_is(saved_position_checksum
)) {
1091 pdr
->set_data_ptr(&this->saved_position
);
1094 } else if(pdr
->second_element_is(get_homing_status_checksum
)) {
1095 bool *homing
= static_cast<bool *>(pdr
->get_data_ptr());
1096 *homing
= this->status
!= NOT_HOMING
;
1101 void Endstops::on_set_public_data(void* argument
)
1103 PublicDataRequest
* pdr
= static_cast<PublicDataRequest
*>(argument
);
1105 if(!pdr
->starts_with(endstops_checksum
)) return;
1107 if(pdr
->second_element_is(trim_checksum
)) {
1108 float *t
= static_cast<float*>(pdr
->get_data_ptr());
1109 this->trim_mm
[0] = t
[0];
1110 this->trim_mm
[1] = t
[1];
1111 this->trim_mm
[2] = t
[2];
1114 } else if(pdr
->second_element_is(home_offset_checksum
)) {
1115 float *t
= static_cast<float*>(pdr
->get_data_ptr());
1116 if(!isnan(t
[0])) homing_axis
[0].home_offset
= t
[0];
1117 if(!isnan(t
[1])) homing_axis
[1].home_offset
= t
[1];
1118 if(!isnan(t
[2])) homing_axis
[2].home_offset
= t
[2];