docs: create specific pages for some panels
28
docs/Job_status.md
Normal file
@ -0,0 +1,28 @@
|
||||
# Job Status
|
||||
|
||||
Also known as "Print Status" or the "printing panel" shows the relevant information of the current print.
|
||||
|
||||

|
||||
|
||||
!!! tip
|
||||
the third row shows the LCD message (`M117`)
|
||||
|
||||
This panel has more information than it shows by default, just click/tap the corresponding the status buttons to access the extra information
|
||||
|
||||
## Position info
|
||||

|
||||
!!! note
|
||||
Layer is calculated from object height, it may not be accurate if variable layer is used
|
||||
|
||||
If that is the case use the Layer Progress method described in the [Quicktips](Quicktips.md#layer-progress)
|
||||
|
||||
## Extrusion info
|
||||

|
||||
|
||||
## Time info
|
||||

|
||||
|
||||
## Extra temperature items
|
||||
|
||||
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)
|
@ -3,13 +3,13 @@
|
||||
### Main Menu
|
||||

|
||||
|
||||
### Job Status
|
||||
### [Job Status](Job_status.md)
|
||||
```py
|
||||
panel: job_status
|
||||
```
|
||||

|
||||
|
||||
### Bed Level
|
||||
### [Bed Level](Screws.md)
|
||||
```py
|
||||
panel: bed_level
|
||||
```
|
||||
@ -84,13 +84,13 @@ panel: system
|
||||
```
|
||||

|
||||
|
||||
### Temperature
|
||||
### [Temperature](Temperature.md)
|
||||
```py
|
||||
panel: temperature
|
||||
```
|
||||

|
||||
|
||||
### Z Calibrate
|
||||
### [Z Calibrate](Zcalibrate.md)
|
||||
```py
|
||||
panel: zcalibrate
|
||||
```
|
||||
|
23
docs/Temperature.md
Normal file
@ -0,0 +1,23 @@
|
||||
# Temperature
|
||||
|
||||
This panel is available when there is at least one device with a temperature sensor asociated,
|
||||
this includes extruders, heaters, sensors and temperature_fans.
|
||||
|
||||
There are 3 main modes of operation:
|
||||
|
||||
## Preheat
|
||||
[Define profiles](Configuration.md#preheat-options) to quickly change the target temperature of multiple selected devices.
|
||||
This is the default mode when not printing.
|
||||
|
||||

|
||||
|
||||
## Delta adjust
|
||||
Change the target of the selected devices, the amount is selectable.
|
||||
This is the default mode while printing
|
||||
|
||||

|
||||
|
||||
## Direct input with keypad
|
||||
Allows to set the exact temperature using the keypad.
|
||||
|
||||

|
@ -14,6 +14,8 @@ have set your pi up for your preferred language.
|
||||
* Save the file as `ks_includes/locales/{LANGUAGE DESIGNATION}/KlipperScreen.po`.
|
||||
* Select `File -> Compile to MO`. Save this file as `ks_includes/locales/{LANGUAGE DESIGNATION}/KlipperScreen.mo`
|
||||
|
||||
Once you have followed those steps, as long as your pi is set up for your preferred language, KlipperScreen will
|
||||
automatically use the translations provided in the file. KlipperScreen currently does not detect RTL languages, but
|
||||
support for RTL is planned in the near future.
|
||||
Once you have followed those steps, restart KlipperScreen, and select it from the list in the settings.
|
||||
If you edited and recompiled, you need to restart KlipperScreen to reload the translation.
|
||||
|
||||
Do not edit the POT file as is automatically generated and your changes will be lost.
|
||||
[Attach your translation on a GitHub issue or create a PR](Contact.md)
|
||||
|
41
docs/Zcalibrate.md
Normal file
@ -0,0 +1,41 @@
|
||||
# Zcalibrate
|
||||
This panel supports various modes of operation to assist in the calibration of the Z axis of the machine.
|
||||
It's strongly suggested to read Klipper documentation about [Bed level](https://www.klipper3d.org/Bed_Level.html)
|
||||
|
||||

|
||||
|
||||
|
||||
## Buttons
|
||||
* "Start" will initiate the only method available, or ask the user if multiple methods are available.
|
||||
* The raise(+) and lower(-) buttons send `TESTZ Z=distance` where distance is selected in the bottom row.
|
||||
* Accept will send `ACCEPT`
|
||||
* Abort will send `ABORT`
|
||||
|
||||
## Calibration methods
|
||||
### Endstop (`Z_ENDSTOP_CALIBRATE`)
|
||||
Available when an 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)
|
||||
|
||||
### Probe (`PROBE_CALIBRATE`)
|
||||
Available when a probe is defined. (BL-Touch is a probe)
|
||||
|
||||
See Klipper documentation: [Calibrating probe Z offset](https://www.klipper3d.org/Probe_Calibrate.html#calibrating-probe-z-offset)
|
||||
|
||||
### Bed mesh (`BED_MESH_CALIBRATE`)
|
||||
Available when a probe is not defined and `[bed_mesh]` is defined
|
||||
|
||||
this mode lets you create a mesh leveling bed using the paper test in various points.
|
||||
|
||||
!!! warning
|
||||
DO NOT adjust the bed screws while using this mode.
|
||||
|
||||
Adjust the screws using the [bed screws](Screws.md) panel before running this tool.
|
||||
|
||||
### Delta Automatic/Manual (`DELTA_CALIBRATE`)
|
||||
Available when the kinematics are defined as delta.
|
||||
|
||||
See Klipper documentation: [Delta calibration](https://www.klipper3d.org/Delta_Calibrate.html)
|
||||
|
||||
!!! note
|
||||
KlipperScreen will automatically Home(`G28`) if needed
|
BIN
docs/img/panels/job_status_extrusion.png
Normal file
After Width: | Height: | Size: 23 KiB |
BIN
docs/img/panels/job_status_speed.png
Normal file
After Width: | Height: | Size: 24 KiB |
BIN
docs/img/panels/job_status_time.png
Normal file
After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 22 KiB |
BIN
docs/img/panels/temperature_delta.png
Normal file
After Width: | Height: | Size: 23 KiB |
BIN
docs/img/panels/temperature_keypad.png
Normal file
After Width: | Height: | Size: 21 KiB |
11
mkdocs.yml
@ -7,7 +7,6 @@ repo_name: jordanruthe/KlipperScreen/
|
||||
repo_url: https://github.com/jordanruthe/KlipperScreen/
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Bed Level/Screws: Screws.md
|
||||
- Setup:
|
||||
- Hardware.md
|
||||
- Installation.md
|
||||
@ -16,10 +15,16 @@ nav:
|
||||
- Macros: macros.md
|
||||
- Android.md
|
||||
- Troubleshooting.md
|
||||
- Panels:
|
||||
- Bed Level/Screws: Screws.md
|
||||
- Job_status/Printing: Job_status.md
|
||||
- Temperature: Temperature.md
|
||||
- Z Calibrate: Zcalibrate.md
|
||||
- Screenshots: Panels.md
|
||||
- Theming.md
|
||||
- Translations.md
|
||||
- Breaking Changes: Changelog.md
|
||||
- Screenshots: Panels.md
|
||||
|
||||
- Contact.md
|
||||
theme:
|
||||
name: material
|
||||
@ -27,8 +32,8 @@ theme:
|
||||
features:
|
||||
- content.code.annotate
|
||||
- content.tooltips
|
||||
- navigation.expand
|
||||
- navigation.indexes
|
||||
- navigation.sections
|
||||
- navigation.top
|
||||
- navigation.tracking
|
||||
- search.highlight
|
||||
|
@ -1 +1,3 @@
|
||||
mkdocs build --clean --site-dir _html --config-file mkdocs.yml
|
||||
# mkdocs build --clean --site-dir _html --config-file mkdocs.yml
|
||||
# For testing is better to use the integrated server.
|
||||
mkdocs serve --config-file mkdocs.yml
|
||||
|