Skip to content

Commit

Permalink
Merge branch 'query_disabled_2'
Browse files Browse the repository at this point in the history
  • Loading branch information
@Zeanon
Zeanon committed Sep 18, 2024
2 parents 0c999fc + 8872161 commit ec1e90f
Show file tree
Hide file tree
Showing 53 changed files with 1,592 additions and 903 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,13 +120,13 @@ See the [Danger Features document](https://dangerklipper.io/Danger_Features.html

- [z_tilt, quad_gantry_level: adaptive horizontal move z](https://github.com/DangerKlippers/danger-klipper/pull/336)

- [core: non-critical-mcus](https://github.com/DangerKlippers/danger-klipper/pull/339)

If you're feeling adventurous, take a peek at the extra features in the bleeding-edge-v2 branch [feature documentation](docs/Bleeding_Edge.md)
and [feature configuration reference](docs/Config_Reference_Bleeding_Edge.md):

- [extruder/pa: do not smooth base extruder position, only advance](https://github.com/DangerKlippers/danger-klipper/pull/266)

- [core: non-critical-mcus](https://github.com/DangerKlippers/danger-klipper/pull/265)

- [dmbutyugin's advanced-features branch - Pull Request #262](https://github.com/DangerKlippers/danger-klipper/pull/262)
- stepper: high precision stepping protocol
- extruder: sync extruder motion with input shaper
Expand Down
14 changes: 14 additions & 0 deletions docs/Config_Reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ serial:
# sending a Klipper command to the micro-controller so that it can
# reset itself. The default is 'arduino' if the micro-controller
# communicates over a serial port, 'command' otherwise.
#is_non_critical: False
# Setting this to True will allow the mcu to be disconnected and
# reconnected at will without errors. Helpful for USB-accelerometer boards
# and USB-probes
```

### [mcu my_extra_mcu]
Expand Down Expand Up @@ -1453,6 +1457,13 @@ extended [G-Code command](G-Codes.md#z_tilt) becomes available.
# values yield better results, but can also lead to situations where the
# bed is tilted in a way that the nozzle touched the bed before the probe.
# The default is conservative.
#use_probe_offsets: false
# If set to true the probe x&y offsets will be taken into acccount when
# positioning the toolhead (that way if you define a point, your probe will
# at the given coordinates instead of the nozzle)
# (usefull for probes like beacon where the offsets switch when using
# scan/dive mode vs contact, that way the actually probed points will always
# stay the same since the probe offset dynamically changes)
```

### [quad_gantry_level]
Expand Down Expand Up @@ -5236,6 +5247,9 @@ extruder_stepper_name:
# example, if the config section for the secondary extruder is
# [extruder_stepper my_extruder_stepper], this parameter's value
# would be 'my_extruder_stepper'.
sensor_pin:
# Input pin connected to the sensor. This parameter must be
# provided.
#multiplier_high: 1.05
# High multiplier to set for the secondary extruder when extruding
# forward and Belay is compressed or when extruding backward and
Expand Down
2 changes: 1 addition & 1 deletion docs/Danger_Features.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- [`[exclude_object]`](./Config_Reference.md#exclude_object) is enabled by default. Use `[exclude_object] enable_exclude_object: False` to disable it

## Additional configuration options

- [`[mcu] is_non_critical`](./Config_Reference.md#mcu) enables marking of an mcu as optional - it can be freely disconnected and connected at will. (useful for MCU-based accelerometer boards, mcu-based probes that shut down in hot chambers, etc...)
- [`[danger_options]`](./Config_Reference.md#danger-options) - New configuration options to adjust klipper values that were previously hidden
- Additional kinematics versions enabled per-axis acceleration, see [limited_cartesian](./Config_Reference.md#⚠️-cartesian-kinematics-with-limits-for-x-and-y-axes) and [limited_corexy](./Config_Reference.md#⚠️-corexy-kinematics-with-limits-for-x-and-y-axes)
- `--rotate-log-at-restart` can be added to your klipper start script or service to force log rotation every restart.
Expand Down
158 changes: 86 additions & 72 deletions docs/Installation.md
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# Installation

These instructions assume the software will run on a Raspberry Pi
computer in conjunction with OctoPrint. It is recommended that a
Raspberry Pi 2 (or later) be used as the host machine (see the
These instructions assume the software will run on a linux based host
running a Klipper compatible front end. It is recommended that a
SBC(Small Board Computer) such as a Raspberry Pi or Debian based Linux
device be used as the host machine (see the
[FAQ](FAQ.md#can-i-run-klipper-on-something-other-than-a-raspberry-pi-3)
for other machines).
for other options).

For the purposes of these instructions host relates to the Linux device and
mcu relates to the printboard. SBC relates to the term Small Board Computer
such as the Raspberry Pi.

## Obtain a Klipper Configuration File

Most Klipper settings are determined by a "printer configuration file"
that will be stored on the Raspberry Pi. An appropriate configuration
printer.cfg, that will be stored on the host. An appropriate configuration
file can often be found by looking in the Klipper
[config directory](../config/) for a file starting with a "printer-"
prefix that corresponds to the target printer. The Klipper
Expand All @@ -35,38 +40,51 @@ printer configuration file, then start with the closest example
[config file](../config/) and use the Klipper
[config reference](Config_Reference.md) for further information.

## Prepping an OS image
## Interacting with Klipper

Start by installing [OctoPi](https://github.com/guysoft/OctoPi) on the
Raspberry Pi computer. Use OctoPi v0.17.0 or later - see the
[OctoPi releases](https://github.com/guysoft/OctoPi/releases) for
release information. One should verify that OctoPi boots and that the
OctoPrint web server works. After connecting to the OctoPrint web
page, follow the prompt to upgrade OctoPrint to v1.4.2 or later.
Klipper is a 3d printer firmware, so it needs some way for the user to
interact with it.

After installing OctoPi and upgrading OctoPrint, it will be necessary
to ssh into the target machine to run a handful of system commands. If
using a Linux or MacOS desktop, then the "ssh" software should already
be installed on the desktop. There are free ssh clients available for
other desktops (eg,
[PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/)). Use the
ssh utility to connect to the Raspberry Pi (`ssh pi@octopi` -- password
is "raspberry") and run the following commands:
Currently the best choices are front ends that retrieve information through
the [Moonraker web API](https://moonraker.readthedocs.io/) and there is also
the option to use [Octoprint](https://octoprint.org/) to control Klipper.

```
git clone https://github.com/DangerKlippers/danger-klipper klipper
./klipper/scripts/install-octopi.sh
```
The choice is up to the user on what to use, but the underlying Klipper is the
same in all cases. We encourage users to research the options available and
make an informed decision.

## Obtaining an OS image for SBC's

There are many ways to obtain an OS image for Klipper for SBC use, most depend on
what front end you wish to use. Some manafactures of these SBC boards also provide
their own Klipper-centric images.

The two main Moonraker based front ends are [Fluidd](https://docs.fluidd.xyz/)
and [Mainsail](https://docs.mainsail.xyz/), the latter of which has a premade install
image ["MainsailOS"](http://docs.mainsailOS.xyz), this has the option for Raspberry Pi
and some OrangePi varianta.

The above will download Klipper, install some system dependencies,
setup Klipper to run at system startup, and start the Klipper host
software. It will require an internet connection and it may take a few
minutes to complete.
Fluidd can be installed via KIAUH(Klipper Install And Update Helper), which
is explained below and is a 3rd party installer for all things Klipper.

OctoPrint can be installed via the popular OctoPi image or via KIAUH, this
process is explained in [OctoPrint.md](OctoPrint.md)

## Installing via KIAUH

Normally you would start with a base image for your SBC, RPiOS Lite for example,
or in the case of a x86 Linux device, Ubuntu Server. Please note that Desktop
variants are not recommended due to certain helper programs that can stop some
Klipper functions working and even mask access to some print boards.

KIAUH can be used to install Klipper and its associated programs on a variety
of Linux based systems that run a form of Debian. More information can be found
at https://github.com/dw-0/kiauh

## Building and flashing the micro-controller

To compile the micro-controller code, start by running these commands
on the Raspberry Pi:
on your host device:

```
cd ~/klipper/
Expand Down Expand Up @@ -108,10 +126,21 @@ It should report something similar to the following:
It's common for each printer to have its own unique serial port name.
This unique name will be used when flashing the micro-controller. It's
possible there may be multiple lines in the above output - if so,
choose the line corresponding to the micro-controller (see the
choose the line corresponding to the micro-controller. If many
items are listed and the choice is ambiguous, unplug the board and
run the command again, the missing item will be your print board(see the
[FAQ](FAQ.md#wheres-my-serial-port) for more information).

For common micro-controllers, the code can be flashed with something
For common micro-controllers with STM32 or clone chips, LPC chips and
others it is usual that these need an initial Klipper flash via SD card.

When flashing with this method, it is important to make sure that the
print board is not connected with USB to the host, due to some boards
being able to feed power back to the board and stopping a flash from
occuring.

For common micro-controllers using Atmega chips, for example the 2560,
the code can be flashed with something
similar to:

```
Expand All @@ -123,53 +152,38 @@ sudo service klipper start
Be sure to update the FLASH_DEVICE with the printer's unique serial
port name.

When flashing for the first time, make sure that OctoPrint is not
connected directly to the printer (from the OctoPrint web page, under
the "Connection" section, click "Disconnect").

## Configuring OctoPrint to use Klipper

The OctoPrint web server needs to be configured to communicate with
the Klipper host software. Using a web browser, login to the OctoPrint
web page and then configure the following items:

Navigate to the Settings tab (the wrench icon at the top of the
page). Under "Serial Connection" in "Additional serial ports" add
`/tmp/printer`. Then click "Save".

Enter the Settings tab again and under "Serial Connection" change the
"Serial Port" setting to `/tmp/printer`.
For common micro-controllers using RP2040 chips, the code can be flashed
with something similar to:

In the Settings tab, navigate to the "Behavior" sub-tab and select the
"Cancel any ongoing prints but stay connected to the printer"
option. Click "Save".
```
sudo service klipper stop
make flash FLASH_DEVICE=first
sudo service klipper start
```

From the main page, under the "Connection" section (at the top left of
the page) make sure the "Serial Port" is set to `/tmp/printer` and
click "Connect". (If `/tmp/printer` is not an available selection then
try reloading the page.)
It is important to note that RP2040 chips may need to be put into Boot mode
before this operation.

Once connected, navigate to the "Terminal" tab and type "status"
(without the quotes) into the command entry box and click "Send". The
terminal window will likely report there is an error opening the
config file - that means OctoPrint is successfully communicating with
Klipper. Proceed to the next section.

## Configuring Klipper

The next step is to copy the
[printer configuration file](#obtain-a-klipper-configuration-file) to
the Raspberry Pi.
the host.

Arguably the easiest way to set the Klipper configuration file is using the
built in editors in Mainsail or Fluidd. These will allow the user to open
the configuration examples and save them to be printer.cfg.

Arguably the easiest way to set the Klipper configuration file is to
use a desktop editor that supports editing files over the "scp" and/or
"sftp" protocols. There are freely available tools that support this
(eg, Notepad++, WinSCP, and Cyberduck). Load the printer config file
in the editor and then save it as a file named `printer.cfg` in the
home directory of the pi user (ie, `/home/pi/printer.cfg`).
Another option is to use a desktop editor that supports editing files
over the "scp" and/or "sftp" protocols. There are freely available tools
that support this (eg, Notepad++, WinSCP, and Cyberduck).
Load the printer config file in the editor and then save it as a file
named "printer.cfg" in the home directory of the pi user
(ie, /home/pi/printer.cfg).

Alternatively, one can also copy and edit the file directly on the
Raspberry Pi via ssh. That may look something like the following (be
host via ssh. That may look something like the following (be
sure to update the command to use the appropriate printer config
filename):

Expand Down Expand Up @@ -201,7 +215,7 @@ serial: /dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0
```

After creating and editing the file it will be necessary to issue a
"restart" command in the OctoPrint web terminal to load the config. A
"restart" command in the command console to load the config. A
"status" command will report the printer is ready if the Klipper
config file is successfully read and the micro-controller is
successfully found and configured.
Expand All @@ -211,10 +225,10 @@ Klipper to report a configuration error. If an error occurs, make any
necessary corrections to the printer config file and issue "restart"
until "status" reports the printer is ready.

Klipper reports error messages via the OctoPrint terminal tab. The
"status" command can be used to re-report error messages. The default
Klipper startup script also places a log in **/tmp/klippy.log** which
provides more detailed information.
Klipper reports error messages via the command console and via pop up in
Fluidd and Mainsail. The "status" command can be used to re-report error
messages. A log is available and usually located in ~/printer_data/logs
this is named klippy.log

After Klipper reports that the printer is ready, proceed to the
[config check document](Config_checks.md) to perform some basic checks
Expand Down
18 changes: 9 additions & 9 deletions docs/MPC.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,15 +90,15 @@ These can be specified in the config but should not need to be changed from the

The `heater power:` for PTC style heaters is recommended to be set at the normal print temperature for the printer. Some common PTC heaters are given below for reference. If your heater is not listed the manufacturer should be able to provide a temperature and power curve.

| Heater Temp (C) | Rapido 2 (W) | Rapido 1 (W) | Dragon Ace (W) | Revo 40 (W) |Revo 60 (W) |
|:---------------:|:------------:|:------------:|:--------------:|:-----------:|:----------:|
| 180 | 72 | 52 | 51 | 30 |45 |
| 200 | 70 | 51 | 48 | 29 |44 |
| 220 | 67 | 50 | 46 | 28 |43 |
| 240 | 65 | 49 | 44 | 28 |42 |
| 260 | 64 | 48 | 43 | 27 |40 |
| 280 | 62 | 47 | 41 | 27 |39 |
| 300 | 60 | 46 | 39 | 26 |38 |
| Heater Temp (C) | Rapido 2 (W) | Rapido 1 (W) | Dragon Ace old (W) | Dragon Ace new (W) | Revo 40 (W) |Revo 60 (W) |
|:---------------:|:------------:|:------------:|:------------------:|:------------------:|:-----------:|:----------:|
| 180 | 72 | 52 | 51 | 66 | 30 |45 |
| 200 | 70 | 51 | 48 | 63 | 29 |44 |
| 220 | 67 | 50 | 46 | 60 | 28 |43 |
| 240 | 65 | 49 | 44 | 58 | 28 |42 |
| 260 | 64 | 48 | 43 | 55 | 27 |40 |
| 280 | 62 | 47 | 41 | 53 | 27 |39 |
| 300 | 60 | 46 | 39 | 51 | 26 |38 |

## Filament Feed Forward Configuration

Expand Down
79 changes: 79 additions & 0 deletions docs/OctoPrint.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# OctoPrint for Klipper

Klipper has a few options for its front ends, Octoprint was the first
and original front end for Klipper. This document will give
a brief overview of installing with this option.

## Install with OctoPi

Start by installing [OctoPi](https://github.com/guysoft/OctoPi) on the
Raspberry Pi computer. Use OctoPi v0.17.0 or later - see the
[OctoPi releases](https://github.com/guysoft/OctoPi/releases) for
release information.

One should verify that OctoPi boots and that the
OctoPrint web server works. After connecting to the OctoPrint web
page, follow the prompt to upgrade OctoPrint if needed.

After installing OctoPi and upgrading OctoPrint, it will be necessary
to ssh into the target machine to run a handful of system commands.

Start by running these commands on your host device:

__If you do not have git installed, please do so with:__
```
sudo apt install git
```
then proceed:
```
cd ~
git clone https://github.com/Klipper3d/klipper
./klipper/scripts/install-octopi.sh
```

The above will download Klipper, install the needed system dependencies,
setup Klipper to run at system startup, and start the Klipper host
software. It will require an internet connection and it may take a few
minutes to complete.

## Installing with KIAUH

KIAUH can be used to install OctoPrint on a variety of Linux based systems
that run a form of Debian. More information can be found
at https://github.com/dw-0/kiauh

## Configuring OctoPrint to use Klipper

The OctoPrint web server needs to be configured to communicate with the Klipper
host software. Using a web browser, login to the OctoPrint web page and then
configure the following items:

Navigate to the Settings tab (the wrench icon at the top of the page).
Under "Serial Connection" in "Additional serial ports" add:

```
~/printer_data/comms/klippy.sock
```
Then click "Save".

_In some older setups this address may be `/tmp/printer`_


Enter the Settings tab again and under "Serial Connection" change the "Serial Port"
setting to the one added above.

In the Settings tab, navigate to the "Behavior" sub-tab and select the
"Cancel any ongoing prints but stay connected to the printer" option. Click "Save".

From the main page, under the "Connection" section (at the top left of the page)
make sure the "Serial Port" is set to the new additional one added
and click "Connect". (If it is not in the available selection then
try reloading the page.)

Once connected, navigate to the "Terminal" tab and type "status" (without the quotes)
into the command entry box and click "Send". The terminal window will likely report
there is an error opening the config file - that means OctoPrint is successfully
communicating with Klipper.

Please proceed to [Installation.md](Installation.md) and the
_Building and flashing the micro-controller_ section
1 change: 1 addition & 0 deletions docs/Overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ communication with the Klipper developers.
## Installation and Configuration

- [Installation](Installation.md): Guide to installing Klipper.
- [Octoprint](OctoPrint.md): Guide to installing Octoprint with Klipper.
- [Config Reference](Config_Reference.md): Description of config
parameters.
- [Rotation Distance](Rotation_Distance.md): Calculating the
Expand Down
Loading

0 comments on commit ec1e90f

Please sign in to comment.