Skip to content

Latest commit

 

History

History
202 lines (164 loc) · 6.57 KB

Installation.md

File metadata and controls

202 lines (164 loc) · 6.57 KB

Installation

This document lists the steps to get Trad Rack set up to work with Kalico or Klipper.

Table of Contents

Klippy module

This section involves adding the Trad Rack Klippy module(s) to Klipper and enabling updates through Moonraker.

If you are using Kalico, you can skip to setting up config files since Kalico already includes the trad_rack module.

The installation procedure differs slightly depending on whether you are using a recent version of Klipper or an older version from before commit bafb126.

For parts of the installation procedure that differ depending on the version of Klipper you are using, there will be an "Old" dropdown below the commands/text that you would use with a recent installation. In such cases, if you are using an old version of Klipper from before commit bafb126, use the commands/text in the dropdown instead of what is directly above.

Klippy module installation

Run the following commands to download and install the Klippy module(s):

cd ~
curl -LJO https://raw.githubusercontent.com/Annex-Engineering/TradRack/main/Kalico/klippy_module/install.sh
chmod +x install.sh
./install.sh
Old 
cd ~
curl -LJO https://raw.githubusercontent.com/Annex-Engineering/TradRack/main/Kalico/klippy_module/install.sh
chmod +x install.sh
./install.sh pre_toolhead_changes

Then remove the install script with the following command:

rm install.sh

Finally, restart the klipper service using the following command:

sudo systemctl restart klipper

Tip

If you ever need to run the install script again in the future (for example if additional Klippy modules get added), you can do so without recreating the trad_rack_klippy_module directory using the following commands:

cd ~
./trad_rack_klippy_module/Kalico/klippy_module/install.sh <branch_name>

If unspecified, branch_name defaults to main.

Enabling Moonraker updates

To enable updates of the Trad Rack Klippy module(s) through Moonraker, add the following to your moonraker.conf file. This file is usually located in ~/printer_data/config/:

[update_manager trad_rack]
type: git_repo
path: ~/trad_rack_klippy_module
origin: https://github.com/Annex-Engineering/TradRack.git
primary_branch: main
managed_services: klipper
Old 
[update_manager trad_rack]
type: git_repo
path: ~/trad_rack_klippy_module
origin: https://github.com/Annex-Engineering/TradRack.git
primary_branch: pre_toolhead_changes
managed_services: klipper

Then restart the moonraker service using the following command:

sudo systemctl restart moonraker

Config files

Complete the following changes/additions to your Kalico config:

Preliminary changes

The following preliminary changes should be made to your existing config file(s):

[idle_timeout]

It is recommended to modify the [idle_timeout] section to prevent the printer from disabling the heaters and motors if the printer is paused. Add the following to your config file or modify gcode if the [idle_timeout] section is already there:

[idle_timeout]
# only turn off heaters and motors if the printer is not paused
gcode:
    {% if not printer.pause_resume.is_paused %}
        TURN_OFF_HEATERS
        M84
    {% endif %}

[save_variables]

The [save_variables] config section is required. See the Kalico Config Reference document for details on how to add this section.

Using provided config files

Copy the following files into your Kalico config folder and include them in your main printer config file:

  • One of the files from the base_config_options folder: base config file. Several options are provided for different boards or stepper drivers. This file is required. Make sure to complete the following changes:
    • [mcu tr] section
      • Replace serial with the serial for your board. See Kalico's Installation document if you need help finding this value.
    • [trad_rack] section
      • Change toolhead_fil_sensor_pin to match the pin you are using for your toolhead filament sensor.
      • Change lane_count to match your Trad Rack.
      • Change the following values to suit your setup. See the Tuning document for more details:
        • bowden_length
        • extruder_load_length
        • hotend_load_length
        • toolhead_unload_length
    • [stepper_tr_selector] section
      • Change position_max accordingly depending on your lane_count, using the formula in the config file.
    • [tmc2209 stepper_tr_selector] or [tmc5160 stepper_tr_selector] section
      • Change run_current to match your selector motor.
    • [tmc2209 stepper_tr_fil_driver] or [tmc5160 stepper_tr_fil_driver] section
      • Change run_current to match your filament driver motor.
  • trad_rack_optional.cfg: optional config file. It is highly recommended to include this file (see the Customization document for more details).

Modifying provided config files for a different board

Follow the instructions in using provided config files. In addition, modify every "pin" or "uart_address" setting in the base config file to match your board: copy each of these settings from a corresponding section in the example Kalico config for your board. Some settings such as tx_pin or uart_address might not be needed.

Building a config from scratch

See the Config Reference document for the required configuration sections and parameters for Trad Rack.