Installation

Follow this guide to install the 3MS configuration and macros.

Info

All SSH commands are run on the Klipper Host (usually a Raspberry Pi) and are labeled like the following:

SSH
echo Hello World

Notice the "SSH" at the top of the code block.

All references to a mainboard usually refer to the 3MS board. If you are using a (main MCU) configuration, references to a mainboard refer to your printer's existing mainboard.

Clone Repository

First, clone the 3MS repository:

SSH
cd ~
git clone https://github.com/3DCoded/3MS
cd 3MS

Storage

If the git clone command fails due to lack of storage on your system, run the following set of commands instead:

SSH
cd ~
git clone -b main --single-branch https://github.com/3DCoded/3MS
cd 3MS

Install Script

K1 Series

If you are setting up the 3MS on a Creality K1 Series printer (K1, K1C, K1 Max), use the following install script instead:

SSH
python3 install.py --path /usr/data/printer_data/config/3ms

Run the install script:

SSH
1	`sh install.sh`

printer.cfg

In the Klipper web interface (e.g. Mainsail/Fluidd/OctoPrint), open printer.cfg and add:

printer.cfg
1	`[include 3ms/main.cfg]`

DynamicMacros

The 3MS configuration depends on DynamicMacros. If you haven't installed it already, follow the instructions here to do so.

Remove the following line from your 3ms/main.cfg if it exists:

3ms/main.cfg
1	`[include ./macros.cfg]`

Moonraker Update Manager

To enable updates for the 3MS, add the following to your moonraker.conf (in the same folder as your printer.cfg):

moonraker.conf
# 3MS Update Manager
[update_manager mmms]
type: git_repo
path: ~/3MS
origin: https://github.com/3DCoded/3MS.git
primary_branch: main
is_system_service: False
install_script: install.sh

Warning

When updating via Moonraker, the following files will be overwritten:

macros.cfg
KlipperScreen.conf
endless/macros.cfg

If you have any changes in these files, they will be lost when updating.

Purge Line

If you use KAMP for purging, set your tip_distance setting in KAMP_Settings.cfg to your filament parking position (this is the distance between your filament sensor and your nozzle).

If you use any other method of purging, add this line to your Start G-Code / PRINT_START macro right before your purge line, and after your MMMS_START:

1	`G1 E100 F900`

Replace E100 with E+parking position

Controller

In 3ms/main.cfg, edit the [include ./controllers/xxx/steppers.cfg] line, replacing xxx with the config name of your controller:

Controller Name	Config Name
SKR Mini E3 V2	`btt_skr_mini_e3_v2`
SKR Pico	`btt_skr_pico`
Mellow Fly D7	`mellow_fly_d7`
BTT MMB	`btt_mmb`
BTT Octopus (main MCU)	`btt_octopus_main`
Zonestar ZM384 (main MCU)	`zonestar_zm384_main`
Mini RAMBo	`mini_rambo`
Geetech A30T	`gtm32_103_v1`

Configure MCU ID

Finally, to configure the MCU ID you saved from Firmware, run in your terminal:

SSH
cd ~ && cat mcu.txt

Copy the path that is output. Now, in your 3ms/controllers/xxx/steppers.cfg, in the [mcu 3ms] section (towards the bottom), set the MCU ID.

Example:

BeforeAfter

3ms/controllers/xxx/steppers.cfg
[mcu 3ms]
serial: /dev/serial/by-id/<your-mcu-id>

3ms/controllers/xxx/steppers.cfg
[mcu 3ms]
serial: /dev/serial/by-id/usb-Klipper_stm32f103xe_33FFD1054746333809650557-if00