Docs: Add Bulleye fix (#367)

Also configuration file clarifications, and other minor updates.

Co-authored-by: jordanruthe <31575189+jordanruthe@users.noreply.github.com>
This commit is contained in:
Alfredo Monclus
2021-12-17 14:41:29 -03:00
committed by GitHub
parent ae47cac064
commit 964ae7986f
6 changed files with 44 additions and 7 deletions

View File

@@ -1,8 +1,6 @@
# KlipperScreen # 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). 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.
Multiple printers update is here! Please check the configuration information for specifying several printers.
### Documentation ### Documentation

View File

@@ -1,8 +1,9 @@
# Configuration # 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 ## Include files
``` ```

View File

@@ -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 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. 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)

View File

@@ -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 #### 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.

View File

@@ -11,11 +11,14 @@ A physical touchscreen is not strictly required, for example you may install a r
### Sample Panels ### Sample Panels
Main Menu Main Menu
![Main Menu](img/main_panel.png) ![Main Menu](img/main_panel.png)
Job Status Job Status
![Job Status](img/job_status.png) ![Job Status](img/job_status.png)
[More](panels.md)
### Inspiration ### Inspiration
KlipperScreen was inspired by [OctoScreen](https://github.com/Z-Bolt/OctoScreen/) and the need for a touchscreen GUI that KlipperScreen was inspired by [OctoScreen](https://github.com/Z-Bolt/OctoScreen/) and the need for a touchscreen GUI that

View File

@@ -8,6 +8,7 @@
### Bed Level ### Bed Level
type: bed_level type: bed_level
![Bed Level](img/bed_level.png) ![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 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 ### Bed Mesh
type: bed_mesh theme:material-dark type: bed_mesh theme:material-dark
![Bed Mesh](img/bed_mesh.png) ![Bed Mesh](img/bed_mesh.png)
### Extrude ### Extrude
type: extrude theme:material-dark type: extrude theme:material-dark
![Extrude](img/extrude.png) ![Extrude](img/extrude.png)
### Fan ### Fan
type: fan type: fan
![Fan](img/fan.png) ![Fan](img/fan.png)
### Fine Tune ### Fine Tune
type: fine_tune theme:custom type: fine_tune theme:custom
![Fine Tune Panel](img/fine_tune.png) ![Fine Tune Panel](img/fine_tune.png)
### Gcode Macros ### Gcode Macros
type: gcode_macros theme: material-darker type: gcode_macros theme: material-darker
![Gcode Macros Panel](img/gcode_macros.png) ![Gcode Macros Panel](img/gcode_macros.png)
### Menu ### Menu
type: menu type: menu
![Menu Panel](img/menu.png) ![Menu Panel](img/menu.png)
### Move ### Move
type: move type: move
![Move Panel](img/move.png) ![Move Panel](img/move.png)
### Network ### Network
type: network type: network
![Network Panel](img/network.png) ![Network Panel](img/network.png)
### Power ### Power
type: power type: power
![Power](img/power.png) ![Power](img/power.png)
### Preheat ### Preheat
type: preheat type: preheat
![Preheat Panel](img/preheat.png) ![Preheat Panel](img/preheat.png)
### Print ### Print
type: print type: print
![Print Panel](img/print.png) ![Print Panel](img/print.png)
### Settings ### Settings
type: settings theme:colorized type: settings theme:colorized
![Settings](img/settings.png) ![Settings](img/settings.png)
### System ### System
type: system type: system
![System Panel](img/system.png) ![System Panel](img/system.png)
### Temperature ### Temperature
type: temperature theme:material-light type: temperature theme:material-light
![Temperature](img/temperature.png) ![Temperature](img/temperature.png)
### Z Calibrate ### Z Calibrate
type: zcalibrate type: zcalibrate
![Z Calibrate](img/zcalibrate.png) ![Z Calibrate](img/zcalibrate.png)
### Limits ### Limits
type: limits theme: material-dark type: limits theme: material-dark
![Limits](img/limits.png) ![Limits](img/limits.png)