Commit | Line | Data |
---|---|---|
df27a6a3 | 1 | /* |
cd011f58 AW |
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. | |
df27a6a3 | 5 | You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>. |
cd011f58 AW |
6 | */ |
7 | ||
7b49793d | 8 | // TODO : THIS FILE IS LAME, MUST BE MADE MUCH BETTER |
cd011f58 | 9 | |
ded56b35 AW |
10 | #include "libs/Module.h" |
11 | #include "libs/Kernel.h" | |
12 | #include <math.h> | |
13 | #include "TemperatureControl.h" | |
3c308aeb | 14 | #include "TemperatureControlPool.h" |
3c132bd0 | 15 | #include "libs/Pin.h" |
e84c3be3 | 16 | #include "libs/Median.h" |
ded56b35 | 17 | |
8f91e4e6 MM |
18 | #include "MRI_Hooks.h" |
19 | ||
7e57bc2c BG |
20 | TemperatureControl::TemperatureControl(uint16_t name) : |
21 | name_checksum(name), waiting(false), min_temp_violated(false) {} | |
ded56b35 AW |
22 | |
23 | void TemperatureControl::on_module_loaded(){ | |
907d5e8a | 24 | |
81b547a1 | 25 | // We start not desiring any temp |
907d5e8a | 26 | this->target_temperature = UNDEFINED; |
ded56b35 AW |
27 | |
28 | // Settings | |
7dd8133c | 29 | this->on_config_reload(this); |
ded56b35 AW |
30 | |
31 | this->acceleration_factor = 10; | |
32 | ||
ded56b35 | 33 | // Register for events |
476dcb96 | 34 | register_for_event(ON_CONFIG_RELOAD); |
df27a6a3 | 35 | this->register_for_event(ON_GCODE_EXECUTE); |
b0be67b5 | 36 | this->register_for_event(ON_GCODE_RECEIVED); |
df27a6a3 | 37 | this->register_for_event(ON_MAIN_LOOP); |
8ccab7cf | 38 | this->register_for_event(ON_SECOND_TICK); |
ded56b35 AW |
39 | |
40 | } | |
41 | ||
7e57bc2c BG |
42 | void TemperatureControl::on_main_loop(void* argument){ |
43 | if (this->min_temp_violated) { | |
44 | kernel->streams->printf("MINTEMP triggered on P%d.%d! check your thermistors!\n", this->thermistor_pin.port_number, this->thermistor_pin.pin); | |
45 | this->min_temp_violated = false; | |
46 | } | |
47 | } | |
7dd8133c AW |
48 | |
49 | // Get configuration from the config file | |
50 | void TemperatureControl::on_config_reload(void* argument){ | |
51 | ||
1306ba99 AW |
52 | // General config |
53 | this->set_m_code = this->kernel->config->value(temperature_control_checksum, this->name_checksum, set_m_code_checksum)->by_default(104)->as_number(); | |
54 | this->set_and_wait_m_code = this->kernel->config->value(temperature_control_checksum, this->name_checksum, set_and_wait_m_code_checksum)->by_default(109)->as_number(); | |
55 | this->get_m_code = this->kernel->config->value(temperature_control_checksum, this->name_checksum, get_m_code_checksum)->by_default(105)->as_number(); | |
f39da6fe | 56 | this->readings_per_second = this->kernel->config->value(temperature_control_checksum, this->name_checksum, readings_per_second_checksum)->by_default(20)->as_number(); |
7dee00e4 | 57 | |
a6a2911f | 58 | this->max_pwm = this->kernel->config->value(temperature_control_checksum, this->name_checksum, max_pwm_checksum)->by_default(255)->as_number(); |
7dd8133c | 59 | |
b0be67b5 MM |
60 | this->designator = this->kernel->config->value(temperature_control_checksum, this->name_checksum, designator_checksum)->by_default(string("T"))->as_string(); |
61 | ||
7dd8133c | 62 | // Values are here : http://reprap.org/wiki/Thermistor |
423df6df AW |
63 | this->r0 = 100000; |
64 | this->t0 = 25; | |
a98f72da | 65 | this->beta = 4066; |
423df6df AW |
66 | this->r1 = 0; |
67 | this->r2 = 4700; | |
a98f72da | 68 | |
3c132bd0 | 69 | // Preset values for various common types of thermistors |
df27a6a3 | 70 | ConfigValue* thermistor = this->kernel->config->value(temperature_control_checksum, this->name_checksum, thermistor_checksum); |
423df6df AW |
71 | if( thermistor->value.compare("EPCOS100K" ) == 0 ){ // Default |
72 | }else if( thermistor->value.compare("RRRF100K" ) == 0 ){ this->beta = 3960; | |
73 | }else if( thermistor->value.compare("RRRF10K" ) == 0 ){ this->beta = 3964; this->r0 = 10000; this->r1 = 680; this->r2 = 1600; | |
74 | }else if( thermistor->value.compare("Honeywell100K") == 0 ){ this->beta = 3974; | |
75 | }else if( thermistor->value.compare("Semitec" ) == 0 ){ this->beta = 4267; } | |
a98f72da | 76 | |
3c132bd0 | 77 | // Preset values are overriden by specified values |
907d5e8a MM |
78 | this->r0 = this->kernel->config->value(temperature_control_checksum, this->name_checksum, r0_checksum )->by_default(this->r0 )->as_number(); // Stated resistance eg. 100K |
79 | this->t0 = this->kernel->config->value(temperature_control_checksum, this->name_checksum, t0_checksum )->by_default(this->t0 )->as_number(); // Temperature at stated resistance, eg. 25C | |
80 | this->beta = this->kernel->config->value(temperature_control_checksum, this->name_checksum, beta_checksum)->by_default(this->beta)->as_number(); // Thermistor beta rating. See http://reprap.org/bin/view/Main/MeasuringThermistorBeta | |
81 | this->r1 = this->kernel->config->value(temperature_control_checksum, this->name_checksum, r1_checksum )->by_default(this->r1 )->as_number(); | |
82 | this->r2 = this->kernel->config->value(temperature_control_checksum, this->name_checksum, r2_checksum )->by_default(this->r2 )->as_number(); | |
83 | ||
84 | ||
df27a6a3 | 85 | // Thermistor math |
907d5e8a MM |
86 | j = (1.0 / beta); |
87 | k = (1.0 / (t0 + 273.15)); | |
88 | ||
c4f4cf73 MM |
89 | // sigma-delta output modulation |
90 | o = 0; | |
3c132bd0 AW |
91 | |
92 | // Thermistor pin for ADC readings | |
7dee00e4 MM |
93 | this->thermistor_pin.from_string(this->kernel->config->value(temperature_control_checksum, this->name_checksum, thermistor_pin_checksum )->required()->as_string()); |
94 | this->kernel->adc->enable_pin(&thermistor_pin); | |
3c132bd0 AW |
95 | |
96 | // Heater pin | |
7dee00e4 MM |
97 | this->heater_pin.from_string( this->kernel->config->value(temperature_control_checksum, this->name_checksum, heater_pin_checksum)->required()->as_string())->as_output(); |
98 | this->heater_pin.set(0); | |
7dd8133c | 99 | |
cb3460e9 | 100 | set_low_on_debug(heater_pin.port_number, heater_pin.pin); |
8f91e4e6 | 101 | |
907d5e8a | 102 | // activate SD-DAC timer |
7dee00e4 | 103 | this->kernel->slow_ticker->attach(1000, &heater_pin, &Pwm::on_tick); |
907d5e8a | 104 | |
f39da6fe MM |
105 | // reading tick |
106 | this->kernel->slow_ticker->attach( this->readings_per_second, this, &TemperatureControl::thermistor_read_tick ); | |
107 | ||
907d5e8a MM |
108 | // PID |
109 | this->p_factor = this->kernel->config->value(temperature_control_checksum, this->name_checksum, p_factor_checksum)->by_default(10 )->as_number(); | |
b6a72b99 MM |
110 | this->i_factor = this->kernel->config->value(temperature_control_checksum, this->name_checksum, i_factor_checksum)->by_default(0.3)->as_number(); |
111 | this->d_factor = this->kernel->config->value(temperature_control_checksum, this->name_checksum, d_factor_checksum)->by_default(200)->as_number(); | |
4b9388c2 | 112 | this->i_max = this->kernel->config->value(temperature_control_checksum, this->name_checksum, i_max_checksum )->by_default(255)->as_number(); |
b6a72b99 | 113 | this->i = 0.0; |
907d5e8a | 114 | this->last_reading = 0.0; |
7dd8133c AW |
115 | } |
116 | ||
b0be67b5 MM |
117 | void TemperatureControl::on_gcode_received(void* argument) |
118 | { | |
119 | Gcode* gcode = static_cast<Gcode*>(argument); | |
120 | if (gcode->has_m) | |
121 | { | |
122 | // Get temperature | |
123 | if( gcode->m == this->get_m_code ){ | |
c4f4cf73 | 124 | gcode->stream->printf("%s:%3.1f /%3.1f @%d ", this->designator.c_str(), this->get_temperature(), ((target_temperature == UNDEFINED)?0.0:target_temperature), this->o); |
ac9f9b7a | 125 | gcode->add_nl = true; |
b0be67b5 | 126 | } |
827a49ca MM |
127 | if (gcode->m == 301) |
128 | { | |
129 | if (gcode->has_letter('S') && (gcode->get_value('S') == this->pool_index)) | |
130 | { | |
131 | if (gcode->has_letter('P')) | |
132 | this->p_factor = gcode->get_value('P'); | |
133 | if (gcode->has_letter('I')) | |
134 | this->i_factor = gcode->get_value('I'); | |
135 | if (gcode->has_letter('D')) | |
136 | this->d_factor = gcode->get_value('D'); | |
137 | if (gcode->has_letter('X')) | |
138 | this->i_max = gcode->get_value('X'); | |
139 | } | |
140 | gcode->stream->printf("%s(S%d): Pf:%g If:%g Df:%g X(I_max):%g Pv:%g Iv:%g Dv:%g O:%d\n", this->designator.c_str(), this->pool_index, this->p_factor, this->i_factor, this->d_factor, this->i_max, this->p, this->i, this->d, o); | |
141 | } | |
142 | if (gcode->m == 303) | |
143 | { | |
144 | if (gcode->has_letter('S') && (gcode->get_value('S') == this->pool_index)) | |
145 | { | |
146 | double target = 150.0; | |
147 | if (gcode->has_letter('P')) | |
148 | { | |
149 | target = gcode->get_value('P'); | |
150 | gcode->stream->printf("Target: %5.1f\n", target); | |
151 | } | |
152 | gcode->stream->printf("Start PID tune, command is %s\n", gcode->command.c_str()); | |
153 | this->pool->PIDtuner->begin(this, target, gcode->stream); | |
154 | } | |
155 | } | |
b0be67b5 MM |
156 | } |
157 | } | |
db453125 | 158 | |
ded56b35 AW |
159 | void TemperatureControl::on_gcode_execute(void* argument){ |
160 | Gcode* gcode = static_cast<Gcode*>(argument); | |
e6b5ae25 AW |
161 | if( gcode->has_m){ |
162 | // Set temperature without waiting | |
907d5e8a MM |
163 | if( gcode->m == this->set_m_code && gcode->has_letter('S') ) |
164 | { | |
eabf7a9b MM |
165 | if (gcode->get_value('S') == 0) |
166 | { | |
907d5e8a | 167 | this->target_temperature = UNDEFINED; |
7dee00e4 | 168 | this->heater_pin.set(0); |
eabf7a9b MM |
169 | } |
170 | else | |
171 | { | |
907d5e8a MM |
172 | this->set_desired_temperature(gcode->get_value('S')); |
173 | } | |
eabf7a9b | 174 | } |
e6b5ae25 | 175 | // Set temperature and wait |
907d5e8a MM |
176 | if( gcode->m == this->set_and_wait_m_code && gcode->has_letter('S') ) |
177 | { | |
eabf7a9b MM |
178 | if (gcode->get_value('S') == 0) |
179 | { | |
907d5e8a | 180 | this->target_temperature = UNDEFINED; |
7dee00e4 | 181 | this->heater_pin.set(0); |
eabf7a9b MM |
182 | } |
183 | else | |
184 | { | |
907d5e8a MM |
185 | this->set_desired_temperature(gcode->get_value('S')); |
186 | // Pause | |
187 | this->kernel->pauser->take(); | |
188 | this->waiting = true; | |
189 | } | |
df27a6a3 | 190 | } |
df27a6a3 | 191 | } |
ded56b35 AW |
192 | } |
193 | ||
db453125 | 194 | |
ded56b35 | 195 | void TemperatureControl::set_desired_temperature(double desired_temperature){ |
907d5e8a | 196 | target_temperature = desired_temperature; |
959dc7db | 197 | if (desired_temperature == 0.0) |
7dee00e4 | 198 | heater_pin.set((o = 0)); |
ded56b35 AW |
199 | } |
200 | ||
201 | double TemperatureControl::get_temperature(){ | |
907d5e8a | 202 | return last_reading; |
ded56b35 AW |
203 | } |
204 | ||
907d5e8a MM |
205 | double TemperatureControl::adc_value_to_temperature(int adc_value) |
206 | { | |
207 | if ((adc_value == 4095) || (adc_value == 0)) | |
208 | return INFINITY; | |
209 | double r = r2 / ((4095.0 / adc_value) - 1.0); | |
210 | if (r1 > 0) | |
211 | r = (r1 * r) / (r1 - r); | |
212 | return (1.0 / (k + (j * log(r / r0)))) - 273.15; | |
ded56b35 AW |
213 | } |
214 | ||
8b8b3339 | 215 | uint32_t TemperatureControl::thermistor_read_tick(uint32_t dummy){ |
907d5e8a MM |
216 | int r = new_thermistor_reading(); |
217 | ||
218 | double temperature = adc_value_to_temperature(r); | |
219 | ||
220 | if (target_temperature > 0) | |
221 | { | |
222 | if ((r <= 1) || (r >= 4094)) | |
36a3f3f0 | 223 | { |
7e57bc2c | 224 | this->min_temp_violated = true; |
907d5e8a | 225 | target_temperature = UNDEFINED; |
7dee00e4 | 226 | heater_pin.set(0); |
36a3f3f0 MM |
227 | } |
228 | else | |
229 | { | |
907d5e8a MM |
230 | pid_process(temperature); |
231 | if ((temperature > target_temperature) && waiting) | |
36a3f3f0 | 232 | { |
907d5e8a MM |
233 | kernel->pauser->release(); |
234 | waiting = false; | |
81b547a1 | 235 | } |
ded56b35 AW |
236 | } |
237 | } | |
959dc7db MM |
238 | else |
239 | { | |
7dee00e4 | 240 | heater_pin.set((o = 0)); |
959dc7db | 241 | } |
907d5e8a | 242 | last_reading = temperature; |
281967e4 | 243 | return 0; |
ded56b35 AW |
244 | } |
245 | ||
907d5e8a MM |
246 | void TemperatureControl::pid_process(double temperature) |
247 | { | |
248 | double error = target_temperature - temperature; | |
ded56b35 | 249 | |
8cdae54c | 250 | p = error * p_factor; |
b6a72b99 | 251 | i += (error * this->i_factor); |
827a49ca MM |
252 | // d was imbued with oldest_raw earlier in new_thermistor_reading |
253 | d = adc_value_to_temperature(d); | |
254 | d = (d - temperature) * this->d_factor; | |
ded56b35 | 255 | |
907d5e8a MM |
256 | if (i > this->i_max) |
257 | i = this->i_max; | |
258 | if (i < -this->i_max) | |
259 | i = -this->i_max; | |
ded56b35 | 260 | |
7dee00e4 | 261 | this->o = (p + i + d) * heater_pin.max_pwm() / 256; |
8cdae54c | 262 | |
7dee00e4 | 263 | if (this->o >= heater_pin.max_pwm()) |
8cdae54c | 264 | { |
95b3d2ba | 265 | i = 0; |
7dee00e4 | 266 | this->o = heater_pin.max_pwm(); |
8cdae54c | 267 | } |
907d5e8a | 268 | if (this->o < 0) |
8cdae54c | 269 | { |
7dee00e4 | 270 | if (this->o < -(heater_pin.max_pwm())) |
95b3d2ba | 271 | i = 0; |
907d5e8a | 272 | this->o = 0; |
8cdae54c | 273 | } |
907d5e8a | 274 | |
a6a2911f AW |
275 | if( this->o > this->max_pwm ){ this->o = max_pwm; } |
276 | ||
7dee00e4 | 277 | this->heater_pin.pwm(o); |
907d5e8a | 278 | } |
ded56b35 | 279 | |
907d5e8a MM |
280 | int TemperatureControl::new_thermistor_reading() |
281 | { | |
7dee00e4 | 282 | int last_raw = this->kernel->adc->read(&thermistor_pin); |
907d5e8a MM |
283 | if (queue.size() >= queue.capacity()) |
284 | { | |
285 | uint16_t l; | |
286 | queue.pop_front(l); | |
827a49ca | 287 | d = l; |
907d5e8a | 288 | } |
c4f4cf73 MM |
289 | uint16_t r = last_raw; |
290 | queue.push_back(r); | |
e84c3be3 BG |
291 | for (int i=0; i<queue.size(); i++) |
292 | median_buffer[i] = *queue.get_ref(i); | |
293 | uint16_t m = median_buffer[quick_median(median_buffer, queue.size())]; | |
294 | return m; | |
907d5e8a | 295 | } |
8ccab7cf MM |
296 | |
297 | void TemperatureControl::on_second_tick(void* argument) | |
298 | { | |
299 | if (waiting) | |
8f91e4e6 | 300 | kernel->streams->printf("%s:%3.1f /%3.1f @%d\n", designator.c_str(), get_temperature(), ((target_temperature == UNDEFINED)?0.0:target_temperature), o); |
8ccab7cf | 301 | } |