diff --git a/install/index.html b/install/index.html index fff4a1e..0657064 100644 --- a/install/index.html +++ b/install/index.html @@ -471,6 +471,7 @@
To update KlipperMaintenance, run in your terminal:
cd KlipperMaintenance
+git pull
sh install.sh
sudo service klipper restart
Keep your 3D printer running smoothly
Info
This is still a work in progress with partial testing.
"},{"location":"#features","title":"Features","text":"Klipper Maintenance supports the following features:
Follow Installation to get started with Klipper Maintenance.
"},{"location":"#configuration","title":"Configuration","text":"After installing KlipperMaintenance, follow Configuration to configure KlipperMaintenance.
"},{"location":"#usage","title":"Usage","text":"To use KlipperMaintenance, follow G-Codes.
"},{"location":"config/","title":"Configuration","text":"After installing KlipperMaintenance, follow this guide to configure it.
"},{"location":"config/#main-section","title":"Main Section","text":"First, a main [maintain]
section must be configured. This has two main purposes:
MAINTAIN_STATUS
commandTo configure it, add to your printer.cfg
:
[maintain]\ninterval: 60 # optional, time (in seconds) between checking if maintenance needs to be done (default is 60)\n
"},{"location":"config/#maintenance-sections","title":"Maintenance Sections","text":"Next, for each maintenance object, a [maintain xxx]
config section should be configured. In this example, three maintenance objects will be configured (note the times here are purely for demonstration and are probably not ideal):
For each [maintain xxx]
section, there are four options that must be set:
label
text that will be displayed when referring to this maintenance objecttrigger
type of event that triggers this maintenance. Currently three options:print_time
print time, in hoursfilament
extruded filament, in meters (330m is roughly 1kg of PLA)time
time, in hoursthreshold
how often maintenance needs to be done. For print_time
and time
, this is in hours. For filament
, this is in metersmessage
message that will be displayed when maintenance needs to be doneExample:
printer.cfg# Lubricate XY rods\n[maintain xyrods]\nlabel: XY smooth rods\ntrigger: print_time\nthreshold: 250\nmessage: Lubricate XY smooth rods\n\n# Replace air filter\n[maintain airfilter]\nlabel: Air filter\ntrigger: time\nthreshold: 500\nmessage: Replace HEPA and charcoal filters\n\n# Extruder maintenance\n[maintain extruder]\nlabel: Extruder maintenance\ntrigger: filament\nthreshold: 700\nmessage: Clean extruder gears and tighten extruder bolts\n
"},{"location":"gcodes/","title":"G-Codes","text":"KlipperMaintenance provides a few helper GCodes to manage your maintenance. Follow this guide to learn how to use them.
"},{"location":"gcodes/#maintain_status","title":"MAINTAIN_STATUS","text":"Shows the current status of maintenance. Accepts no parameters. Using the example from Configuration and assuming air filter is expired, here is an example:
InputMAINTAIN_STATUS\n
OutputXY smooth rods: 200h remaining\nMaintenance \"Air filter\" Expired!\nReplace HEPA and charcoal filters\nExtruder maintenance: 400m remaining\n
"},{"location":"gcodes/#check_maintenance","title":"CHECK_MAINTENANCE","text":"Shows the current status of provided maintenance. Example:
InputCHECK_MAINTENANCE NAME=xyrods\n
OutputMaintenance xyrods Status:\nNext maintenance in 200h\nMaintenance message: Lubricate XY smooth rods\n
"},{"location":"gcodes/#update_maintenance","title":"UPDATE_MAINTENANCE","text":"Marks the provided maintenance as complete. Example:
inputUPDATE_MAINTENANCE NAME=xyrods\n
This resets the maintenance timer for the xyrods
maintenance.
Follow this guide to install or update KlipperMaintenance.
"},{"location":"install/#install","title":"Install","text":"To install KlipperMaintenance, run in your terminal:
cd ~\ngit clone https://github.com/3DCoded/KlipperMaintenance\ncd KlipperMaintenance\nsh install.sh\nsudo service klipper restart\n
"},{"location":"install/#update","title":"Update","text":"To update KlipperMaintenance, run in your terminal:
cd KlipperMaintenance\nsh install.sh\nsudo service klipper restart\n
"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Klipper Maintenance","text":"Keep your 3D printer running smoothly
Info
This is still a work in progress with partial testing.
"},{"location":"#features","title":"Features","text":"Klipper Maintenance supports the following features:
Follow Installation to get started with Klipper Maintenance.
"},{"location":"#configuration","title":"Configuration","text":"After installing KlipperMaintenance, follow Configuration to configure KlipperMaintenance.
"},{"location":"#usage","title":"Usage","text":"To use KlipperMaintenance, follow G-Codes.
"},{"location":"config/","title":"Configuration","text":"After installing KlipperMaintenance, follow this guide to configure it.
"},{"location":"config/#main-section","title":"Main Section","text":"First, a main [maintain]
section must be configured. This has two main purposes:
MAINTAIN_STATUS
commandTo configure it, add to your printer.cfg
:
[maintain]\ninterval: 60 # optional, time (in seconds) between checking if maintenance needs to be done (default is 60)\n
"},{"location":"config/#maintenance-sections","title":"Maintenance Sections","text":"Next, for each maintenance object, a [maintain xxx]
config section should be configured. In this example, three maintenance objects will be configured (note the times here are purely for demonstration and are probably not ideal):
For each [maintain xxx]
section, there are four options that must be set:
label
text that will be displayed when referring to this maintenance objecttrigger
type of event that triggers this maintenance. Currently three options:print_time
print time, in hoursfilament
extruded filament, in meters (330m is roughly 1kg of PLA)time
time, in hoursthreshold
how often maintenance needs to be done. For print_time
and time
, this is in hours. For filament
, this is in metersmessage
message that will be displayed when maintenance needs to be doneExample:
printer.cfg# Lubricate XY rods\n[maintain xyrods]\nlabel: XY smooth rods\ntrigger: print_time\nthreshold: 250\nmessage: Lubricate XY smooth rods\n\n# Replace air filter\n[maintain airfilter]\nlabel: Air filter\ntrigger: time\nthreshold: 500\nmessage: Replace HEPA and charcoal filters\n\n# Extruder maintenance\n[maintain extruder]\nlabel: Extruder maintenance\ntrigger: filament\nthreshold: 700\nmessage: Clean extruder gears and tighten extruder bolts\n
"},{"location":"gcodes/","title":"G-Codes","text":"KlipperMaintenance provides a few helper GCodes to manage your maintenance. Follow this guide to learn how to use them.
"},{"location":"gcodes/#maintain_status","title":"MAINTAIN_STATUS","text":"Shows the current status of maintenance. Accepts no parameters. Using the example from Configuration and assuming air filter is expired, here is an example:
InputMAINTAIN_STATUS\n
OutputXY smooth rods: 200h remaining\nMaintenance \"Air filter\" Expired!\nReplace HEPA and charcoal filters\nExtruder maintenance: 400m remaining\n
"},{"location":"gcodes/#check_maintenance","title":"CHECK_MAINTENANCE","text":"Shows the current status of provided maintenance. Example:
InputCHECK_MAINTENANCE NAME=xyrods\n
OutputMaintenance xyrods Status:\nNext maintenance in 200h\nMaintenance message: Lubricate XY smooth rods\n
"},{"location":"gcodes/#update_maintenance","title":"UPDATE_MAINTENANCE","text":"Marks the provided maintenance as complete. Example:
inputUPDATE_MAINTENANCE NAME=xyrods\n
This resets the maintenance timer for the xyrods
maintenance.
Follow this guide to install or update KlipperMaintenance.
"},{"location":"install/#install","title":"Install","text":"To install KlipperMaintenance, run in your terminal:
cd ~\ngit clone https://github.com/3DCoded/KlipperMaintenance\ncd KlipperMaintenance\nsh install.sh\nsudo service klipper restart\n
"},{"location":"install/#update","title":"Update","text":"To update KlipperMaintenance, run in your terminal:
cd KlipperMaintenance\ngit pull\nsh install.sh\nsudo service klipper restart\n
"}]}
\ No newline at end of file