aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Code_Overview.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Note 'config' object shouldn't be accessed after initial loadKevin O'Connor2025-06-041-0/+5
| | | | | | | | | | Update Code_Overview.md to note that the config object should not be stored after the "config loading phase". Remove a few inadvertent cases where a 'config' object was stored in module member variables. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* force_move: Implement CLEAR for SET_KINEMATIC_POSITION (#6262)Dennis Marttinen2025-01-101-4/+4
| | | | | | | | `CLEAR` clears the homing status (resets the axis limits) without turning off the motors. This is particularly useful when implementing safe Z homing in `[homing_override]` on printers with multiple independent Z steppers (where `FORCE_MOVE` can't be used). Signed-off-by: Dennis Marttinen <twelho@welho.tech>
* toolhead: Rename MoveQueue class to LookAheadQueueKevin O'Connor2024-01-181-17/+19
| | | | | | | Rename this class so that is is not confused with the mcu "move queue". Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor wording update to Code_Overview.mdKevin O'Connor2022-05-171-3/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Code_Overview.md with more realistic task timing guidelinesKevin O'Connor2022-05-171-3/+6
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add low-level MMIO coding hints to Code_Overview.mdKevin O'Connor2021-11-221-2/+16
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor example change in Code_Overview.mdKevin O'Connor2021-11-161-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add recommendation on Python type handling to Code_Overview.mdKevin O'Connor2021-11-161-0/+10
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Code_Overview.md with information on get_status()Kevin O'Connor2021-11-161-0/+11
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update documentation with new klipper github URLKevin O'Connor2021-09-231-5/+5
| | | | | | | | The main code repository moved from https://github.com/KevinOConnor/klipper.git to https://github.com/Klipper3d/klipper.git . Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stepper: Query the stepper mcu position during startupKevin O'Connor2021-08-061-5/+4
| | | | | | | | Try to keep the host mcu_position synchronized with the micro-controller by querying during startup and after every homing event. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Use hash marks for header linesKevin O'Connor2021-07-271-18/+9
| | | | | | Consistently use leading hash marks (#) to note section headers. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs : make modifications to all md files to make them compatible with mkdocsDamien2021-07-271-9/+11
| | | | | | | | all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
* docs: Update Code_Overview.md with the removal of calc_tag_position()Kevin O'Connor2021-06-111-11/+10
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stepper: Remove set_tag_position() codeKevin O'Connor2021-05-291-6/+5
| | | | | | Have callers store the stepper positions in a dict. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* gcode_move: Move GCodeMove class from gcode.py to new extras moduleKevin O'Connor2020-08-201-6/+7
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* gcode: Split G0/G1 command handling to new gcode_move classKevin O'Connor2020-08-201-3/+3
| | | | | | | | Split up the main GCodeParser class into GCodeDispatch and GCodeMove classes. The GCodeMove class is now available using the "gcode_move" printer object name. This split simplifies the gcode.py code. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor updates to Code_Overview.mdKevin O'Connor2020-03-021-14/+14
| | | | | | Minor indentation change. Update for change to stepcompress_append(). Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix another typo in Code_Overview.mdKevin O'Connor2019-12-041-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix typo in Code_Overview.mdKevin O'Connor2019-12-041-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor "coordinate system" wording change to Code_Overview.mdKevin O'Connor2019-12-041-16/+16
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add information on coordinate systems to Code_Overview.mdKevin O'Connor2019-12-041-0/+87
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stepper: Add get/set_tag_position() and convert calc_position()Kevin O'Connor2019-11-131-5/+6
| | | | | | | | | Rename calc_position() to calc_tag_position() and have it calculate the value of the position from the last stepper set_tag_position() call. This enables the calc_tag_position() code to be more flexible as it can be run with arbitrary positions. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add get_status() to list of kinematics methods in Code_Overview.mdKevin O'Connor2019-11-121-4/+5
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stepper_enable: Move motor_off() logic to stepper_enable.pyKevin O'Connor2019-11-121-4/+3
| | | | | | | | Directly disable all the stepper motors on a global motor_off() from the StepperEnable() class in stepper_enable.py. This simplifies the toolhead and kinematic classes. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Code_Overview.md with new trapq systemKevin O'Connor2019-11-071-39/+39
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor micro-controller updates to Code_Overview.mdKevin O'Connor2019-11-071-6/+7
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix typo in Code_Overview.mdKevin O'Connor2019-08-091-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Code_Overview.md with removal of printer_state() callbackKevin O'Connor2019-01-081-11/+21
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* sam3: Rename src/sam3x8e to src/sam3Kevin O'Connor2019-01-071-11/+10
| | | | | | | This is in preparation for merging sam3 and sam4 code into one directory. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor update to Code_Overview.md with further kinematics infoKevin O'Connor2018-11-171-18/+20
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a section with micro-controller porting tips to Code_Overview.mdKevin O'Connor2018-07-111-0/+53
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor updates to Code_Overview.mdKevin O'Connor2018-07-031-12/+13
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* itersolve: Support setting the stepper position via a cartesian coordinateKevin O'Connor2018-06-221-10/+6
| | | | | | | | | 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>
* delta: Rename get_position() to calc_position()Kevin O'Connor2018-06-221-4/+4
| | | | | | | | Calculating the cartesian position from the stepper positions can be complex and cpu intensive, so rename it to calc_position() to be more descriptive. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update documentation with iterative solver changesKevin O'Connor2018-06-201-85/+49
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* chelper: Move the host C code to a new klippy/chelper/ directoryKevin O'Connor2018-04-301-27/+29
| | | | | | | Move the C code out of the main klippy/ directory and into its own directory. This reduces the clutter in the main klippy directory. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix internal link description in Code_Overview.mdKevin O'Connor2018-04-231-2/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a section on adding new host modules to Code_Overview.mdKevin O'Connor2018-03-281-1/+73
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add tips for porting to new kinematics to Code_Overview.mdKevin O'Connor2018-02-171-0/+86
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a section on time handling to Code_Overview.mdKevin O'Connor2017-09-271-0/+64
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stepcompress: Implement print time to clock conversion in C codeKevin O'Connor2017-09-191-9/+8
| | | | | | | Implement the conversion from print_time to the local mcu's clock within the C code. This simplifies the python code. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Code_Overview.md - step compress queue no longer 64 bitKevin O'Connor2017-08-311-4/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Code_Overview.md with PRU and command_dispatch() changesKevin O'Connor2017-08-111-11/+14
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Avoid using "firmware" in the documentationKevin O'Connor2017-04-271-3/+3
| | | | | | | | The term "firmware" is ambiguous - it could refer to the entire project (host and micro-controller software) or to just the micro-controller software. Avoid the term in the documentation. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Use "look-ahead" instead of "lookahead" in Code OverviewKevin O'Connor2017-04-271-3/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add initial Kinematics documentKevin O'Connor2017-04-151-1/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Reword and reformat parts of move code flow in Code_OverviewKevin O'Connor2017-04-131-55/+63
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Code Overview document with code flow for a typical moveKevin O'Connor2017-04-101-0/+94
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* sched: Move timer dispatch loop to board codeKevin O'Connor2017-03-301-3/+3
| | | | | | | | Rename sched_timer_kick() to sched_timer_dispatch() and move its loop into its callers in the board code. This eliminates the need to export timer_try_set_next() from the board code. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
generated by cgit v1.2.3-70-g09d2 (git 2.50.1) at 2025-09-02 18:26:49 +0000