lixxbox 94858b9340 new file: docs/_config.yml
new file:   docs/_sass/color_schemes/mainsail-dark.scss
	new file:   docs/_sass/color_schemes/mainsail.scss
	new file:   docs/about.md
	new file:   docs/additional-support/index.md
	new file:   docs/additional-support/shares.md.draft
	new file:   docs/additional-support/slicer-upload.md
	new file:   docs/additional-support/thumbnails.md
	new file:   docs/additional-support/webcam.md.draft
	new file:   docs/assets/img/additional/FileUpload-PrusaSlicer-2.2.0.png
	new file:   docs/assets/img/additional/PrusaSlicer-thumbnails.png
	new file:   docs/assets/img/additional/SuperSlicer-thumbnails.png
	new file:   docs/assets/img/additional/large-preview.png
	new file:   docs/assets/img/logo-mainsail-light.png
	renamed:    docs/images/logo-mainsail.png -> docs/assets/img/logo-mainsail.png
	new file:   docs/assets/img/logo.png
	new file:   docs/assets/img/logo.svg
	new file:   docs/assets/img/screenshot.png
	deleted:    docs/images/screenshot-dashboard.png
	deleted:    docs/images/screenshot-gcode-thumbnail.png
	deleted:    docs/images/superslicer-upload.png
	new file:   docs/index.md
	new file:   docs/necessary-cfg.md
	new file:   docs/setup-guide/index.md
	new file:   docs/setup-guide/klipper.md
	new file:   docs/setup-guide/mainsail.md
	new file:   docs/setup-guide/moonraker.md
	new file:   docs/setup-guide/operating-system.md
2020-11-27 23:28:52 +01:00

64 lines
2.0 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
layout: default
title: Klipper
parent: Setup Guide
nav_order: 3
permalink: /setup/klipper
---
## Klipper
### Installation
The following commands will clone Klipper to an appropriate directory in HOME and run the setup script.
```bash
cd ~
git clone https://github.com/KevinOConnor/klipper
cd ~/klipper
./scripts/install-octopi.sh
```
### Configuration
After Klipper is installed, you will need to change the default location of the printer.cfg and add the UDS (unix domain socket). This is defined in the file `/etc/default/klipper`
To edit this file type:
```bash
sudo nano /etc/default/klipper
```
find the following line:
```
KLIPPY_ARGS="/home/pi/klipper/klippy/klippy.py /home/pi/printer.cfg -l /tmp/klippy.log"
```
and change the config location to `/home/pi/klipper_config/printer.cfg` and add `-a /tmp/klippy_uds` to define UDS.
```
KLIPPY_ARGS="/home/pi/klipper/klippy/klippy.py /home/pi/klipper_config/printer.cfg -l /tmp/klippy.log -a /tmp/klippy_uds"
```
Save the file with `CTRL+O` and close the editor with `CTRL+X`.
You have to create the directories for your klipper configuration and the virtual_sdcard directory:
```bash
mkdir ~/klipper_config
mkdir ~/sdcard
```
Move your printer.cfg to ~/klipper_config and check if the following entries are present in the config.
```ini
[virtual_sdcard]
# for gcode upload
path: ~/sdcard
[display_status]
# for display messages in status panel
[pause_resume]
# for pause/resume functionality.
# Mainsail needs gcode macros for `PAUSE`, `RESUME` and `CANCEL_PRINT` to make the buttons work.
```
> **These entries are very important.**
For the full functionality of mainsail, you should also define gcode macros for `PAUSE`, `RESUME` and `CANCEL_PRINT`. You'll find further information in [this](../necessary-cfg.md){: target="_blank"} document.
After your config is in place, restart klipper with `sudo service klipper restart`. Check the `/tmp/klippy.log` for errors, if Klipper starts correctly you can continue the guide.
---
[< previous step](operating-system.md){: .btn } [next step >](moonraker.md){: .btn}