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

docs: minor fixups

Browse Source
This commit is contained in:
alfrix 2024-01-08 09:59:43 -03:00
parent 0accfad2f7
commit 060cd1db0f
13 changed files with 43 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Android.md
View File

@ -11,7 +11,7 @@ This article describes how to use KlipperScreen from an android device
1. [First installl KlipperScreen on the Pi](Installation.md) 1. [First installl KlipperScreen on the Pi](Installation.md)
2. Install [XServer-XSDL](https://play.google.com/store/apps/details?id=x.org.server) on the android device 2. Install [XServer-XSDL](https://play.google.com/store/apps/details?id=x.org.server) on the android device
3. Choose [USB(ADB)](#adb) or [WIFI](#wifi) 3. Choose [USB(ADB)](#adb) or [WI-FI](#wifi)
### ADB ### ADB
@ -104,11 +104,11 @@ sudo service KlippyScreenAndroid stop
sudo rm /etc/systemd/system/KlippyScreenAndroid.service sudo rm /etc/systemd/system/KlippyScreenAndroid.service
``` ```
Follow this guide on how to setup the new launcher script with [USB(ADB)](#adb) or [WIFI](#wifi) and restart KS. Follow this guide on how to set up the new launcher script with [USB(ADB)](#adb) or [WI-FI](#wifi) and restart KS.
## Help ## Help
[The Discourse thread has old instructions but you may get some help if needed](https://klipper.discourse.group/t/how-to-klipperscreen-on-android-smart-phones/1196) [The Discourse thread has old instructions, but you may get some help if needed](https://klipper.discourse.group/t/how-to-klipperscreen-on-android-smart-phones/1196)
[#klipper-screen channel on Discord](https://discord.klipper3d.org/) [#klipper-screen channel on Discord](https://discord.klipper3d.org/)

2
docs/Changelog.md
View File

@ -23,7 +23,7 @@ and the power device in moonraker.conf to have the same name.
The "Power" panel will be in the Menu if there are power devices found The "Power" panel will be in the Menu if there are power devices found
#### [2022 01 11](https://github.com/KlipperScreen/KlipperScreen/commit/8a8c6c064cc6d097b1b34a5c42b4001367e545a6) #### [2022 01 11](https://github.com/KlipperScreen/KlipperScreen/commit/8a8c6c064cc6d097b1b34a5c42b4001367e545a6)
* The Preheat panel has been deprecated in favor of an all in one Temperature panel * The Preheat panel has been deprecated in favor of an all-in-one Temperature panel
Remove preheat panel from your Klipperscreen.conf or replace the occurrences of preheat with temperature Remove preheat panel from your Klipperscreen.conf or replace the occurrences of preheat with temperature

2
docs/Configuration.md
View File

@ -151,7 +151,7 @@ button press. There are two menus available in KlipperScreen, __main and __print
printer is idle. The __print menu is accessible from the printing status page. printer is idle. The __print menu is accessible from the printing status page.
!!! info !!! info
A predefined set of menus is already provided and it's recommended to be used A predefined set of menus is already provided
A menu item is configured as follows: A menu item is configured as follows:
```{ .ini .no-copy } ```{ .ini .no-copy }

2
docs/Contact.md
View File

@ -20,4 +20,4 @@ or open an issue describing the changes.
or even provide ideas for a feature. or even provide ideas for a feature.
[Github repository](https://github.com/KlipperScreen/KlipperScreen/) [GitHub repository](https://github.com/KlipperScreen/KlipperScreen/)

11
docs/Installation.md
View File

@ -7,20 +7,19 @@ 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
This install process is meant for a non-desktop version of the OS for example RaspberryOS Lite, but it should work on other debian derivatives. The installation process is meant for a non-desktop version of the OS for example RaspberryOS Lite, but it should work on other debian derivatives.
[Click to learn how to check if you installed a desktop version](../../FAQ/#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: If you installed a desktop (GUI version) of the OS and want to run KlipperScreen exclusively then do:
```sh title="Boot to console / KlipperScreen" ```sh title="Boot to console / KlipperScreen"
sudo systemctl set-default multi-user.target sudo systemctl set-default multi-user.target && sudo reboot
sudo reboot
``` ```
to undo and go back to the desktop environment: to undo and go back to the desktop environment:
```sh title="Boot to the desktop" ```sh title="Boot to the desktop"
sudo systemctl set-default graphical.target sudo systemctl set-default graphical.target && sudo reboot
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.

2
docs/Panels/Job_status.md
View File

@ -24,5 +24,5 @@ This panel has more information than it shows by default, just click/tap the cor
## Extra temperature items ## Extra temperature items
By default only extruder and bed temperatures will be available but additional items can be defined By default, only extruder and bed temperatures will be available but additional items can be defined
using ["titlebar_items" in the config](../Configuration.md#printer-options) using ["titlebar_items" in the config](../Configuration.md#printer-options)

2
docs/Panels/Zcalibrate.md
View File

@ -16,7 +16,7 @@ It's strongly suggested to read Klipper documentation about [Bed level](https://
## Calibration methods ## Calibration methods
### Endstop (`Z_ENDSTOP_CALIBRATE`) ### Endstop (`Z_ENDSTOP_CALIBRATE`)
Available when an physical endstop is defined for `[stepper_z]` Available when a physical endstop is defined for `[stepper_z]`
See Klipper documentation: [Calibrating a Z endstop](https://www.klipper3d.org/Manual_Level.html#calibrating-a-z-endstop) See Klipper documentation: [Calibrating a Z endstop](https://www.klipper3d.org/Manual_Level.html#calibrating-a-z-endstop)

3
docs/Theming.md
View File

@ -2,7 +2,8 @@
To create a custom theme, create a folder in: _${KlipperScreen_Directory}/styles/_ To create a custom theme, create a folder in: _${KlipperScreen_Directory}/styles/_
The folder name will be the theme name, in that folder create another folder named `images` this is where the icons should be placed. The icons must be SVG files and they need to have specific names that are defined in the code, use the default theme as a reference for the names or check the code. The folder name will be the theme name, in that folder create another folder named `images` this is where the icons should be placed.
The icons must be SVG files with specific names that are defined in the code, use the default theme as a reference for the names or check the code.
To edit colors and styles, create a css file named `style.css` you can use the contents of another theme as a reference. To edit colors and styles, create a css file named `style.css` you can use the contents of another theme as a reference.

10
docs/Troubleshooting.md
View File

@ -12,9 +12,9 @@ The first step to troubleshooting any problem is getting the cause of the error.
Depending on your setup the file could be accessible from the web interface alongside other logs Depending on your setup the file could be accessible from the web interface alongside other logs
Mainsail | Fluidd | Mainsail | Fluidd |
:-:|:-: |:-------------------------------------------------------:|:---------------------------------------------------:|
![mainsail_logs](img/troubleshooting/logs_mainsail.png) | ![fluidd_logs](img/troubleshooting/logs_fluidd.png) | ![mainsail_logs](img/troubleshooting/logs_mainsail.png) | ![fluidd_logs](img/troubleshooting/logs_fluidd.png) |
if you can't find it in the web interface, use sftp to grab the log (for example Filezilla, WinSCP) if you can't find it in the web interface, use sftp to grab the log (for example Filezilla, WinSCP)
Located at `~/printer_data/logs`or in `/tmp/` if the former doesn't exist. Located at `~/printer_data/logs`or in `/tmp/` if the former doesn't exist.
@ -74,7 +74,7 @@ cat /var/log/Xorg.0.log
```sh ```sh
modprobe: FATAL: Module g2d_23 not found in directory /lib/modules/6.1.21-v8+ modprobe: FATAL: Module g2d_23 not found in directory /lib/modules/6.1.21-v8+
``` ```
This error is common on RaspberryOS when using FBturbo and it's not a related issue. This error is common on RaspberryOS when using FBturbo, it's not a related issue.
!!! abstract "If you see this line in the [system logs](#system-logs):" !!! abstract "If you see this line in the [system logs](#system-logs):"
```sh ```sh
@ -119,7 +119,7 @@ In KliperScreen settings find 'Screen DPMS' and turn it off.
Your screen doesn't seem to support turning off via software. Your screen doesn't seem to support turning off via software.
KlipperScreen will enable an internal screensaver to make it all black, and hopefully avoid burn-in. KlipperScreen will enable an internal screensaver to make it all black, and hopefully avoid burn-in.
If you find a way of turning it off and you want to share it: [Contact](Contact.md) If you find a way of turning it off, please share it: [Contact](Contact.md)
## Touch issues ## Touch issues

2
docs/Troubleshooting/Physical_Install.md
View File

@ -1,4 +1,4 @@
# Physical install issues # Physical installation issues
If the screen never shows the console even during startup, Then it's typically an improperly installed screen, If the screen never shows the console even during startup, Then it's typically an improperly installed screen,

27
docs/VNC.md
View File

@ -11,23 +11,22 @@ This article describes how to use KlipperScreen through a remote connection.
1. [First installl KlipperScreen](Installation.md) 1. [First installl KlipperScreen](Installation.md)
2. Install a vnc server package, for example: 2. Install a vnc server package, for example:
```bash ```bash
sudo apt install tigervnc-standalone-server sudo apt install tigervnc-standalone-server
``` ```
3. Create `launch_KlipperScreen.sh`: 3. Create `launch_KlipperScreen.sh`:
```bash ```bash
#!/usr/bin/env bash #!/usr/bin/env bash
# Use display 10 to avoid clashing with local X server, if anyy
# Use display 10 to avoid clashing with local X server, if anyy 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 ```
```
4. Restart KlipperScreen or reboot the system: 4. Restart KlipperScreen or reboot the system:
```bash ```bash
sudo systemctl service KlipperScreen restart sudo systemctl service KlipperScreen restart
``` ```
5. On KlipperScreen set the following configuration: 5. On KlipperScreen set the following configuration:
DPMS: off DPMS: off

14
docs/index.md
View File

@ -28,16 +28,16 @@ will natively work with [Klipper](https://github.com/klipper3d/klipper) and [Moo
KlipperScreen has been created and maintained by Jordan Ruthe from 2020 to 2021 KlipperScreen has been created and maintained by Jordan Ruthe from 2020 to 2021
|Donate to Jordan| | Donate to Jordan |
|-| |--------------------------------------------------|
|[Patreon](https://www.patreon.com/klipperscreen)| | [Patreon](https://www.patreon.com/klipperscreen) |
|[Ko-fi](https://ko-fi.com/klipperscreen)| | [Ko-fi](https://ko-fi.com/klipperscreen) |
The current maintainer is Alfredo Monclus (alfrix) from 2021 onwards The current maintainer is Alfredo Monclus (alfrix) from 2021 onwards
|Dontate to Alfrix| | Dontate to Alfrix |
|-| |-----------------------------------|
|[Ko-fi](https://ko-fi.com/alfrix)| | [Ko-fi](https://ko-fi.com/alfrix) |
thanks to all the people who helped along the way. thanks to all the people who helped along the way.

4
docs/macros.md
View File

@ -3,7 +3,7 @@
## Recommended ## Recommended
!!! note !!! note
If you have already installed other UIs then you may have this macros already, and it's usually asked by KIAUH If you have already installed other UIs then you may have these macros already, and it's usually asked by KIAUH
None of the following macros are strictly required for KlipperScreen, but they provide the toolhead parking at pause and cancel. None of the following macros are strictly required for KlipperScreen, but they provide the toolhead parking at pause and cancel.
@ -109,7 +109,7 @@ gcode:
### LOAD_FILAMENT / UNLOAD_FILAMENT ### LOAD_FILAMENT / UNLOAD_FILAMENT
This macros are used in the Extrude panel `Load` and `Unload` buttons. and they will be hidden from the macros panel. These macros are used in the Extrude panel `Load` and `Unload` buttons. and they will be hidden from the macros panel.
The selected speed in the panel is transferred as a parameter. The selected speed in the panel is transferred as a parameter.