diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2018-01-12 18:38:49 -0500 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2018-01-12 18:38:49 -0500 |
| commit | 054cbbe094afc31ddd344f87f64ce3c035461e6e (patch) | |
| tree | 709868d8287693cf70edab7eba2d3ecce8d311c2 | |
| parent | 0d8ddcadbbbbe059559618db56a88d3e06d578e9 (diff) | |
| download | kutter-054cbbe094afc31ddd344f87f64ce3c035461e6e.tar.gz kutter-054cbbe094afc31ddd344f87f64ce3c035461e6e.tar.xz kutter-054cbbe094afc31ddd344f87f64ce3c035461e6e.zip | |
docs: Add a FAQ item on steps to upgrade the software
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
| -rw-r--r-- | docs/FAQ.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/FAQ.md b/docs/FAQ.md index 22c60842..3b0768a2 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -10,6 +10,7 @@ Frequently asked questions 7. [Why is the Z position_endstop set to 0.5 in the default configs?](#why-is-the-z-position_endstop-set-to-05-in-the-default-configs) 8. [I converted my config from Marlin and the X/Y axes work fine, but I just get a screeching noise when homing the Z axis](#i-converted-my-config-from-marlin-and-the-xy-axes-work-fine-but-i-just-get-a-screeching-noise-when-homing-the-z-axis) 9. [When I set "restart_method=command" my AVR device just hangs on a restart](#when-i-set-restart_methodcommand-my-avr-device-just-hangs-on-a-restart) +10. [How do I upgrade to the latest software?](#how-do-i-upgrade-to-the-latest-software) ### How do I calculate the step_distance parameter in the printer config file? @@ -191,3 +192,38 @@ flash an updated bootloader to the AVR device. Flashing a new bootloader is a one time step that typically requires an external programmer - search the web to find the instructions for your particular device. + +### How do I upgrade to the latest software? + +The general way to upgrade is to ssh into the Raspberry Pi and run: + +``` +cd ~/klipper +git pull +~/klipper/scripts/install-octopi.sh +``` + +Then one can recompile and flash the micro-controller code. For +example: + +``` +sudo service klipper stop +make flash FLASH_DEVICE=/dev/ttyACM0 +sudo service klipper start +``` + +However, it's often the case that only the host software changes. In +this case, one can update and restart just the host software with: + +``` +cd ~/klipper +git pull +sudo service klipper restart +``` + +If after using this shortcut the software warns about needing to +reflash the micro-controller or some other unusual error occurs, then +follow the full upgrade steps outlined above. Note that the RESTART +and FIRMWARE_RESTART g-code commands do not load new software - the +above "sudo service klipper restart" and "make flash" commands are +needed for a software change to take effect. |