CreatBot/CreatBotKlipperScreen
7
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
alfrix 2024-05-01 15:37:16 -03:00
parent 135e1858a8
commit 2205fa1955
9 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/FAQ.md
View File

@ -8,17 +8,6 @@ The minimum version is Python 3.7, this is checked during install.
KlipperScreen was not designed to work with OctoPrint and there are no plans to make it compatible. KlipperScreen was not designed to work with OctoPrint and there are no plans to make it compatible.
## How to Check if You Have a Desktop Environment
1. Let you device finish startup
2. At the end of the boot process look at the screen and check using this examples
| Desktop environment | Console |
|:------------------------------------------:|:--------------------------------------------:|
| ![de](img/troubleshooting/desktop.png) | ![boot](img/troubleshooting/boot.png) |
| Desktop environment | Console |
| ![delog](img/troubleshooting/delog.png) | ![clilog](img/troubleshooting/clilog.png) |
## Can i use KlipperScreen as a desktop application? ## Can i use KlipperScreen as a desktop application?
Yes, First disable the service: Yes, First disable the service:

26
docs/Installation.md
View File

@ -7,19 +7,9 @@ It's strongly recommended to test it and ensure your hardware is working with Ra
Once you have established that the screen is working, then proceed installing KlipperScreen. Once you have established that the screen is working, then proceed installing KlipperScreen.
## Setup ## Setup
The installation script is meant for RaspberryOS Lite, but it should work on other debian derivatives. The installation script is meant for RaspberryOS Lite, but it should work on other debian derivatives.
[Click to learn how to check if you installed a desktop version](FAQ.md#how-to-check-if-you-have-a-desktop-environment)
If you installed a desktop (GUI version) of the OS and want to run KlipperScreen exclusively then do:
```sh title="Boot to console / KlipperScreen"
sudo systemctl set-default multi-user.target && sudo reboot
```
to undo and go back to the desktop environment:
```sh title="Boot to the desktop"
sudo systemctl set-default graphical.target && sudo reboot
```
## Auto install ## Auto install
[KIAUH](https://github.com/th33xitus/kiauh) is a tool that helps you install or upgrade Klipper, Moonraker, Mainsail, and other extensions. [KIAUH](https://github.com/th33xitus/kiauh) is a tool that helps you install or upgrade Klipper, Moonraker, Mainsail, and other extensions.
@ -31,27 +21,21 @@ You can visit [KIAUH on GitHub](https://github.com/th33xitus/kiauh) to learn mor
## Manual Install ## Manual Install
First install [Klipper](https://www.klipper3d.org/Installation.html) and [Moonraker](https://moonraker.readthedocs.io/en/latest/installation/).
### KlipperScreen Installation
Execute the following commands: Execute the following commands:
```sh ```sh
cd ~/ cd ~/
git clone https://github.com/KlipperScreen/KlipperScreen.git git clone https://github.com/KlipperScreen/KlipperScreen.git
cd ~/KlipperScreen ./KlipperScreen/scripts/KlipperScreen-install.sh
./scripts/KlipperScreen-install.sh
``` ```
This script will install packages that are listed under manual install, create a python virtual environment at This script will install the necessary packages, create a python virtual environment at
`~/.KlipperScreen-env` and install a systemd service file. `~/.KlipperScreen-env` and install a systemd service file.
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, if it doesn't start then go to the [troubleshooting page](Troubleshooting.md)
## Moonraker configuration ## Moonraker configuration
In moonraker.conf ensure that the IP of the device is a trusted client: In moonraker.conf ensure that the IP of the device is a trusted client:
@ -61,10 +45,8 @@ In moonraker.conf ensure that the IP of the device is a trusted client:
trusted_clients: trusted_clients:
127.0.0.1 127.0.0.1
``` ```
!!! warning
having `force_logins: true` in this section or if you don't want to use `trusted_clients`
Will require the [moonraker api key](https://moonraker.readthedocs.io/en/latest/installation/#retrieving-the-api-key) in [KlipperScreen.conf](Configuration.md) Or add the [moonraker api key](https://moonraker.readthedocs.io/en/latest/installation/#retrieving-the-api-key) to [KlipperScreen.conf](Configuration.md)
If you wish to use the update manager feature of moonraker for KlipperScreen, add the following block to `moonraker.conf`: If you wish to use the update manager feature of moonraker for KlipperScreen, add the following block to `moonraker.conf`:

5
docs/Panels/Zcalibrate.md
View File

@ -54,3 +54,8 @@ this mode lets you create a mesh leveling bed using the paper test in various po
Available when the kinematics are defined as delta. Available when the kinematics are defined as delta.
Klipper documentation: [Delta calibration](https://www.klipper3d.org/Delta_Calibrate.html) Klipper documentation: [Delta calibration](https://www.klipper3d.org/Delta_Calibrate.html)
### Axis Twist Compensation (`AXIS_TWIST_COMPENSATION_CALIBRATE`)
Available when `[axis_twist_compensation]` is defined in the Klipper configuration.
Klipper documentation: [Axis Twist Compensation](https://www.klipper3d.org/Axis_Twist_Compensation.html)

4
docs/Troubleshooting.md
View File

@ -140,6 +140,10 @@ If you find a way of turning it off, please share it: [Contact](Contact.md)
[Follow this steps](Troubleshooting/Network.md) [Follow this steps](Troubleshooting/Network.md)
## I see the Desktop environment instead of KlipperScreen
[Follow this steps](Troubleshooting/Desktop.md)
## Other issues ## Other issues
If you found an issue not listed here, or can't make it work, please provide all the log files If you found an issue not listed here, or can't make it work, please provide all the log files

20
docs/Troubleshooting/Desktop.md Normal file
View File

@ -0,0 +1,20 @@
#### Check if You Have a Desktop Environment
1. Let you device finish startup
2. At the end of the boot process look at the screen and check using this examples
| Desktop environment | Console |
|:------------------------------------------:|:--------------------------------------------:|
| ![de](../img/troubleshooting/desktop.png) | ![boot](../img/troubleshooting/boot.png) |
| Desktop environment | Console |
| ![delog](../img/troubleshooting/delog.png) | ![clilog](../img/troubleshooting/clilog.png) |
If you installed a desktop (GUI version) of the OS and want to run KlipperScreen exclusively then do:
```sh title="Boot to console / KlipperScreen"
sudo systemctl set-default multi-user.target && sudo reboot
```
to undo and go back to the desktop environment:
```sh title="Boot to the desktop"
sudo systemctl set-default graphical.target && sudo reboot
```

2
docs/Troubleshooting/Last_resort.md
View File

@ -8,7 +8,7 @@ See [Physical install issues](Physical_Install.md)
If the screen shows the bootup text, but ends in a blinking cursor or login prompt, If the screen shows the bootup text, but ends in a blinking cursor or login prompt,
and no matter what you tried in [Troubleshooting](../Troubleshooting.md) you can't make it work, then do this: and no matter what you tried in [Troubleshooting](../Troubleshooting.md) you can't make it work, then do this:
1. Install a distro with a desktop enviromenment [Click to learn how to check](../../FAQ/#how-to-check-if-you-have-a-desktop-environment) 1. Install a distro with a desktop enviromenment [Click to learn how to check](./Desktop.md)
2. Ensure that the screen is working properly (display and touch) 2. Ensure that the screen is working properly (display and touch)

6
docs/Troubleshooting/Network.md
View File

@ -1,7 +1,9 @@
# Wi-Fi networks not listed # Wi-Fi networks not listed
!!! tip "First start" !!! tip "First start"
The initial scan may take a couple of minutes, first be patient before assuming it's an issue The initial scan may take a while, first be patient before assuming it's an issue
The network panel requires network-manager to function, (if you are using a fork this may not be the case)
Check if network-manager is installed: Check if network-manager is installed:
@ -15,8 +17,6 @@ if the response is the following:
dpkg-query: the package 'network-manager' is not installed dpkg-query: the package 'network-manager' is not installed
``` ```
go to [wpa_supplicant](wpa_supplicant.md)
if the response is the following: if the response is the following:
```sh ```sh

2
docs/Troubleshooting/Rotation.md
View File

@ -145,4 +145,4 @@ here are some examples:
## Touchscreen touch rotation ## Touchscreen touch rotation
[See touch rotation](../Touch_issues/#touch-rotation-and-matrix) [See touch rotation](./Touch_issues.md#touch-rotation-and-matrix)

6
docs/VNC.md
View File

@ -19,8 +19,8 @@ The host device could be for example a Raspberry Pi
3. Create `~/KlipperScreen/scripts/launch_KlipperScreen.sh`: 3. Create `~/KlipperScreen/scripts/launch_KlipperScreen.sh`:
```bash ```bash
#!/usr/bin/env bash #!/bin/bash
# Use display 10 to avoid clashing with local X server, if anyy # Use display 10 to avoid clashing with local X server, if any
Xtigervnc -rfbport 5900 -noreset -AlwaysShared -SecurityTypes none :10& Xtigervnc -rfbport 5900 -noreset -AlwaysShared -SecurityTypes none :10&
DISPLAY=:10 $KS_XCLIENT& DISPLAY=:10 $KS_XCLIENT&
wait wait
@ -60,7 +60,7 @@ Turn off DPMS and Display timeout:
* Triple-click "Home" button * Triple-click "Home" button
* Guided access pops up * Guided access pops up
* Press "Start" * Press "Start"
* Now iPad is locked to VNC viewer until "Guided access" mode is disabled by triple-clicking "Home" button and entering the restrictions password. * Now iPad is locked to VNC viewer until "Guided access" mode is disabled by triple-clicking "Home" button and entering the password.
##### On the VNC viewer: ##### On the VNC viewer:
* Press "+" button at the top right * Press "+" button at the top right
* Enter IP address of your print host. * Enter IP address of your print host.