From 964ae7986fbf0dbc91e77aa8c6c068f10b9667df Mon Sep 17 00:00:00 2001 From: Alfredo Monclus Date: Fri, 17 Dec 2021 14:41:29 -0300 Subject: [PATCH] Docs: Add Bulleye fix (#367) Also configuration file clarifications, and other minor updates. Co-authored-by: jordanruthe <31575189+jordanruthe@users.noreply.github.com> --- README.md | 4 +--- docs/Configuration.md | 5 +++-- docs/Installation.md | 5 ++++- docs/Troubleshooting.md | 17 ++++++++++++++++- docs/index.md | 3 +++ docs/panels.md | 17 +++++++++++++++++ 6 files changed, 44 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a02a617d..357bc359 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # KlipperScreen -KlipperScreen is touchscreen GUI for Klipper based 3D printers. KlipperScreen interfaces with [Klipper](https://github.com/kevinOConnor/klipper) via [Moonraker](https://github.com/arksine/moonraker). - -Multiple printers update is here! Please check the configuration information for specifying several printers. +KlipperScreen is a touchscreen GUI that interfaces with [Klipper](https://github.com/kevinOConnor/klipper) via [Moonraker](https://github.com/arksine/moonraker). It can switch between multiple printers to access them from a single location, and it doesn't even need to run on the same host, you can install it on another device and configure the IP address to access the printer. ### Documentation diff --git a/docs/Configuration.md b/docs/Configuration.md index 9799a0bb..4ee91e52 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -1,8 +1,9 @@ # Configuration -Create a blank file in `~/klipper_config/KlipperScreen.conf`, if the file already exist then just edit it. +Usually you don't need to create a configuration file, but if you need to change something that is not changeable in the UI +create a blank file in `~/klipper_config/KlipperScreen.conf`, if the file already exist then just edit it. -Write in the file only the options that need to be changed. +Write in the file only the options that need to be changed, and restart KlipperScreen. ## Include files ``` diff --git a/docs/Installation.md b/docs/Installation.md index fdf151a5..aa6c5818 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -51,4 +51,7 @@ This script will install packages that are listed under manual install, create a If you need a custom location for the configuration file, you can add -c or --configfile to the systemd file and specify the location of your configuration file. -At this point KlipperScreen should be working, check out the [hardware page](Hardware.md) if you still haven't installed the screen, or head to the [troubleshooting page](Troubleshooting.md) if you are having problems +If your screen needs additional software, proceed with the manufacturer instructions if they are provided +and check out the [hardware page](Hardware.md) + +At this point KlipperScreen should be working, if it doesn't start then go to the [troubleshooting page](Troubleshooting.md) diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index 8889ec3b..dc8f4d22 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -45,4 +45,19 @@ Once you have saved that file, restart KlipperScreen and it should show up on yo #### Screen is all white or blank -Improperly installed screen, follow the manufacturer instructions on how to physically connect the screen and install the proper drivers. +Improperly installed screen, follow the manufacturer instructions on how to physically connect the screen and install +the proper drivers. + +### Touch not working on debian Bullseye + +Some dsi screens have issues where touch doesn't work with debian bullseye, the current fix +(at least until upstream is fixed) consist in editing `/boot/config.txt` and changing: + +`dtoverlay=vc4-kms-v3d` + +to: + +`dtoverlay=vc4-fkms-v3d` + +and reboot. That should make the touch work, if your screen is rotated 180 degrees, then you may need to adjust +[the touch rotation](Hardware.md) as described in the Hardware page. diff --git a/docs/index.md b/docs/index.md index 853f7122..56fd02b9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,11 +11,14 @@ A physical touchscreen is not strictly required, for example you may install a r ### Sample Panels Main Menu + ![Main Menu](img/main_panel.png) Job Status + ![Job Status](img/job_status.png) +[More](panels.md) ### Inspiration KlipperScreen was inspired by [OctoScreen](https://github.com/Z-Bolt/OctoScreen/) and the need for a touchscreen GUI that diff --git a/docs/panels.md b/docs/panels.md index 99eb7a9f..ca068323 100644 --- a/docs/panels.md +++ b/docs/panels.md @@ -8,6 +8,7 @@ ### Bed Level type: bed_level + ![Bed Level](img/bed_level.png) The bed level panel has the ability to have preset locations from Klipper. Please see documentation on the following @@ -24,64 +25,80 @@ panel. ### Bed Mesh type: bed_mesh theme:material-dark + ![Bed Mesh](img/bed_mesh.png) ### Extrude type: extrude theme:material-dark + ![Extrude](img/extrude.png) ### Fan type: fan + ![Fan](img/fan.png) ### Fine Tune type: fine_tune theme:custom + ![Fine Tune Panel](img/fine_tune.png) ### Gcode Macros type: gcode_macros theme: material-darker + ![Gcode Macros Panel](img/gcode_macros.png) ### Menu type: menu + ![Menu Panel](img/menu.png) ### Move type: move + ![Move Panel](img/move.png) ### Network type: network + ![Network Panel](img/network.png) ### Power type: power + ![Power](img/power.png) ### Preheat type: preheat + ![Preheat Panel](img/preheat.png) ### Print type: print + ![Print Panel](img/print.png) ### Settings type: settings theme:colorized + ![Settings](img/settings.png) ### System type: system + ![System Panel](img/system.png) ### Temperature type: temperature theme:material-light + ![Temperature](img/temperature.png) ### Z Calibrate type: zcalibrate + ![Z Calibrate](img/zcalibrate.png) ### Limits type: limits theme: material-dark + ![Limits](img/limits.png)