aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* build: Define DECL_CONSTANT mechanism for defining exported constantsKevin O'Connor2016-12-231-2/+15
| | | | | | | | | Add a DECL_CONSTANT macro to allow the firmware to define constants that are to be exported to the host during the "identify" phase. This replaces the existing hardcoded mechanism of scanning the Kconfig header file for certain constants. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add an example to the description of the message block contentsKevin O'Connor2016-12-221-24/+33
| | | | | | | | Use a more real-world example to improve the description of message block contents. Make it more clear that the data dictionary contains and utilizes the full command descriptions. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update protocol document to highlight its "compression" systemKevin O'Connor2016-12-211-10/+31
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor wording change to protocol documentKevin O'Connor2016-12-211-3/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor updates to protocol documentKevin O'Connor2016-12-211-11/+12
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update installation documentKevin O'Connor2016-12-211-7/+26
| | | | | | | | | | Various installation updates. Recommend upgrade to OctoPrint v1.3.0. Recommend configuring OctoPrint to not disconnect on error. Note quirk with needing to reload page if "/tmp/printer" not in list of serial connections. Add brief documentation on use of extended commands and checking for errors. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a features documentKevin O'Connor2016-12-202-1/+87
| | | | | | Add a document describing some high-level features in Klipper. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend latest version of pyserial in installation instructionsKevin O'Connor2016-12-091-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor updates to wording of some documentsKevin O'Connor2016-12-013-16/+15
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* gcode: Add support for CLEAR_SHUTDOWN commandKevin O'Connor2016-12-011-10/+0
| | | | | | Add ability to clear the MCU shutdown flag from the console. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* gcode: Support parsing of "extended" gcode commandsKevin O'Connor2016-11-301-5/+0
| | | | | | | | | | Support human readable commands (eg, "help"). Add a "help" command to list these extended commands. Also, add support for declaring command aliases, command help, and command availability next to the handlers themselves. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* klippy: Validate that options in the config file existKevin O'Connor2016-11-301-12/+4
| | | | | | | | Check that all options specified in the config file are valid. This catches possible typos and spelling errors in variable names that have a default. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* pyhelper: Add ability to route error messages to python loggingKevin O'Connor2016-11-302-3/+1
| | | | | | | Instead of writing error messages to stderr, route them into the python code and use the standard python logging system. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* reactor: Add support for greenletsKevin O'Connor2016-11-291-1/+1
| | | | | | | Add support for greenlets - a mechanism for tasks that can pause while still allowing regular reactor events to occur. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* homing: Verify the endstops are no longer triggered after retract moveKevin O'Connor2016-11-181-2/+0
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* homing: Check for timeout during homing operationKevin O'Connor2016-11-181-3/+0
| | | | | | | | Should a homing move complete without hitting the endstop, then disable motors, disable the endstop checking, and report the error to the user. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* delta: Initial support for linear delta kinematicsKevin O'Connor2016-11-141-1/+1
| | | | | | This adds support for delta based robots. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* queuelogger: Add support for background log writingKevin O'Connor2016-11-121-2/+4
| | | | | | | | | | | | | | Writing to the debug log can cause an unbounded delay due to disk IO. This is particularly so on embedded machines such as the Raspberry Pi that run on SD cards. These log writing delays can cause problems for the main processing threads. The new "queuelogger" code forwards all the main thread log messages to a queue, and a background thread writes the log messages from the queue to the destination file. This eliminates the IO delay from the main threads. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* extruder: Don't do pressure advance on velocity changes due to corneringKevin O'Connor2016-11-051-7/+0
| | | | | | | | | | | | | Due to the lookahead, small changes in the direction of the toolhead cause minor changes in toolhead velocity. These "cornering" velocity changes cause the current extruder code to trigger pressure advance and its associated pressure retract. This causes the extruder to rapidly "jerk" the filament. This code change updates the extruder to detect velocity changes due solely to cornering and avoid pressure advance. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add information on the "move queue" to Firmware_CommandsKevin O'Connor2016-11-021-3/+15
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* mcu: Remove python checks for stepcompress integer overflowKevin O'Connor2016-11-021-3/+1
| | | | | | | Now that the C code checks for overflow, it is no longer necessary for the python code to check. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Todo updatesKevin O'Connor2016-10-191-30/+42
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Firmware_Commands.md with information on common firmware commandsKevin O'Connor2016-10-192-1/+271
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Protocol.md with information on host / firmware communicationKevin O'Connor2016-10-192-0/+299
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add todo list to documentationKevin O'Connor2016-10-122-0/+158
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Clarification of some installation and config stepsKevin O'Connor2016-09-151-1/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Describe running Klippy in batch mode for debuggingKevin O'Connor2016-09-101-0/+42
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Installation.md - Arduino Due is also supportedKevin O'Connor2016-07-281-1/+2
| | | | | | | Update the document introduction to note that the Arduino Due is also now supported. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: ARM updates for Code_Overview.mdKevin O'Connor2016-07-261-22/+35
| | | | | | | | Some details on the code flow and organization have changed since support for ARM processors was added. Update Code_Overview.md accordingly. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update documentation with Arduino Due installation infoKevin O'Connor2016-06-141-3/+18
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Change the debugging docs to recommend a serial baud rate of 250000Kevin O'Connor2016-06-131-6/+5
| | | | | | | A baud of 250000 is a better choice for production use. It's better to test with that rate also. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* Initial commit of source code.Kevin O'Connor2016-05-254-0/+309
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 10:41:42 +0000