diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2021-06-11 23:02:05 -0400 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2021-06-11 23:04:30 -0400 |
| commit | d1665fae4f48519198fcd430d5fc18f17aee4e77 (patch) | |
| tree | 9e69e58cf6a8eb159c66250af8e9651edb2aa90e /docs | |
| parent | acdad7640809fbfdfae45394f0301f08ceab3115 (diff) | |
| download | kutter-d1665fae4f48519198fcd430d5fc18f17aee4e77.tar.gz kutter-d1665fae4f48519198fcd430d5fc18f17aee4e77.tar.xz kutter-d1665fae4f48519198fcd430d5fc18f17aee4e77.zip | |
docs: Update Code_Overview.md with the removal of calc_tag_position()
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Code_Overview.md | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/docs/Code_Overview.md b/docs/Code_Overview.md index 167b7c18..2b35688f 100644 --- a/docs/Code_Overview.md +++ b/docs/Code_Overview.md @@ -447,17 +447,16 @@ but does not include moves on the look-ahead queue. One may use the `toolhead.flush_step_generation()` or `toolhead.wait_moves()` calls to fully flush the look-ahead and step generation code. -The "kinematic" position (`stepper.set_tag_position()` and -`kin.calc_tag_position()`) is the cartesian position of the toolhead -as derived from the "stepper" position and is relative to the -coordinate system specified in the config file. This may differ from -the requested cartesian position due to the granularity of the stepper -motors. If the robot is in motion when `stepper.set_tag_position()` is -issued then the reported value includes moves buffered on the -micro-controller, but does not include moves on the look-ahead -queue. One may use the `toolhead.flush_step_generation()` or -`toolhead.wait_moves()` calls to fully flush the look-ahead and step -generation code. +The "kinematic" position (`kin.calc_position()`) is the cartesian +position of the toolhead as derived from "stepper" positions and is +relative to the coordinate system specified in the config file. This +may differ from the requested cartesian position due to the +granularity of the stepper motors. If the robot is in motion when the +"stepper" positions are taken then the reported value includes moves +buffered on the micro-controller, but does not include moves on the +look-ahead queue. One may use the `toolhead.flush_step_generation()` +or `toolhead.wait_moves()` calls to fully flush the look-ahead and +step generation code. The "toolhead" position (`toolhead.get_position()`) is the last requested position of the toolhead in cartesian coordinates relative |