Update Docs (#346)

This commit is contained in:
Alfredo Monclus 2021-11-29 13:09:25 -03:00 committed by GitHub
parent 4569192ffa
commit 1e5d701631
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 36 additions and 23 deletions

View File

@ -1,21 +1,8 @@
# Configuration
The configuration options are outlined below:
Create a blank file in `~/klipper_config/KlipperScreen.conf_`, if the file already exist then just edit it.
KlipperScreen will search for a configuration file in the following order:
1. _~/KlipperScreen.conf_
2. _${KlipperScreen_Directory}/KlipperScreen.conf_
3. _~/klipper_config/KlipperScreen.conf_
If one of those files are found, it will be used over the default configuration. The default configuration will be
merged with the custom configuration, so if you do not define any menus the default menus will be used.
The default config is included here: (do not edit use as reference)
_${KlipperScreen_Directory}/ks_includes/default.conf_
If no config file is found then a new configuration file will be created in:
_~/klipper_config/KlipperScreen.conf_ Or _~/KlipperScreen.conf_
Write in the file only the options that need to be changed.
## Include files
```
@ -143,3 +130,24 @@ icon: home
method: printer.gcode.script
params: {"script":"G28"}
```
## KlipperScreen behaviour towards configuration
KlipperScreen will search for a configuration file in the following order:
1. _~/KlipperScreen.conf_
2. _${KlipperScreen_Directory}/KlipperScreen.conf_
3. _~/klipper_config/KlipperScreen.conf_
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.
If one of those files are found, it will be used over the default configuration. The default configuration will be
merged with the custom configuration, so if you do not define any menus the default menus will be used.
The default config is included here: (do not edit use as reference)
_${KlipperScreen_Directory}/ks_includes/default.conf_
Preferably *do not* copy the entire default.conf file, just configure the settings needed.
If no config file is found, then when a setting is changed in the settings panel, a new configuration file will be created automatically.

View File

@ -15,13 +15,14 @@ Follow the instructions to install Klipper and Moonraker.
* klipper: https://www.klipper3d.org/Installation.html
* moonraker: https://moonraker.readthedocs.io/en/latest/installation/
Ensure that 127.0.0.1 is a trusted client for moonraker, such as in this example:
In moonraker.conf ensure that 127.0.0.1 is a trusted client for moonraker, such as in this example:
```
[authorization]
trusted_clients:
127.0.0.1
```
Warning: `force_logins: true` is not supported
Note: `force_logins: true` requires the moonraker api key in [KlipperScreen.conf](Configuration.md)
If you wish to use the update manager feature of moonraker for KlipperScreen, add the following block into the moonraker
configuration:

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 104 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 120 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 107 KiB

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 244 KiB

After

Width:  |  Height:  |  Size: 22 KiB

BIN
docs/img/limits.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 106 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 226 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 130 KiB

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 81 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

@ -23,11 +23,11 @@ for _Screws Calibrate_ will appear. This button runs the SCREWS_TILT_CALCULATE c
panel.
### Bed Mesh
type: bed_mesh
type: bed_mesh theme:material-dark
![Bed Mesh](img/bed_mesh.png)
### Extrude
type: extrude
type: extrude theme:material-dark
![Extrude](img/extrude.png)
### Fan
@ -35,11 +35,11 @@ type: fan
![Fan](img/fan.png)
### Fine Tune
type: fine_tune
type: fine_tune theme:custom
![Fine Tune Panel](img/fine_tune.png)
### Gcode Macros
type: gcode_macros
type: gcode_macros theme: material-darker
![Gcode Macros Panel](img/gcode_macros.png)
### Menu
@ -67,7 +67,7 @@ type: print
![Print Panel](img/print.png)
### Settings
type: settings
type: settings theme:colorized
![Settings](img/settings.png)
### System
@ -75,9 +75,13 @@ type: system
![System Panel](img/system.png)
### Temperature
type: temperature
type: temperature theme:material-light
![Temperature](img/temperature.png)
### Z Calibrate
type: zcalibrate
![Z Calibrate](img/zcalibrate.png)
### Limits
type: limits theme: material-dark
![Limits](img/limits.png)