aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Code_Overview.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2018-06-22 13:03:07 -0400
committerKevin O'Connor <kevin@koconnor.net>2018-06-22 14:09:01 -0400
commit890298d34d76923e895ff7905b9dbe374035e694 (patch)
treecdc5590ef88c62b76f5fb0543c12d2cbe267edf2 /docs/Code_Overview.md
parent0216201cb6b9b486a75e446ca1cb2bbd18f329d7 (diff)
downloadkutter-890298d34d76923e895ff7905b9dbe374035e694.tar.gz
kutter-890298d34d76923e895ff7905b9dbe374035e694.tar.xz
kutter-890298d34d76923e895ff7905b9dbe374035e694.zip
itersolve: Support setting the stepper position via a cartesian coordinate
Add support for an itersolve_set_position() function that sets a stepper position from a cartesian coordinate. This eliminates the need for both the python and C code to be able to translate from a cartesian coordinate to a stepper position. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Code_Overview.md')
-rw-r--r--docs/Code_Overview.md16
1 files changed, 6 insertions, 10 deletions
diff --git a/docs/Code_Overview.md b/docs/Code_Overview.md
index 1bb883f4..64d54c28 100644
--- a/docs/Code_Overview.md
+++ b/docs/Code_Overview.md
@@ -319,19 +319,15 @@ Useful steps:
seconds) to a cartesian coordinate (in millimeters), and then
calculate the desired stepper position (in millimeters) from that
cartesian coordinate.
-4. Implement the `set_position()` method in the python code. This also
- calculates the desired stepper positions given a cartesian
- coordinate.
-5. Implement the `calc_position()` method in the new kinematics class.
+4. Implement the `calc_position()` method in the new kinematics class.
This method is the inverse of set_position(). It does not need to
be efficient as it is typically only called during homing and
probing operations.
-6. Implement the `move()` method. This method generally invokes the
- iterative solver for each stepper.
-7. Other methods. The `home()`, `check_move()`, and other methods
- should also be implemented. However, at the start of development
- one can use empty code here.
-8. Implement test cases. Create a g-code file with a series of moves
+5. Other methods. The `move()`, `home()`, `check_move()`, and other
+ methods should also be implemented. These functions are typically
+ used to provide kinematic specific checks. However, at the start of
+ development one can use boiler-plate code here.
+6. Implement test cases. Create a g-code file with a series of moves
that can test important cases for the given kinematics. Follow the
[debugging documentation](Debugging.md) to convert this g-code file
to micro-controller commands. This is useful to exercise corner