diff options
Diffstat (limited to 'klippy/extras/tsl1401cl_filament_width_sensor.py')
| -rw-r--r-- | klippy/extras/tsl1401cl_filament_width_sensor.py | 130 |
1 files changed, 130 insertions, 0 deletions
diff --git a/klippy/extras/tsl1401cl_filament_width_sensor.py b/klippy/extras/tsl1401cl_filament_width_sensor.py new file mode 100644 index 00000000..06530bf8 --- /dev/null +++ b/klippy/extras/tsl1401cl_filament_width_sensor.py @@ -0,0 +1,130 @@ +# Support for filament width sensor +# +# Copyright (C) 2019 Mustafa YILDIZ <mydiz@hotmail.com> +# +# This file may be distributed under the terms of the GNU GPLv3 license. + +ADC_REPORT_TIME = 0.500 +ADC_SAMPLE_TIME = 0.001 +ADC_SAMPLE_COUNT = 8 +MEASUREMENT_INTERVAL_MM = 10 + +class FilamentWidthSensor: + def __init__(self, config): + self.printer = config.get_printer() + self.reactor = self.printer.get_reactor() + self.pin = config.get('pin') + self.nominal_filament_dia = config.getfloat('default_nominal_filament_diameter', above=1.0) + self.measurement_delay = config.getfloat('measurement_delay', above=0.) + self.measurement_max_difference = config.getfloat('max_difference', above=0.) + self.max_diameter = self.nominal_filament_dia + self.measurement_max_difference + self.min_diameter = self.nominal_filament_dia - self.measurement_max_difference + self.is_active = True + # filament array [position, filamentWidth] + self.filament_array = [] + self.lastFilamentWidthReading = 0 + # printer objects + self.gcode = self.toolhead = self.ppins = self.mcu_adc = None + self.printer.register_event_handler("klippy:ready", self.handle_ready) + # Start adc + self.ppins = self.printer.lookup_object('pins') + self.mcu_adc = self.ppins.setup_pin('adc', self.pin) + self.mcu_adc.setup_minmax(ADC_SAMPLE_TIME, ADC_SAMPLE_COUNT) + self.mcu_adc.setup_adc_callback(ADC_REPORT_TIME, self.adc_callback) + # extrude factor updating + self.extrude_factor_update_timer = self.reactor.register_timer( + self.extrude_factor_update_event) + + # Initialization + def handle_ready(self): + # Load printer objects + self.gcode = self.printer.lookup_object('gcode') + self.toolhead = self.printer.lookup_object('toolhead') + self.gcode.register_command('QUERY_FILAMENT_WIDTH', self.cmd_M407) + self.gcode.register_command('RESET_FILAMENT_WIDTH_SENSOR', self.cmd_ClearFilamentArray) + self.gcode.register_command('DISABLE_FILAMENT_WIDTH_SENSOR', self.cmd_M406) + self.gcode.register_command('ENABLE_FILAMENT_WIDTH_SENSOR', self.cmd_M405) + + # Start extrude factor update timer + self.reactor.update_timer(self.extrude_factor_update_timer, self.reactor.NOW) + + def adc_callback(self, read_time, read_value): + # read sensor value + self.lastFilamentWidthReading = round(read_value * 5, 2) + + def update_filament_array(self, last_epos): + # Fill array + if len(self.filament_array) > 0: + # Get last reading position in array & calculate next reading position + next_reading_position = self.filament_array[-1][0] + MEASUREMENT_INTERVAL_MM + if next_reading_position <= (last_epos + self.measurement_delay): + self.filament_array.append([last_epos + self.measurement_delay, self.lastFilamentWidthReading]) + else: + # add first item to array + self.filament_array.append([self.measurement_delay + last_epos, self.lastFilamentWidthReading]) + + def extrude_factor_update_event(self, eventtime): + # Update extrude factor + pos = self.toolhead.get_position() + last_epos = pos[3] + # Update filament array for lastFilamentWidthReading + self.update_filament_array(last_epos) + # Does filament exists + if self.lastFilamentWidthReading > 0.5: + if len(self.filament_array) > 0: + # Get first position in filament array + pending_position = self.filament_array[0][0] + if pending_position <= last_epos: + # Get first item in filament_array queue + item = self.filament_array.pop(0) + filament_width = item[1] + if (filament_width <= self.max_diameter) and (filament_width >= self.min_diameter): + percentage = round(self.nominal_filament_dia / filament_width * 100) + self.gcode.run_script("M221 S" + str(percentage)) + else: + self.gcode.run_script("M221 S100") + else: + self.gcode.run_script("M221 S100") + self.filament_array = [] + return eventtime + 1 + + def cmd_M407(self, params): + response = "" + if self.lastFilamentWidthReading > 0: + response += "Filament dia (measured mm): " + str(self.lastFilamentWidthReading) + else: + response += "Filament NOT present" + self.gcode.respond(response) + + def cmd_ClearFilamentArray(self, params): + self.filament_array = [] + self.gcode.respond("Filament width measurements cleared!") + # Set extrude multiplier to 100% + self.gcode.run_script_from_command("M221 S100") + + def cmd_M405(self, params): + response = "Filament width sensor Turned On" + if self.is_active: + response = "Filament width sensor is already On" + else: + self.is_active = True + # Start extrude factor update timer + self.reactor.update_timer(self.extrude_factor_update_timer, self.reactor.NOW) + self.gcode.respond(response) + + def cmd_M406(self, params): + response = "Filament width sensor Turned Off" + if not self.is_active: + response = "Filament width sensor is already Off" + else: + self.is_active = False + # Stop extrude factor update timer + self.reactor.update_timer(self.extrude_factor_update_timer, self.reactor.NEVER) + # Clear filament array + self.filament_array = [] + # Set extrude multiplier to 100% + self.gcode.run_script_from_command("M221 S100") + self.gcode.respond(response) + +def load_config(config): + return FilamentWidthSensor(config) |