From f9cb29ac910d7268637c114cd0f3c91f5eae39f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Thu, 28 Jul 2016 09:43:41 +0200 Subject: [PATCH] A bunch of documentation fixes and updates --- docs/api/fileops.rst | 5 +- docs/configuration/config_yaml.rst | 108 ++++++++++++++++++++++++++++- 2 files changed, 108 insertions(+), 5 deletions(-) diff --git a/docs/api/fileops.rst b/docs/api/fileops.rst index 136b1a3f..7cadb8c4 100644 --- a/docs/api/fileops.rst +++ b/docs/api/fileops.rst @@ -390,8 +390,9 @@ Issue a file command } - :param target: The target location on which to delete the file, either ``local`` (for OctoPrint's ``uploads`` - folder) or ``sdcard`` for the printer's SD card (if available) + :param target: The target location on which the file to send the command for is located, either + ``local`` (for OctoPrint's ``uploads`` folder) or ``sdcard`` for the printer's SD card + (if available) :param filename: The filename of the file for which to issue the command :json string command: The command to issue for the file, currently only ``select`` is supported :json boolean print: ``select`` and ``slice`` command: Optional, whether to start printing the file directly after selection diff --git a/docs/configuration/config_yaml.rst b/docs/configuration/config_yaml.rst index a0aad14b..7c885e84 100644 --- a/docs/configuration/config_yaml.rst +++ b/docs/configuration/config_yaml.rst @@ -244,6 +244,9 @@ The following settings are only relevant to you if you want to do OctoPrint deve # be fully rerendered on request to / on the server. enabled: true + # Whether to enable the preemptive cache + preemptive: true + # Settings for stylesheet preference. OctoPrint will prefer to use the stylesheet type # specified here. Usually (on a production install) that will be the compiled css (default). # Developers may specify less here too. @@ -260,6 +263,9 @@ The following settings are only relevant to you if you want to do OctoPrint deve # set to false, no minification will take place either. minify: true + # Whether to delete generated web assets on server startup (forcing a regeneration) + clean_on_startup: true + # Settings for the virtual printer virtualPrinter: @@ -321,6 +327,10 @@ The following settings are only relevant to you if you want to do OctoPrint deve # < ok T0:34.3/220.0 T1:23.5/0.0 B:43.2/0.0 repetierStyleTargetTemperature: false + # If enabled, uses repetier style resends, sending multiple resends for the same line + # to make sure nothing gets lost on the line + repetierStyleResends: false + # If enabled, reports the first extruder in M105 responses as T instead of T0 # # True: > M105 @@ -348,9 +358,54 @@ The following settings are only relevant to you if you want to do OctoPrint deve # side will block rxBuffer: 64 - # Size of + # Size of simulated command buffer commandBuffer: 4 + # Whether to support the M112 command with simulated kill + supportM112: true + + # Whether to send messages received via M117 back as "echo:" lines + echoOnM117: true + + # Whether to simulate broken M29 behaviour (missing ok after response) + brokenM29: true + +.. _sec-configuration-config_yaml-estimation: + +Estimation +---------- + +The following settings provide parameters for estimators within OctoPrint. Currently only +the estimation of the left print time during an active job utilizes this section. + +.. code-block:: yaml + + estimation: + # Parameters for the print time estmation during an ongoing print job + printTime: + # Until which percentage to do a weighted mixture of statistical duration (analysis or + # past prints) with the result from the calculated estimate if that's already available. + # Utilized to compensate for the fact that the earlier in a print job, the least accuracy + # even a stable calculated estimate provides. + statsWeighingUntil: 0.5 + + # Range the assumed percentage (based on current estimated statistical, calculated or mixed + # total vs elapsed print time so far) needs to be around the actual percentage for the + # result to be used + validityRange: 0.15 + + # If no estimate could be calculated until this percentage and no statistical data is available, + # use dumb linear estimate + forceDumbFromPercent: 0.3 + + # If no estimate could be calculated until this many minutes into the print and no statistical + # data is available, use dumb linear estimate + forceDumbAfterMin: 30 + + # Average fluctuation between individual calculated estimates to consider in stable range. Seconds + # of difference. + stableThreshold: 60 + .. _sec-configuration-config_yaml-events: Events @@ -454,6 +509,16 @@ Use the following settings to enable or disable OctoPrint features: # Whether to enable the keyboard control feature in the control tab keyboardControl: true + # Whether to actively poll the watched folder (true) or to rely on the OS's file system + # notifications instead (false) + pollWatched: false + + # Whether to ignore identical resends from the printer (true, repetier) or not (false) + ignoreIdenticalResends: false + + # If ignoredIdenticalResends is true, how many consecutive identical resends to ignore + identicalResendsCount: 7 + .. _sec-configuration-config_yaml-folder: Folder @@ -640,8 +705,24 @@ Use the following settings to configure the serial connection to the printer: # Command to send in order to initiate a handshake with the printer. # Defaults to "M110 N0" which simply resets the line numbers in the firmware and which # should be acknowledged with a simple "ok". - helloCommand: - - M110 N0 + helloCommand: M110 N0 + + # Whether to disconnect on errors or not + disconnectOnErrors: true + + # Whether to completely ignore errors from the firmware or not + ignoreErrorsFromFirmware: false + + # Whether to log resends to octoprint.log or not. Invaluable debug tool without performance + # impact, leave on if possible please + logResends: true + + # Whether to support resends without follow-up ok or not + supportResendsWithoutOk: false + + # Whether to "manually" trigger an ok for M29 (a lot of versions of this command are buggy and + # the responds skips on the ok) + triggerOkForM29: true .. _sec-configuration-config_yaml-server: @@ -736,6 +817,27 @@ Use the following settings to configure the server: # Command to shut down the system OctoPrint is running on, defaults to being unset systemShutdownCommand: sudo shutdown -h now + # Settings of when to display what disk space warning + diskspace: + + # Threshold (bytes) after which to consider disk space becoming sparse, + # defaults to 500MB + warning: 63488000 + + # Threshold (bytes) after which to consider disk space becoming critical, + # defaults to 200MB + critical: 209715200 + + # Configuration of the preemptive cache + preemptiveCache: + + # which server paths to exclude from the preemptive cache + exceptions: + - /some/path + + # How many days to leave unused entries in the preemptive cache config + until: 7 + .. note::