| 
									
										
										
										
											2018-01-19 23:46:01 -05:00
										 |  |  | # Printer cooling fan | 
					
						
							|  |  |  | # | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  | # Copyright (C) 2016-2024  Kevin O'Connor <kevin@koconnor.net> | 
					
						
							| 
									
										
										
										
											2018-01-19 23:46:01 -05:00
										 |  |  | # | 
					
						
							|  |  |  | # This file may be distributed under the terms of the GNU GPLv3 license. | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  | from . import pulse_counter, output_pin | 
					
						
							| 
									
										
										
										
											2018-01-19 23:46:01 -05:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  | class Fan: | 
					
						
							| 
									
										
										
										
											2018-05-18 19:12:03 -04:00
										 |  |  |     def __init__(self, config, default_shutdown_speed=0.): | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |         self.printer = config.get_printer() | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  |         self.last_fan_value = self.last_req_value = 0. | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |         # Read config | 
					
						
							| 
									
										
										
										
											2018-01-19 23:46:01 -05:00
										 |  |  |         self.max_power = config.getfloat('max_power', 1., above=0., maxval=1.) | 
					
						
							| 
									
										
										
										
											2019-02-27 13:27:52 -05:00
										 |  |  |         self.kick_start_time = config.getfloat('kick_start_time', 0.1, | 
					
						
							|  |  |  |                                                minval=0.) | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |         self.off_below = config.getfloat('off_below', default=0., | 
					
						
							|  |  |  |                                          minval=0., maxval=1.) | 
					
						
							| 
									
										
										
										
											2018-01-29 12:54:06 -05:00
										 |  |  |         cycle_time = config.getfloat('cycle_time', 0.010, above=0.) | 
					
						
							|  |  |  |         hardware_pwm = config.getboolean('hardware_pwm', False) | 
					
						
							| 
									
										
										
										
											2018-05-18 19:12:03 -04:00
										 |  |  |         shutdown_speed = config.getfloat( | 
					
						
							|  |  |  |             'shutdown_speed', default_shutdown_speed, minval=0., maxval=1.) | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |         # Setup pwm object | 
					
						
							|  |  |  |         ppins = self.printer.lookup_object('pins') | 
					
						
							|  |  |  |         self.mcu_fan = ppins.setup_pin('pwm', config.get('pin')) | 
					
						
							|  |  |  |         self.mcu_fan.setup_max_duration(0.) | 
					
						
							|  |  |  |         self.mcu_fan.setup_cycle_time(cycle_time, hardware_pwm) | 
					
						
							|  |  |  |         shutdown_power = max(0., min(self.max_power, shutdown_speed)) | 
					
						
							|  |  |  |         self.mcu_fan.setup_start_value(0., shutdown_power) | 
					
						
							| 
									
										
										
										
											2021-02-06 15:11:29 -08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-09-03 18:23:55 +02:00
										 |  |  |         self.enable_pin = None | 
					
						
							|  |  |  |         enable_pin = config.get('enable_pin', None) | 
					
						
							|  |  |  |         if enable_pin is not None: | 
					
						
							|  |  |  |             self.enable_pin = ppins.setup_pin('digital_out', enable_pin) | 
					
						
							|  |  |  |             self.enable_pin.setup_max_duration(0.) | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  |         # Create gcode request queue | 
					
						
							|  |  |  |         self.gcrq = output_pin.GCodeRequestQueue(config, self.mcu_fan.get_mcu(), | 
					
						
							|  |  |  |                                                  self._apply_speed) | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-02-06 15:11:29 -08:00
										 |  |  |         # Setup tachometer | 
					
						
							|  |  |  |         self.tachometer = FanTachometer(config) | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |         # Register callbacks | 
					
						
							|  |  |  |         self.printer.register_event_handler("gcode:request_restart", | 
					
						
							|  |  |  |                                             self._handle_request_restart) | 
					
						
							| 
									
										
										
										
											2021-02-06 15:11:29 -08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |     def get_mcu(self): | 
					
						
							|  |  |  |         return self.mcu_fan.get_mcu() | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  |     def _apply_speed(self, print_time, value): | 
					
						
							| 
									
										
										
										
											2019-10-03 14:59:03 -07:00
										 |  |  |         if value < self.off_below: | 
					
						
							|  |  |  |             value = 0. | 
					
						
							| 
									
										
										
										
											2018-04-20 13:15:03 -04:00
										 |  |  |         value = max(0., min(self.max_power, value * self.max_power)) | 
					
						
							| 
									
										
										
										
											2018-01-19 23:46:01 -05:00
										 |  |  |         if value == self.last_fan_value: | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  |             return "discard", 0. | 
					
						
							| 
									
										
										
										
											2022-09-03 18:23:55 +02:00
										 |  |  |         if self.enable_pin: | 
					
						
							|  |  |  |             if value > 0 and self.last_fan_value == 0: | 
					
						
							|  |  |  |                 self.enable_pin.set_digital(print_time, 1) | 
					
						
							|  |  |  |             elif value == 0 and self.last_fan_value > 0: | 
					
						
							|  |  |  |                 self.enable_pin.set_digital(print_time, 0) | 
					
						
							| 
									
										
										
										
											2024-09-15 00:17:35 -04:00
										 |  |  |         if (value and self.kick_start_time | 
					
						
							| 
									
										
										
										
											2019-11-24 18:37:30 -05:00
										 |  |  |             and (not self.last_fan_value or value - self.last_fan_value > .5)): | 
					
						
							| 
									
										
										
										
											2018-01-19 23:46:01 -05:00
										 |  |  |             # Run fan at full speed for specified kick_start_time | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  |             self.last_req_value = value | 
					
						
							|  |  |  |             self.last_fan_value = self.max_power | 
					
						
							| 
									
										
										
										
											2018-01-19 23:46:01 -05:00
										 |  |  |             self.mcu_fan.set_pwm(print_time, self.max_power) | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  |             return "delay", self.kick_start_time | 
					
						
							|  |  |  |         self.last_fan_value = self.last_req_value = value | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  |         self.mcu_fan.set_pwm(print_time, value) | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  |     def set_speed(self, print_time, value): | 
					
						
							|  |  |  |         self.gcrq.send_async_request(print_time, value) | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |     def set_speed_from_command(self, value): | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  |         self.gcrq.queue_gcode_request(value) | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |     def _handle_request_restart(self, print_time): | 
					
						
							|  |  |  |         self.set_speed(print_time, 0.) | 
					
						
							| 
									
										
										
										
											2021-02-06 15:11:29 -08:00
										 |  |  | 
 | 
					
						
							|  |  |  |     def get_status(self, eventtime): | 
					
						
							|  |  |  |         tachometer_status = self.tachometer.get_status(eventtime) | 
					
						
							|  |  |  |         return { | 
					
						
							| 
									
										
										
										
											2024-08-16 13:22:38 -04:00
										 |  |  |             'speed': self.last_req_value, | 
					
						
							| 
									
										
										
										
											2021-02-06 15:11:29 -08:00
										 |  |  |             'rpm': tachometer_status['rpm'], | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | class FanTachometer: | 
					
						
							|  |  |  |     def __init__(self, config): | 
					
						
							|  |  |  |         printer = config.get_printer() | 
					
						
							|  |  |  |         self._freq_counter = None | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         pin = config.get('tachometer_pin', None) | 
					
						
							|  |  |  |         if pin is not None: | 
					
						
							|  |  |  |             self.ppr = config.getint('tachometer_ppr', 2, minval=1) | 
					
						
							|  |  |  |             poll_time = config.getfloat('tachometer_poll_interval', | 
					
						
							|  |  |  |                                         0.0015, above=0.) | 
					
						
							|  |  |  |             sample_time = 1. | 
					
						
							|  |  |  |             self._freq_counter = pulse_counter.FrequencyCounter( | 
					
						
							|  |  |  |                 printer, pin, sample_time, poll_time) | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |     def get_status(self, eventtime): | 
					
						
							| 
									
										
										
										
											2021-03-01 14:57:40 -05:00
										 |  |  |         if self._freq_counter is not None: | 
					
						
							|  |  |  |             rpm = self._freq_counter.get_frequency() * 30. / self.ppr | 
					
						
							| 
									
										
										
										
											2021-02-06 15:11:29 -08:00
										 |  |  |         else: | 
					
						
							|  |  |  |             rpm = None | 
					
						
							|  |  |  |         return {'rpm': rpm} | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  | 
 | 
					
						
							|  |  |  | class PrinterFan: | 
					
						
							|  |  |  |     def __init__(self, config): | 
					
						
							|  |  |  |         self.fan = Fan(config) | 
					
						
							|  |  |  |         # Register commands | 
					
						
							|  |  |  |         gcode = config.get_printer().lookup_object('gcode') | 
					
						
							|  |  |  |         gcode.register_command("M106", self.cmd_M106) | 
					
						
							|  |  |  |         gcode.register_command("M107", self.cmd_M107) | 
					
						
							|  |  |  |     def get_status(self, eventtime): | 
					
						
							|  |  |  |         return self.fan.get_status(eventtime) | 
					
						
							| 
									
										
										
										
											2020-04-24 22:59:38 -04:00
										 |  |  |     def cmd_M106(self, gcmd): | 
					
						
							| 
									
										
										
										
											2019-11-13 11:29:27 -05:00
										 |  |  |         # Set fan speed | 
					
						
							| 
									
										
										
										
											2020-04-24 22:59:38 -04:00
										 |  |  |         value = gcmd.get_float('S', 255., minval=0.) / 255. | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |         self.fan.set_speed_from_command(value) | 
					
						
							| 
									
										
										
										
											2020-04-24 22:59:38 -04:00
										 |  |  |     def cmd_M107(self, gcmd): | 
					
						
							| 
									
										
										
										
											2019-11-13 11:29:27 -05:00
										 |  |  |         # Turn fan off | 
					
						
							| 
									
										
										
										
											2020-07-03 23:23:24 -04:00
										 |  |  |         self.fan.set_speed_from_command(0.) | 
					
						
							| 
									
										
										
										
											2018-01-19 23:46:01 -05:00
										 |  |  | 
 | 
					
						
							|  |  |  | def load_config(config): | 
					
						
							|  |  |  |     return PrinterFan(config) |