Installing Klipper

Welcome to the klipper installation guide! I will go over steps to install klipper on your machine. If you use a 2021 TronXY Board, you will first have to flush the stock firmware. A guide on how to do so can be found here.

Once the chitu firmware is gone from your board (yay!), we can get started on configuring klipper. For this guide I will be using Octoprint, in combination with a V6 tronxy board. Example configuration will be included.

First, you need to flash octopi on your Raspberry Pi. This is fairly easy to do, a guide can be found here.

After this, we need to get klipper started on your Raspberry pi! Don't worry, we still need to flash the mainboard, but that step will come later.


 * 1) You need to establish an SSH connection to your raspberry pi. This can be done through Putty, or through your CMD window. Default SSH login is: `ssh pi@octopi`, default password is `raspberry`.
 * 2) Once you are in your pi, it should say `pi@octopi:` on the first line from the bottom. Great! Now we are in our raspberry pi.
 * 3) After this, we need to install klipper on our machine. You need to run the following commands in the SSH window to install klipper on the pi:
 * 4) If you get the following error: you should run  and allow it to run through completion.  After that, run  and allow it to complete.
 * 5) Great! You should have installed klipper correctly, if no error messages pop up. To verify, you can run `cd ~/klipper/`. Awesome! Let's continue.
 * 6) Now, we need to build our klipper file, for our mainboard. While inside of the klipper folder (step 3), run the following command:  make menuconfig
 * 7) This command should open up a window, where we will start to configure the klipper.bin for our machine:



Now that we have our klipper firmware ready, we need to compile it for our board. For this, press `Q` to exit the menu and save when prompted. `Y`.

Next, run the following command: make

This will compile our klipper.bin ! Sadly, TronXY Boards do not use .bin files, but .cbd. We can do that using the following command (while cd'd in the klipper folder): Put this update.cbd on an SD card, and insert it in your board! It should beep twice.

Next, it is important we make sure the pi can see the board. Connect a USB from the pi to the board, and configure `/tmp/printer` as an additional port in your web interface. (should be in settings -> connection on octoprint).

After that, we can connect to our board! Awesome.

Printer.cfg Setup.
Many pin configurations can be found in marlin. For V6 boards, I will try to include some pins, which should work on your board. Please refer to the marlin zip at here. Go to `Marlin/src/pins/` and look for your corresponding board.

We shall start configuring the board! First, we need to check the MCU serial ID. Run `ls /dev/serial/by-id/*` in the command line through SSH. It should say something similar to `/dev/serial/by-id/usb-1a86_USB_Serial-if00-port0`.

This will be the first entry in our printer.cfg file! This file needs to be created in `/home/pi/printer.cfg`. A good utility to use is Visual Studio Code, with the SSH Extension. It allows you to make edits over SSH on your own real quick.

The first entry in your file will be your MCU: If your serial port is different, replace it with your own.

Once you run `FIRMWARE_RESTART` through your web interface, it should give a different error, which is great! That means your klipper will work correctly for sure.

Next, you need to configure klipper. This can be done using this documentation reference. Please read through it thoroughly.

For the V6 board, here's an example configuration: (MAKE SURE TO NOT RELY ON THIS ALONE. You should always follow the documentation reference.) You now have klipper! Any further questions should not be related to the TronXY board anymore, but can be found on the Klipper website at https://www.klipper3d.org/.

Example config was pulled from this link, which has more example configs for TronXYs.

Hope you enjoyed the guide! Happy printing. For any comments, contact knarfie#0001 through the TronXY discord.