cdanesi/OctoPrint-CalibrationTools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix design on standard view (#3)

Browse Source 
* Move notes above the fields
* Adding documentation
* Add documentation
* Fix design issue on standard view
This commit is contained in:
Sergiu Toporjinschi
2022-02-08 21:34:52 +02:00
committed by GitHub
parent 1401aa8252
commit a2751b96d6
15 changed files with 210 additions and 788 deletions
Download Patch File Download Diff File Expand all files Collapse all files
octoprint_CalibrationTools/templates/tabs/tab-doc.jinja2
+36 -1
View File
@@ -1,3 +1,38 @@
{% import "macros.jinja2" as snipped %}
{{ snipped.quote("For using this plugin, I strongly recommending you to read <a href='https://teachingtechyt.github.io/calibration.html#pid' target='_blank'>teachingtechyt.github.io</a>","", "text-warning") }}
{{ snipped.quote("Before starting I strongly recommend reading some documentation about tunning <a href='https://teachingtechyt.github.io/calibration.html#intro' target='_blank'>teachingtechyt.github.io</a>","",
"text-warning") }}
The stepper motors divides a full rotation in a number of equal steps.
E-Steps tuning is a process of setting the exact number of steps need it for pushing a fix amount of filament for feeding the hot-end.<br>
{{ snipped.subSection("E-Steps") }}
You will have to:
<lu>
<li>Mark a specific length of filament at the extruder motor entrance;</li>
<li>Set the hot-end on a printing temperature in E-Steps tab;</li>
<li>Set the extrusion length and speed;</li>
<li>Press "Start extrusion";</li>
<li>When extrusion finished, check the remaining length between the extruder and the filament mark location;</li>
<li>Refresh the current values from EEPROM;</li>
<li>Feed data collected in E-Steps tab and save the results in EEPROM;</li>
</lu>
{{ snipped.subSection("X-Y-Z Steps") }}
You will have to:
<lu>
<li>Print a <a href="https://www.thingiverse.com/thing:1278865" target="_blank">test cube</a> with a known size on all three axes X,Y,X;</li>
<li>Refresh the current values from EEPROM;</li>
<li>Feed data collected in E-Steps tab and save the results in EEPROM;</li>
</lu>
{{ snipped.subSection("PID Autotune") }}
You will have to:
<lu>
<li>Refresh the current values from EEPROM;</li>
<li>Set the hot-end index which you want to tune;</li>
<li>Set the usual temperature used in your prints for that specific hot-end;</li>
<li>Set the usual fan speed used in your prints;</li>
<li>Monitor temperature tab, when it starts to cool down save the results in EEPROM;</li>
<li>For tuning heated bed the index is already set on -1;</li>
</lu>
octoprint_CalibrationTools/templates/tabs/tab-esteps.jinja2
+29 -17
View File
@@ -1,24 +1,36 @@
{% import "macros.jinja2" as snipped %}
{{ snipped.subSection("Process description", true) }}
You will have to:
<lu>
<li>Mark a specific length of filament at the extruder motor entrance;</li>
<li>Set the hot-end on a printing temperature in E-Steps tab;</li>
<li>Set the extrusion length and speed;</li>
<li>Press "Start extrusion";</li>
<li>When extrusion finished, check the remaining length between the extruder and the filament mark location;</li>
<li>Refresh the current values from EEPROM;</li>
<li>Feed data collected in E-Steps tab and save the results in EEPROM;</li>
</lu>
<br>
{{ snipped.quote("
This calibration is best done with the extruder detached from the hot end, so no restriction is present on the movement. If it is convenient, you can partially disassemble the printer so the output of the extruder is
open and the filament exits in free air. If this is inconvenient, the process below aims to minimize restrictions by extruding very slowly and with a slightly higher temperature. The results from this should still be
reliable.
", "
<a href='https://teachingtechyt.github.io/calibration.html#esteps' target='_blank'>For more information about how to use this visit teachingtechyt.github.io</a>
", "text-warning") }}
", "<a href='https://teachingtechyt.github.io/calibration.html#esteps' target='_blank'>teachingtechyt.github.io</a>", "text-warning") }}
{{ snipped.subSection("Parameters", true) }}
{{ snipped.subSection("Test parameters") }}
<!-- M104 S210 command -->
<div class="row-fluid">
<div class="span6">
<div data-bind="class: $root.columnLabelCls()">
<label for="temperature" class="pull-right" style="margin-top: 5px;" title="x">
Heating
</label>
</div>
<div class="span6">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
{{ snipped.linkToMarlin("M104", "Marlin website") }}
<span class="add-on" title="Command to preheat the tool before testing">M104&nbsp;&nbsp;&nbsp;S</span>
@@ -29,12 +41,12 @@ reliable.
</div>
<!-- G1 E100 F50 command -->
<div class="row-fluid">
<div class="span6">
<div data-bind="class: $root.columnLabelCls()">
<label for="extrusionLenSpeed" class="pull-right" style="margin-top: 5px;" title="x">
Extrusion length & speed
</label>
</div>
<div class="span6">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
{{ snipped.linkToMarlin("G000-G001", "Marlin website") }}
<span class="add-on" title="Command to extrude filament for testing">G1&nbsp;&nbsp;&nbsp;E</span>
@@ -49,8 +61,8 @@ reliable.
{{ snipped.field("Extrusion marking length", "The length marked on filament before extrusion. ", "number", "$root.testParam.markLength", "true", "mm", 0.01, 50) }}
<div class="row-fluid" style="margin-bottom: 5px;">
<div class="span6"></div>
<div class="span6">
<div data-bind="class: $root.columnLabelCls()"></div>
<div data-bind="class: $root.columnFieldCls()">
<button class="btn btn-success"
data-bind="click: $root.startExtrusion, enable: !$root.startExtrusionActive() && $root.is_admin() && $root.controlViewModel.isOperational() && (!$root.controlViewModel.isPrinting())"
title="This will trigger M90, M83, G1 E100 F50, M82, G90 in order for extruding filament">
@@ -60,15 +72,15 @@ reliable.
</div>
</div>
{{ snipped.subSection("Test results") }}
{{ snipped.subSection("Results") }}
<div class="row-fluid">
<div class="span6">
<div data-bind="class: $root.columnLabelCls()">
<label for="eSteps" class="pull-right" style="margin-top: 5px;" title="Current value for number of steps/mm for E axe in EEPROM">
E steps
</label>
</div>
<div class="span6">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-append">
<input type="number" id="eSteps" title="Current value for number of steps/mm for E axe in EEPROM" class="input-small" step="0.01" data-bind="value: $root.steps.E(), enable:false">
<span class="add-on" title="Current value for number of steps/mm for E axe in EEPROM">steps/mm</span>
@@ -85,12 +97,12 @@ reliable.
<!-- M92 E900 -->
<div class="row-fluid">
<div class="span6">
<div data-bind="class: $root.columnLabelCls()">
<label for="newESteps" class="pull-right" style="margin-top: 5px;" title="The new calculated number of steps/mm for E axe">
New E axe steps/mm
</label>
</div>
<div class="span6">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
{{ snipped.linkToMarlin("M092", "Marlin website") }}
<span class="add-on" title="Command to change number of steps/mm for E axe" data-bind="text: $root.results.newStepsDisplay"></span>
@@ -100,8 +112,8 @@ reliable.
</div>
<div class="row-fluid" style="margin-bottom: 5px;">
<div class="span6"></div>
<div class="span6">
<div data-bind="class: $root.columnLabelCls()"></div>
<div data-bind="class: $root.columnFieldCls()">
<button class="btn btn-primary" data-bind="click: $root.saveESteps, enable: $root.is_admin() && $root.controlViewModel.isOperational() && (!$root.controlViewModel.isPrinting())"
title="Saves the new calculated value of steps/mm on printer EEPROM">
<i class="fas fa-save" data-color="#000000"></i>&nbsp&nbsp
octoprint_CalibrationTools/templates/tabs/tab-pid.jinja2
+31 -20
View File
@@ -1,18 +1,29 @@
{% import "macros.jinja2" as snipped %}
{{ snipped.subSection("Note", true) }}
{{ snipped.subSection("Process description", true) }}
You will have to:
<lu>
<li>Refresh the current values from EEPROM;</li>
<li>Set the hot-end index which you want to tune;</li>
<li>Set the usual temperature used in your prints for that specific hot-end;</li>
<li>Set the usual fan speed used in your prints;</li>
<li>Monitor temperature tab, when it starts to cool down save the results in EEPROM;</li>
<li>For tuning heated bed the index is already set on -1;</li>
</lu>
<br>
{{ snipped.quote("It is recommended to run the tuning with conditions as close to printing as possible. This means filament loaded and the part cooling fan set to your normal speed. It is not essential, but you may
prefer to start this process with the hot end at room temperature.",
"<a href='https://teachingtechyt.github.io/calibration.html#pid' target='_blank'>For more information about how to use this visit teachingtechyt.github.io</a>", "text-warning") }}
{{ snipped.subSection("Current PID values") }}
{{ snipped.subSection("Current PID values", true) }}
<div class="row-fluid">
<div class="span5">
<div data-bind="class: $root.columnLabelCls()">
<label for="hotEndPid" class="pull-right" style="margin-top: 5px;" title="Current hot-end PID">
Current hot-end PID
</label>
</div>
<div class="span7">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append" id="hotEndPid">
<span class="add-on" title="Proportional gain">P</span>
<span class="add-on numberDisplay" title="Proportional gain" data-bind="text: $root.pidCurrentValues.hotEnd.P()"></span>
@@ -24,12 +35,12 @@ prefer to start this process with the hot end at room temperature.",
</div>
</div>
<div class="row-fluid">
<div class="span5">
<div data-bind="class: $root.columnLabelCls()">
<label for="bedPid" class="pull-right" style="margin-top: 5px;" title="Current bed PID">
Current bed PID
</label>
</div>
<div class="span7">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append" id="bedPid">
<span class="add-on" title="Proportional gain">P</span>
<span class="add-on numberDisplay" title="Proportional gain" data-bind="text: $root.pidCurrentValues.bed.P()"></span>
@@ -41,9 +52,9 @@ prefer to start this process with the hot end at room temperature.",
</div>
</div>
<div class="row-fluid">
<div class="span5">
<div data-bind="class: $root.columnLabelCls()">
</div>
<div class="span7">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append" id="bedPid">
<button class="btn" data-bind="click: $root.getCurrentValues, enable: $root.controlViewModel.isOperational() && (!$root.controlViewModel.isPrinting())" title="Load current PIDs">
<i class="fas fa-sync-alt" style="color:false" data-color="false"></i>&nbsp&nbsp
@@ -55,12 +66,12 @@ prefer to start this process with the hot end at room temperature.",
{{ snipped.subSection("Hot-end tuning") }}
<div class="row-fluid">
<div class="span5">
<div data-bind="class: $root.columnLabelCls()">
<label for="fanSpeed" class="pull-right" style="margin-top: 5px;" title="Fan speed">
Turn fan to max
</label>
</div>
<div class="span7">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
{{ snipped.linkToMarlin("M106", "Marlin website") }}
<span class="add-on" title="Command for turning the fan to 100%">M106&nbsp;&nbsp;&nbsp;S</span>
@@ -69,12 +80,12 @@ prefer to start this process with the hot end at room temperature.",
</div>
</div>
<div class="row-fluid">
<div class="span5">
<div data-bind="class: $root.columnLabelCls()">
<label for="tunningPIDNoCycles" class="pull-right" style="margin-top: 5px;" title="x">
Tuning PID
</label>
</div>
<div class="span7">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
{{ snipped.linkToMarlin("M303", "Marlin website") }}
<span class="add-on" title="Command for triggering tool PID tunning">M303&nbsp;&nbsp;&nbsp;C</span>
@@ -90,8 +101,8 @@ prefer to start this process with the hot end at room temperature.",
</div>
<div class="row-fluid" style="margin-bottom: 5px;">
<div class="span5"></div>
<div class="span7">
<div data-bind="class: $root.columnLabelCls()"></div>
<div data-bind="class: $root.columnFieldCls()">
<button class="btn btn-success" data-bind="click: $root.startPidHotEnd, enable: $root.controlViewModel.isOperational() && (!$root.controlViewModel.isPrinting())"
title="This will trigger PID auto tuning (M106 Sx; M303 Ex Sx U1; M500)">
<i class="fas fa-play" style="color:false" data-color="false"></i>&nbsp&nbsp
@@ -102,12 +113,12 @@ prefer to start this process with the hot end at room temperature.",
{{ snipped.subSection("Heated bed tuning") }}
<div class="row-fluid">
<div class="span5">
<div data-bind="class: $root.columnLabelCls()">
<label for="fanSpeed" class="pull-right" style="margin-top: 5px;" title="Fan speed">
Turn fan to max
</label>
</div>
<div class="span7">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
{{ snipped.linkToMarlin("M106", "Marlin website") }}
<span class="add-on" title="Command for turning the fan to 100%">M106&nbsp;&nbsp;&nbsp;S</span>
@@ -116,12 +127,12 @@ prefer to start this process with the hot end at room temperature.",
</div>
</div>
<div class="row-fluid">
<div class="span5">
<div data-bind="class: $root.columnLabelCls()">
<label for="tunningPIDNoCycles" class="pull-right" style="margin-top: 5px;" title="x">
Tuning PID
</label>
</div>
<div class="span7">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
{{ snipped.linkToMarlin("M303", "Marlin website") }}
<span class="add-on" title="Command for triggering bed PID tunning">M303&nbsp;&nbsp;&nbsp;C</span>
@@ -137,8 +148,8 @@ prefer to start this process with the hot end at room temperature.",
</div>
<div class="row-fluid" style="margin-bottom: 5px;">
<div class="span5"></div>
<div class="span7">
<div data-bind="class: $root.columnLabelCls()"></div>
<div data-bind="class: $root.columnFieldCls()">
<button class="btn btn-success" data-bind="click: $root.startPidBed, enable: $root.controlViewModel.isOperational() && (!$root.controlViewModel.isPrinting())"
title="This will trigger PID auto tuning (M303 E-1 Sx U1; M500)">
<i class="fas fa-play" style="color:false" data-color="false"></i>&nbsp&nbsp
octoprint_CalibrationTools/templates/tabs/tab-xyz.jinja2
+26 -16
View File
@@ -1,13 +1,23 @@
{% import "macros.jinja2" as snipped %}
{{ snipped.subSection("Process description", true) }}
You will have to:
<lu>
<li>Print a <a href="https://www.thingiverse.com/thing:1278865" target="_blank">test cube</a> with a known size on all three axes X,Y,X;</li>
<li>Refresh the current values from EEPROM;</li>
<li>Feed data collected in E-Steps tab and save the results in EEPROM;</li>
</lu>
<br>
{{ snipped.quote("This step is not necessary for many people, but is still worth doing if you are going over the machine in detail. Consider this procedure necessary if your printed parts are clearly over or under
sized.","<a href='https://teachingtechyt.github.io/calibration.html#xyzsteps' target='_blank'>teachingtechyt.github.io</a>", "text-warning") }}
{{ snipped.subSection("X-Y-Z Steps", true) }}
<div class="row-fluid">
<div class="span3">
<label for="tunningPIDNoCycles" class="pull-right" style="margin-top: 5px;" title="x">
<div data-bind="class: $root.columnLabelCls()">
<label for="tunningPIDNoCycles" class="pull-right" style="margin-top: 5px; white-space: nowrap;" title="x">
Current values
</label>
</div>
<div class="span9">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
{{ snipped.linkToMarlin("M092", "Marlin website") }}
<span class="add-on" title="">M92&nbsp;&nbsp;&nbsp;X</span>
@@ -24,12 +34,12 @@
</div>
</div>
<div class="row-fluid">
<div class="span3">
<label for="tunningPIDNoCycles" class="pull-right" style="margin-top: 5px;" title="x">
GCode cube size
<div data-bind="class: $root.columnLabelCls()">
<label for="tunningPIDNoCycles" class="pull-right" style="margin-top: 5px; white-space: nowrap;" title="">
GCode sizes
</label>
</div>
<div class="span9">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
<span class="add-on" title="">X</span>
<input type="number" id="" class="input-small numberDisplay" step="0.001" min="0" max="100" title="" data-bind="value: $root.eStepsXYZ.gCodeCubeSize.X">
@@ -42,12 +52,12 @@
</div>
</div>
<div class="row-fluid">
<div class="span3">
<label for="tunningPIDNoCycles" class="pull-right" style="margin-top: 5px;" title="x">
Printed cube size
<div data-bind="class: $root.columnLabelCls()">
<label for="tunningPIDNoCycles" class="pull-right" style="margin-top: 5px; white-space: nowrap;" title="">
Printed sizes
</label>
</div>
<div class="span9">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
<span class="add-on" title="">X</span>
<input type="number" id="" class="input-small numberDisplay" step="0.001" min="0" max="100" title="" data-bind="value: $root.eStepsXYZ.printedCubeSize.X">
@@ -60,12 +70,12 @@
</div>
</div>
<div class="row-fluid">
<div class="span3">
<label for="tunningPIDNoCycles" class="pull-right" style="margin-top: 5px;" title="x">
<div data-bind="class: $root.columnLabelCls()">
<label for="tunningPIDNoCycles" class="pull-right" style="margin-top: 5px; white-space: nowrap;" title="">
New values
</label>
</div>
<div class="span9">
<div data-bind="class: $root.columnFieldCls()">
<div class="input-prepend input-append">
{{ snipped.linkToMarlin("M092", "Marlin website") }}
<span class="add-on" title="">M92&nbsp;&nbsp;&nbsp;X</span>
@@ -79,8 +89,8 @@
</div>
</div>
<div class="row-fluid" style="margin-bottom: 5px;">
<div class="span3"></div>
<div class="span9">
<div data-bind="class: $root.columnLabelCls()"></div>
<div data-bind="class: $root.columnFieldCls()">
<button class="btn btn-success" data-bind="click: $root.saveEStepsXYZ, enable: $root.saveEStepsXYZActive() && $root.controlViewModel.isOperational() && (!$root.controlViewModel.isPrinting())"
title="This will save new values to EEPROM (M92 Xx Yx Zx; M500)">
<i class="fas fa-save" style="color:false" data-color="false"></i>&nbsp&nbsp