docs update
This commit is contained in:
Alfredo Monclus
parent
78465fa564
commit
a68a1d3b91
50
README.md
50
README.md
@ -1,50 +1,54 @@
|
||||
Sure, here's an improved version of your text:
|
||||
|
||||
# KlipperScreen
|
||||
|
||||
KlipperScreen is a touchscreen GUI that interfaces with [Klipper](https://github.com/Klipper3d/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.
|
||||
KlipperScreen is a touchscreen GUI that interfaces with [Klipper](https://github.com/Klipper3d/klipper) via [Moonraker](https://github.com/arksine/moonraker). It allows you to switch between multiple printers and access them from a single location. Notably, it doesn't need to run on the same host as your printer; you can install it on another device and configure the IP address to connect to the printer.
|
||||
|
||||
### Documentation
|
||||
|
||||
[Click here to access the documentation.](https://klipperscreen.github.io/KlipperScreen/)
|
||||
For detailed information, [click here to access the documentation](https://klipperscreen.github.io/KlipperScreen/).
|
||||
|
||||
### Inspiration
|
||||
KlipperScreen was inspired by [OctoScreen](https://github.com/Z-Bolt/OctoScreen/) and the need for a touchscreen GUI that
|
||||
will natively work with [Klipper](https://github.com/Klipper3d/klipper) and [Moonraker](https://github.com/arksine/moonraker).
|
||||
|
||||
KlipperScreen draws inspiration from [OctoScreen](https://github.com/Z-Bolt/OctoScreen/) and was developed to provide a native touchscreen GUI compatible with [Klipper](https://github.com/Klipper3d/klipper) and [Moonraker](https://github.com/arksine/moonraker).
|
||||
|
||||
[](https://klipperscreen.readthedocs.io/en/latest/Panels/)
|
||||
|
||||
[More Screenshots](https://klipperscreen.readthedocs.io/en/latest/Panels/)
|
||||
Explore more screenshots [here](https://klipperscreen.readthedocs.io/en/latest/Panels/).
|
||||
|
||||
### Translations <a href="https://hosted.weblate.org/engage/klipperscreen/"><img src="https://hosted.weblate.org/widget/klipperscreen/svg-badge.svg" alt="Translation status" /></a>
|
||||
### Translations
|
||||
|
||||
Translations are hosted on Weblate, Thanks to the Weblate team for supporting the Open-Source community.
|
||||
Translations for KlipperScreen are hosted on Weblate. Thanks to the Weblate team for supporting the open-source community.
|
||||
|
||||
<a href="https://hosted.weblate.org/engage/klipperscreen/">
|
||||
<img src="https://hosted.weblate.org/widget/klipperscreen/svg-badge.svg" alt="Translation status" />
|
||||
</a>
|
||||
|
||||
Click the widget below to access the translation platform:
|
||||
|
||||
<a href="https://hosted.weblate.org/engage/klipperscreen/">
|
||||
<img src="https://hosted.weblate.org/widget/klipperscreen/horizontal-auto.svg" alt="Weblate widget" width=50% />
|
||||
<img src="https://hosted.weblate.org/widget/klipperscreen/horizontal-auto.svg" alt="Weblate widget" width="50%" />
|
||||
</a>
|
||||
|
||||
### About the project
|
||||
### About the Project
|
||||
|
||||
KlipperScreen has been created and maintained by Jordan Ruthe from 2020 to 2021
|
||||
KlipperScreen was created by Jordan Ruthe in 2020.
|
||||
|
||||
|Donate to Jordan|
|
||||
|-|
|
||||
|[Patreon](https://www.patreon.com/klipperscreen)|
|
||||
|[Ko-fi](https://ko-fi.com/klipperscreen)|
|
||||
| Donate to Jordan |
|
||||
|------------------|
|
||||
| [Patreon](https://www.patreon.com/klipperscreen) |
|
||||
| [Ko-fi](https://ko-fi.com/klipperscreen) |
|
||||
|
||||
The current maintainer is Alfredo Monclus (alfrix) from 2021 onwards
|
||||
Since 2021, the project has been maintained by Alfredo Monclus (alfrix).
|
||||
|
||||
|Dontate to Alfrix|
|
||||
|-|
|
||||
|[Ko-fi](https://ko-fi.com/alfrix)|
|
||||
| Donate to Alfrix |
|
||||
|------------------|
|
||||
| [Ko-fi](https://ko-fi.com/alfrix) |
|
||||
|
||||
thanks to all the people who helped along the way.
|
||||
|
||||
[Contributors](https://github.com/KlipperScreen/KlipperScreen/graphs/contributors)
|
||||
We extend our gratitude to all contributors who have helped along the way. [Meet the contributors](https://github.com/KlipperScreen/KlipperScreen/graphs/contributors).
|
||||
|
||||
### Sponsors
|
||||
|
||||
|
||||
 
|
||||
|
||||
Thank you [LDO](https://ldomotors.com/) for sponsoring KlipperScreen and the open source community.
|
||||
Special thanks to [LDO](https://ldomotors.com/) and [YUMI](https://wiki.yumi-lab.com/) for sponsoring KlipperScreen and the open-source community.
|
||||
44
docs/FAQ.md
44
docs/FAQ.md
@ -1,29 +1,49 @@
|
||||
Got it. Here’s the updated FAQ with the necessary modifications:
|
||||
|
||||
# Frequently Asked Questions
|
||||
|
||||
## What is the minimum Python version required?
|
||||
|
||||
The minimum version is Python 3.8, this is checked during install.
|
||||
The minimum required version of Python is 3.8. This requirement is checked during installation.
|
||||
|
||||
## OctoPrint?
|
||||
??? "Using Older Python Versions"
|
||||
If you need to use Python 3.7, you can do so with KlipperScreen v0.4.1 by running:
|
||||
```sh
|
||||
git reset --hard v0.4.1
|
||||
```
|
||||
|
||||
KlipperScreen was not designed to work with OctoPrint and there are no plans to make it compatible.
|
||||
## Does KlipperScreen work with OctoPrint?
|
||||
|
||||
## Can i use KlipperScreen as a desktop application?
|
||||
KlipperScreen is not designed to work with OctoPrint, and there are no plans to make it compatible.
|
||||
|
||||
Yes, First disable the service:
|
||||
## Can I use KlipperScreen as a desktop application?
|
||||
|
||||
```shell
|
||||
Yes, you can use KlipperScreen as a desktop application. During installation, do not install it as a service. If you have already installed it as a service, you can disable it by running:
|
||||
```sh
|
||||
sudo systemctl disable KlipperScreen
|
||||
```
|
||||
Then, you can open the application via the menu when needed. You can also find the shortcut in `KlipperScreen/scripts/KlipperScreen.desktop`.
|
||||
|
||||
and open the application via the menu when you need it.
|
||||
## Why did the title bar turn red and display CPU and RAM usage?
|
||||
|
||||
The red title bar indicating high CPU and RAM usage is a warning system. High resource usage can lead to issues, such as "timer too close" errors in Klipper. If this warning appears during an update or maintenance process, it is generally not an issue—just avoid starting a print job until the warning clears. You can use htop or similar tools from an SSH connection to check what’s consuming the resources.
|
||||
|
||||
you can also find the shortcut in `KlipperScreen/scripts/KlipperScreen.desktop`
|
||||
## How can I switch between multiple printers?
|
||||
|
||||
## Titlebar turned red and says CPU and RAM
|
||||
KlipperScreen supports multiple printers. You can switch between them by configuring each printer's IP address in the KlipperScreen settings. This allows you to manage all your printers from a single interface, even if they are running on different hosts.
|
||||
|
||||
It's the high resource warning system, having your printer with very high usage of CPU or RAM will lead to issues,
|
||||
usually involving timer too close in klipper, if it appears during an update or some maintanance process, it should not be an issue,
|
||||
just don't start printing until it clears.
|
||||
## Can I customize the KlipperScreen interface?
|
||||
|
||||
Yes, you can customize the KlipperScreen interface by editing the configuration files. Detailed instructions and options for customization can be found in the [documentation](https://klipperscreen.github.io/KlipperScreen/).
|
||||
|
||||
## What should I do if my touchscreen is not responding correctly?
|
||||
|
||||
If your touchscreen is not responding or has touch accuracy issues, check the [Touch Issues section](Troubleshooting/Touch_issues.md) in the troubleshooting guide. You may need to calibrate the touch settings or adjust the touch matrix.
|
||||
|
||||
## How do I update KlipperScreen?
|
||||
|
||||
To update KlipperScreen, follow the instructions in the [updating guide](Updating.md).
|
||||
|
||||
## What if I sometimes see the desktop instead of KlipperScreen?
|
||||
|
||||
If you sometimes see the desktop instead of KlipperScreen, and you only want to see KlipperScreen, you may have installed a distro with a full desktop environment. [Check these instructions](Troubleshooting/Desktop.md) on how to properly switch.
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
# Hardware
|
||||
|
||||
There are no recommended screens, but the minimum supported resolution is 480x320.
|
||||
KlipperScreen supports a variety of screens, with a minimum supported resolution of 480x320. Generally, if a device can display a GNU/Linux desktop, it should be compatible with KlipperScreen.
|
||||
|
||||
In general, if the device can show a GNU/Linux desktop, then KlipperScreen should work too.
|
||||
## Supported Hardware
|
||||
|
||||
#### Hardware known to work
|
||||
The following screens are known to work with KlipperScreen:
|
||||
|
||||
* [BTT PI TFT50](https://www.biqu.equipment/collections/lcd/products/bigtreetech-pi-tft50-v1-0-tft-display-for-raspberry-pi-3d-printer-part)
|
||||
* [BTT HDMI5/7](https://biqu.equipment/products/bigtreetech-hdmi5-v1-0-hdmi7-v1-0)
|
||||
@ -16,17 +16,17 @@ In general, if the device can show a GNU/Linux desktop, then KlipperScreen shoul
|
||||
* [WAVESHARE 4.3 inch DSI LCD](https://www.waveshare.com/4.3inch-dsi-lcd.htm)
|
||||
* [Android phone](Android.md)
|
||||
|
||||
For more hardware known to work with KlipperScreen, visit the [Klipper Discourse](https://klipper.discourse.group/t/hardware-known-to-work-with-klipperscreen/35).
|
||||
|
||||
* [More known hardware in the klipper discourse](https://klipper.discourse.group/t/hardware-known-to-work-with-klipperscreen/35)
|
||||
### Install
|
||||
|
||||
### Configuration
|
||||
1. **Install Your Screen**: Follow the manufacturer’s instructions for installing your screen. If you see a white screen, it indicates that the installation was not successful. Ensure that you can at least see a console.
|
||||
2. **Install KlipperScreen**: Once the screen is properly installed and functioning, proceed to [install KlipperScreen](Installation.md).
|
||||
|
||||
Follow the manufacturer instructions on how to install your screen. In general if you see a white screen, then it's not properly installed, ensure that you at least see a console, Then [install](Installation.md) KlipperScreen, if you are having troubles refer to the [troubleshooting page](Troubleshooting.md) for further information.
|
||||
## Screen Rotation
|
||||
|
||||
## Screen rotation
|
||||
For information on screen rotation, refer to the [Rotation section](Troubleshooting/Rotation.md) in the troubleshooting guide.
|
||||
|
||||
[Moved to Rotation](Troubleshooting/Rotation.md)
|
||||
## Touchscreen Touch Rotation
|
||||
|
||||
## Touchscreen touch rotation
|
||||
|
||||
[Moved to Touch issues](Troubleshooting/Touch_issues.md#touch-rotation-and-matrix)
|
||||
For touchscreen rotation and matrix issues, see the [Touch Issues section](Troubleshooting/Touch_issues.md#touch-rotation-and-matrix) in the troubleshooting guide.
|
||||
@ -1,74 +1,67 @@
|
||||
# Installation
|
||||
|
||||
## First steps
|
||||
## First Steps
|
||||
|
||||
Install the screen, following the instructions provided by the manufacturer, Some screens don't neeed extra software but some need to be installed with a script.
|
||||
It's strongly recommended to test it and ensure your hardware is working with RaspberryOS, Ubuntu or any distro you like.
|
||||
Once you have established that the screen is working, then proceed installing KlipperScreen.
|
||||
1. **Install the Screen**: Follow the manufacturer’s instructions for installing your screen. Some screens may require additional software, while others might not.
|
||||
2. **Test the Screen**: Ensure your hardware is functioning correctly by testing it with RaspberryOS, Ubuntu, or your preferred distribution.
|
||||
3. **Proceed to Install KlipperScreen**: Once you’ve confirmed that the screen is working, you can proceed with installing KlipperScreen.
|
||||
|
||||
## Setup
|
||||
|
||||
The installation script is meant for RaspberryOS Lite, but it should work on other debian derivatives.
|
||||
The installation script is designed for RaspberryOS Lite, but it should work on other Debian derivatives as well.
|
||||
|
||||
## 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/dw-0/kiauh) is a tool that helps you install or upgrade Klipper, Moonraker, Mainsail, and other extensions.
|
||||
|
||||
|
||||
|
||||
You can visit [KIAUH on GitHub](https://github.com/th33xitus/kiauh) to learn more and view its documentation.
|
||||
|
||||
|
||||
Visit [KIAUH on GitHub](https://github.com/dw-0/kiauh) to learn more and view its documentation.
|
||||
|
||||
## Manual Install
|
||||
|
||||
Execute the following commands:
|
||||
Follow these steps to manually install KlipperScreen:
|
||||
|
||||
Clone the KlipperScreen repository and run the installation script:
|
||||
```sh
|
||||
cd ~/
|
||||
git clone https://github.com/KlipperScreen/KlipperScreen.git
|
||||
./KlipperScreen/scripts/KlipperScreen-install.sh
|
||||
```
|
||||
This script will install the necessary packages, create a Python virtual environment at `~/.KlipperScreen-env`, and install a systemd service file.
|
||||
|
||||
This script will install the necessary packages, create a python virtual environment at
|
||||
`~/.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
|
||||
the location of your configuration file.
|
||||
|
||||
## Moonraker configuration
|
||||
|
||||
In moonraker.conf ensure that the IP of the device is a trusted client:
|
||||
|
||||
```ini title="moonraker.conf"
|
||||
[authorization]
|
||||
trusted_clients:
|
||||
127.0.0.1
|
||||
```
|
||||
|
||||
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`:
|
||||
|
||||
```ini title="moonraker.conf"
|
||||
[update_manager KlipperScreen]
|
||||
type: git_repo
|
||||
path: ~/KlipperScreen
|
||||
origin: https://github.com/KlipperScreen/KlipperScreen.git
|
||||
virtualenv: ~/.KlipperScreen-env
|
||||
requirements: scripts/KlipperScreen-requirements.txt
|
||||
system_dependencies: scripts/system-dependencies.json
|
||||
managed_services: KlipperScreen
|
||||
```
|
||||
!!! tip
|
||||
If you see warnings in other UIs ignore them until KlipperScreen finishes installing, and Moonraker is restarted.
|
||||
If you need a custom location for the configuration file, you can add the `-c` or `--configfile` option to the systemd file and specify the desired location.
|
||||
|
||||
## Moonraker Configuration
|
||||
|
||||
1. Ensure that the IP of the device is a trusted client in `moonraker.conf`:
|
||||
```ini
|
||||
[authorization]
|
||||
trusted_clients:
|
||||
127.0.0.1
|
||||
```
|
||||
Alternatively, add the [Moonraker API key](https://moonraker.readthedocs.io/en/latest/installation/#retrieving-the-api-key) to `KlipperScreen.conf`.
|
||||
|
||||
2. To use the update manager feature of Moonraker for KlipperScreen, add the following block to `moonraker.conf`:
|
||||
```ini
|
||||
[update_manager KlipperScreen]
|
||||
type: git_repo
|
||||
path: ~/KlipperScreen
|
||||
origin: https://github.com/KlipperScreen/KlipperScreen.git
|
||||
virtualenv: ~/.KlipperScreen-env
|
||||
requirements: scripts/KlipperScreen-requirements.txt
|
||||
system_dependencies: scripts/system-dependencies.json
|
||||
managed_services: KlipperScreen
|
||||
```
|
||||
|
||||
!!! tip
|
||||
If you see warnings in other UIs, ignore them until KlipperScreen finishes installing and Moonraker is restarted.
|
||||
|
||||
## Printer Configuration
|
||||
|
||||
Some basic configuration needs to be applied for correct functionality.
|
||||
|
||||
```ini title="printer.cfg"
|
||||
Add the following basic configurations to your `printer.cfg` file for correct functionality:
|
||||
```ini
|
||||
[virtual_sdcard]
|
||||
path: ~/printer_data/gcodes
|
||||
[display_status]
|
||||
@ -77,4 +70,4 @@ path: ~/printer_data/gcodes
|
||||
|
||||
## Macros
|
||||
|
||||
You may need some macros for the printer to function as you expected, [read more in the macros page](macros.md)
|
||||
You may need additional macros for the printer to function as expected. For more information, [read the macros page](macros.md).
|
||||
@ -1,27 +1,28 @@
|
||||
# Last resort to make the screen work
|
||||
# Last Resort to Make the Screen Work
|
||||
|
||||
If the screen never shows the console or bootup text during startup, Then it's typically an improperly installed screen
|
||||
See [Physical install issues](Physical_Install.md)
|
||||
If your screen never shows the console or bootup text during startup, it is typically due to an improperly installed screen. See [Physical Install Issues](Physical_Install.md) for more information.
|
||||
|
||||
|
||||
|
||||
|
||||
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:
|
||||
If the screen shows the bootup text but ends with a blinking cursor or login prompt, and no matter what you tried in [Troubleshooting](../Troubleshooting.md) you can't make it work, then follow these steps:
|
||||
|
||||
1. Install a distro with a desktop enviromenment [Click to learn how to check](./Desktop.md)
|
||||
1. **Install a Distro with a Desktop Environment**
|
||||
[Click to learn how to check](./Desktop.md)
|
||||
|
||||
2. Ensure that the screen is working properly (display and touch)
|
||||
2. **Ensure Proper Functionality**
|
||||
Make sure the screen is working properly, including both display and touch functionality.
|
||||
|
||||
3. Deactivate the Desktop Environment to let KlipperScreen exclusively
|
||||
3. **Deactivate the Desktop Environment for KlipperScreen**
|
||||
To allow KlipperScreen to run exclusively, enter the following command in a terminal and press enter:
|
||||
```sh
|
||||
sudo systemctl set-default multi-user.target && sudo reboot
|
||||
```
|
||||
|
||||
```sh title="On a terminal type this command and press enter"
|
||||
sudo systemctl set-default multi-user.target && sudo reboot
|
||||
```
|
||||
4. **Reboot and Install KlipperScreen**
|
||||
Wait for the system to reboot and then proceed to install KlipperScreen.
|
||||
|
||||
4. Wait for the reboot and install KlipperScreen
|
||||
If it still doesn't work, or if you did something else to make it work and want to share your solution:
|
||||
|
||||
If it still doesn't work, or you did something else to make it work and want to share:
|
||||
[Contact Us](../Contact.md)
|
||||
|
||||
[Contact us](../Contact.md)
|
||||
|
||||
Remember to share the logs, as those aid a lot in the troubleshooting.
|
||||
Remember to share the logs, as they are crucial for troubleshooting.
|
||||
@ -5,10 +5,10 @@
|
||||
|
||||
The network panel requires network-manager to function, (if you are using a fork this may not be the case)
|
||||
|
||||
if version of KlipperScreen installed was previous than v0.3.9, then re-run the installer and reboot
|
||||
Usually permissions are set with the installer, try a re-run of the installer and reboot
|
||||
|
||||
|
||||
??? "Alternative workaround for network-manager not having permissions"
|
||||
???+ "Alternative workaround for network-manager not having permissions"
|
||||
|
||||
in order to fix this polkit needs to be configured or disabled:
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 5.8 KiB |
@ -1,32 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 28.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<svg version="1.1" id="Title_x5F_Block_x5F_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
x="0px" y="0px" viewBox="0 0 48.33 46.65" style="enable-background:new 0 0 48.33 46.65;" xml:space="preserve">
|
||||
<style type="text/css">
|
||||
.st0{fill:#326799;}
|
||||
.st1{fill:#FFFFFF;}
|
||||
</style>
|
||||
<g>
|
||||
<g id="LINE_00000112602005870069098340000004982466735197827505_">
|
||||
<polygon class="st0" points="0.35,0.36 0.35,36.8 9.69,46.3 47.98,46.29 47.98,10.09 38.43,0.35 "/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="CIRCLE_00000069376942971437616230000007314134857363302586_">
|
||||
<circle class="st1" cx="23.66" cy="23.61" r="9.9"/>
|
||||
</g>
|
||||
<g>
|
||||
<g id="LINE_00000010273851397589190970000017974792002660671666_">
|
||||
<polygon class="st1" points="15.38,35.92 10.69,31.13 10.69,16.35 5.82,11.39 5.82,33.13 13.18,40.61 34.52,40.61 29.88,35.92
|
||||
"/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="CIRCLE">
|
||||
<circle class="st0" cx="23.66" cy="23.61" r="5.21"/>
|
||||
</g>
|
||||
<g>
|
||||
<g id="ARC_00000070824896212674021930000015994269423148645055_">
|
||||
<path class="st1" d="M17.31,13.64l-2.88-2.91h18.28l4.71,4.81l0.03,18.68l-3.98-4.02c-0.92,1.35-2.11,2.49-3.49,3.35l6.96,7.08
|
||||
h5.35V13.53l-7.38-7.5c0,0-29.09,0-29.09,0v2.85c0,0,8.04,8.19,8.04,8.19C14.76,15.7,15.94,14.53,17.31,13.64z"/>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 1.4 KiB |
BIN
docs/img/sponsors/LDO.png
Normal file
BIN
docs/img/sponsors/LDO.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.1 KiB |
BIN
docs/img/sponsors/YUMI.png
Normal file
BIN
docs/img/sponsors/YUMI.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.4 KiB |
@ -40,8 +40,9 @@ thanks to all the [contributors](https://github.com/KlipperScreen/KlipperScreen/
|
||||
|
||||
### Sponsors
|
||||
|
||||
|
||||
 
|
||||
|
||||
|
||||
Thank you [LDO](https://ldomotors.com/) for sponsoring KlipperScreen and the open source community.
|
||||
|
||||
Thanks YUMI 3D-EXPERT.FR for sponsoring KlipperScreen and the open source community.
|
||||
Thanks [YUMI](https://wiki.yumi-lab.com/) for sponsoring KlipperScreen and the open source community.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user