aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: Note the use of the virtual_sdcard featureKevin O'Connor2018-03-022-6/+21
| | | | | | Note that virtual_sdcard helps on slower machines. 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: Update Config_checks.mdDave Bacon2018-02-071-1/+1
| | | | | | Navigation should be to the temperature tab to find the Tool temperature box. Signed-off-by: Dave Bacon <drb.github@mrbacon.com>
* docs: Add github issue templateKevin O'Connor2018-01-311-0/+2
| | | | | | Add an issue template requesting the klippy log file. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Remove bed level probe from todoKevin O'Connor2018-01-281-2/+0
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Try to make the klippy.log bug reporting more clearKevin O'Connor2018-01-212-15/+15
| | | | | | | Emphasize that the log file needs to be attached to the issue. Encourage M112 to be issued on every bug report. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a FAQ item on steps to upgrade the softwareKevin O'Connor2018-01-121-0/+36
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Debugging.md with information on logextractKevin O'Connor2018-01-111-5/+28
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stepper: Automatically detect and handle shared stepper enable linesKevin O'Connor2018-01-101-2/+0
| | | | | | | | | | | It's common for multiple steppers to use the same stepper enable line. Detect this and only create a single digital_out oid on the micro-controller. Also, prohibit any other pin from being used multiple times in the config file. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note pressure_advance over 0.20 is unlikely to improve qualityKevin O'Connor2018-01-081-1/+4
| | | | | | | Update the pressure advance tuning document to note that 0.20 is likely the ceiling of a useful pressure advance setting. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a table of contents to the FAQKevin O'Connor2018-01-051-2/+12
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update installation document with pointers to FAQKevin O'Connor2018-01-042-27/+73
| | | | | | Add some pointers to the FAQ for common pitfalls during installation. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor update to square.scadKevin O'Connor2018-01-022-29/+29
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add an initial configuration checklist documentKevin O'Connor2017-12-264-2/+133
| | | | | | | Provide a document with basic steps that a user can run to verify that the pins in the configuration file are set correctly. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a CONTRIBUTING documentKevin O'Connor2017-12-242-0/+75
| | | | | | | Add an initial document detailing best practices for contributing to the document. Add the "developer certificate of origin" document. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Offer alternatives to ssh/scp/sftpKevin O'Connor2017-12-212-46/+63
| | | | | | | | Try to make the Installation document more friendly to users not familiar with the Linux command-line. Offer some hints on how to obtain ssh and how to edit the config file remotely. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update square test print to contain notches on inside of squareKevin O'Connor2017-12-172-84/+449
| | | | | | | Add additional notches and move them to the inside of the square where they will not impact the outside perimeter test. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add FAQ item on AVR watchdog restart failuresKevin O'Connor2017-12-111-0/+15
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Provide additional information on "make flash" failuresKevin O'Connor2017-12-111-0/+23
| | | | | | Add some additional information on "make flash" problems. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a FAQ documentKevin O'Connor2017-11-303-2/+108
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add further details on how to report a bugKevin O'Connor2017-11-211-3/+10
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note version 0.5.0 releaseKevin O'Connor2017-10-251-0/+20
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Installation document to recommend latest octoprint versionKevin O'Connor2017-10-251-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* gpiocmds: Allow the start value for a pin to differ from the default_valueKevin O'Connor2017-10-121-21/+21
| | | | | | | | | Allow the start value to be different from the default/shutdown value for the pin. This will be useful for "heater fans" that should startup in the off state, and transition to full on in a shutdown state. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* endstop: Eliminate end_stop_set_oversample commandKevin O'Connor2017-10-121-7/+9
| | | | | | | | | | Pass the sample_ticks and sample_count parameters directly in the end_stop_home command instead. This simplifies the code. Also, simplify calculation of next wakeup time in end_stop_oversample_event(). Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Point to beaglebone.md from the main installation documentKevin O'Connor2017-10-112-7/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Octoprint should not run at a higher priority than Klipper on beagleboneKevin O'Connor2017-10-111-2/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add mailing list to Contact.mdKevin O'Connor2017-10-101-0/+11
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Contact.md file with developer contact informationKevin O'Connor2017-10-103-1/+43
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a notch to the default square.stl test objectKevin O'Connor2017-10-032-14/+128
| | | | | | | | Place a small notch on one side of the square. The notch provides interesting information on the extruder performance, and it makes it easier to compare with previous prints of the object. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Remove items from Todo.mdKevin O'Connor2017-10-011-11/+0
| | | | | | | | Several items were recently implemented. Remove the "cubic vs quadratic" item as investigations into cubic compression weren't promising. 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>
* docs: Reword performance paragraph in Features.mdKevin O'Connor2017-09-271-4/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Features.md document for multiple micro-controllersKevin O'Connor2017-09-261-0/+8
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* chipmisc: Add support for Replicape boardKevin O'Connor2017-09-201-0/+14
| | | | | | | Add support for configuring and controlling the hardware specific to the revision "B3" Replicape board. 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>
* toolhead: Permit look-ahead between Z movesKevin O'Connor2017-09-031-3/+3
| | | | | | | | Extend the look-ahead mechanism to work between moves that contain Z movement. This improves Klipper's handling of g-code produced in "vase mode". 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: Remove documentation for "custom" command blocksKevin O'Connor2017-08-262-20/+3
| | | | | | | | It should no longer be necessary to configure "custom" commands during mcu setup. The ad5206 and static_digital_output config sections should provide similar functionality. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* pru: Compile the irq_poll() function with -O2 optimizationKevin O'Connor2017-08-151-1/+1
| | | | | | | | Compile the PRU binary with -Os optimization, but request that the timer dispatch code be compiled with -O2 optimization. This improves the performance of timers slightly. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* pru: Compile with -Os instead of -O2Kevin O'Connor2017-08-141-1/+1
| | | | | | | The gcc -Os option significantly reduces the size of the PRU binary and it has little impact on performance. 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: Update benchmarks in Features documentKevin O'Connor2017-08-111-5/+11
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Kinematics.md with regards to stepper torque limitsKevin O'Connor2017-07-191-10/+10
| | | | | | | It is not necessary to limit stepper acceleration - only the limiting of stepper torque is important. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Improve description of delta stepper acceleration limitsKevin O'Connor2017-07-191-6/+11
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* pru: Add documentation and install scripts for running on the PRUKevin O'Connor2017-07-051-0/+79
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* avr: Add SIMULAVR build option; don't show WATCHDOG or SERIAL_BAUD_U2XKevin O'Connor2017-05-281-4/+4
| | | | | | | | | | | Add a CONFIG_SIMULAVR option to the Kbuild menus and don't directly prompt users for CONFIG_WATCHDOG or CONFIG_SERIAL_BAUD_U2X. The only reason to disable these options would be if one were running on simulavr. This simplifies the user visible menu options. Also, only show CONFIG_CLEAR_PRESCALER for at90usb1286 chips. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note how to handle odd corner in Pressure_Advance.mdKevin O'Connor2017-05-251-5/+13
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a prerequisites section to Pressure_advance.mdKevin O'Connor2017-05-221-0/+12
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Todo item for supporting custom fan and pin config sectionsKevin O'Connor2017-05-221-0/+6
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>