src/modules/tools/temperaturecontrol/TemperatureControl.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 #ifndef temperaturecontrol_h
   9 #define temperaturecontrol_h
  10
  11 #include "Module.h"
  12 #include "Pwm.h"
  13 #include "TempSensor.h"
  14 #include "TemperatureControlPublicAccess.h"
  15
  16 class TemperatureControl : public Module {
  17
  18     public:
  19         TemperatureControl(uint16_t name, int index);
  20         ~TemperatureControl();
  21
  22         void on_module_loaded();
  23         void on_main_loop(void* argument);
  24         void on_gcode_execute(void* argument);
  25         void on_gcode_received(void* argument);
  26         void on_second_tick(void* argument);
  27         void on_get_public_data(void* argument);
  28         void on_set_public_data(void* argument);
  29         void on_halt(void* argument);
  30
  31         void set_desired_temperature(float desired_temperature);
  32
  33         float get_temperature();
  34
  35         friend class PID_Autotuner;
  36
  37     private:
  38         void load_config();
  39         uint32_t thermistor_read_tick(uint32_t dummy);
  40         void pid_process(float);
  41
  42         int pool_index;
  43
  44         float target_temperature;
  45
  46         float preset1;
  47         float preset2;
  48
  49         TempSensor *sensor;
  50
  51         // PID runtime
  52         float i_max;
  53
  54         int o;
  55
  56         float last_reading;
  57
  58         float readings_per_second;
  59
  60         uint16_t name_checksum;
  61
  62         Pwm  heater_pin;
  63
  64         struct {
  65             bool use_bangbang:1;
  66             bool waiting:1;
  67             bool min_temp_violated:1;
  68             bool link_to_tool:1;
  69             bool active:1;
  70             bool readonly:1;
  71         };
  72
  73         uint16_t set_m_code;
  74         uint16_t set_and_wait_m_code;
  75         uint16_t get_m_code;
  76         struct pad_temperature public_data_return;
  77
  78         std::string designator;
  79
  80         void setPIDp(float p);
  81         void setPIDi(float i);
  82         void setPIDd(float d);
  83
  84         float hysteresis;
  85         float iTerm;
  86         float lastInput;
  87         // PID settings
  88         float p_factor;
  89         float i_factor;
  90         float d_factor;
  91         float PIDdt;
  92 };
  93
  94 #endif