limits.h

00001 /*
00002   limits.h - code pertaining to limit-switches and performing the homing cycle
00003   Part of Grbl
00004 
00005   Copyright (c) 2012-2016 Sungeun K. Jeon for Gnea Research LLC
00006   Copyright (c) 2009-2011 Simen Svale Skogsrud
00007 
00008   Grbl is free software: you can redistribute it and/or modify
00009   it under the terms of the GNU General Public License as published by
00010   the Free Software Foundation, either version 3 of the License, or
00011   (at your option) any later version.
00012 
00013   Grbl is distributed in the hope that it will be useful,
00014   but WITHOUT ANY WARRANTY; without even the implied warranty of
00015   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016   GNU General Public License for more details.
00017 
00018   You should have received a copy of the GNU General Public License
00019   along with Grbl.  If not, see <http://www.gnu.org/licenses/>.
00020 */
00021 
00022 #ifndef limits_h
00023 #define limits_h
00024 
00025 
00026 // Initialize the limits module
00027 void limits_init();
00028 
00029 // Disables hard limits.
00030 void limits_disable();
00031 
00032 // Returns limit state as a bit-wise uint8 variable.
00033 uint8_t limits_get_state();
00034 
00035 // Perform one portion of the homing cycle based on the input settings.
00036 void limits_go_home(uint8_t cycle_mask);
00037 
00038 // Check for soft limit violations
00039 void limits_soft_check(float *target);
00040 
00041 #endif