nebq / klipperphoneslinux

Turning Mobile Phones into High Performance Klipper Host for 3D Printers Based on Native Linux

KlipperPhonesLinux

中文文档

Turning your old phones into high-performance Klipper host machine running on Debian Linux!

Features

• 💻 Native Linux Ubuntu 20.04 distribution, with CAN compatibility
• 📱Equipped with a high-resolution capacitive touchscreen, providing an outstanding appearance
• 🚀 Low cost with exceptional CPU performance
• ⚡ DC supply, Power on simultaneously with your 3D printer
• 🌈 Pre-installed Klipper runtime environment, no need for secondary installation
• 🛠️ Integrated with various useful tools: USB serial terminal, SSH service, WebSSH terminal...
• 🌐 Community Support: Share experiences, solve problems, and collaborate with other enthusiasts to contribute to the development of this project.

Supported Models

• Xiaomi Redmi 2 (wt88047)
• Xiaomi Redmi 5 Plus (xiaomi-vince)
• Xiaomi Mi 5X (xiaomi-tissot)
• Xiaomi Mi A1 (xiaomi-tissot)
• Xiaomi Mi A2 Lite (xiaomi-daisy)
• Xiaomi Redmi 6 Pro (xiaomi-daisy)
• Xiaomi Redmi 4 Prime (xiaomi-markw)
• Xiaomi Redmi Note 4 (xiaomi-mido)
• Xiaomi Redmi S2 (xiaomi-ysl)
• Xiaomi Redmi Y2 (xiaomi-ysl)
• Xiaomi Redmi 4x (xiaomi-santoni)
• Xiaomi Note 2 (xiaomi-scorpio)
• Xiaomi 5 (xiaomi-gemini)
• Huawei Maimang 5 (huawei milan)
• Huawei G9 (Plus) (huawei milan)
• Huawei Nova (Plus) (huawei milan)
• No model for your device? No problem! Porting Tutorial

Flashing Instructions:

• Xiaomi Redmi 2
• Xiaomi Qualcomm 625 Models
• Xiaomi Note 2
• Xiaomi Redmi 4x
• Huawei Maimang 5 / G9 (Plus) / Nova (Plus)
• Xiaomi 5

Quick Start After Flashing

• Connect to the terminal

  • Using the network (recommended)
    • Connect to your local network with KlipperScreen
    • Enter your phone's IP address in a web browser with port 8888, e.g., 192.168.31.124:8888
    • Entering:
      • Host 0.0.0.0
      • Port 22
      • Username umeko
      • Password 1234
    • Then you can connect into your phone's SSH console in the web page.
  • Using USB serial
    • Connect your phone to your computer with a USB cable; your computer will recognize it as a serial device.
    • Use PuTTY or other terminal software to access the terminal console.

• Connect to your 3D printer motherboard using an OTG adapter

  • In the command line, use the lsusb command to ensure the system recognizes your 3D printer motherboard.
    • Common motherboards will be displayed as Qingheng, OpenMoko xxx, etc.
    • If not recognized, check your cable connections.
  • Install Klipper firmware for your 3D printer motherboard.

    • Install cross-compiler

      sudo apt update
      sudo apt install avrdude gcc-avr binutils-avr avr-libc stm32flash libnewlib-arm-none-eabi gcc-arm-none-eabi binutils-arm-none-eabi pkg-config
      

    • Refer to Klipper documentation to compile and install Klipper firmware for your motherboard.

• Configure the 3D printer's configuration file

  • Obtain the configuration file from your printer motherboard supplier or find it in the Klipper repository.

  • Open the Fluidd interface, accessible through a web browser at your phone's IP address, e.g., 192.168.31.124

  • In the Config tab on the left, rename your motherboard configuration file to printer.cfg and overwrite the original file.

  • At the end of printer.cfg, add [include fluidd.cfg].

  • ⚠️ Please do not overwrite or delete the moonraker.conf file on the phone, as this can cause serious errors.

• Now you have completed the basic configuration. Enjoy!

Convert Your Phone to DC Power Supply ( PCB )

• Xiaomi Redmi 2 (wt88047)
• Xiaomi Redmi Note 4x (xiaomi-mido)
• Xiaomi Redmi 4 Prime(xiaomi-markw)
• Xiaomi Note 2

Common Issues and Solutions:

• Enabling and configuring CAN
• Connecting console with usb cable
• Error during homing, 'timer too close'
  • If you have a Qualcomm Snapdragon 625 model, disable CPU temperature monitoring in Klipper settings.
• lsusb shows no reaction
• Rotate the screen
• Compile your own Linux kernel
• Uninstall the Klipper related components.
• Setup multiple printers on KlipperScreen

Acknowledgements

• PostmarketOS
  • Real Linux distribution for phones and other mobile devices
• Klipper
  • Klipper 3d-Printer firmware. It combines the power of a general purpose computer with one or more micro-controllers.
• moonraker
  • API Web Server for Klipper
• KlipperScreen
  • Touchscreen GUI that interfaces with Klipper via Moonraker.
• fluidd
  • Free and open-source Klipper web interface for managing your 3d printer.