Klipper Firmware Installation

Last Updated: 9/4/2023 for Klipper Stack v0.5.0

Klipper Installation Instructions

Setting up Mainboard

While powered on, before you put the new SD card in: 

1. Press and hold the ‘erase’ button  
2. While holding, press the ‘reset’ button 
3. After, release the ‘erase’ button

This will factory reset the Archimajor board. You should see an error come up on the touchscreen if this was successful. You can now power off and proceed with the next steps.

Writing img and initial access

You will need to download Raspberry Pi Imager or similar SD writing software and the current disk image from github.

Raspberry pi imager, img

1. Download and install Raspberry Pi Imager
2. Download here
3. Run Raspberry Pi Imager and Insert a MicroSD card into your computer
4. For the operating system, select ‘Use Custom’ and select the disk image from your computer.
5. Select the MicroSD storage device
6. Select the settings icon, and change hostname (save for next steps), wifi, password, then save.
   1. Choose a host name of your liking. The hostname will be the name for this machine. 
   2. Check the box for enable SSH
   3. Set username and password as ‘pi’ and ‘raspberry’ respectively. ***IMPORTANT*** Username must be ‘pi’ for system scripts to function correctly.
   4. Do *Not* Enter the ssid and password for your wifi. Uncheck ‘Configure wireless lan’ (you will be able to connect to your network this way, but will not allow you to change networks through the wifisetup.conf)

7. 
8. 
9. Click Save
10. Select Write and wait for it to finish.
11. Insert the MicroSD card into the raspberry pi and power on.

12. The machine will go through the first boot sequence which can take several minutes and boot multiple times. Please let the process complete uninterrupted.

Operations and Software

Change Configuration

1. Click on ‘CHANGE CONFIGURATION’
2. Select the correct machine type.

Setting up Wifi

Go to the machine tab and open the ‘wifi_setup.conf’ file:

Enter your SSID (Name of network) and the password, then click save and close.

Afterwards, send reboot to the raspberry pi here for changes to take effect:

Change Hostname

If for some reason you need to change the hostname of the machine, you can provide a new one. Make sure that you don’t use the same hostname for multiple machines. You can connect to the interface using hostname.local instead of the ip address after rebooting.

Change Password - Optional

Download Putty

1. Start Putty and type in the hostname you defined earlier in the Host Name (or IP address) section.

If hostname doesn’t work, you can find the IP address through the touchscreen settings and use that instead.

2. Select open. 
3. Accept the security message
4. Type Username, enter
5. Type Password, enter

Run ‘passwd’

Change the password to: Smcc13JLJpA22Jp

Mac Network Address

This will report mac addresses, ip address, and hostname to the console:

Install Update

If there is an update available for klipper_config in the update manager or commits available with ‘check for updates’, get up to date with ‘install updates’:

Please be patient while installing updates and do not turn the machine off while in progress. 

Debugging: 

If a shutdown error occurs, note relative time of occurrence and error message, then attempt to return the printer to its normal state, insert a USB drive and run the ‘send log files to USB’ command in the USB Drive section. 

Safely unmount the USB and send the log files to [e-mail] with relative time occurrence and error message.

If you’re not able to return the printer to the normal state, SSH in with putty or connect a keyboard and hit ctrl+alt+f4 to access the terminal and run the following command with a USB drive plugged in:

sudo sh /usr/local/bin/log_farmer.sh

This will do the same as pressing the send log files to USB button.

Putty, SSH - ***SECTION IS NOW OBSOLETE, ONLY SHOWN FOR REFERENCE*** 

6. Download Putty
7. Start Putty and type in the hostname you defined earlier in the Host Name (or IP address) section.

If hostname doesn’t work, you can find the IP address through the touchscreen settings and use that instead.

8. Select open. 
9. Accept the security message
10. Type Username, enter
11. Type Password, enter

2.0 - Flashing firmware

***Follow the steps below  ONLY if this command doesn’t work - 

Run: ./printer_data/config/src/system_config/upload_firmware.sh

*** If the above command is successful, skip section 2.1

2.1 - kiauh

1. Launch the Klipper install interface by entering ./kiauh/kiauh.sh to execute the kiauh.sh executable in the kiauh folder.
2. Go to Advanced to set the microcontroller settings + flash the board firmware
3. Select build and flash (option 4)
4. 
5. For the 32 bit Ultimachine board, choose Micro-controller Architecture SAM3/SAM4 (Due and Duet) & Processor to 3x8e, with the communication interface being USB. Type q to quit from the Advanced menu gray screens.
6. 
7. To Build the firmware and flash the board, select Build + Flash (Option 5)
8. 
9. Select Regular flashing method, USB, then the available MCU.q
10. 
11. 
    1. If it can't find MCU, then check that the bot is plugged in, has power, has a USB cable between the Archimajor board and the Raspberry Pi, and that all connections are good.
    2. When in doubt, hit control C to cancel and repeat the process

12. After this is complete, hit b to go back and q to quit kiauh.