aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* pwmcmds: Export the maximum PWM valueKevin O'Connor2017-05-151-4/+4
| | | | | | | Instead of assuming the maximum PWM value is 255, export a constant from the firmware to the host with the maximum value. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note version 0.4.0 releaseKevin O'Connor2017-05-031-0/+20
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Make it clear a RESTART is likely needed in Installation documentKevin O'Connor2017-05-031-8/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend users stop klipper before flashing the micro-controllerKevin O'Connor2017-05-011-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Reword XY+Z delta moves in KinematicsKevin O'Connor2017-05-011-4/+5
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Use only single space at start of new sentenceKevin O'Connor2017-05-016-23/+23
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Reword smoothed look-ahead description in KinematicsKevin O'Connor2017-05-012-12/+15
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Improve wording of slow lookahead descriptionKevin O'Connor2017-04-271-3/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Improve documentation for those starting in docs/Kevin O'Connor2017-04-273-16/+30
| | | | | | | | Those that reach Klipper via github may jump directly to the docs/ directory in search of documentation. Add README.md and rework Overview.md with that in mind. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Avoid using "firmware" in the documentationKevin O'Connor2017-04-278-455/+466
| | | | | | | | 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: Add backticks around commands in Firmware CommandsKevin O'Connor2017-04-271-59/+60
| | | | 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: Update Firmware Commands document with an integer exampleKevin O'Connor2017-04-271-1/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Use a markdown link to docs/prints/square.stlKevin O'Connor2017-04-271-7/+7
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Kinematics document image updatesKevin O'Connor2017-04-2712-48/+304
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Todo updatesKevin O'Connor2017-04-271-7/+0
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Reword alternate linux machine in installation instructionsKevin O'Connor2017-04-241-4/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Remove "experimental" from descriptionsKevin O'Connor2017-04-242-4/+3
| | | | | | | The Klipper software has progressed to the point where it does not need to be described as "experimental" software. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Installation updatesKevin O'Connor2017-04-241-55/+45
| | | | | | Recommend using 'make flash' and clean up the octoprint instructions. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* build: Add workaround to suppress broken avr-gcc "misspelled" warningsKevin O'Connor2017-04-241-3/+0
| | | | | | | Detect avr gcc v4.8.1 and then disable warnings during the klipper.o linking to suppress bogus "misspelled signal handler" warnings. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* scripts: Add octopi installation scriptsKevin O'Connor2017-04-211-36/+16
| | | | | | | | Add a system startup script so that Klipper can automatically start at boot time. Create an installation script that will install the system dependencies and the startup script. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* gcode: Ignore M21 commandKevin O'Connor2017-04-201-3/+0
| | | | | | | No need to recommend users disable "SD card support" in octoprint - instead, just ignore the M21 command. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Reword parts of the pressure advance kinematics description.Kevin O'Connor2017-04-193-42/+86
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Misc image updatesKevin O'Connor2017-04-196-24/+98
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add info on delta acceleration limitsKevin O'Connor2017-04-191-1/+17
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add initial Pressure Advance tuning documentKevin O'Connor2017-04-198-7/+324
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Todo - initial kinematic document writtenKevin O'Connor2017-04-151-3/+0
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Updates to Features documentKevin O'Connor2017-04-151-7/+12
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add initial Kinematics documentKevin O'Connor2017-04-1527-3/+2324
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* queuelogger: Automatically roll log fileKevin O'Connor2017-04-141-3/+0
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Todo - RPi power over USB now implementedKevin O'Connor2017-04-131-5/+0
| | | | 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>
* hub-ctrl: Add support for micro-controller reset via RPi usb power togglingKevin O'Connor2017-04-131-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Features document with latest performance benchmarksKevin O'Connor2017-04-111-4/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add documentation on how to run the graphstats.py scriptKevin O'Connor2017-04-111-0/+23
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Debugging.md file with python virtual env setupKevin O'Connor2017-04-111-9/+3
| | | | | | | | Direct readers to the main Installation file to setup the python virtual environment and remove the outdated instructions in the Debugging file. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Firmware_Commands with recent end stop changesKevin O'Connor2017-04-111-4/+4
| | | | 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>
* corexy: Initial corexy kinematic implementationKevin O'Connor2017-04-031-1/+1
| | | | | | Add initial support for corexy kinematics. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update benchmark results in Features documentKevin O'Connor2017-03-311-3/+3
| | | | 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>
* docs: Update benchmark results in Features documentKevin O'Connor2017-03-261-3/+3
| | | | | | | Some additional tweeks to the scheduler has resulted in minor improvements to the stepper benchmarks. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* mcu: Support config mechanism for translating seconds to clock ticksKevin O'Connor2017-03-131-1/+5
| | | | | | | Introduce a TICKS() macro during config parsing that will translate time in seconds to time in clock ticks. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>