Hardware
There are no recommended screens, but the minimum supported resolution is 480x320.
In general, if the device can show a GNU/Linux desktop, then KlipperScreen should work too.
Hardware known to work
- BTT PI TFT50
- BTT HDMI5/7
- Raspberry PI 7" Touchscreen
- Hyperpixel 4
- 3.5" Elegoo
- 3.5" RPi Display
- 5" HDMI Display-B
- VoCore
- WAVESHARE 4.3 inch DSI LCD
- DFrobot DFR0550
Configuration
Follow the manufacturer instructions on how to install your screen. In general if you see a white screen, then it's not properly installed, ensure that you at least see a console, Then install KlipperScreen, if you are having troubles refer to the troubleshooting page for further information.
Screen rotation
Configure the server to start in the desired orientation, there are many ways to achieve this, here are some examples:
Warning
Rotation is handled by the OS and not by KlipperScreen, if you can't rotate your screen it's usually an issue with the OS configuration
Example
Create /usr/share/X11/xorg.conf.d/90-monitor.conf
Paste this section modifying the options to suit your needs:
Section "Monitor"
Identifier "DPI-1"
# This identifier would be the same as the name of the connector printed by xrandr.
# it can be "HDMI-0" "DisplayPort-0", "DSI-0", "DVI-0", "DPI-0" etc
Option "Rotate" "left"
# Valid rotation options are normal,inverted,left,right
Option "PreferredMode" "1920x1080"
# May be necesary if you are not getting your prefered resolution.
EndSection
Raspberry Pi
To set screen orientation when in console mode, you will need to edit the kernel command line to pass the required orientation to the system.
To rotate by 90 degrees clockwise, add the following to the cmdline, making sure everything is on the same line, do not add any carriage returns. Possible rotation values are 0, 90, 180 and 270.
Other values can be "HDMI-0" "HDMI-1, "DPI-0" etcRaspberry Pi legacy mode (works with vc4-fkms-v3d)
add to config.txt
RebootWarning
Pi4 doesn't support 90 and 270 degrees with this method, see the official docs
Value | result |
---|---|
0 | no rotation |
1 | rotate 90 degrees clockwise |
2 | rotate 180 degrees clockwise |
3 | rotate 270 degrees clockwise |
0x10000h | horizontal flip |
0x20000 | vertical flip |