From 76138fde5c91f27527cf43603e5e406c46b6120f Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Mon, 21 Jan 2019 11:57:44 -0500 Subject: [PATCH] docs: Add a FAQ item for "Do I have to use OctoPrint?" Signed-off-by: Kevin O'Connor --- docs/FAQ.md | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index a5827f16..fb92b32f 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -9,17 +9,18 @@ Frequently asked questions 6. [How do I change the serial baud rate?](#how-do-i-change-the-serial-baud-rate) 7. [Can I run Klipper on something other than a Raspberry Pi 3?](#can-i-run-klipper-on-something-other-than-a-raspberry-pi-3) 8. [Can I run multiple instances of Klipper on the same host machine?](#can-i-run-multiple-instances-of-klipper-on-the-same-host-machine) -9. [Why can't I move the stepper before homing the printer?](#why-cant-i-move-the-stepper-before-homing-the-printer) -10. [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) -11. [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) -12. [My TMC motor driver turns off in the middle of a print](#my-tmc-motor-driver-turns-off-in-the-middle-of-a-print) -13. [I keep getting random "Lost communication with MCU" errors](#i-keep-getting-random-lost-communication-with-mcu-errors) -14. [My Raspberry Pi keeps rebooting during prints](#my-raspberry-pi-keeps-rebooting-during-prints) -15. [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) -16. [Will the heaters be left on if the Raspberry Pi crashes?](#will-the-heaters-be-left-on-if-the-raspberry-pi-crashes) -17. [How do I convert a Marlin pin number to a Klipper pin name?](#how-do-i-convert-a-marlin-pin-number-to-a-klipper-pin-name) -18. [How do I cancel an M109/M190 "wait for temperature" request?](#how-do-i-cancel-an-m109m190-wait-for-temperature-request) -19. [How do I upgrade to the latest software?](#how-do-i-upgrade-to-the-latest-software) +9. [Do I have to use OctoPrint?](#do-i-have-to-use-octoprint) +10. [Why can't I move the stepper before homing the printer?](#why-cant-i-move-the-stepper-before-homing-the-printer) +12. [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) +12. [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) +13. [My TMC motor driver turns off in the middle of a print](#my-tmc-motor-driver-turns-off-in-the-middle-of-a-print) +14. [I keep getting random "Lost communication with MCU" errors](#i-keep-getting-random-lost-communication-with-mcu-errors) +15. [My Raspberry Pi keeps rebooting during prints](#my-raspberry-pi-keeps-rebooting-during-prints) +16. [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) +17. [Will the heaters be left on if the Raspberry Pi crashes?](#will-the-heaters-be-left-on-if-the-raspberry-pi-crashes) +18. [How do I convert a Marlin pin number to a Klipper pin name?](#how-do-i-convert-a-marlin-pin-number-to-a-klipper-pin-name) +19. [How do I cancel an M109/M190 "wait for temperature" request?](#how-do-i-cancel-an-m109m190-wait-for-temperature-request) +20. [How do I upgrade to the latest software?](#how-do-i-upgrade-to-the-latest-software) ### How can I donate to the project? @@ -166,6 +167,17 @@ start, stop, and installation scripts (if any). The [klipper-start.sh](../scripts/klipper-start.sh) script may be useful as examples. +### Do I have to use OctoPrint? + +The Klipper software is not dependent on OctoPrint. It is possible to +use alternative software to send commands to Klipper, but doing so +requires Linux admin knowledge. + +Klipper creates a "virtual serial port" via the "/tmp/printer" file, +and it emulates a classic 3d-printer serial interface via that file. +In general, alternative software may work with Klipper as long as it +can be configured to use "/tmp/printer" for the printer serial port. + ### Why can't I move the stepper before homing the printer? The code does this to reduce the chance of accidentally commanding the