README.md

Welcome to the Kalico project!

This is a community-maintained fork of the Klipper firmware.

Our goal is to support features and behavior that could be "risky" if used incorrectly.

If I want my printer to light itself on fire, I should be able to make my printer light itself on fire.

See the Danger Features document for more information on some of the differences from Klipper.

Features merged into the main branch:

• core: no Python2 tests; no PRU boards

• core: git-untracked folder, plugins for user-plugins

• core: danger_options

• core: rotate log file at every restart

• fan: normalising Fan PWM power (klipper#6307)

• fan: reverse FAN (klipper#4983)

• heaters: modify PID without reload

• heaters: MPC temperature control

• heaters: velocity PID (klipper#6272)

• heaters: PID-Profiles

• heaters: expose heater thermistor out of min/max

• heaters/fan: new heated_fan module

• gcode: jinja2.ext.do extension (klipper#5149)

• gcode: gcode_shell_command (klipper#2173 / kiuah )

• gcode: expose math functions to gcode macros (klipper#4072)

• gcode: HEATER_INTERRUPT gcode command

• gcode: RELOAD_GCODE_MACROS command

• probe: dockable Probe (klipper#4328)

• probe: drop the first result (klipper#3397)

• probe: z_calibration (klipper#4614 / protoloft/z_calibration)

• z_tilt: z-tilt calibration (klipper3d#4083 / dk/ztilt_calibration)

• stepper: home_current

• stepper: current_change_dwell_time

• homing: post-home retract

• homing: sensorless minimum home distance

• homing: min_home_dist

• virtual_sdcard: scanning of subdirectories (klipper#6327)

• retraction: z_hop while retracting (klipper#6311)

• danger_options: allow plugins to override conflicting extras

• danger_options: expose the multi mcu homing timeout as a parameter

• danger_options: option to configure the homing elapsed distance tolerance

• danger_options: option to ignore ADC out of range

• temperature_mcu: add reference_voltage (klipper#5713)

• adxl345: improve ACCELEROMETER_QUERY command

• extruder: add flag to use the PA constant from a trapq move vs a cached value

• force_move: turn on by default

• respond: turn on by default

• exclude_object: turn on by default

• bed_mesh: add bed_mesh_default config option

• config: CONFIG_SAVE updates included files

• kinematics: independent X&Y accel/velocity for corexy and cartesian

• kinematics: independent X&Y accel/velocity for corexz

• idle_timeout: allow the idle timeout to be disabled

• canbus: custom CAN bus uuid hash for deterministic uuids

• filament_switch|motion_sensor: runout distance, smart and runout gcode

• z_tilt|qgl: custom threshold for probe_points_increasing check

• save_config: save without restarting the firmware

• configfile: recursive globs / (klipper#6375)

• temperature_fan: curve control algorithm

• shaper_calibrate: store and expose accel_per_hz

• resonance_tester: accepts ACCEL_PER_HZ in TEST_RESONANCES

• mcu: support for AT32F403

• z_tilt, quad_gantry_level: adaptive horizontal move z

• core: non-critical-mcus

• gcode_macros: !python templates

• core: action_log

• danger_options: configurable homing constants

If you're feeling adventurous, take a peek at the extra features in the bleeding-edge-v2 branch feature documentation and feature configuration reference:

• extruder/pa: do not smooth base extruder position, only advance

• dmbutyugin's advanced-features branch - Pull Request #262

  • stepper: high precision stepping protocol
  • extruder: sync extruder motion with input shaper
  • extruder: new print_pa_tower utility
  • input_shaper: smooth input shapers
  • input_shaper: new print_ringing_tower utility

Switch to Kalico

Note

Any add-on modules you are using will need to be reinstalled after switching to Kalico. This includes things like Beacon support, led-effect, etc.

Any data in ~/printer_data such as printer configs and macros will be unaffected.

Option 1. Manually clone the repository

If desired, make a backup copy of your existing Klipper installation by running:

mv ~/klipper ~/klipper_old

Then clone the Kalico repo and restart the klipper service:

git clone https://github.com/KalicoCrew/kalico.git ~/klipper
sudo systemctl restart klipper

Option 2. Using KIAUH

For users that are not comfortable using Git directly, KIAUH v6 is able to use custom repositories.

To do this, add the Kalico repo to KIAUH's custom repository settings with the following steps:

From the KIAUH menu select:

• [S] Settings
• 1) Set custom Klipper repository
• Use https://github.com/KalicoCrew/kalico as the new repository URL
• Use main or bleeding-edge-v2 as the new branch name
• Select 'Y' to apply the changes
• Enter 'B' for back twice
• 'Q' to quit

Option 3. Adding a git-remote to the existing installation

Can switch back to mainline klipper at any time via a git checkout upstream_main

cd ~/klipper
git remote add kalico https://github.com/KalicoCrew/kalico.git
git checkout -b upstream-main origin/master
git branch -D master
git checkout -b main kalico/main
sudo systemctl restart klipper
sudo systemctl restart moonraker

---

Kalico is a 3d-Printer firmware. It combines the power of a general purpose computer with one or more micro-controllers. See the features document for more information on why you should use Kalico.

To begin using Kalico start by installing it.

Kalico is Free Software. See the license or read the documentation.