From 86e21741527880bf3b25e8c39ad12ac487e922e5 Mon Sep 17 00:00:00 2001 From: Jordan Ruthe Date: Tue, 23 Mar 2021 21:23:42 -0400 Subject: [PATCH] docs: Put hardware on its own page. --- docs/Hardware.md | 26 ++++++++++++++++++++++++++ docs/Installation.md | 21 --------------------- mkdocs.yml | 1 + 3 files changed, 27 insertions(+), 21 deletions(-) create mode 100644 docs/Hardware.md diff --git a/docs/Hardware.md b/docs/Hardware.md new file mode 100644 index 00000000..2e69a354 --- /dev/null +++ b/docs/Hardware.md @@ -0,0 +1,26 @@ +# Hardware + +KlipperScreen should run on any touchscreen that you can connect to a computer. The required video driver may +be slightly different depending on what model you get. I am developing on a 1024x600 resolution screen. Due to this, +other resolutions may not be scaled properly at this moment. UI scaling is a future development item. + +#### Configure Hardware + +Add the following to _/boot/config.txt_. You can alter the hdmi_cvt to your screen specifications. This example is setup +for a resolution of 1024x600 and a refresh rate of 60hz. +``` +hdmi_cvt=1024 600 60 6 0 0 0 +hdmi_group=2 +hdmi_mode=87 +hdmi_drive=2 +``` +* Development has been using 1024x600 for a screen resolution. Other resolutions may have issues currently + +After changing _/boot/config.txt_ you must reboot your raspberry pi. Please also ensure you followed setting up your screen via the screen instructions. This will likely have a xorg.conf.d file for input from the touchscreen that you need to create. + +#### Hardware known to work + +[Click here](https://klipper.discourse.group/t/hardware-known-to-work-with-klipperscreen/35) to go to a post on the Klipper discourse server for known hardware or see the below list. + +[BTT PI TFT50](https://www.biqu.equipment/collections/lcd/products/bigtreetech-pi-tft50-v1-0-tft-display-for-raspberry-pi-3d-printer-part) +[Raspberry PI 7" Touchscreen](https://www.raspberrypi.org/products/raspberry-pi-touch-display/) diff --git a/docs/Installation.md b/docs/Installation.md index 2f8fa3dd..e3e81345 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -1,26 +1,5 @@ # Installation -### Required Hardware -KlipperScreen should run on any HDMI touchscreen that you can connect to a computer. The required video driver may -be slightly different depending on what model you get. I am developing on a 1024x600 resolution screen. Due to this, -other resolutions may not be scaled properly at this moment. UI scaling is a future development item. - -#### Configure Hardware - -Add the following to _/boot/config.txt_. You can alter the hdmi_cvt to your screen specifications. This example is setup -for a resolution of 1024x600 and a refresh rate of 60hz. -``` -hdmi_cvt=1024 600 60 6 0 0 0 -hdmi_group=2 -hdmi_mode=87 -hdmi_drive=2 -``` -* Development has been using 1024x600 for a screen resolution. Other resolutions may have issues currently - -After changing _/boot/config.txt_ you must reboot your raspberry pi. Please also ensure you followed setting up your screen via the screen instructions. This will likely have a xorg.conf.d file for input from the touchscreen that you need to create. - -### Installation - #### Setup Raspberry Pi This install process is meant for Raspbian non-desktop version. If you have installed it on the GUI version, use `sudo raspi-config` to set boot to console by choosing the following options in order: diff --git a/mkdocs.yml b/mkdocs.yml index 133b74af..45e2dc67 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,6 @@ site_name: KlipperScreen nav: + - Hardware.md - Installation.md - Configuration.md - changelog.md