You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-12Lines changed: 21 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
This plugin creates a model of the work surface (using the least squares method on user provided points), allowing for leveling of machines through gcode that otherwise cannot be leveled (e.g. for a grbl machine). A user just needs to measure some z values at a variety of x and y values (e.g. with the paper test), then configure a couple of settings, and the plugin will handle the leveling on file upload.
4
4
5
+
This plugin really only makes sense it you have no other way of leveling out stuff (i.e. your firmware doesn't offer that feature). Also note, that the plugin will stop leveling upon a `G91` command.
6
+
5
7
## Setup
6
8
7
9
Install via the bundled [Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)
@@ -14,19 +16,26 @@ or manually using this URL:
14
16
15
17
## Configuration
16
18
17
-
The Polynomial Degree determines how detailed and curvy the model of the surface will be.
18
-
The degree should be kept as low as possible to avoid issues between test points.
19
+
+ The polynomial degree settings determine how many curves you can have in each direction.
20
+
- For example:
21
+
* A degree of 0 will just be a flat constant height.
22
+
* A degree of 1 will be a sloped line (in each direction so a setting of x:1 y:1 could handle a slightly tilted surface).
23
+
* A degree of 2 will curve down and up.
24
+
- If you are just worried about a bit of sag on an axis then something like a degree of 2 would make sense. If you use too large of a degree, like 10 in each direction with only 5 points, then the model of the surface will really closely match at your entered points, but it will be so curvy that it will be useless between the points.
25
+
* Start with a smaller degree (e.g. 1 or 2)
26
+
* Adjust existing points if you are having issues at the places you measured
27
+
* or consider increasing the degree by 1
28
+
* Add points between existing values if you are having issues in that area
29
+
30
+
+ The minimum and maximum z values are safeguards against bad combinations of gcode and configuration that would spit out positions outside of machines range.
31
+
- If the plugin detects that a movement would fall outside this range, then the file upload will display an error and you should consider changing the configuration.
19
32
20
-
The Minimum and Maximum z values are used to check for positions that could damage your machine.
21
-
These values should be safe to move to with a <code>G0</code> command.
22
-
If the plugin detects that a movement would fall outside this range, then the file upload will display an error and you should consider changing the configuration.
33
+
+ The invert setting is not needed by most normal configurations, and should be left disabled.
34
+
- In my specific setup, I have a G0 Z0 sent to the printer place my toolhead as high as it can go, and a G0 Z71 takes the toolhead right to the surface. With this setting enabled, I can have the gcode files I upload to OctoPrint say that a Z of 0 is right on the surface and a z of 10 is 10 mm above it.
23
35
24
-
The invert option determines how the original positions and the gcode positions should be combined.
25
-
If you want positive gcode values to move the toolhead up and the toolhead is at the work surface at a negative, then do not enable the invert option.
26
-
If positive movement moves the toolhead down, but you want a positive value in the gcode to move up then enable the invert option.
27
36
28
-
The Line break up option breaks up long moves into shorter ones that follow the height model.
29
-
Set the distance to 0.0 to disable this feature; otherwise, all moves longer than the specified length will be broken into smaller moves.
37
+
+The segment length option breaks up long moves into shorter ones that follow the height model at each of the endpoints.
38
+
-Set the distance to 0.0 to disable this feature; otherwise, all moves longer than the specified length will be broken into smaller moves.
30
39
31
-
The calibration points are used to create a model of the surface.
32
-
Enter the x and y coordinate, then the observed z coordinate.
40
+
+The calibration points are used to create a model of the surface.
41
+
-Enter the x and y coordinate, then the measured z coordinate.
The Minimum and Maximum z values are used to check for positions that could damage your machine.
11
-
These values should be safe to move to with a <code>G0</code> command.
12
-
If the plugin detects that a movement would fall outside this range, then the file upload will display an error and you should consider changing the configuration.
The Line break up option breaks up long moves into shorter ones that follow the height model.
21
-
Set the distance to 0.0 to disable this feature; otherwise, all moves longer than the specified length will be broken into smaller moves.
6
+
See <ahref="https://github.com/Willmac16/OctoPrint-GcodeLeveling#Configuration">The Configuration section</a> for more info about configuring this plugin.
22
7
</span>
23
8
</div>
24
9
<div>
@@ -42,13 +27,19 @@
42
27
</div>
43
28
</div>
44
29
<div>
45
-
<spanclass="help-inline">{{ _('Invert addition of original position')}}</span>
30
+
<spanclass="help-inline">{{ _('Invert GCODE File position addition')}}</span>
0 commit comments