src/modules/tools/temperatureswitch/TemperatureSwitch.h

   1 /*
   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/>.
   6 */
   7
   8 /*
   9 TemperatureSwitch is an optional module that will automatically turn on or off a switch
  10 based on a setpoint temperature. It is commonly used to turn on/off a cooling fan or water pump
  11 to cool the hot end's cold zone. Specifically, it turns one of the small MOSFETs on or off.
  12
  13 Author: Michael Hackney, mhackney@eclecticangler.com
  14 */
  15
  16 #ifndef TEMPERATURESWITCH_MODULE_H
  17 #define TEMPERATURESWITCH_MODULE_H
  18
  19 using namespace std;
  20
  21 #include "libs/Module.h"
  22 #include <string>
  23 #include <vector>
  24
  25 class TemperatureSwitch : public Module
  26 {
  27     public:
  28         TemperatureSwitch();
  29         void on_module_loaded();
  30         void on_second_tick(void *argument);
  31         void on_gcode_received(void *argument);
  32
  33     private:
  34         bool load_config(uint16_t modcs);
  35
  36         // get the highest temperature from the set of configured temperature controllers
  37         float get_highest_temperature();
  38
  39         // turn the switch on or off
  40         void set_switch(bool cooler_state);
  41
  42         // the set of temperature controllers that match the required designator prefix
  43         vector<uint16_t> temp_controllers;
  44
  45         // temperatureswitch.hotend.threshold_temp
  46         float temperatureswitch_threshold_temp;
  47
  48         // temperatureswitch.hotend.switch
  49         uint16_t temperatureswitch_switch_cs;
  50
  51         // check temps on heatup every X seconds
  52         // this can be set in config: temperatureswitch.hotend.heatup_poll
  53         uint16_t temperatureswitch_heatup_poll;
  54
  55         // check temps on cooldown every X seconds
  56         // this can be set in config: temperatureswitch.hotend.cooldown_poll
  57         uint16_t temperatureswitch_cooldown_poll;
  58
  59         // our internal second counter
  60         uint16_t second_counter;
  61
  62         // we are delaying for this many seconds
  63         uint16_t current_delay;
  64
  65         // the mcode that will arm the switch, 0 means always armed
  66         uint16_t arm_mcode;
  67
  68         enum TRIGGER_TYPE {LEVEL, RISING, FALLING };
  69
  70         // is the switch currently on (1) or off (0)?
  71         struct {
  72             bool temperatureswitch_state:1;
  73             bool inverted:1;
  74             bool lower:1;
  75             bool armed:1;
  76             bool one_shot:1;
  77             TRIGGER_TYPE trigger:2;
  78         };
  79 };
  80
  81 #endif