3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add get_status() to list of kinematics methods in Code_Overview.md 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2019-11-12 22:47:10 -05:00
parent e532b75e21
commit 0bf4ab66da
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/Code_Overview.md
View File

@ -335,10 +335,11 @@ Useful steps:
coordinates from the current position of each stepper. It does not coordinates from the current position of each stepper. It does not
need to be efficient as it is typically only called during homing need to be efficient as it is typically only called during homing
and probing operations. and probing operations.
5. Other methods. Implement the `check_move()`, `home()`, 5. Other methods. Implement the `check_move()`, `get_status()`,
`set_position()`, and `get_steppers()` methods. These functions are `get_steppers()`, `home()`, and `set_position()` methods. These
typically used to provide kinematic specific checks. However, at functions are typically used to provide kinematic specific
the start of development one can use boiler-plate code here. 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 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 that can test important cases for the given kinematics. Follow the
[debugging documentation](Debugging.md) to convert this g-code file [debugging documentation](Debugging.md) to convert this g-code file