CreatBot/GeneralKlipperScreen
7
0
Fork 0
forked from CreatBot/CreatBotKlipperScreen
Code Pull Requests Activity

docs: add a notices about config newlines, preheat and menus

Browse Source
This commit is contained in:
alfrix 2023-07-13 19:31:28 -03:00 committed by Alfredo Monclus
parent f19d39fce1
commit 0d05ef3b59
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/Configuration.md
View File

@ -5,6 +5,13 @@ create a blank file in `~/printer_data/config/KlipperScreen.conf`, if the file a
Write in the file only the options that need to be changed, and restart KlipperScreen.
!!! failure "Critical"
Each configuration option should be on a newline, as they are presented here.
The line endings should be of UNIX style (LF).
## Include files
```py
[include conf.d/*.conf]
@ -96,6 +103,11 @@ camera_url: http://127.0.0.1/webcam/?action=stream
```
## Preheat Options
!!! question
Adding a custom preheat section will cause the defaults to not load, this is
the intended behaviour.
```py
[preheat my_temp_setting]
extruder: 195
@ -126,6 +138,9 @@ different items and there are several panel options available. It is possible to
button press. There are two menus available in KlipperScreen, __main and __print. The __main menu is displayed while the
printer is idle. The __print menu is accessible from the printing status page.
!!! info
A predefined set of menus is already provided and it's recommended to be used
A menu item is configured as follows:
```py
[menu __main my_menu_item]