coolant_control.h

00001 /*
00002   coolant_control.h - spindle control methods
00003   Part of Grbl
00004 
00005   Copyright (c) 2012-2016 Sungeun K. Jeon for Gnea Research LLC
00006 
00007   Grbl is free software: you can redistribute it and/or modify
00008   it under the terms of the GNU General Public License as published by
00009   the Free Software Foundation, either version 3 of the License, or
00010   (at your option) any later version.
00011 
00012   Grbl is distributed in the hope that it will be useful,
00013   but WITHOUT ANY WARRANTY; without even the implied warranty of
00014   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015   GNU General Public License for more details.
00016 
00017   You should have received a copy of the GNU General Public License
00018   along with Grbl.  If not, see <http://www.gnu.org/licenses/>.
00019 */
00020 
00021 #ifndef coolant_control_h
00022 #define coolant_control_h
00023 
00024 #define COOLANT_NO_SYNC     false
00025 #define COOLANT_FORCE_SYNC  true
00026 
00027 #define COOLANT_STATE_DISABLE   0  // Must be zero
00028 #define COOLANT_STATE_FLOOD     bit(0)
00029 #define COOLANT_STATE_MIST      bit(1)
00030 
00031 
00032 // Initializes coolant control pins.
00033 void coolant_init();
00034 
00035 // Returns current coolant output state. Overrides may alter it from programmed state.
00036 uint8_t coolant_get_state();
00037 
00038 // Immediately disables coolant pins.
00039 void coolant_stop();
00040 
00041 // Sets the coolant pins according to state specified.
00042 void coolant_set_state(uint8_t mode);
00043 
00044 // G-code parser entry-point for setting coolant states. Checks for and executes additional conditions.
00045 void coolant_sync(uint8_t mode);
00046 
00047 #endif