2016-04-27 09:15:20 -05:00
/**
* Marlin 3 D Printer Firmware
* Copyright ( C ) 2016 MarlinFirmware [ https : //github.com/MarlinFirmware/Marlin]
*
* Based on Sprinter and grbl .
* Copyright ( C ) 2011 Camiel Gubbels / Erik van der Zalm
*
* This program 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 .
*
* This program is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
* GNU General Public License for more details .
*
* You should have received a copy of the GNU General Public License
* along with this program . If not , see < http : //www.gnu.org/licenses/>.
*
*/
/**
* endstops . h - manages endstops
*/
# ifndef ENDSTOPS_H
# define ENDSTOPS_H
enum EndstopEnum { X_MIN = 0 , Y_MIN = 1 , Z_MIN = 2 , Z_MIN_PROBE = 3 , X_MAX = 4 , Y_MAX = 5 , Z_MAX = 6 , Z2_MIN = 7 , Z2_MAX = 8 } ;
class Endstops {
public :
2016-05-26 13:01:20 -05:00
static bool enabled , enabled_globally ;
static volatile char endstop_hit_bits ; // use X_MIN, Y_MIN, Z_MIN and Z_MIN_PROBE as BIT value
2016-04-27 09:15:20 -05:00
# if ENABLED(Z_DUAL_ENDSTOPS)
2016-05-26 13:01:20 -05:00
static uint16_t
2016-04-27 09:15:20 -05:00
# else
2016-05-26 13:01:20 -05:00
static byte
2016-04-27 09:15:20 -05:00
# endif
2016-05-26 13:01:20 -05:00
current_endstop_bits , old_endstop_bits ;
2016-04-27 09:15:20 -05:00
2016-07-17 15:34:30 -05:00
Endstops ( ) { } ;
2016-04-27 09:15:20 -05:00
/**
* Initialize the endstop pins
*/
void init ( ) ;
/**
* Update the endstops bits from the pins
*/
2016-05-26 13:01:20 -05:00
static void update ( ) ;
2016-04-27 09:15:20 -05:00
/**
* Print an error message reporting the position when the endstops were last hit .
*/
2016-05-26 13:01:20 -05:00
static void report_state ( ) ; //call from somewhere to create an serial error message with the locations the endstops where hit, in case they were triggered
2016-04-27 09:15:20 -05:00
2016-04-27 16:46:24 -05:00
/**
* Report endstop positions in response to M119
*/
2016-05-26 13:01:20 -05:00
static void M119 ( ) ;
2016-04-27 16:46:24 -05:00
2016-04-27 09:15:20 -05:00
// Enable / disable endstop checking globally
2016-05-30 19:08:46 -05:00
static void enable_globally ( bool onoff = true ) { enabled_globally = enabled = onoff ; }
2016-04-27 09:15:20 -05:00
// Enable / disable endstop checking
2016-05-30 19:08:46 -05:00
static void enable ( bool onoff = true ) { enabled = onoff ; }
2016-04-27 09:15:20 -05:00
// Disable / Enable endstops based on ENSTOPS_ONLY_FOR_HOMING and global enable
2016-05-30 19:08:46 -05:00
static void not_homing ( ) { enabled = enabled_globally ; }
2016-04-27 09:15:20 -05:00
// Clear endstops (i.e., they were hit intentionally) to suppress the report
2016-05-30 19:08:46 -05:00
static void hit_on_purpose ( ) { endstop_hit_bits = 0 ; }
2016-04-27 09:15:20 -05:00
// Enable / disable endstop z-probe checking
2016-05-03 22:15:18 -05:00
# if HAS_BED_PROBE
2016-05-26 13:01:20 -05:00
static volatile bool z_probe_enabled ;
2016-05-30 19:08:46 -05:00
static void enable_z_probe ( bool onoff = true ) { z_probe_enabled = onoff ; }
2016-04-27 09:15:20 -05:00
# endif
2016-04-28 04:15:53 -05:00
private :
# if ENABLED(Z_DUAL_ENDSTOPS)
2016-05-26 13:01:20 -05:00
static void test_dual_z_endstops ( EndstopEnum es1 , EndstopEnum es2 ) ;
2016-04-28 04:15:53 -05:00
# endif
2016-04-27 09:15:20 -05:00
} ;
extern Endstops endstops ;
# endif // ENDSTOPS_H