Skip to content

Android

This article describes how to use KlipperScreen from an Android device

Warning

The experience may not be equal to run KlipperScreen natively. Depending on the device or the network you may encounter performance degradation or other issues.

  1. First installl KlipperScreen

  2. Install XServer-XSDL on the Android device

    Devices that do not have acces to the play store can grab the apk from the official sourceforge. ViewTouch does work too

    with older versions of Android you may have to use v1.11.40

  3. Choose USB (ADB) or WI-FI

ADB

Bug

Some users have found that using this method may cause memory-leaks

Warning

Leaving the phone always connected it's not recommended, remove the battery to avoid issues.

  1. Install ADB on the computer/SBC/Pi with this command: 
    sudo apt-get install android-tools-adb

  2. Put your Android device in Debug mode.

    Usually it involves enabling developer mode and "USB debugging" the exact method varies on different vendors and versions of the device

    search "how to enable Android debugging on device-model-and-brand"

  3. Copy the sample launcher script with the following commands:

    cd ~/KlipperScreen/scripts
cp sample-android-adb.sh launch_KlipperScreen.sh
chmod +x ~/KlipperScreen/scripts/launch_KlipperScreen.sh

  4. Start Xserver-XSDL On the Android device

  5. Go to Startup

WIFI

  1. Create a launcher script by entering the following commands:

    rm ~/KlipperScreen/scripts/launch_KlipperScreen.sh
touch ~/KlipperScreen/scripts/launch_KlipperScreen.sh
chmod +x ~/KlipperScreen/scripts/launch_KlipperScreen.sh
nano ~/KlipperScreen/scripts/launch_KlipperScreen.sh

  2. Start the app on the Android device (Xserver-XSDL or ViewTouch)

  3. Paste this into the script:

    Replace the example IP with the one that Android app shows in the screen. 

    DISPLAY=192.168.150.122:0 $KS_XCLIENT

Important

It's recommended to use a static IP address, because if it changes your connection will stop working.

Startup

Enter this command on the computer/SBC/Pi 

sudo service KlipperScreen restart

Doesn't start

Follow this steps:

  1. Reboot the Android device
  2. Open the XSDL app and leave it waiting in the blue-screen
  3. Reboot the computer/SBC/Pi

Xserver-XSDL config

Some versions of the app require this configuration to work as expected.

On the splash-screen of the app go to: 

“CHANGE DEVICE CONFIGURATION”
└──Mouse Emulation Modde
    └──Desktop, No Emulation
if you missed it, restart the app.

Turn off DPMS and Display timeout:

disable_dpms_poweroff

Stop Screen Blanking in Xserver-XSDL

Even after enabling the "Stay Awake" option in the Developer/USB Debugging options of your Android device, the Xserver-XSDL may still go to a black screen but keep the backlight of your device on. To keep the screen always active, upon start up of Xserver-XSDL app, select the Change Device Configuration at the top of the splash screen and then select the Command line parameters, one argument per line option. Append the following argument (must be on seperate lines): 

-s
0
This will disable the screen-saver in Xserver and keep KlipperScreen always active.

Migration from other tutorials

KlipperScreen says error option "service" is not supported anymore.

Stop the other service and Remove it, for example if the service is KlippyScreenAndroid:

sudo service KlippyScreenAndroid stop
sudo rm /etc/systemd/system/KlippyScreenAndroid.service

Follow this guide on how to set up the new launcher script with USB(ADB) or WI-FI and restart KS.

Help

The Discourse thread has old instructions, but you may get some help if needed

#klipper-screen channel on Discord