Skip to content

Commit

Permalink
Add section about quirks
Browse files Browse the repository at this point in the history
  • Loading branch information
dalegaard committed Jan 26, 2023
1 parent 6ba09f4 commit 20ee7b4
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,26 @@ After generating a config, one can use this in other commands like so:
$ ./klipper_estimator --config_file config.json estimate ...
```

### Quirks

Be aware of the following "quirks" when using `klipper_estimator` compared to Klipper itself:

#### Relative extrusion by default

`klipper_estimator` assumes _relative_ extrusion and _absolute_ movement by
default. This is different from Klipper, which assumes _absolute_ extrusion as
well. This difference exists because `klipper_estimator` can't see inside
macros. Most users use relative extrusion, and put the M83 command in their
print start macro, making it invisible to `klipper_estimator`.

If you wish to use _absolute_ extrusion, you must ensure that an `M82` command
is inserted in your slicer start gcode. E.g.:

```
PRINT_START
M82
```

### `estimate` mode

Estimation mode is useful for determining statistics about a print, in order to
Expand Down

0 comments on commit 20ee7b4

Please sign in to comment.