diff --git a/docs/Hardware.md b/docs/Hardware.md index 117e0391..4bdab17c 100644 --- a/docs/Hardware.md +++ b/docs/Hardware.md @@ -10,12 +10,10 @@ In general, if the device can show a GNU/Linux desktop, then KlipperScreen shoul * [BTT HDMI5/7](https://biqu.equipment/products/bigtreetech-hdmi5-v1-0-hdmi7-v1-0) * [Raspberry PI 7" Touchscreen](https://www.raspberrypi.org/products/raspberry-pi-touch-display/) * [Hyperpixel 4](https://shop.pimoroni.com/products/hyperpixel-4) -* [3.5" Elegoo](https://www.elegoo.com/de/products/elegoo-3-5-inch-tft-lcd-screen) * [3.5" RPi Display](http://www.lcdwiki.com/3.5inch_RPi_Display) * [5" HDMI Display-B](http://lcdwiki.com/5inch_HDMI_Display-B) * [VoCore](https://klipper.discourse.group/t/hardware-known-to-work-with-klipperscreen/35/7) * [WAVESHARE 4.3 inch DSI LCD](https://www.waveshare.com/4.3inch-dsi-lcd.htm) -* [DFrobot DFR0550](https://wiki.dfrobot.com/5%27%27TFT-Display_with_Touchscreen_V1.0_SKU_DFR0550) * [Android phone](Android.md) diff --git a/docs/Hardware/GPIO_35.md b/docs/Hardware/GPIO_35.md new file mode 100644 index 00000000..4d608f18 --- /dev/null +++ b/docs/Hardware/GPIO_35.md @@ -0,0 +1,49 @@ + +How i installed the 3.5" (A) type of screen on RaspberryOS Bookworm (Debian 12) + +![preview](../img/hardware/rpi35a.jpg) + +!!! abstract + this is based on my own experience and it's provided for general information + and does not constitute as advice of any kind. + + +## Initial install + +This screens connect to the [GPIO](https://en.wikipedia.org/wiki/General-purpose_input/output) +they were usually installed via repositories named LCD-show ([1](https://github.com/waveshare/LCD-show), [2](https://github.com/goodtft/LCD-show)), +however in the bookworm release there is a simpler solution + +```sh +sudo nano /boot/firmware/config.txt +``` +at the bottom add: +``` +dtoverlay=piscreen,drm +``` + +???+ info + in this context drm stands for [Direct Rendering Manager](https://en.wikipedia.org/wiki/Direct_Rendering_Manager) + +Close the nano editor using `ctrl`+`x` (exit), then `y` for yes (save). + +```sh +sudo reboot +``` + +## Wrong colors + +Some screens will not behave correctly and display wrong colors, +this usually due to the wrong [SPI](https://en.wikipedia.org/wiki/Serial_Peripheral_Interface) speed +In my case I had to use 16 Mhz (default is 24Mhz) +``` +dtoverlay=piscreen,drm,speed=16000000 +``` + +## Rotation + +You can rotate the screen adding a rotate line with the degrees [0, 90, 180, 270] +``` +dtoverlay=piscreen,drm,speed=16000000,rotate=180 +``` +Screen rotation will require adjusting the touch matrix see [Touch issues](../../Troubleshooting/Touch_issues/) \ No newline at end of file diff --git a/docs/Hardware/HDMI.md b/docs/Hardware/HDMI.md new file mode 100644 index 00000000..df8e6da2 --- /dev/null +++ b/docs/Hardware/HDMI.md @@ -0,0 +1,48 @@ + +Screens that use HDMI should work out of the box + +you may need to configure the resolution in RaspberryOS Bookworm +you can do this by editing the kernel commandline + +``` +sudo nano /boot/firmware/cmdline.txt +``` + +!!! tip "Important" + Put all parameters in cmdline.txt on the same line, do not use carriage returns. + +for example: +``` +video=1920x1080 +``` + +more complex example: +``` +video=HDMI-A-1:1920x1080M@60,rotate=90,reflect_x +``` + +| Device | Display | +|-------------|-------------------------------------------------| +| HDMI-A-1 | HDMI 1 (sometimes HDMI 0 on PCB) | +| HDMI-A-2 | HDMI 2 (sometimes HDMI 1 on PCB if starts at 0) | +| DSI-1 | DSI or DPI | +| Composite-1 | Composite | + + +Valid mode specifiers: +``` +x[M][R][-][@][i][m][eDd] +``` +options on brackets are optional + +| Option | Description | +|-----------------|----------------------------------------------------------------------------------------| +| M | Calculate timings using [CVT](https://en.wikipedia.org/wiki/Coordinated_Video_Timings) | +| R | CVT reduced blanking (refresh rate must be 60Hz) | +| - | Bits per pixel, A.K.A. BitDepth usuallly 24 | +| @ | acceptable refresh rates are 50, 60, 70 or 85 Hz only | +| e | Force enable | +| D | Force enable Digital mode | +| d | Disable | + +For more info read [modedb default video mode support](https://docs.kernel.org/fb/modedb.html) diff --git a/docs/img/hardware/rpi35a.jpg b/docs/img/hardware/rpi35a.jpg new file mode 100644 index 00000000..43d07e63 Binary files /dev/null and b/docs/img/hardware/rpi35a.jpg differ diff --git a/docs/img/troubleshooting/xtcal.png b/docs/img/troubleshooting/xtcal.png new file mode 100644 index 00000000..1330fc4f Binary files /dev/null and b/docs/img/troubleshooting/xtcal.png differ diff --git a/mkdocs.yml b/mkdocs.yml index 49b708bc..4a3990fa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,7 +9,10 @@ nav: - Home: index.md - FAQ: FAQ.md - Setup: - - Hardware.md + - Hardware: Hardware.md + - Hardware specific: + - GPIO 3.5": Hardware/GPIO_35.md + - HDMI: Hardware/HDMI.md - Installation.md - Updating.md - Configuration.md