Documentation updates close #821

This commit is contained in:
alfrix 2022-11-28 17:26:15 -03:00
parent d6161539a6
commit 3c8886ab36
4 changed files with 53 additions and 39 deletions

View File

@ -76,7 +76,7 @@ calibrate_y_position: 100
# Bed Screws # Bed Screws
# define the screw positons required for odd number of screws in a comma separated list # define the screw positons required for odd number of screws in a comma separated list
# possible values are: bl, br, bm, fl, fr, fm, lm, rm # possible values are: bl, br, bm, fl, fr, fm, lm, rm
# they correspond to back-left, back-right, back-middle, front-left, front-right, front-middle, left-middle, left-right # they correspond to back-left, back-right, back-middle, front-left, front-right, front-middle, left-middle, right-middle
screw_positions: "" screw_positions: ""
# Rotation is useful if the screen is not directly in front of the machine. # Rotation is useful if the screen is not directly in front of the machine.

View File

@ -35,11 +35,31 @@ Moved to [Thumbnails](Thumbnails.md)
## Layer Progress ## Layer Progress
Accurate layer progress as a message below the status:
PrusaSlicer/SuperSlicer > Printer Settings > Custom Gcode > After layer change Gcode PrusaSlicer/SuperSlicer > Printer Settings > Custom Gcode > After layer change Gcode
`M117 Layer {layer_num+1}/[total_layer_count] : {filament_settings_id[0]}` `M117 Layer {layer_num+1}/[total_layer_count] : {filament_settings_id[0]}`
![Layer_progress](img/quicktips/PS_SS_Layer_progress.png) ![Layer_progress](img/quicktips/PS_SS_Layer_progress.png)
Accurate layer progress in the secondary screen of the printing panel:
The layer number in the secondary screen of the printing panelis calculated according to object height and provided layer height.
It will be innacurate when using variable layer height, but can be fixed by providing klipper with the correct data.
![speed_screenshot](img/panels/job_status_speed.png)
PrusaSlicer/SuperSlicer:
Printer Settings > Custom Gcode > Start Gcode
`SET_PRINT_STATS_INFO TOTAL_LAYER=[total_layer_count]`
Printer Settings > Custom Gcode > After layer change Gcode
`SET_PRINT_STATS_INFO CURRENT_LAYER={layer_num + 1}`
## Supported Macros ## Supported Macros
[Macros](macros.md) [Macros](macros.md)

View File

@ -1,21 +1,32 @@
## Create Translations # Translations
You can use an editor such as [poedit](https://poedit.net/) to assist in translations. This guide will assume that you ## Updating an existing translation:
will be using poedit.
This guide will refer to `language designation`. This can be found from running `echo $LANG` on your pi, as long as you You can use an editor such as [poedit](https://poedit.net/) to assist in translations.
have set your pi up for your preferred language.
#### New Language * Edit `ks_includes/locals/{ISO 639 lang code}/LC_MESSAGES/KlipperScreen.po`
To test your translation:
In poedit go to `File -> Compile to MO`. Save it on the same folder, and restart KlipperScreen
## Adding a new Language:
Example using poedit
* Select `Create a new translation` or `File -> New from POT/PO` and select `ks_includes/locals/KlipperScreen.pot`. * Select `Create a new translation` or `File -> New from POT/PO` and select `ks_includes/locals/KlipperScreen.pot`.
* Enter your language designation. !!! important
* Create the translations Do not edit the POT file as is automatically generated and your changes will be lost.
* Save the file as `ks_includes/locales/{LANGUAGE DESIGNATION}/KlipperScreen.po`. * Save the file as `ks_includes/locales/{ISO 639 lang code}/LC_MESSAGES/KlipperScreen.po`
* Select `File -> Compile to MO`. Save this file as `ks_includes/locales/{LANGUAGE DESIGNATION}/KlipperScreen.mo` * Select `File -> Compile to MO`. Save it on the same folder, and restart KlipperScreen
Once you have followed those steps, restart KlipperScreen, and select it from the list in the settings. !!! note
[Wikipedia ISO 639 Language Codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
Once you have restarted KlipperScreen, select it from the list in the settings.
If you edited and recompiled, you need to restart KlipperScreen to reload the translation. 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.
## Contributing:
[Attach your translation on a GitHub issue or create a PR](Contact.md) [Attach your translation on a GitHub issue or create a PR](Contact.md)

View File

@ -7,51 +7,34 @@ Load and Unload Filament macros are used in the Extrude-Panel if it is available
The selected speed is transferred to this macro. The selected speed is transferred to this macro.
The following example macros show how this can be used in the macro. The following example macros show how this can be used in the macro.
```py ```jinja
[gcode_macro LOAD_FILAMENT]
gcode:
{% set speed = params.SPEED|default(500) %}
G91
G1 E50 F{speed}
G1 E50 F{speed}
G92
```
```py
[gcode_macro UNLOAD_FILAMENT]
gcode:
{% set speed = params.SPEED|default(500) %}
G91
G1 E-50 F{speed}
G1 E-50 F{speed}
G92
```
this could be interesting to tweak the purge speed, this would be one Example Macro from alfrix:
```py
[gcode_macro LOAD_FILAMENT] [gcode_macro LOAD_FILAMENT]
gcode: gcode:
{% set speed = params.SPEED|default(300) %} {% set speed = params.SPEED|default(300) %}
{% set max_velocity = printer.configfile.settings['extruder'].max_extrude_only_velocity %} {% set max_velocity = printer.configfile.settings['extruder'].max_extrude_only_velocity %}
SAVE_GCODE_STATE NAME=load_state
M300 # beep M300 # beep
G91 G91
G92 E0 G92 E0
G1 E350 F{max_velocity} G1 E350 F{max_velocity} # fast-load
G1 E25 F{speed} #purge G1 E25 F{speed} # purge
M300 M300
M300 M300
RESTORE_GCODE_STATE NAME=load_state
``` ```
```py ```jinja
[gcode_macro UNLOAD_FILAMENT] [gcode_macro UNLOAD_FILAMENT]
gcode: gcode:
{% set speed = params.SPEED|default(300) %} {% set speed = params.SPEED|default(300) %}
{% set max_velocity = printer.configfile.settings['extruder'].max_extrude_only_velocity %} {% set max_velocity = printer.configfile.settings['extruder'].max_extrude_only_velocity %}
SAVE_GCODE_STATE NAME=unload_state
G91 G91
M300 # beep M300 # beep
G92 E0 G92 E0
G1 E25 F{speed} # purge G1 E25 F{speed} # purge
G1 E-420 F{max_velocity} G1 E-420 F{max_velocity} # fast-unload
M300 M300
M300 M300
RESTORE_GCODE_STATE NAME=unload_state
``` ```