diff options
author | Alexander Gee <bostwickenator@gmail.com> | 2020-05-09 03:22:40 +0300 |
---|---|---|
committer | Alexander Gee <bostwickenator@gmail.com> | 2020-05-23 01:45:32 +0300 |
commit | 93fdd9151b94bc35d3da497dc42d681aee717ccb (patch) | |
tree | 0d51cc0c2db8fe8b04c4ed4c36b3f373ef384997 /plugins/PostProcessingPlugin | |
parent | 52050d858fcd50e9301679a8019bfbf41378747b (diff) |
Add PostProcessingPlugin script DisplayPercentCompleteOnLCD
Diffstat (limited to 'plugins/PostProcessingPlugin')
-rw-r--r-- | plugins/PostProcessingPlugin/scripts/DisplayPercentCompleteOnLCD.py | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/plugins/PostProcessingPlugin/scripts/DisplayPercentCompleteOnLCD.py b/plugins/PostProcessingPlugin/scripts/DisplayPercentCompleteOnLCD.py new file mode 100644 index 0000000000..41cb390f7b --- /dev/null +++ b/plugins/PostProcessingPlugin/scripts/DisplayPercentCompleteOnLCD.py @@ -0,0 +1,93 @@ +# Cura PostProcessingPlugin +# Author: Alexander Gee +# Date: May 3, 2020 +# Modified: May 3, 2020 + +# Description: This plugin will write the percent of time complete on the LCD using Marlin's M73 command. + + +from ..Script import Script + +import re + +class DisplayPercentCompleteOnLCD(Script): + + def __init__(self): + super().__init__() + + def getSettingDataString(self): + return """{ + "name":"Display Percent Complete on LCD", + "key":"DisplayPercentCompleteOnLCD", + "metadata": {}, + "version": 2, + "settings": + { + "TurnOn": + { + "label": "Enable", + "description": "When enabled, It will write the percent of time complete on the LCD using Marlin's M73 command.", + "type": "bool", + "default_value": false + } + } + }""" + + # Get the time value from a line as a float. + # Example line ;TIME_ELAPSED:1234.6789 or ;TIME:1337 + def getTimeValue(self, line): + list_split = re.split(":", line) # Split at ":" so we can get the numerical value + return float(list_split[1]) # Convert the numerical portion to a float + + def execute(self, data): + if self.getSettingValueByKey("TurnOn"): + total_time = -1 + previous_layer_end_percentage = 0 + for layer in data: + layer_index = data.index(layer) + lines = layer.split("\n") + + for line in lines: + if line.startswith(";TIME:") and total_time == -1: + # This line represents the total time required to print the gcode + total_time = self.getTimeValue(line) + # Emit 0 percent to sure Marlin knows we are overriding the completion percentage + lines.insert(lines.index(line),"M73 P0") + + elif line.startswith(";TIME_ELAPSED:"): + # We've found one of the time elapsed values which are added at the end of layers + + # If total_time was not already found then noop + if (total_time == -1): + continue + + # Calculate percentage value this layer ends at + layer_end_percentage = int((self.getTimeValue(line) / total_time) * 100) + + # Figure out how many percent of the total time is spent in this layer + layer_percentage_delta = layer_end_percentage - previous_layer_end_percentage + + # If this layer represents less than 1 percent then we don't need to emit anything, continue to the next layer + if (layer_percentage_delta == 0): + continue + + # Grab the index of the current line and figure out how many lines represent one percent + step = lines.index(line) / layer_percentage_delta + + for percentage in range(1, layer_percentage_delta + 1): + # We add the percentage value here as while processing prior lines we will have inserted + # percentage lines before the current one. Failing to do this will upset the spacing + line_index = int((percentage * step) + percentage) + + # Due to integer truncation of the total time value in the gcode the percentage we + # calculate may slightly exceed 100, as that is not valid we cap the value here + output = min(percentage + previous_layer_end_percentage, 100) + + # Now insert the sanitized percentage into the GCODE + lines.insert(line_index, "M73 P{}".format(output)) + + previous_layer_end_percentage = layer_end_percentage + + # Join up the lines for this layer again and store them in the data array + data[layer_index] = "\n".join(lines) + return data |