Skip to content

Installation guide for fresh systems

Jump to bottom
C0co edited this page Oct 20, 2024 · 24 revisions

You are lucky!

I have prepared a full image ready to go for you.
Its a fresh and clean system to make it as simple for you as I can.

Whats in the box?

To understand what is included in my image, here is the list, what it is based on:

  • Armbian-unofficial_24.2.0-trunk_Mkspi_bookworm_current_6.6.17 Installed is:
  • kiauh v5.1 (v6 is in alpha state)
  • Klipper v0.12.0-289
  • Moonraker v0.9.2-6
  • and everything you need for input shaping, wifi and of course the touch screen functionality.
  • no crowsnest, klippain-shaketune or other things. Simply a pure basis for everyone

This makes it:
image

Flashing the image:

  1. Simply download the image file for your needs and flash it to your EMMC card or an USB flash drive (eg. by using balenaEtcher or a similar tool).
  2. Boot it.
  3. Done.

You can find the full image at the [releases section](https://github.com/Phil1988/FreeDi/releases/).

The initial release can be found here: https://github.com/Phil1988/FreeDi/releases/tag/v1.00

Creating the "perfect match" with your hardware

Depending on your hardware setup and liking there are 3 possible ways to make it work with your printer.
Use a browser to open the Mainsail UI of your printer (by entering the printers IP address). Go to the MACHINE section:

image

On the right side you will find your current Klipper versions for the MCU, the toolhead (MKS_THR) and also the host:
image
Depending on the versions, choose one of the following guides:

#1 Your mainboard MCU and the toolhead are on Klipper v0.12.0-289 already?

Yes, its on Klipper v0.12.0-289

The only thing left to do for us is to find unique ID of your toolhead and insert it to your printer.cfg.

  1. SSH to your printer (eg. via putty) and run the command ls /dev/serial/by-id/* Note the device ID which will be printed like: image

  2. Connect to your printer via your favorite browser and replace the ID in the [mcu MKS_THR] section of the printer.cfg with the one you got before: image

#2 Your mainboard MCU and the toolhead are NOT on Klipper v0.12.0-289
- and you want it the easy way?

Yes please, go easy on me!

Just take my pre compiled files and flash them.
You can find them in the releases section.
Make sure you get the version matching your klipper.

Flashing the Mainboard MCU:

  1. Format a microSD card as FAT32 (not lager in size then 32GB – maybe larger sized SD-cards will work if you create a partition not larger then 32GB).
  2. Copy the „X_4.bin“ file to this SD-card.
  3. Eject the microSD card from your computer.
  4. Shut down your printer and wait at least 30sec.
  5. Put the microSD card into the SD card slot of the printers mainboard.
  6. Turn the printer on. The mainboard STM32F402 MCU will now be flashed (which takes about 10sec, but make sure to not turn it down before 1min… just in case).

Flashing the THR toolhead:

  1. SSH to your printer (eg. via putty) and run the command ls /dev/serial/by-id/* Note the device ID which will be printed like: image

  2. Connect to your printer via your favorite browser and replace the ID in the [mcu MKS_THR] section of the printer.cfg with the one you got before: image

Put your Toolhead into "RP2 Boot" mode.

  1. Remove the back cover of the tool head.
  2. Press and hold the „boot“ button.
  3. Press and release the „reset“ button.
  4. Release the „boot“ button.

Verify if its really in "RP2 Boot" mode. You can do this by:

lsusb

This means it is in boot mode:
tut6_in_bootloaderMode
This means it NOT in boot mode:
tut6_not_in_bootloaderMode

Run lsblk and see if you can find a partition at 128MB size:

lsblk

This means it is in boot mode and the partition is "sda1":
tut5

This means it NOT in boot mode:
tut2 8
if thats the case, go back to step 1.

Flashing the firmware to the toolhead.

  1. Find the file Toolhead_RP2040.uf2 from the firmware section matching your Klipper version.
  2. Download it.
  3. Use your favourite program to copy this file to the ~/X3seriesLCD folder of your printer (eg. WinSCP).
  4. Flash the toolhead by run:
sudo cp ~/X3seriesLCD/Toolhead_RP2040.uf2 /dev/sda1
  1. Shut the system down (sudo shutdown) and shut it off (switch off).
  2. Wait a few seconds and turn the printer on.

#3 You are a hardliner and want to compile it on your own?

Yessir, I want it the hard way!

Compiling the toolhead firmware

Run:

cd ~/klipper
make menuconfig

set it according to this:
tut1
save with q

Run:

make clean
make -j4

Flashing the tool head

Bring the toolhead into "RP2 Boot" mode (check the easy section how to do that).
Check the partition with lsblk - in my case "sda1".
Run the following command adjusted to the partition you found.

sudo cp ~/klipper/out/klipper.uf2 /dev/sda1

Compiling the mainboard mcu firmware

Run:

cd ~/klipper
make menuconfig

set it according to this:
tut6
save with q

Run:

make clean
make -j4

This will generate a „klipper.bin“ file in the /home/mks/klipper/out/ folder.
Use your favourite program to get this file onto your computer (I am using WinSCP).
Rename it to „X_4.bin“ and flash it like in the easy section.

Wiki

Clone this wiki locally