diff --git a/1.8.7/api/access.html b/1.8.7/api/access.html index 23a556832..26bec1fc0 100644 --- a/1.8.7/api/access.html +++ b/1.8.7/api/access.html @@ -141,7 +141,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -941,7 +941,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/connection.html b/1.8.7/api/connection.html index 56f7a0016..9da6f17cf 100644 --- a/1.8.7/api/connection.html +++ b/1.8.7/api/connection.html @@ -112,7 +112,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -342,7 +342,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/datamodel.html b/1.8.7/api/datamodel.html index 1aa0c061e..91cccd853 100644 --- a/1.8.7/api/datamodel.html +++ b/1.8.7/api/datamodel.html @@ -139,7 +139,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -1200,7 +1200,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/files.html b/1.8.7/api/files.html index 609181fa6..a0a519185 100644 --- a/1.8.7/api/files.html +++ b/1.8.7/api/files.html @@ -121,7 +121,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -1125,7 +1125,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/general.html b/1.8.7/api/general.html index ab3d2bb82..7d66e004a 100644 --- a/1.8.7/api/general.html +++ b/1.8.7/api/general.html @@ -123,7 +123,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -489,7 +489,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/index.html b/1.8.7/api/index.html index cc2b3443b..25246b1e8 100644 --- a/1.8.7/api/index.html +++ b/1.8.7/api/index.html @@ -108,7 +108,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -309,7 +309,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/job.html b/1.8.7/api/job.html index c3c1cd3e6..cf3eed04d 100644 --- a/1.8.7/api/job.html +++ b/1.8.7/api/job.html @@ -116,7 +116,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -444,7 +444,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/languages.html b/1.8.7/api/languages.html index 9817f65bc..70cd969cf 100644 --- a/1.8.7/api/languages.html +++ b/1.8.7/api/languages.html @@ -119,7 +119,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -460,7 +460,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/logs.html b/1.8.7/api/logs.html index 3eeb158c0..16340c07d 100644 --- a/1.8.7/api/logs.html +++ b/1.8.7/api/logs.html @@ -108,7 +108,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -180,7 +180,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/printer.html b/1.8.7/api/printer.html index 105c84720..816345076 100644 --- a/1.8.7/api/printer.html +++ b/1.8.7/api/printer.html @@ -130,7 +130,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -1487,7 +1487,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/printerprofiles.html b/1.8.7/api/printerprofiles.html index 96447dbd1..946e412a8 100644 --- a/1.8.7/api/printerprofiles.html +++ b/1.8.7/api/printerprofiles.html @@ -121,7 +121,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -677,7 +677,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/push.html b/1.8.7/api/push.html index 385e4cdf3..81a19bc5c 100644 --- a/1.8.7/api/push.html +++ b/1.8.7/api/push.html @@ -117,7 +117,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -555,7 +555,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/server.html b/1.8.7/api/server.html index dc7067f08..a55cfbe32 100644 --- a/1.8.7/api/server.html +++ b/1.8.7/api/server.html @@ -108,7 +108,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -210,7 +210,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/settings.html b/1.8.7/api/settings.html index d1c20fac0..a11d8937b 100644 --- a/1.8.7/api/settings.html +++ b/1.8.7/api/settings.html @@ -115,7 +115,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -628,7 +628,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/slicing.html b/1.8.7/api/slicing.html index f57122018..fb3e22bc3 100644 --- a/1.8.7/api/slicing.html +++ b/1.8.7/api/slicing.html @@ -124,7 +124,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -682,7 +682,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/system.html b/1.8.7/api/system.html index 8c5244e8d..794dd2c68 100644 --- a/1.8.7/api/system.html +++ b/1.8.7/api/system.html @@ -119,7 +119,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -488,7 +488,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/timelapse.html b/1.8.7/api/timelapse.html index 8183694be..7dcd986b8 100644 --- a/1.8.7/api/timelapse.html +++ b/1.8.7/api/timelapse.html @@ -122,7 +122,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -563,7 +563,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/users.html b/1.8.7/api/users.html index a5bc462ec..35e70a0a0 100644 --- a/1.8.7/api/users.html +++ b/1.8.7/api/users.html @@ -85,7 +85,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -151,7 +151,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/util.html b/1.8.7/api/util.html index ede6d922a..95d3377e4 100644 --- a/1.8.7/api/util.html +++ b/1.8.7/api/util.html @@ -119,7 +119,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -762,7 +762,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/version.html b/1.8.7/api/version.html index 11c4eed4d..751364bc9 100644 --- a/1.8.7/api/version.html +++ b/1.8.7/api/version.html @@ -108,7 +108,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -207,7 +207,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/api/wizard.html b/1.8.7/api/wizard.html index c5c3c52ed..f181edd29 100644 --- a/1.8.7/api/wizard.html +++ b/1.8.7/api/wizard.html @@ -116,7 +116,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -277,7 +277,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/action_command_notification.html b/1.8.7/bundledplugins/action_command_notification.html index f0377fcec..5ab13fc51 100644 --- a/1.8.7/bundledplugins/action_command_notification.html +++ b/1.8.7/bundledplugins/action_command_notification.html @@ -110,7 +110,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -219,7 +219,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/action_command_prompt.html b/1.8.7/bundledplugins/action_command_prompt.html index e23d89387..57803f1bb 100644 --- a/1.8.7/bundledplugins/action_command_prompt.html +++ b/1.8.7/bundledplugins/action_command_prompt.html @@ -110,7 +110,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -253,7 +253,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/announcements.html b/1.8.7/bundledplugins/announcements.html index e9c59c08c..9ed3386e9 100644 --- a/1.8.7/bundledplugins/announcements.html +++ b/1.8.7/bundledplugins/announcements.html @@ -108,7 +108,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -226,7 +226,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/appkeys.html b/1.8.7/bundledplugins/appkeys.html index b5f2778eb..7d349151b 100644 --- a/1.8.7/bundledplugins/appkeys.html +++ b/1.8.7/bundledplugins/appkeys.html @@ -129,7 +129,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -988,7 +988,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/backup.html b/1.8.7/bundledplugins/backup.html index 5427a90c6..0a8d02245 100644 --- a/1.8.7/bundledplugins/backup.html +++ b/1.8.7/bundledplugins/backup.html @@ -119,7 +119,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -301,7 +301,7 @@

A list of paths to exclude, relative to your plugin’s data folder

Return type
-

list

+

list

@@ -337,8 +337,8 @@

Helpers
Parameters
    -

  • exclude (list) – Names of data folders to exclude, defaults to None

    • -

  • filename (str) – Name of backup to be created, if None (default) the backup +

  • exclude (list) – Names of data folders to exclude, defaults to None

    • +

  • filename (str) – Name of backup to be created, if None (default) the backup name will be auto-generated. This should use a .zip extension.

@@ -376,7 +376,7 @@

Helpers
Parameters
-

filename (str) – The name of the backup to delete

+

filename (str) – The name of the backup to delete

@@ -435,7 +435,7 @@

Helpers
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/discovery.html b/1.8.7/bundledplugins/discovery.html index f28954bbe..1d285f7cc 100644 --- a/1.8.7/bundledplugins/discovery.html +++ b/1.8.7/bundledplugins/discovery.html @@ -117,7 +117,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -318,7 +318,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/errortracking.html b/1.8.7/bundledplugins/errortracking.html index f19617fc0..fbe1bd1f9 100644 --- a/1.8.7/bundledplugins/errortracking.html +++ b/1.8.7/bundledplugins/errortracking.html @@ -108,7 +108,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -206,7 +206,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/file_check.html b/1.8.7/bundledplugins/file_check.html index e877bb503..9763d402e 100644 --- a/1.8.7/bundledplugins/file_check.html +++ b/1.8.7/bundledplugins/file_check.html @@ -104,7 +104,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -176,7 +176,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/firmware_check.html b/1.8.7/bundledplugins/firmware_check.html index 24edc4712..a1eecdb0e 100644 --- a/1.8.7/bundledplugins/firmware_check.html +++ b/1.8.7/bundledplugins/firmware_check.html @@ -104,7 +104,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -177,7 +177,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/gcodeviewer.html b/1.8.7/bundledplugins/gcodeviewer.html index a4b7ca372..b8a4ac423 100644 --- a/1.8.7/bundledplugins/gcodeviewer.html +++ b/1.8.7/bundledplugins/gcodeviewer.html @@ -108,7 +108,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -202,7 +202,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/index.html b/1.8.7/bundledplugins/index.html index 950bbbc5e..9ac0cc7bd 100644 --- a/1.8.7/bundledplugins/index.html +++ b/1.8.7/bundledplugins/index.html @@ -104,7 +104,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -262,7 +262,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/logging.html b/1.8.7/bundledplugins/logging.html index 72c8fa521..45491e68a 100644 --- a/1.8.7/bundledplugins/logging.html +++ b/1.8.7/bundledplugins/logging.html @@ -115,7 +115,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -461,7 +461,7 @@

Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/loginui.html b/1.8.7/bundledplugins/loginui.html index 1917649c9..e3c44f95e 100644 --- a/1.8.7/bundledplugins/loginui.html +++ b/1.8.7/bundledplugins/loginui.html @@ -85,7 +85,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -148,7 +148,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/pluginmanager.html b/1.8.7/bundledplugins/pluginmanager.html index 06dcc7ed6..bcbf7426a 100644 --- a/1.8.7/bundledplugins/pluginmanager.html +++ b/1.8.7/bundledplugins/pluginmanager.html @@ -113,7 +113,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -317,7 +317,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/softwareupdate.html b/1.8.7/bundledplugins/softwareupdate.html index 4a583b40e..bb3337b53 100644 --- a/1.8.7/bundledplugins/softwareupdate.html +++ b/1.8.7/bundledplugins/softwareupdate.html @@ -128,7 +128,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -793,7 +793,7 @@

A dictionary of check configurations as described above

Return type
-

dict

+

dict

@@ -862,7 +862,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/tracking.html b/1.8.7/bundledplugins/tracking.html index 4f798f6a7..8d10bcc9a 100644 --- a/1.8.7/bundledplugins/tracking.html +++ b/1.8.7/bundledplugins/tracking.html @@ -108,7 +108,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -214,7 +214,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/bundledplugins/virtual_printer.html b/1.8.7/bundledplugins/virtual_printer.html index 2f9c5ec7f..b98e441c4 100644 --- a/1.8.7/bundledplugins/virtual_printer.html +++ b/1.8.7/bundledplugins/virtual_printer.html @@ -108,7 +108,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -192,7 +192,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/configuration/cli.html b/1.8.7/configuration/cli.html index dcd27e48c..4d528d5fc 100644 --- a/1.8.7/configuration/cli.html +++ b/1.8.7/configuration/cli.html @@ -93,7 +93,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -258,7 +258,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/configuration/config_yaml.html b/1.8.7/configuration/config_yaml.html index e030dc3aa..e179e4d07 100644 --- a/1.8.7/configuration/config_yaml.html +++ b/1.8.7/configuration/config_yaml.html @@ -116,7 +116,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -1345,7 +1345,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/configuration/index.html b/1.8.7/configuration/index.html index 1baddf5fb..8dda5f10b 100644 --- a/1.8.7/configuration/index.html +++ b/1.8.7/configuration/index.html @@ -93,7 +93,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -199,7 +199,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/configuration/logging_yaml.html b/1.8.7/configuration/logging_yaml.html index bc4ffbf1e..9dee98b15 100644 --- a/1.8.7/configuration/logging_yaml.html +++ b/1.8.7/configuration/logging_yaml.html @@ -98,7 +98,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -201,7 +201,7 @@

Changing logging handlerslogging.handlers.

+logging.handlers.

Changing logging formatters

@@ -213,7 +213,7 @@

Changing logging formattersPython documentation on LogRecord attributes.

+Python documentation on LogRecord attributes.

@@ -251,7 +251,7 @@

Changing logging formatters
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/configuration/yaml.html b/1.8.7/configuration/yaml.html index ea9fbbb80..90b61dee8 100644 --- a/1.8.7/configuration/yaml.html +++ b/1.8.7/configuration/yaml.html @@ -103,7 +103,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -345,7 +345,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/development/branches.html b/1.8.7/development/branches.html index 5b6034534..afd5c8e4f 100644 --- a/1.8.7/development/branches.html +++ b/1.8.7/development/branches.html @@ -94,7 +94,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -230,7 +230,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/development/environment.html b/1.8.7/development/environment.html index 7c237c07b..f4abad69f 100644 --- a/1.8.7/development/environment.html +++ b/1.8.7/development/environment.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -594,7 +594,7 @@

Visual Studio Code (vscode)
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/development/index.html b/1.8.7/development/index.html index 4f3097349..d223c4953 100644 --- a/1.8.7/development/index.html +++ b/1.8.7/development/index.html @@ -94,7 +94,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -192,7 +192,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/development/request-profiling.html b/1.8.7/development/request-profiling.html index 48ee24fc8..e9aea9fd6 100644 --- a/1.8.7/development/request-profiling.html +++ b/1.8.7/development/request-profiling.html @@ -97,7 +97,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -177,7 +177,7 @@

Errors
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/development/versioning.html b/1.8.7/development/versioning.html index 3276378e9..642366e69 100644 --- a/1.8.7/development/versioning.html +++ b/1.8.7/development/versioning.html @@ -94,7 +94,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -185,7 +185,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/development/virtual_printer.html b/1.8.7/development/virtual_printer.html index 7e26ce08c..e614bbfca 100644 --- a/1.8.7/development/virtual_printer.html +++ b/1.8.7/development/virtual_printer.html @@ -100,7 +100,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -460,7 +460,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/events/index.html b/1.8.7/events/index.html index f1a028c9a..fc0606526 100644 --- a/1.8.7/events/index.html +++ b/1.8.7/events/index.html @@ -106,7 +106,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -1183,7 +1183,7 @@

Example
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/features/accesscontrol.html b/1.8.7/features/accesscontrol.html index 019293591..57fa68b65 100644 --- a/1.8.7/features/accesscontrol.html +++ b/1.8.7/features/accesscontrol.html @@ -110,7 +110,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -390,7 +390,7 @@

If you are using a VPN and your setup ABSOLUTELY REQUIRES disabling internal
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/features/action_commands.html b/1.8.7/features/action_commands.html index 975ad7935..652205772 100644 --- a/1.8.7/features/action_commands.html +++ b/1.8.7/features/action_commands.html @@ -96,7 +96,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -239,7 +239,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/features/atcommands.html b/1.8.7/features/atcommands.html index 1d479c781..63a5402ba 100644 --- a/1.8.7/features/atcommands.html +++ b/1.8.7/features/atcommands.html @@ -96,7 +96,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -186,7 +186,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/features/custom_controls.html b/1.8.7/features/custom_controls.html index b65dba4ab..484ff9d05 100644 --- a/1.8.7/features/custom_controls.html +++ b/1.8.7/features/custom_controls.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -371,7 +371,7 @@

(Optional) Step size per slider “tick”, defaults to 1.

regex

-

(Optional) A regular expression to +

(Optional) A regular expression to match against lines received from the printer to retrieve information from it (e.g. specific output). Together with template this allows rendition of received data from the printer within the UI.

Please also read the note below.

@@ -379,7 +379,7 @@

template

(Optional) A template to use for rendering the match of regex. May contain placeholders in -Python Format String Syntax for either named +Python Format String Syntax for either named groups within the regex (e.g. Temperature: {temperature} for a regex T:\s*(?P<temperature>\d+(\.\d*)) or positional groups within the regex (e.g. Position: X={0}, Y={1}, Z={2}, E={3} for a regex X:([0-9.]+) Y:([0-9.]+) Z:([0-9.]+) E:([0-9.]+)).

@@ -504,7 +504,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/features/gcode_scripts.html b/1.8.7/features/gcode_scripts.html index 79bf1a873..e390aa98f 100644 --- a/1.8.7/features/gcode_scripts.html +++ b/1.8.7/features/gcode_scripts.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -448,7 +448,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/features/index.html b/1.8.7/features/index.html index e10181450..49859a240 100644 --- a/1.8.7/features/index.html +++ b/1.8.7/features/index.html @@ -96,7 +96,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -201,7 +201,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/features/plugins.html b/1.8.7/features/plugins.html index 8aabb4985..5e31df394 100644 --- a/1.8.7/features/plugins.html +++ b/1.8.7/features/plugins.html @@ -104,7 +104,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -233,7 +233,7 @@

Manual Installation
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/features/safemode.html b/1.8.7/features/safemode.html index 86ecb5f77..3b440fda0 100644 --- a/1.8.7/features/safemode.html +++ b/1.8.7/features/safemode.html @@ -100,7 +100,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -254,7 +254,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/genindex.html b/1.8.7/genindex.html index 1b7c604f9..b0899259c 100644 --- a/1.8.7/genindex.html +++ b/1.8.7/genindex.html @@ -85,7 +85,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -2576,7 +2576,7 @@

W

Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/http-routingtable.html b/1.8.7/http-routingtable.html index b902fc483..532b3f37c 100644 --- a/1.8.7/http-routingtable.html +++ b/1.8.7/http-routingtable.html @@ -92,7 +92,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -567,7 +567,7 @@

HTTP Routing Table

Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/index.html b/1.8.7/index.html index 5a8811673..10721df67 100644 --- a/1.8.7/index.html +++ b/1.8.7/index.html @@ -86,7 +86,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -305,7 +305,7 @@

Contents
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/base.html b/1.8.7/jsclientlib/base.html index 4d332ad9b..416473900 100644 --- a/1.8.7/jsclientlib/base.html +++ b/1.8.7/jsclientlib/base.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -776,7 +776,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/browser.html b/1.8.7/jsclientlib/browser.html index 72ae5278d..d30e6ef05 100644 --- a/1.8.7/jsclientlib/browser.html +++ b/1.8.7/jsclientlib/browser.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -252,7 +252,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/connection.html b/1.8.7/jsclientlib/connection.html index c08c28595..469022203 100644 --- a/1.8.7/jsclientlib/connection.html +++ b/1.8.7/jsclientlib/connection.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -253,7 +253,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/control.html b/1.8.7/jsclientlib/control.html index 769714473..33a379654 100644 --- a/1.8.7/jsclientlib/control.html +++ b/1.8.7/jsclientlib/control.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -269,7 +269,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/files.html b/1.8.7/jsclientlib/files.html index be3291e3f..61d4081df 100644 --- a/1.8.7/jsclientlib/files.html +++ b/1.8.7/jsclientlib/files.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -527,7 +527,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/index.html b/1.8.7/jsclientlib/index.html index de148615f..6a19e00ed 100644 --- a/1.8.7/jsclientlib/index.html +++ b/1.8.7/jsclientlib/index.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -274,7 +274,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/job.html b/1.8.7/jsclientlib/job.html index e7680db78..4465458ec 100644 --- a/1.8.7/jsclientlib/job.html +++ b/1.8.7/jsclientlib/job.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -305,7 +305,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/languages.html b/1.8.7/jsclientlib/languages.html index dd7cb6144..f0bfb3d81 100644 --- a/1.8.7/jsclientlib/languages.html +++ b/1.8.7/jsclientlib/languages.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -236,7 +236,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/logs.html b/1.8.7/jsclientlib/logs.html index 88e1fe682..5fbd1738c 100644 --- a/1.8.7/jsclientlib/logs.html +++ b/1.8.7/jsclientlib/logs.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -179,7 +179,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/printer.html b/1.8.7/jsclientlib/printer.html index b6f7a5bb9..2675b7f40 100644 --- a/1.8.7/jsclientlib/printer.html +++ b/1.8.7/jsclientlib/printer.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -666,7 +666,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/printerprofiles.html b/1.8.7/jsclientlib/printerprofiles.html index 157ac7e8e..8b100ade7 100644 --- a/1.8.7/jsclientlib/printerprofiles.html +++ b/1.8.7/jsclientlib/printerprofiles.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -266,7 +266,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/settings.html b/1.8.7/jsclientlib/settings.html index 7a7c798c9..a102c7d9b 100644 --- a/1.8.7/jsclientlib/settings.html +++ b/1.8.7/jsclientlib/settings.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -265,7 +265,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/slicing.html b/1.8.7/jsclientlib/slicing.html index fc0201db0..fe4f1adb0 100644 --- a/1.8.7/jsclientlib/slicing.html +++ b/1.8.7/jsclientlib/slicing.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -286,7 +286,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/socket.html b/1.8.7/jsclientlib/socket.html index 06ea56829..852561c64 100644 --- a/1.8.7/jsclientlib/socket.html +++ b/1.8.7/jsclientlib/socket.html @@ -111,7 +111,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -361,7 +361,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/system.html b/1.8.7/jsclientlib/system.html index 75ab4fcc6..79334170f 100644 --- a/1.8.7/jsclientlib/system.html +++ b/1.8.7/jsclientlib/system.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -237,7 +237,7 @@

Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/timelapse.html b/1.8.7/jsclientlib/timelapse.html index 0a00a382c..be2167940 100644 --- a/1.8.7/jsclientlib/timelapse.html +++ b/1.8.7/jsclientlib/timelapse.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -351,7 +351,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/users.html b/1.8.7/jsclientlib/users.html index d9496d894..f69331c55 100644 --- a/1.8.7/jsclientlib/users.html +++ b/1.8.7/jsclientlib/users.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -364,7 +364,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/util.html b/1.8.7/jsclientlib/util.html index 564d8b310..4e7138093 100644 --- a/1.8.7/jsclientlib/util.html +++ b/1.8.7/jsclientlib/util.html @@ -107,7 +107,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -428,7 +428,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/jsclientlib/wizard.html b/1.8.7/jsclientlib/wizard.html index 633dab583..f34ef9d48 100644 --- a/1.8.7/jsclientlib/wizard.html +++ b/1.8.7/jsclientlib/wizard.html @@ -106,7 +106,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -217,7 +217,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/modules/cli.html b/1.8.7/modules/cli.html index c278d6015..8d8f9abdd 100644 --- a/1.8.7/modules/cli.html +++ b/1.8.7/modules/cli.html @@ -115,7 +115,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -148,7 +148,7 @@

octoprint.cli

-class octoprint.cli.HiddenOption(param_decls: Optional[Sequence[str]] = None, show_default: Optional[Union[bool, str]] = None, prompt: Union[bool, str] = False, confirmation_prompt: Union[bool, str] = False, prompt_required: bool = True, hide_input: bool = False, is_flag: Optional[bool] = None, flag_value: Optional[Any] = None, multiple: bool = False, count: bool = False, allow_from_autoenv: bool = True, type: Optional[Union[click.types.ParamType, Any]] = None, help: Optional[str] = None, hidden: bool = False, show_choices: bool = True, show_envvar: bool = False, **attrs: Any)
+class octoprint.cli.HiddenOption(param_decls: Optional[Sequence[str]] = None, show_default: Optional[Union[bool, str]] = None, prompt: Union[bool, str] = False, confirmation_prompt: Union[bool, str] = False, prompt_required: bool = True, hide_input: bool = False, is_flag: Optional[bool] = None, flag_value: Optional[Any] = None, multiple: bool = False, count: bool = False, allow_from_autoenv: bool = True, type: Optional[Union[click.types.ParamType, Any]] = None, help: Optional[str] = None, hidden: bool = False, show_choices: bool = True, show_envvar: bool = False, **attrs: Any)

Custom option sub class with empty help.

@@ -344,7 +344,7 @@
Tags
-
1.9.2
+
1.9.3
1.8.7
diff --git a/1.8.7/modules/filemanager.html b/1.8.7/modules/filemanager.html index ca2d760ef..759162aac 100644 --- a/1.8.7/modules/filemanager.html +++ b/1.8.7/modules/filemanager.html @@ -115,7 +115,7 @@

Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

@@ -208,7 +208,7 @@ overridden by sub classes.

Parameters
-

high_priority (bool) – Whether the current entry has high priority or not.

+

high_priority (bool) – Whether the current entry has high priority or not.

Returns

@@ -218,7 +218,7 @@

Return type
-

object

+

object

@@ -282,7 +282,7 @@
class octoprint.filemanager.analysis.GcodeAnalysisQueue(finished_callback)
-

A queue to analyze GCODE files. Analysis results are dict instances structured as follows:

+

A queue to analyze GCODE files. Analysis results are dict instances structured as follows:

@@ -350,14 +350,14 @@
Parameters
    -

  • name (str) – Name of the file to analyze.

    • -

  • path (str) – Storage location specific path to the file to analyze.

    • -

  • type (str) – Type of file to analyze, necessary to map to the correct AbstractAnalysisQueue sub class. +

  • name (str) – Name of the file to analyze.

    • +

  • path (str) – Storage location specific path to the file to analyze.

    • +

  • type (str) – Type of file to analyze, necessary to map to the correct AbstractAnalysisQueue sub class. At the moment, only gcode is supported here.

    • -

  • location (str) – Location the file is located on.

    • -

  • absolute_path (str) – Absolute path on disk through which to access the file.

    • +

  • location (str) – Location the file is located on.

    • +

  • absolute_path (str) – Absolute path on disk through which to access the file.

  • printer_profile (PrinterProfile) – PrinterProfile which to use for analysis.

    • -

  • analysis (dict) – GcodeAnalysisQueue results from prior analysis, or None if there is none.

    • +

  • analysis (dict) – GcodeAnalysisQueue results from prior analysis, or None if there is none.

@@ -384,11 +384,11 @@
Parameters

  • path (string) – the file’s new path, will be sanitized

    • -

  • file_object (object) – a file object that provides a save method which will be called with the destination path +

  • file_object (object) – a file object that provides a save method which will be called with the destination path where the object should then store its contents

    • -

  • printer_profile (object) – the printer profile associated with this file (if any)

    • -

  • links (list) – any links to add with the file

    • -

  • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file +

  • printer_profile (object) – the printer profile associated with this file (if any)

    • +

  • links (list) – any links to add with the file

    • +

  • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file and its metadata will just be silently overwritten

  • display (unicode) – display name of the file

@@ -408,7 +408,7 @@
Parameters

  • path (string) – the path of the new folder

    • -

  • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

    • +

  • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

  • display (unicode) – display name of the folder

@@ -594,9 +594,9 @@
Parameters
    -

  • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or +

  • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or set to None, defatuls to storage root.

    • -

  • recursive (bool) – Whether to determine only the date of the specified path (False, default) or +

  • recursive (bool) – Whether to determine only the date of the specified path (False, default) or the whole path’s subtree (True).

@@ -666,7 +666,7 @@ from root of base folder

  • filter (function) – a filter that matches the files that are to be returned, may be left out in which case no filtering will take place

    • -

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only +

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only do one step down into sub folders to be able to populate the children.

    • @@ -730,7 +730,7 @@ path_on_disk(path)

    Retrieves the path on disk for path.

    Note: if the storage is not on disk and there exists no path on disk to refer to it, this method should -raise an io.UnsupportedOperation

    +raise an io.UnsupportedOperation

    Opposite of path_in_storage().

    Parameters
    @@ -777,7 +777,7 @@
    Parameters

    • path (string) – the path of the folder to remove

      • -

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will +

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will be raised if the folder is not empty (apart from any metadata files) when it’s to be removed

    @@ -821,7 +821,7 @@
    sanitize_name(name)
    -

    Raises a ValueError for a name containing / or \. Otherwise +

    Raises a ValueError for a name containing / or \. Otherwise sanitizes the given name using octoprint.files.sanitize_filename. Also strips any leading ..

    @@ -877,11 +877,11 @@
    Parameters

    • path (string) – the file’s new path, will be sanitized

      • -

    • file_object (object) – a file object that provides a save method which will be called with the destination path +

    • file_object (object) – a file object that provides a save method which will be called with the destination path where the object should then store its contents

      • -

    • printer_profile (object) – the printer profile associated with this file (if any)

      • -

    • links (list) – any links to add with the file

      • -

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file +

    • printer_profile (object) – the printer profile associated with this file (if any)

      • +

    • links (list) – any links to add with the file

      • +

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file and its metadata will just be silently overwritten

    • display (unicode) – display name of the file

    @@ -901,7 +901,7 @@
    Parameters

    • path (string) – the path of the new folder

      • -

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • +

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

    • display (unicode) – display name of the folder

    @@ -1087,9 +1087,9 @@
    Parameters
      -

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or +

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or set to None, defatuls to storage root.

      • -

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or +

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or the whole path’s subtree (True).

    @@ -1159,7 +1159,7 @@ from root of base folder

  • filter (function) – a filter that matches the files that are to be returned, may be left out in which case no filtering will take place

    • -

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only +

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only do one step down into sub folders to be able to populate the children.

    • @@ -1223,7 +1223,7 @@ path_on_disk(path)

    Retrieves the path on disk for path.

    Note: if the storage is not on disk and there exists no path on disk to refer to it, this method should -raise an io.UnsupportedOperation

    +raise an io.UnsupportedOperation

    Opposite of path_in_storage().

    Parameters
    @@ -1270,7 +1270,7 @@
    Parameters

    • path (string) – the path of the folder to remove

      • -

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will +

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will be raised if the folder is not empty (apart from any metadata files) when it’s to be removed

    @@ -1363,7 +1363,7 @@

    Wrapper for file representations to save to storages.

    Parameters
    -

    filename (str) – The file’s name

    +

    filename (str) – The file’s name

    @@ -1373,8 +1373,8 @@
    Parameters
      -

    • path (str) – The absolute path to where to save the file

      • -

    • permissions (int) – The permissions to set on the file

      • +

    • path (str) – The absolute path to where to save the file

      • +

    • permissions (int) – The permissions to set on the file

    @@ -1389,7 +1389,7 @@

    The file’s contents as a stream.

    Return type
    -

    io.IOBase

    +

    io.IOBase

    @@ -1405,8 +1405,8 @@
    Parameters
      -

    • filename (str) – The file’s name

      • -

    • path (str) – The file’s absolute path

      • +

    • filename (str) – The file’s name

      • +

    • path (str) – The file’s absolute path

    • move (boolean) – Whether to move the file upon saving (True, default) or copying.

    @@ -1418,8 +1418,8 @@
    Parameters
      -

    • path (str) – The absolute path to where to save the file

      • -

    • permissions (int) – The permissions to set on the file

      • +

    • path (str) – The absolute path to where to save the file

      • +

    • permissions (int) – The permissions to set on the file

    @@ -1434,7 +1434,7 @@

    The file’s contents as a stream.

    Return type
    -

    io.IOBase

    +

    io.IOBase

    @@ -1451,7 +1451,7 @@ to do the decoding yourself.

    Parameters
    -

    input_stream (io.RawIOBase) – The stream to process on the fly.

    +

    input_stream (io.RawIOBase) – The stream to process on the fly.

    @@ -1469,7 +1469,7 @@ wrapper input_stream.

    Parameters
    -

    line (bytes) – The line as read from self.input_stream in byte representation

    +

    line (bytes) – The line as read from self.input_stream in byte representation

    Returns

    @@ -1479,7 +1479,7 @@

    Return type
    -

    bytes or None

    +

    bytes or None

    @@ -1515,7 +1515,7 @@ their contents in the order they are provided to the constructor.

    Parameters
    -

    *streams – One or more io.IOBase streams to concatenate.

    +

    *streams – One or more io.IOBase streams to concatenate.

    @@ -1555,7 +1555,7 @@

    A wrapper allowing processing of one or more consecutive streams.

    Parameters
    -

    *streams – One or more io.IOBase streams to process one after another to save to storage.

    +

    *streams – One or more io.IOBase streams to process one after another to save to storage.

    @@ -1610,7 +1610,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/modules/index.html b/1.8.7/modules/index.html index a12f8f836..a88696d67 100644 --- a/1.8.7/modules/index.html +++ b/1.8.7/modules/index.html @@ -115,7 +115,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -210,7 +210,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/modules/plugin.html b/1.8.7/modules/plugin.html index 53112d2e0..1839538e1 100644 --- a/1.8.7/modules/plugin.html +++ b/1.8.7/modules/plugin.html @@ -115,7 +115,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -157,31 +157,31 @@
    Parameters

    • init (boolean) – A flag indicating whether this is the initial call to construct the singleton (True) or not -(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError +(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError will be raised. The same will happen if the plugin manager has not yet been initialized and this is set to False.

      • -

    • plugin_folders (list) – A list of folders (as strings containing the absolute path to them) in which to look for +

    • plugin_folders (list) – A list of folders (as strings containing the absolute path to them) in which to look for potential plugin modules. If not provided this defaults to the configured plugins base folder and src/plugins within OctoPrint’s code base.

      • -

    • plugin_bases (list) – A list of recognized plugin base classes for which to look for provided implementations. If not +

    • plugin_bases (list) – A list of recognized plugin base classes for which to look for provided implementations. If not provided this defaults to OctoPrintPlugin.

      • -

    • plugin_entry_points (list) – A list of entry points pointing to modules which to load as plugins. If not provided +

    • plugin_entry_points (list) – A list of entry points pointing to modules which to load as plugins. If not provided this defaults to the entry point octoprint.plugin.

      • -

    • plugin_disabled_list (list) – A list of plugin identifiers that are currently disabled. If not provided this +

    • plugin_disabled_list (list) – A list of plugin identifiers that are currently disabled. If not provided this defaults to all plugins for which enabled is set to False in the settings.

      • -

    • plugin_sorting_order (dict) – A dict containing a custom sorting orders for plugins. The keys are plugin identifiers, +

    • plugin_sorting_order (dict) – A dict containing a custom sorting orders for plugins. The keys are plugin identifiers, mapped to dictionaries containing the sorting contexts as key and the custom sorting value as value.

      • -

    • plugin_blacklist (list) – A list of plugin identifiers/identifier-requirement tuples +

    • plugin_blacklist (list) – A list of plugin identifiers/identifier-requirement tuples that are currently blacklisted.

      • -

    • plugin_restart_needing_hooks (list) – A list of hook namespaces which cause a plugin to need a restart in order +

    • plugin_restart_needing_hooks (list) – A list of hook namespaces which cause a plugin to need a restart in order be enabled/disabled. Does not have to contain full hook identifiers, will be matched with startswith similar to logging handlers

      • -

    • plugin_obsolete_hooks (list) – A list of hooks that have been declared obsolete. Plugins implementing them will +

    • plugin_obsolete_hooks (list) – A list of hooks that have been declared obsolete. Plugins implementing them will not be enabled since they might depend on functionality that is no longer available.

      • -

    • plugin_considered_bundled (list) – A list of plugin identifiers that are considered bundled plugins even if +

    • plugin_considered_bundled (list) – A list of plugin identifiers that are considered bundled plugins even if installed separately.

      • -

    • plugin_validators (list) – A list of additional plugin validators through which to process each plugin.

      • -

    • compatibility_ignored_list (list) – A list of plugin keys for which it will be ignored if they are flagged as +

    • plugin_validators (list) – A list of additional plugin validators through which to process each plugin.

      • +

    • compatibility_ignored_list (list) – A list of plugin keys for which it will be ignored if they are flagged as incompatible. This is for development purposes only and should not be used in production.

    @@ -196,7 +196,7 @@

    PluginManager

    Raises
    -

    ValueError – init was True although the plugin manager was already initialized, or it was False although +

    ValueError – init was True although the plugin manager was already initialized, or it was False although the plugin manager was not yet initialized.

    @@ -210,9 +210,9 @@
    Parameters

    • plugin_key (string) – The plugin identifier for which to create the settings instance.

      • -

    • defaults (dict) – The default settings for the plugin, if different from get_settings_defaults.

      • -

    • get_preprocessors (dict) – The getter preprocessors for the plugin.

      • -

    • set_preprocessors (dict) – The setter preprocessors for the plugin.

      • +

    • defaults (dict) – The default settings for the plugin, if different from get_settings_defaults.

      • +

    • get_preprocessors (dict) – The getter preprocessors for the plugin.

      • +

    • set_preprocessors (dict) – The setter preprocessors for the plugin.

    • settings (octoprint.settings.Settings) – The settings instance to use.

    @@ -254,10 +254,10 @@
    Parameters
      -

    • types (list) – A list of plugin implementation types to match against.

      • +

    • types (list) – A list of plugin implementation types to match against.

    • method (string) – Name of the method to call on all matching implementations.

      • -

    • args (tuple) – A tuple containing the arguments to supply to the called method. Optional.

      • -

    • kwargs (dict) – A dictionary containing the keyword arguments to supply to the called method. Optional.

      • +

    • args (tuple) – A tuple containing the arguments to supply to the called method. Optional.

      • +

    • kwargs (dict) – A dictionary containing the keyword arguments to supply to the called method. Optional.

    • callback (function) – A callback to invoke after an implementation has been called successfully. Will be called with the three arguments name, plugin and result. name will be the plugin identifier, plugin the plugin implementation instance itself and result the result returned from the @@ -283,8 +283,8 @@

      Parameters

      • settings (Settings) – The Settings instance on which to operate.

        • -

      • plugin_key (str) – The plugin identifier of the plugin for which to create this instance.

        • -

      • defaults (dict) – The plugin’s defaults settings, will be used to determine valid paths within the plugin’s +

      • plugin_key (str) – The plugin identifier of the plugin for which to create this instance.

        • +

      • defaults (dict) – The plugin’s defaults settings, will be used to determine valid paths within the plugin’s settings structure

      @@ -297,7 +297,7 @@
      Parameters
        -

      • path (list, tuple) – The path for which to retrieve the value.

        • +

      • path (list, tuple) – The path for which to retrieve the value.

      • merged (boolean) – Whether to merge the returned result with the default settings (True) or not (False, default).

      @@ -306,7 +306,7 @@

      The retrieved settings value.

      Return type
      -

      object

      +

      object

    @@ -340,8 +340,8 @@
    Parameters
      -

    • path (list, tuple) – The path for which to retrieve the value.

      • -

    • value (object) – The value to set.

      • +

    • path (list, tuple) – The path for which to retrieve the value.

      • +

    • value (object) – The value to set.

    • force (boolean) – If set to True, the modified configuration will even be written back to disk if the value didn’t change.

    @@ -396,13 +396,13 @@
    Parameters
      -

    • overlay (dict) – Overlay dict to add

      • +

    • overlay (dict) – Overlay dict to add

    • at_end (boolean) – Whether to add overlay at end or start (default) of config hierarchy

      • -

    • key (str) – Key to use to identify overlay. If not set one will be built based on the overlay’s hash

      • +

    • key (str) – Key to use to identify overlay. If not set one will be built based on the overlay’s hash

    Return type
    -

    str

    +

    str

    @@ -414,7 +414,7 @@ removed, False otherwise.

    Parameters
    -

    key (str) – The key of the overlay to remove

    +

    key (str) – The key of the overlay to remove

    Return type

    boolean

    @@ -440,7 +440,7 @@ want to create a log file for logging the output of the slicing engine itself if some debug flag is set.

    Parameters
    -

    postfix (str) – Postfix of the logfile for which to create the path. If set, the file name of the log file +

    postfix (str) – Postfix of the logfile for which to create the path. If set, the file name of the log file will be plugin_<plugin identifier>_<postfix>.log, if not it will be plugin_<plugin identifier>.log.

    @@ -448,7 +448,7 @@

    Absolute path to the log file, directly usable by the plugin.

    Return type
    -

    str

    +

    str

    @@ -551,7 +551,7 @@

    A list of all found and matching implementations.

    Return type
    -

    list

    +

    list

    @@ -560,12 +560,12 @@
    get_helpers(name, *helpers)

    Retrieves the named helpers for the plugin with identifier name.

    -

    If the plugin is not available, returns None. Otherwise returns a dict with the requested plugin +

    If the plugin is not available, returns None. Otherwise returns a dict with the requested plugin helper names mapped to the method - if a helper could not be resolved, it will be missing from the dict.

    Parameters
      -

    • name (str) – Identifier of the plugin for which to look up the helpers.

      • +

    • name (str) – Identifier of the plugin for which to look up the helpers.

    • helpers (one or more str) – Identifiers of the helpers of plugin name to return.

    @@ -577,7 +577,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -588,13 +588,13 @@

    Retrieves all registered handlers for the specified hook.

    Parameters
    -

    hook (str) – The hook for which to retrieve the handlers.

    +

    hook (str) – The hook for which to retrieve the handlers.

    Returns

    A dict containing all registered handlers mapped by their plugin’s identifier.

    Return type
    -

    dict

    +

    dict

    @@ -611,7 +611,7 @@

    A list of all found implementations

    Return type
    -

    list

    +

    list

    @@ -624,7 +624,7 @@
    Parameters
      -

    • identifier (str) – The identifier of the plugin to retrieve.

      • +

    • identifier (str) – The identifier of the plugin to retrieve.

    • require_enabled (boolean) – Whether to only return the plugin if is enabled (True, default) or also if it’s disabled.

    @@ -646,7 +646,7 @@
    Parameters
      -

    • identifier (str) – The identifier of the plugin to retrieve.

      • +

    • identifier (str) – The identifier of the plugin to retrieve.

    • require_enabled (boolean) – Whether to only return the plugin if is enabled (True, default) or also if it’s disabled.

    @@ -680,7 +680,7 @@

    Return type
    -

    (bool)

    +

    (bool)

    @@ -705,7 +705,7 @@

    Return type
    -

    (bool)

    +

    (bool)

    @@ -735,7 +735,7 @@

    hook is expected to be an exact hook name.

    hooks is expected to be a list containing one or more hook names or patterns. That can be either an exact hook name or an -fnmatch.fnmatch() pattern.

    +fnmatch.fnmatch() pattern.

    Parameters
      @@ -747,7 +747,7 @@

      True if the hook matches any of the hooks, False otherwise.

      Return type
      -

      (bool)

      +

      (bool)

    @@ -765,8 +765,8 @@
    Parameters
      -

    • name (str) – the plugin’s identifier

      • -

    • flag (str) – the flag to check

      • +

    • name (str) – the plugin’s identifier

      • +

    • flag (str) – the flag to check

    Returns
    @@ -797,8 +797,8 @@
    Parameters
      -

    • name (str) – plugin identifier

      • -

    • **flags (dict) – dictionary of flag names and values

      • +

    • name (str) – plugin identifier

      • +

    • **flags (dict) – dictionary of flag names and values

    @@ -835,7 +835,7 @@

    • startup (boolean) – whether this is called during startup of the platform

    • initialize_implementations (boolean) – whether plugin implementations should be initialized

      • -

    • force_reload (list) – list of plugin identifiers which should be force reloaded

      • +

    • force_reload (list) – list of plugin identifiers which should be force reloaded

    @@ -849,9 +849,9 @@
    Parameters
      -

    • plugin (str) – The sending plugin’s identifier.

      • -

    • data (object) – The message.

      • -

    • permissions (list) – A list of permissions to test against in the client.

      • +

    • plugin (str) – The sending plugin’s identifier.

      • +

    • data (object) – The message.

      • +

    • permissions (list) – A list of permissions to test against in the client.

    @@ -876,15 +876,15 @@
    Parameters
      -

    • key (str) – Identifier of the plugin

      • -

    • location (str) – Installation folder of the plugin

      • +

    • key (str) – Identifier of the plugin

      • +

    • location (str) – Installation folder of the plugin

    • instance (module) – Plugin module instance - this may be None if the plugin has been blacklisted!

      • -

    • name (str) – Human readable name of the plugin

      • -

    • version (str) – Version of the plugin

      • -

    • description (str) – Description of the plugin

      • -

    • author (str) – Author of the plugin

      • -

    • url (str) – URL of the website of the plugin

      • -

    • license (str) – License of the plugin

      • +

    • name (str) – Human readable name of the plugin

      • +

    • version (str) – Version of the plugin

      • +

    • description (str) – Description of the plugin

      • +

    • author (str) – Author of the plugin

      • +

    • url (str) – URL of the website of the plugin

      • +

    • license (str) – License of the plugin

    @@ -898,7 +898,7 @@

    Author of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -945,7 +945,7 @@

    Description of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -976,7 +976,7 @@

    Reason why disabling this plugin is discouraged (only for bundled plugins)

    Return type
    -

    str or None

    +

    str or None

    @@ -1013,13 +1013,13 @@ get_hook(hook)
    Parameters
    -

    hook (str) – Hook to return.

    +

    hook (str) – Hook to return.

    Returns

    Handler for the requested hook or None if no handler is registered.

    Return type
    -

    callable or None

    +

    callable or None

    @@ -1029,13 +1029,13 @@ get_implementation(*types)
    Parameters
    -

    types (list) – List of Plugin sub classes the implementation needs to implement.

    +

    types (list) – List of Plugin sub classes the implementation needs to implement.

    Returns

    The plugin’s implementation if it matches all of the requested types, None otherwise.

    Return type
    -

    object

    +

    object

    @@ -1050,7 +1050,7 @@

    Helpers provided by the plugin.

    Return type
    -

    dict

    +

    dict

    @@ -1064,7 +1064,7 @@

    Whether the plugin should be flagged as hidden or not

    Return type
    -

    bool

    +

    bool

    @@ -1079,7 +1079,7 @@

    Hooks provided by the plugin.

    Return type
    -

    dict

    +

    dict

    @@ -1094,7 +1094,7 @@

    Implementation provided by the plugin.

    Return type
    -

    object

    +

    object

    @@ -1121,7 +1121,7 @@

    License of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1169,18 +1169,18 @@
    Parameters

    • show_enabled (boolean) – whether to show the enabled part

      • -

    • enabled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the enabled state

      • +

    • enabled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the enabled state

    • show_bundled (boolean) – whether to show the bundled part

      • -

    • bundled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the bundled state

      • +

    • bundled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the bundled state

    • show_location (boolean) – whether to show the location part

      • -

    • location_str (str) – the format string to use for displaying the plugin’s installation location

      • +

    • location_str (str) – the format string to use for displaying the plugin’s installation location

    Returns

    The long string representation of the plugin as described above

    Return type
    -

    str

    +

    str

    @@ -1207,7 +1207,7 @@

    Name of the plugin, fallback is the plugin’s identifier.

    Return type
    -

    str

    +

    str

    @@ -1241,7 +1241,7 @@

    Python compatibility string of the plugin

    Return type
    -

    str

    +

    str

    @@ -1271,7 +1271,7 @@

    Website URL for the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1294,7 +1294,7 @@

    Version of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1377,7 +1377,7 @@ not None sorted by that.

    Parameters
    -

    context (str) – The sorting context for which to provide the +

    context (str) – The sorting context for which to provide the sorting key value.

    Returns
    @@ -1389,7 +1389,7 @@

    Return type
    -

    int or None

    +

    int or None

    @@ -1554,7 +1554,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/modules/printer.html b/1.8.7/modules/printer.html index 09b689919..507220540 100644 --- a/1.8.7/modules/printer.html +++ b/1.8.7/modules/printer.html @@ -115,7 +115,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -185,8 +185,8 @@
    Parameters
      -

    • path (str) – path in storage of the file to check

      • -

    • sd (bool) – True if to check against SD storage, False otherwise

      • +

    • path (str) – path in storage of the file to check

      • +

    • sd (bool) – True if to check against SD storage, False otherwise

    Returns
    @@ -213,7 +213,7 @@
    Parameters
      -

    • tool (str) – The tool to switch to, matching the regex “tool[0-9]+” (e.g. “tool0”, “tool1”, …)

      • +

    • tool (str) – The tool to switch to, matching the regex “tool[0-9]+” (e.g. “tool0”, “tool1”, …)

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -227,10 +227,10 @@
    Parameters
      -

    • commands (str, list) – The commands to send. Might be a single command provided just as a string or a list +

    • commands (str, list) – The commands to send. Might be a single command provided just as a string or a list of multiple commands to send in order.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      • -

    • force (bool) – Whether to force sending of the command right away or allow queuing while printing

      • +

    • force (bool) – Whether to force sending of the command right away or allow queuing while printing

    @@ -245,9 +245,9 @@
    Parameters
      -

    • port (str) – Name of the serial port to connect to. If not provided, an auto detection will be attempted.

      • -

    • baudrate (int) – Baudrate to connect with. If not provided, an auto detection will be attempted.

      • -

    • profile (str) – Name of the printer profile to use for this connection. If not provided, the default +

    • port (str) – Name of the serial port to connect to. If not provided, an auto detection will be attempted.

      • +

    • baudrate (int) – Baudrate to connect with. If not provided, an auto detection will be attempted.

      • +

    • profile (str) – Name of the printer profile to use for this connection. If not provided, the default will be retrieved from the PrinterProfileManager.

    @@ -267,8 +267,8 @@
    Parameters
      -

    • amount (int, float) – The amount of material to extrude in mm

      • -

    • speed (int, None) – Speed at which to extrude (F parameter). If set to None (or left out)

      • +

    • amount (int, float) – The amount of material to extrude in mm

      • +

    • speed (int, None) – Speed at which to extrude (F parameter). If set to None (or left out)

    • maximum speed of E axis from the printer profile will be used. (the) –

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -291,7 +291,7 @@
    Parameters
      -

    • factor (int, float) – The factor for the feed rate to send to the firmware. Percentage expressed as either an +

    • factor (int, float) – The factor for the feed rate to send to the firmware. Percentage expressed as either an int between 0 and 100 or a float between 0 and 1.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -306,7 +306,7 @@
    Parameters
      -

    • factor (int, float) – The factor for the flow rate to send to the firmware. Percentage expressed as either an +

    • factor (int, float) – The factor for the flow rate to send to the firmware. Percentage expressed as either an int between 0 and 100 or a float between 0 and 1.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -331,7 +331,7 @@

    A dictionary holding the connection options in the structure specified above

    Return type
    -

    (dict)

    +

    (dict)

    @@ -441,7 +441,7 @@

    The communication layer’s transport object

    Return type
    -

    object

    +

    object

    @@ -453,7 +453,7 @@
    Parameters
      -

    • axes (str, list) – The axis or axes to home, each of which must converted to lower case must match one of +

    • axes (str, list) – The axis or axes to home, each of which must converted to lower case must match one of “x”, “y”, “z” and “e”

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -501,8 +501,8 @@
    Parameters
      -

    • path (str) – path in storage of the file to check

      • -

    • sd (bool) – True if to check against SD storage, False otherwise

      • +

    • path (str) – path in storage of the file to check

      • +

    • sd (bool) – True if to check against SD storage, False otherwise

    Returns
    @@ -591,7 +591,7 @@ if the lock can’t be acquired.

    Parameters
    -

    blocking (bool) – Whether to block while attempting to acquire the lock (default) or not

    +

    blocking (bool) – Whether to block while attempting to acquire the lock (default) or not

    @@ -603,10 +603,10 @@
    Parameters
      -

    • axes (dict) – Axes and distances to jog, keys are axes (“x”, “y”, “z”), values are distances in mm

      • -

    • relative (bool) – Whether to interpret the distance values as relative (true, default) or absolute (false) +

    • axes (dict) – Axes and distances to jog, keys are axes (“x”, “y”, “z”), values are distances in mm

      • +

    • relative (bool) – Whether to interpret the distance values as relative (true, default) or absolute (false) coordinates

      • -

    • speed (int, bool or None) – Speed at which to jog (F parameter). If set to False no speed will be set +

    • speed (int, bool or None) – Speed at which to jog (F parameter). If set to False no speed will be set specifically. If set to None (or left out) the minimum of all involved axes speeds from the printer profile will be used.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      • @@ -665,8 +665,8 @@
      Parameters
        -

      • name (str) – The name of the GCODE script to render.

        • -

      • context (dict) – An optional context of additional template variables to provide to the renderer.

        • +

      • name (str) – The name of the GCODE script to render.

        • +

      • context (dict) – An optional context of additional template variables to provide to the renderer.

      • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      @@ -684,7 +684,7 @@
      Parameters
        -

      • path (str) – The path to select for printing. Either an absolute path or relative path to a local file in +

      • path (str) – The path to select for printing. Either an absolute path or relative path to a local file in the uploads folder or a filename on the printer’s SD card.

      • sd (boolean) – Indicates whether the file is on the printer’s SD card or not.

      • printAfterSelect (boolean) – Indicates whether a print should be started @@ -736,8 +736,8 @@

        Parameters
          -

        • value (bool) – The value to set

          • -

        • blocking (bool) – Whether to block while attempting to set the value (default) or not

          • +

        • value (bool) – The value to set

          • +

        • blocking (bool) – Whether to block while attempting to set the value (default) or not

        Returns
        @@ -753,10 +753,10 @@
        Parameters
          -

        • heater (str) – The heater for which to set the target temperature. Either “bed” for setting the bed +

        • heater (str) – The heater for which to set the target temperature. Either “bed” for setting the bed temperature or something matching the regular expression “tool[0-9]+” (e.g. “tool0”, “tool1”, …) for the hotends of the printer

          • -

        • value (int, float) – The temperature in celsius to set the target temperature to.

          • +

        • value (int, float) – The temperature in celsius to set the target temperature to.

        • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

        @@ -770,7 +770,7 @@
        Parameters
          -

        • offsets (dict) – A dictionary specifying the offsets to apply. Keys must match the format for the heater +

        • offsets (dict) – A dictionary specifying the offsets to apply. Keys must match the format for the heater parameter to set_temperature(), so “bed” for the offset for the bed target temperature and “tool[0-9]+” for the offsets to the hotend target temperatures.

        • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

          • @@ -847,7 +847,7 @@

          Called when the PrinterInterface receives a new communication log entry from the communication layer.

          Parameters
          -

          data (str) – The received log line.

          +

          data (str) – The received log line.

        @@ -858,7 +858,7 @@

        Called when the PrinterInterface receives a new message from the communication layer.

        Parameters
        -

        data (str) – The received message.

        +

        data (str) – The received message.

        @@ -882,7 +882,7 @@
    Parameters
    -

    data (dict) – A dict of all current temperatures in the format as specified above

    +

    data (dict) – A dict of all current temperatures in the format as specified above

    @@ -894,8 +894,8 @@
    Parameters
      -

    • name (str) – Name of the registered message (e.g. the feedback command)

      • -

    • output (str) – Output for the registered message

      • +

    • name (str) – Name of the registered message (e.g. the feedback command)

      • +

    • output (str) – Output for the registered message

    @@ -940,7 +940,7 @@
    Parameters
    -

    data (dict) – The current data in the format as specified above.

    +

    data (dict) – The current data in the format as specified above.

    @@ -967,7 +967,7 @@
    Parameters
    -

    data (dict) – The initial data in the format as specified above.

    +

    data (dict) – The initial data in the format as specified above.

    @@ -1244,7 +1244,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/modules/server.html b/1.8.7/modules/server.html index 45bd4e119..96a48636c 100644 --- a/1.8.7/modules/server.html +++ b/1.8.7/modules/server.html @@ -115,7 +115,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -286,8 +286,8 @@
    Parameters
      -

    • url (str) – URL to validate

      • -

    • allowed_paths (List[str]) – List of allowed paths, only paths contained +

    • url (str) – URL to validate

      • +

    • allowed_paths (List[str]) – List of allowed paths, only paths contained will be considered valid.

    @@ -295,7 +295,7 @@

    Whether the url passed validation or not.

    Return type
    -

    bool

    +

    bool

    @@ -398,7 +398,7 @@
    property cookies
    -

    A dict with the contents of all cookies transmitted with +

    A dict with the contents of all cookies transmitted with the request.

    @@ -418,7 +418,7 @@
    -class octoprint.server.util.flask.OctoPrintFlaskResponse(response: Optional[Union[Iterable[bytes], bytes, Iterable[str], str]] = None, status: Optional[Union[int, str, http.HTTPStatus]] = None, headers: Optional[Union[Mapping[str, Union[str, int, Iterable[Union[str, int]]]], Iterable[Tuple[str, Union[str, int]]]]] = None, mimetype: Optional[str] = None, content_type: Optional[str] = None, direct_passthrough: bool = False)
    +class octoprint.server.util.flask.OctoPrintFlaskResponse(response: Optional[Union[Iterable[bytes], bytes, Iterable[str], str]] = None, status: Optional[Union[int, str, http.HTTPStatus]] = None, headers: Optional[Union[Mapping[str, Union[str, int, Iterable[Union[str, int]]]], Iterable[Tuple[str, Union[str, int]]]]] = None, mimetype: Optional[str] = None, content_type: Optional[str] = None, direct_passthrough: bool = False)
    @@ -482,7 +482,7 @@
    default(obj)

    Convert o to a JSON serializable type. See -json.JSONEncoder.default(). Python does not support +json.JSONEncoder.default(). Python does not support overriding how basic types like str or list are serialized, they are handled before this method.

    @@ -576,7 +576,7 @@
    -octoprint.server.util.flask.check_lastmodified(lastmodified: Union[int, float, datetime.datetime]) → bool
    +octoprint.server.util.flask.check_lastmodified(lastmodified: Union[int, float, datetime.datetime]) → bool

    Compares the provided lastmodified value with the value of the If-Modified-Since header.

    If lastmodified is an int or float, it’s assumed to be a Unix timestamp and converted to a timezone aware datetime instance in UTC.

    @@ -584,16 +584,16 @@ result will always be False.

    Parameters
    -

    lastmodified (Union[int, float, datetime]) – The last modified value to compare against

    +

    lastmodified (Union[int, float, datetime]) – The last modified value to compare against

    Raises
    -

    ValueError – If anything but an int, float or datetime instance is passed

    +

    ValueError – If anything but an int, float or datetime instance is passed

    Returns

    true if the values indicate that the document is still up to date

    Return type
    -

    bool

    +

    bool

    @@ -781,7 +781,7 @@
    -class octoprint.server.util.tornado.CustomHTTP1ServerConnection(stream: tornado.iostream.IOStream, params: Optional[tornado.http1connection.HTTP1ConnectionParameters] = None, context: Optional[object] = None)
    +class octoprint.server.util.tornado.CustomHTTP1ServerConnection(stream: tornado.iostream.IOStream, params: Optional[tornado.http1connection.HTTP1ConnectionParameters] = None, context: Optional[object] = None)

    A custom implementation of tornado.http1connection.HTTP1ServerConnection which utilizes a CustomHTTP1Connection instead of a tornado.http1connection.HTTP1Connection in _server_request_loop. The implementation logic is otherwise the same as tornado.http1connection.HTTP1ServerConnection.

    @@ -825,7 +825,7 @@ to another url and logs a deprecation warning.

    Parameters
    -

    url (str) – URL to which to redirect

    +

    url (str) – URL to which to redirect

    @@ -849,14 +849,14 @@
    Parameters
      -

    • path (str) – The system path from which to serve files (this will be forwarded to the initialize method of +

    • path (str) – The system path from which to serve files (this will be forwarded to the initialize method of :class:~tornado.web.StaticFileHandler)

      • -

    • default_filename (str) – The default filename to serve if none is explicitly specified and the request references +

    • default_filename (str) – The default filename to serve if none is explicitly specified and the request references a subdirectory of the served path (this will be forwarded to the initialize method of :class:~tornado.web.StaticFileHandler as the default_filename keyword parameter). Defaults to None.

      • -

    • as_attachment (bool) – Whether to serve requested files with Content-Disposition: attachment header (True) +

    • as_attachment (bool) – Whether to serve requested files with Content-Disposition: attachment header (True) or not. Defaults to False.

      • -

    • allow_client_caching (bool) – Whether to allow the client to cache (by not setting any Cache-Control or +

    • allow_client_caching (bool) – Whether to allow the client to cache (by not setting any Cache-Control or Expires headers on the response) or not.

    • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise @@ -874,7 +874,7 @@ called with the requested path as parameter.

    • mime_type_guesser (function) – Callback to guess the mime type to use for the content type encoding of the response. Will be called with the requested path on disk as parameter.

      • -

    • is_pre_compressed (bool) – if the file is expected to be pre-compressed, i.e, if there is a file in the same +

    • is_pre_compressed (bool) – if the file is expected to be pre-compressed, i.e, if there is a file in the same directory with the same name, but with ‘.gz’ appended and gzip-encoded

    @@ -955,8 +955,8 @@
    Parameters
      -

    • data (str) – The data with which to respond

      • -

    • content_type (str) – The content type with which to respond. Defaults to text/plain

      • +

    • data (str) – The data with which to respond

      • +

    • content_type (str) – The content type with which to respond. Defaults to text/plain

    @@ -1135,10 +1135,10 @@
    Parameters
      -

    • url (str) – URL to forward any requests to. A 404 response will be returned if this is not set. Defaults to None.

      • -

    • as_attachment (bool) – Whether to serve files with Content-Disposition: attachment header (True) +

    • url (str) – URL to forward any requests to. A 404 response will be returned if this is not set. Defaults to None.

      • +

    • as_attachment (bool) – Whether to serve files with Content-Disposition: attachment header (True) or not. Defaults to False.

      • -

    • basename (str) – base name of file names to return as part of the attachment header, see above. Defaults to None.

      • +

    • basename (str) – base name of file names to return as part of the attachment header, see above. Defaults to None.

    • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise a tornado.web.HTTPError if access is not allowed in which case the request will not be further processed. @@ -1267,7 +1267,7 @@

      Tags
      -
      1.9.2
      +
      1.9.3
      1.8.7
      diff --git a/1.8.7/modules/settings.html b/1.8.7/modules/settings.html index c4518eaad..191864b37 100644 --- a/1.8.7/modules/settings.html +++ b/1.8.7/modules/settings.html @@ -115,7 +115,7 @@

      Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

      @@ -171,15 +171,15 @@
      Parameters

      • init (boolean) – A flag indicating whether this is the initial call to construct the singleton (True) or not -(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError +(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError will be raised. The same will happen if the plugin manager has not yet been initialized and this is set to False.

        • -

      • basedir (str) – Path of the base directory for all of OctoPrint’s settings, log files, uploads etc. If not set +

      • basedir (str) – Path of the base directory for all of OctoPrint’s settings, log files, uploads etc. If not set the default will be used: ~/.octoprint on Linux, %APPDATA%/OctoPrint on Windows and ~/Library/Application Support/OctoPrint on MacOS.

        • -

      • configfile (str) – Path of the configuration file (config.yaml) to work on. If not set the default will +

      • configfile (str) – Path of the configuration file (config.yaml) to work on. If not set the default will be used: <basedir>/config.yaml for basedir as defined above.

        • -

      • overlays (list) – List of paths to config overlays to put between default settings and config.yaml

        • +

      • overlays (list) – List of paths to config overlays to put between default settings and config.yaml

      Returns
      @@ -189,7 +189,7 @@

      Settings

      Raises
      -

      ValueError – init is True but settings are already initialized or vice versa.

      +

      ValueError – init is True but settings are already initialized or vice versa.

    @@ -477,7 +477,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/modules/slicing.html b/1.8.7/modules/slicing.html index d6dd3f2d9..f0b779adc 100644 --- a/1.8.7/modules/slicing.html +++ b/1.8.7/modules/slicing.html @@ -115,7 +115,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -154,12 +154,12 @@
    Parameters
      -

    • slicer (str) – Identifier of the slicer this profile belongs to.

      • -

    • name (str) – Identifier of this slicing profile.

      • -

    • data (object) – Profile data, actual structure depends on individual slicer implementation.

      • -

    • display_name (str) – Displayable name for this slicing profile.

      • -

    • description (str) – Description of this slicing profile.

      • -

    • default (bool) – Whether this is the default slicing profile for the slicer.

      • +

    • slicer (str) – Identifier of the slicer this profile belongs to.

      • +

    • name (str) – Identifier of this slicing profile.

      • +

    • data (object) – Profile data, actual structure depends on individual slicer implementation.

      • +

    • display_name (str) – Displayable name for this slicing profile.

      • +

    • description (str) – Description of this slicing profile.

      • +

    • default (bool) – Whether this is the default slicing profile for the slicer.

    @@ -184,7 +184,7 @@ supplied overrides. This will be called according to the method signature of save_slicer_profile().

  • profile (SlicingProfile) – The profile from which to derive the temporary profile.

    • -

  • overrides (dict) – Optional overrides to apply to the profile for creation of the temporary profile.

    • +

  • overrides (dict) – Optional overrides to apply to the profile for creation of the temporary profile.

    • @@ -197,7 +197,7 @@
    Parameters
      -

    • profile_path (str) – Absolute path to the base folder where all slicing profiles are stored.

      • +

    • profile_path (str) – Absolute path to the base folder where all slicing profiles are stored.

    • printer_profile_manager (PrinterProfileManager) – PrinterProfileManager instance to use for accessing available printer profiles, most importantly the currently selected one.

    @@ -212,7 +212,7 @@
    Parameters
      -

    • slicer (str) – Identifier of the slicer for which to retrieve all slicer profiles

      • +

    • slicer (str) – Identifier of the slicer for which to retrieve all slicer profiles

    • require_configured (boolean) – Whether to require the slicer slicer to be already configured (True) or not (False, default). If False and the slicer is not yet configured, a SlicerNotConfigured exception will be raised.

      • @@ -240,9 +240,9 @@
      Parameters
        -

      • slicer_name (str) – Identifier of the slicer on which to cancel the job.

        • -

      • source_path (str) – The absolute path to the source file being sliced.

        • -

      • dest_path (str) – The absolute path to the destination file being sliced to.

        • +

      • slicer_name (str) – Identifier of the slicer on which to cancel the job.

        • +

      • source_path (str) – The absolute path to the source file being sliced.

        • +

      • dest_path (str) – The absolute path to the destination file being sliced to.

      Raises
      @@ -281,8 +281,8 @@
      Parameters
        -

      • slicer (str) – Identifier of the slicer for which to delete the profile.

        • -

      • name (str) – Identifier of the profile to delete.

        • +

      • slicer (str) – Identifier of the slicer for which to delete the profile.

        • +

      • name (str) – Identifier of the profile to delete.

      Raises
      @@ -303,8 +303,8 @@
      Parameters
        -

      • slicer (str) – Identifier of the slicer to which the profile belongs to.

        • -

      • name (str) – Identifier of the profile for which to retrieve the path.

        • +

      • slicer (str) – Identifier of the slicer to which the profile belongs to.

        • +

      • name (str) – Identifier of the profile for which to retrieve the path.

      • must_exist (boolean) – Whether the path must exist (True) or not (False, default).

      @@ -312,7 +312,7 @@

      The absolute path to the profile identified by name for slicer slicer.

      Return type
      -

      str

      +

      str

      Raises
        @@ -331,7 +331,7 @@
        Parameters
          -

        • slicer (str) – Identifier of the slicer to return

          • +

        • slicer (str) – Identifier of the slicer to return

        • require_configured (boolean) – Whether to raise an exception if the slicer has not been configured yet (True, the default), or also return an unconfigured slicer (False).

        @@ -351,13 +351,13 @@

        Retrieves the path where the profiles for slicer slicer are stored.

        Parameters
        -

        slicer (str) – Identifier of the slicer for which to retrieve the path.

        +

        slicer (str) – Identifier of the slicer for which to retrieve the path.

        Returns

        The absolute path to the folder where the slicer’s profiles are stored.

        Return type
        -

        str

        +

        str

        Raises

        UnknownSlicer – The slicer slicer is unknown.

        @@ -376,7 +376,7 @@
        load_profile(slicer, name, require_configured=True)

        Loads the slicing profile for slicer with the given profile name and returns it. If it can’t be loaded -due to an IOError None will be returned instead.

        +due to an IOError None will be returned instead.

        If require_configured is True (the default) a SlicerNotConfigured exception will be raised if the indicated slicer has not yet been configured.

        @@ -403,7 +403,7 @@

        Retrieves the last modification date of slicer’s profiles.

        Parameters
        -

        slicer (str) – the slicer for which to retrieve the last modification date

        +

        slicer (str) – the slicer for which to retrieve the last modification date

        Returns

        (float) the time stamp of the last modification of the slicer’s profiles

        @@ -429,11 +429,11 @@
        save_profile(slicer, name, profile, overrides=None, allow_overwrite=True, display_name=None, description=None)

        Saves the slicer profile profile for slicer slicer under name name.

        -

        profile may be either a SlicingProfile or a dict.

        +

        profile may be either a SlicingProfile or a dict.

        If it’s a SlicingProfile, its slicer`, name and - if provided - display_name and description attributes will be overwritten with the supplied values.

        -

        If it’s a dict, a new SlicingProfile instance will be created with the supplied meta data and +

        If it’s a dict, a new SlicingProfile instance will be created with the supplied meta data and the profile data as the data attribute.

        Note

        @@ -442,15 +442,15 @@
        Parameters
          -

        • slicer (str) – Identifier of the slicer for which to save the profile.

          • -

        • name (str) – Identifier under which to save the profile.

          • -

        • profile (SlicingProfile or dict) – The SlicingProfile or a dict containing the profile +

        • slicer (str) – Identifier of the slicer for which to save the profile.

          • +

        • name (str) – Identifier under which to save the profile.

          • +

        • profile (SlicingProfile or dict) – The SlicingProfile or a dict containing the profile data of the profile the save.

          • -

        • overrides (dict) – Overrides to apply to the profile before saving it.

          • +

        • overrides (dict) – Overrides to apply to the profile before saving it.

        • allow_overwrite (boolean) – If True (default) if a profile for the same slicer of the same name already exists, it will be overwritten. Otherwise an exception will be thrown.

          • -

        • display_name (str) – The name to display to the user for the profile.

          • -

        • description (str) – A description of the profile.

          • +

        • display_name (str) – The name to display to the user for the profile.

          • +

        • description (str) – A description of the profile.

        Returns
        @@ -461,7 +461,7 @@
        Raises
          -

        • ValueError – The supplied profile is neither a SlicingProfile nor a dict.

          • +

        • ValueError – The supplied profile is neither a SlicingProfile nor a dict.

        • UnknownSlicer – The slicer slicer is unknown.

        • ProfileAlreadyExists – A profile with name name already exists for slicer and allow_overwrite is False.

          • @@ -477,14 +477,14 @@
          Parameters
            -

          • slicer (str) – Identifier of the slicer for which to set the default +

          • slicer (str) – Identifier of the slicer for which to set the default profile.

            • -

          • name (str) – Identifier of the profile to set as default.

            • -

          • require_configured (bool) – Whether the slicer needs to be configured +

          • name (str) – Identifier of the profile to set as default.

            • +

          • require_configured (bool) – Whether the slicer needs to be configured for the action to succeed. Defaults to false. Will raise a SlicerNotConfigured error if true and the slicer has not been configured yet.

            • -

          • require_exists (bool) – Whether the profile is required to exist in +

          • require_exists (bool) – Whether the profile is required to exist in order to be set as default. Defaults to true. Will raise a UnknownProfile error if true and the profile is unknown.

          @@ -535,24 +535,24 @@
          Parameters
            -

          • slicer_name (str) – The identifier of the slicer to use for slicing.

            • -

          • source_path (str) – The absolute path to the source file to slice.

            • -

          • dest_path (str) – The absolute path to the destination file to slice to.

            • -

          • profile_name (str) – The name of the slicing profile to use.

            • +

          • slicer_name (str) – The identifier of the slicer to use for slicing.

            • +

          • source_path (str) – The absolute path to the source file to slice.

            • +

          • dest_path (str) – The absolute path to the destination file to slice to.

            • +

          • profile_name (str) – The name of the slicing profile to use.

          • callback (callable) – A callback to call after slicing has finished.

            • -

          • callback_args (list or tuple) – Arguments of the callback to call after slicing has finished. Defaults to +

          • callback_args (list or tuple) – Arguments of the callback to call after slicing has finished. Defaults to an empty list.

            • -

          • callback_kwargs (dict) – Keyword arguments for the callback to call after slicing has finished, will be +

          • callback_kwargs (dict) – Keyword arguments for the callback to call after slicing has finished, will be extended by _analysis, _error or _cancelled as described above! Defaults to an empty dictionary.

            • -

          • overrides (dict) – Overrides for the printer profile to apply.

            • +

          • overrides (dict) – Overrides for the printer profile to apply.

          • on_progress (callable) – Callback to call upon slicing progress.

            • -

          • on_progress_args (list or tuple) – Arguments of the progress callback. Defaults to an empty list.

            • -

          • on_progress_kwargs (dict) – Keyword arguments of the progress callback, will be extended by _progress +

          • on_progress_args (list or tuple) – Arguments of the progress callback. Defaults to an empty list.

            • +

          • on_progress_kwargs (dict) – Keyword arguments of the progress callback, will be extended by _progress as described above! Defaults to an empty dictionary.

            • -

          • printer_profile_id (str) – Identifier of the printer profile for which to slice, if another than the +

          • printer_profile_id (str) – Identifier of the printer profile for which to slice, if another than the one currently selected is to be used.

            • -

          • position (dict) – Dictionary containing the x and y coordinate in the print bed’s coordinate system +

          • position (dict) – Dictionary containing the x and y coordinate in the print bed’s coordinate system of the sliced model’s center. If not provided the model will be positioned at the print bed’s center. Example: dict(x=10,y=20).

          @@ -687,7 +687,7 @@
          Tags
          -
          1.9.2
          +
          1.9.3
          1.8.7
          diff --git a/1.8.7/modules/users.html b/1.8.7/modules/users.html index 52136f249..5ef7df276 100644 --- a/1.8.7/modules/users.html +++ b/1.8.7/modules/users.html @@ -115,7 +115,7 @@

          Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

          @@ -225,7 +225,7 @@
          Tags
          -
          1.9.2
          +
          1.9.3
          1.8.7
          diff --git a/1.8.7/modules/util.html b/1.8.7/modules/util.html index ad1d30f83..4ea7d10e7 100644 --- a/1.8.7/modules/util.html +++ b/1.8.7/modules/util.html @@ -115,7 +115,7 @@

          Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

          @@ -174,7 +174,7 @@
          class octoprint.util.RepeatedTimer(interval, function, args=None, kwargs=None, run_first=False, condition=None, on_condition_false=None, on_cancelled=None, on_finish=None, daemon=True)

          This class represents an action that should be run repeatedly in an interval. It is similar to python’s -own threading.Timer class, but instead of only running once the function will be run again and again, +own threading.Timer class, but instead of only running once the function will be run again and again, sleeping the stated interval in between.

          RepeatedTimers are started, as with threads, by calling their start() method. The timer can be stopped (in between runs) by calling the cancel() method. The interval the time waited before execution of a loop may @@ -216,11 +216,11 @@

          Parameters
            -

          • interval (float or callable) – The interval between each function call, in seconds. Can also be a callable +

          • interval (float or callable) – The interval between each function call, in seconds. Can also be a callable returning the interval to use, in case the interval is not static.

          • function (callable) – The function to call.

            • -

          • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

            • -

          • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

            • +

          • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

            • +

          • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

          • run_first (boolean) – If set to True, the function will be run for the first time before the first wait period. If set to False (the default), the function will be run for the first time after the first wait period.

          • condition (callable) – Condition that needs to be True for loop to continue. Defaults to lambda: True.

            • @@ -230,7 +230,7 @@ before the on_finish callback.

          • on_finish (callable) – Callback to call when the timer finishes, either due to being cancelled or since the condition became false.

            • -

          • daemon (bool) – daemon flag to set on underlying thread.

            • +

          • daemon (bool) – daemon flag to set on underlying thread.

          @@ -250,7 +250,7 @@
          class octoprint.util.ResettableTimer(interval, function, args=None, kwargs=None, on_reset=None, on_cancelled=None, daemon=True)

          This class represents an action that should be run after a specified amount of time. It is similar to python’s -own threading.Timer class, with the addition of being able to reset the counter to zero.

          +own threading.Timer class, with the addition of being able to reset the counter to zero.

          ResettableTimers are started, as with threads, by calling their start() method. The timer can be stopped (in between runs) by calling the cancel() method. Resetting the counter can be done with the reset() method.

          For example:

          @@ -268,14 +268,14 @@
          Parameters
            -

          • interval (float or callable) – The interval before calling function, in seconds. Can also be a callable +

          • interval (float or callable) – The interval before calling function, in seconds. Can also be a callable returning the interval to use, in case the interval is not static.

          • function (callable) – The function to call.

            • -

          • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

            • -

          • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

            • +

          • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

            • +

          • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

          • on_cancelled (callable) – Callback to call when the timer finishes due to being cancelled.

          • on_reset (callable) – Callback to call when the timer is reset.

            • -

          • daemon (bool) – daemon flag to set on underlying thread.

            • +

          • daemon (bool) – daemon flag to set on underlying thread.

          @@ -352,7 +352,7 @@
          Parameters

          • message (string) – The message to include in the deprecation warning.

            • -

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

            • @@ -380,8 +380,8 @@
            Parameters
              -

            • filename (str) – The file to deserialize from

              • -

            • encoding (str) – The encoding to use for the file, defaults to utf-8

              • +

            • filename (str) – The file to deserialize from

              • +

            • encoding (str) – The encoding to use for the file, defaults to utf-8

            Returns
            @@ -408,8 +408,8 @@
            Parameters
              -

            • a (dict) – The dictionary to clean against b.

              • -

            • b (dict) – The dictionary containing the key structure to clean from a.

              • +

            • a (dict) – The dictionary to clean against b.

              • +

            • b (dict) – The dictionary containing the key structure to clean from a.

            @@ -436,8 +436,8 @@
            Parameters
              -

            • a (dict) – The dictionary to check for the keys from b.

              • -

            • b (dict) – The dictionary whose keys to check a for.

              • +

            • a (dict) – The dictionary to check for the keys from b.

              • +

            • b (dict) – The dictionary whose keys to check a for.

            Returns
            @@ -478,7 +478,7 @@
            Parameters
              -

            • dictionary (dict) – The dictionary to filter

              • +

            • dictionary (dict) – The dictionary to filter

            • filter_function (callable) – The filter function to apply, called with key and value of an entry in the dictionary, must return True for values to keep and False for values to strip

              • @@ -492,7 +492,7 @@

            Return type
            -

            dict

            +

            dict

          @@ -564,8 +564,8 @@
          Parameters
            -

          • a (dict) – The dictionary to merge b into

            • -

          • b (dict) – The dictionary to merge into a

            • +

          • a (dict) – The dictionary to merge b into

            • +

          • b (dict) – The dictionary to merge into a

          • leaf_merger (callable) – An optional callable to use to merge leaves (non-dict values)

          • in_place (boolean) – If set to True, a will be merged with b in place, meaning a will be modified

          @@ -574,7 +574,7 @@

          b deep-merged into a

          Return type
          -

          dict

          +

          dict

          @@ -597,8 +597,8 @@
          Parameters
            -

          • source (dict) – Source dictionary

            • -

          • target (dict) – Dictionary to compare to source dictionary and derive diff for

            • +

          • source (dict) – Source dictionary

            • +

          • target (dict) – Dictionary to compare to source dictionary and derive diff for

          Returns
          @@ -609,7 +609,7 @@

          Return type
          -

          dict

          +

          dict

        @@ -632,8 +632,8 @@
        Parameters
          -

        • a (dict) – The dictionary to clean against b.

          • -

        • b (dict) – The dictionary containing the key structure to clean from a.

          • +

        • a (dict) – The dictionary to clean against b.

          • +

        • b (dict) – The dictionary containing the key structure to clean from a.

        @@ -708,10 +708,10 @@

        The class if it could be found.

        Return type
        -

        type

        +

        type

        Raises
        -

        ImportError –

        +

        ImportError –

        @@ -737,7 +737,7 @@

        Formats a datetime instance as “YYYY-mm-dd HH:MM” and returns the resulting string.

        Parameters
        -

        d (datetime.datetime) – The datetime instance to format

        +

        d (datetime.datetime) – The datetime instance to format

        Returns

        The datetime formatted as “YYYY-mm-dd HH:MM”

        @@ -756,7 +756,7 @@

        Based on http://stackoverflow.com/a/1094933/2028598

        Parameters
        -

        num (int) – The byte count to format

        +

        num (int) – The byte count to format

        Returns

        The formatted byte count.

        @@ -773,7 +773,7 @@

        Formats a timedelta instance as “HH:MM:ss” and returns the resulting string.

        Parameters
        -

        d (datetime.timedelta) – The timedelta instance to format

        +

        d (datetime.timedelta) – The timedelta instance to format

        Returns

        The timedelta formatted as “HH:MM:ss”

        @@ -807,7 +807,7 @@
        Parameters

        • filename (string) – The file name to check against the extensions.

          • -

        • extensions (list) – The extensions to check against, a list of strings

          • +

        • extensions (list) – The extensions to check against, a list of strings

        Returns
        @@ -831,7 +831,7 @@
        Parameters

        • message (string) – The message to include in the deprecation warning.

          • -

        • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

        • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

          • @@ -887,10 +887,10 @@
          Parameters
            -

          • filename (str) – The file to write to

            • -

          • data (object) – The data to serialize

            • -

          • encoding (str) – The encoding to use for the file

            • -

          • compressed (bool) – Whether to compress the data before writing it to the file

            • +

          • filename (str) – The file to write to

            • +

          • data (object) – The data to serialize

            • +

          • encoding (str) – The encoding to use for the file

            • +

          • compressed (bool) – Whether to compress the data before writing it to the file

          @@ -898,28 +898,28 @@
          -octoprint.util.to_bytes(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes
          +octoprint.util.to_bytes(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes

          Make sure s_or_u is a byte string.

          Parameters
          Returns

          converted bytes.

          Return type
          -

          bytes

          +

          bytes

          -octoprint.util.to_native_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str
          +octoprint.util.to_native_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str

          Deprecated since version 1.8.0: to_native_str is no longer needed, use to_unicode instead

          @@ -927,7 +927,7 @@
          -octoprint.util.to_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes
          +octoprint.util.to_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes

          Deprecated since version 1.3.11: to_str has been renamed to to_bytes and in a future version will become the new to_unicode

          @@ -935,21 +935,21 @@
          -octoprint.util.to_unicode(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str
          +octoprint.util.to_unicode(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str

          Make sure s_or_u is a unicode string (str).

          Parameters
          Returns

          converted string.

          Return type
          -

          str

          +

          str

          @@ -964,7 +964,7 @@
          Parameters

          • message (string) – The message to include in the deprecation warning.

            • -

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

            • @@ -990,7 +990,7 @@
            Parameters

            • message (string) – The message to include in the deprecation warning.

              • -

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

              • @@ -1051,13 +1051,13 @@
    -call(command: Union[str, List[str], Tuple[str]], delimiter: bytes = b'\n', buffer_size: int = - 1, **kwargs) → Tuple[Optional[int], List[str], List[str]]
    +call(command: Union[str, List[str], Tuple[str]], delimiter: bytes = b'\n', buffer_size: int = - 1, **kwargs) → Tuple[Optional[int], List[str], List[str]]

    Calls a command

    Parameters
      -

    • command (list, tuple or str) – command to call

      • -

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, +

    • command (list, tuple or str) – command to call

      • +

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, stdout and stderr will be overwritten)

    @@ -1069,13 +1069,13 @@
    -checked_call(command: Union[str, List[str], Tuple[str]], **kwargs) → Tuple[int, List[str], List[str]]
    +checked_call(command: Union[str, List[str], Tuple[str]], **kwargs) → Tuple[int, List[str], List[str]]

    Calls a command and raises an error if it doesn’t return with return code 0

    Parameters
      -

    • command (list, tuple or str) – command to call

      • -

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, +

    • command (list, tuple or str) – command to call

      • +

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, stdout and stderr will be overwritten)

    @@ -1115,9 +1115,9 @@
    Parameters
      -

    • returncode (int) – the return code of the command

      • -

    • stdout (str) – the stdout output produced by the command

      • -

    • stderr (str) – the stderr output produced by the command

      • +

    • returncode (int) – the return code of the command

      • +

    • stdout (str) – the stdout output produced by the command

      • +

    • stderr (str) – the stderr output produced by the command

    @@ -1130,7 +1130,7 @@
    -octoprint.util.commandline.clean_ansi(line: Union[str, bytes]) → Union[str, bytes]
    +octoprint.util.commandline.clean_ansi(line: Union[str, bytes]) → Union[str, bytes]

    Removes ANSI control codes from line.

    Note: This function also still supports an input of bytes, leading to an output of bytes. This if for reasons of backwards compatibility only, @@ -1138,7 +1138,7 @@ a future version of OctoPrint. A warning will be logged.

    Parameters
    -

    line (str or bytes) – the line to process

    +

    line (str or bytes) – the line to process

    Returns

    (str or bytes) The line without any ANSI control codes

    @@ -1224,7 +1224,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/concepts.html b/1.8.7/plugins/concepts.html index 70577bbac..8e49fb355 100644 --- a/1.8.7/plugins/concepts.html +++ b/1.8.7/plugins/concepts.html @@ -102,7 +102,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -133,7 +133,7 @@

    General Concepts

    -

    OctoPrint’s plugins are Python Packages which in their +

    OctoPrint’s plugins are Python Packages which in their top-level module define a bunch of control properties defining metadata (like name, version etc of the plugin) as well as information on how to initialize the plugin and into what parts of the system the plugin will actually plug in to perform its job.

    @@ -210,7 +210,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/controlproperties.html b/1.8.7/plugins/controlproperties.html index ed44afa12..634a632c1 100644 --- a/1.8.7/plugins/controlproperties.html +++ b/1.8.7/plugins/controlproperties.html @@ -99,7 +99,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -296,7 +296,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/distributing.html b/1.8.7/plugins/distributing.html index 6611be707..d9a6c1e40 100644 --- a/1.8.7/plugins/distributing.html +++ b/1.8.7/plugins/distributing.html @@ -105,7 +105,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -242,7 +242,7 @@

    Version management after the official plu
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/gettingstarted.html b/1.8.7/plugins/gettingstarted.html index ec23585ef..e2589e039 100644 --- a/1.8.7/plugins/gettingstarted.html +++ b/1.8.7/plugins/gettingstarted.html @@ -108,7 +108,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1382,7 +1382,7 @@

    Where do we go from here?
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/helpers.html b/1.8.7/plugins/helpers.html index cbe957a30..8de80a145 100644 --- a/1.8.7/plugins/helpers.html +++ b/1.8.7/plugins/helpers.html @@ -99,7 +99,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -274,7 +274,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/hooks.html b/1.8.7/plugins/hooks.html index 9dca728b1..442aa08a6 100644 --- a/1.8.7/plugins/hooks.html +++ b/1.8.7/plugins/hooks.html @@ -148,7 +148,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -655,7 +655,7 @@
    Parameters
      -

    • components (dict) – System components to use for user manager instance initialization

      • +

    • components (dict) – System components to use for user manager instance initialization

    • settings (SettingsManager) – The global settings manager instance to fetch configuration values from if necessary

    @@ -663,7 +663,7 @@

    The userManager instance to use globally.

    Return type
    -

    UserManager subclass or None

    +

    UserManager subclass or None

    @@ -716,7 +716,7 @@
    Parameters
    -

    apikey (str) – The API key to validate

    +

    apikey (str) – The API key to validate

    Returns

    The user in whose name the request will be processed further

    @@ -916,7 +916,7 @@ OctoPrint’s CLI.

    Return type
    -

    list

    +

    list

    @@ -950,9 +950,9 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • firmware_name (str) – The parsed name of the firmware

      • -

    • firmware_data (dict) – All data contained in the M115 report

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • firmware_name (str) – The parsed name of the firmware

      • +

    • firmware_data (dict) – All data contained in the M115 report

    @@ -981,10 +981,10 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • capability (str) – The name of the parsed capability

      • -

    • enabled (bool) – Whether the capability is reported as enabled or disabled

      • -

    • already_defined (dict) – Already defined capabilities (capability name mapped to enabled flag)

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • capability (str) – The name of the parsed capability

      • +

    • enabled (bool) – Whether the capability is reported as enabled or disabled

      • +

    • already_defined (dict) – Already defined capabilities (capability name mapped to enabled flag)

    @@ -1064,13 +1064,13 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • line (str) – The complete line as received from the printer, format // action:<command>

      • -

    • action (str) – The parsed out action command incl. parameters, so for a line like // action:some_command key value this will be +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • line (str) – The complete line as received from the printer, format // action:<command>

      • +

    • action (str) – The parsed out action command incl. parameters, so for a line like // action:some_command key value this will be some_command key value

      • -

    • name (str) – The action command name, for a line like // action:some_command key value this will be +

    • name (str) – The action command name, for a line like // action:some_command key value this will be some_command

      • -

    • params (str) – The action command’s parameter, for a line like // action:some_command key value this will +

    • params (str) – The action command’s parameter, for a line like // action:some_command key value this will be key value

    @@ -1155,11 +1155,11 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • phase (str) – The current phase in the command progression, either queuing or sending. Will always +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • phase (str) – The current phase in the command progression, either queuing or sending. Will always match the <phase> of the hook.

      • -

    • cmd (str) – The @ command without the leading @

      • -

    • parameters (str) – Any parameters provided to the @ command. If none were provided this will be an empty string.

      • +

    • cmd (str) – The @ command without the leading @

      • +

    • parameters (str) – Any parameters provided to the @ command. If none were provided this will be an empty string.

    @@ -1362,15 +1362,15 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • phase (str) – The current phase in the command progression, either queuing, queued, sending or +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • phase (str) – The current phase in the command progression, either queuing, queued, sending or sent. Will always match the <phase> of the hook.

      • -

    • cmd (str) – The GCODE command for which the hook was triggered. This is the full command as taken either +

    • cmd (str) – The GCODE command for which the hook was triggered. This is the full command as taken either from the currently streamed GCODE file or via other means (e.g. user input our status polling).

      • -

    • cmd_type (str) – Type of command, e.g. temperature_poll for temperature polling or sd_status_poll for SD +

    • cmd_type (str) – Type of command, e.g. temperature_poll for temperature polling or sd_status_poll for SD printing status polling.

      • -

    • gcode (str) – Parsed GCODE command, e.g. G0 or M110, may also be None if no known command could be parsed

      • -

    • subcode (str) – Parsed subcode of the GCODE command, e.g. 1 for M80.1. Will be None if no subcode was provided +

    • gcode (str) – Parsed GCODE command, e.g. G0 or M110, may also be None if no known command could be parsed

      • +

    • subcode (str) – Parsed subcode of the GCODE command, e.g. 1 for M80.1. Will be None if no subcode was provided or no command could be parsed.

    • tags – Tags attached to the command

    @@ -1454,14 +1454,14 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • line (str) – The line received from the printer.

      • +

    • line (str) – The line received from the printer.

    Returns

    The received line or in any case, a modified version of it.

    Return type
    -

    str

    +

    str

    @@ -1528,14 +1528,14 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • error_message (str) – The error message received from the printer.

      • +

    • error_message (str) – The error message received from the printer.

    Returns

    True if the error was handled in the plugin and should not be processed further, False (or None) otherwise.

    Return type
    -

    bool

    +

    bool

    @@ -1632,15 +1632,15 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • script_type (str) – The type of the script for which the hook was called, currently only “gcode” is supported here.

      • -

    • script_name (str) – The name of the script for which the hook was called.

      • +

    • script_type (str) – The type of the script for which the hook was called, currently only “gcode” is supported here.

      • +

    • script_name (str) – The name of the script for which the hook was called.

    Returns

    A 2-tuple in the form (prefix, postfix), 3-tuple in the form (prefix, postfix, variables), or None

    Return type
    -

    tuple or None

    +

    tuple or None

    @@ -1719,13 +1719,13 @@

    For an example of use see the bundled virtual_printer plugin.

    Parameters
    -

    candidates (list) – The port names already found on the system available for connection.

    +

    candidates (list) – The port names already found on the system available for connection.

    Returns

    Additional port names to offer up for connection.

    Return type
    -

    list

    +

    list

    @@ -1819,11 +1819,11 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • port (str) – The port for which to construct a serial instance. May be None or AUTO in which case port +

    • port (str) – The port for which to construct a serial instance. May be None or AUTO in which case port auto detection is to be performed.

      • -

    • baudrate (int) – The baudrate for which to construct a serial instance. May be 0 in which case baudrate auto +

    • baudrate (int) – The baudrate for which to construct a serial instance. May be 0 in which case baudrate auto detection is to be performed.

      • -

    • read_timeout (int) – The read timeout to set on the serial port.

      • +

    • read_timeout (int) – The read timeout to set on the serial port.

    Returns
    @@ -1863,7 +1863,7 @@

    A list of custom events to register

    Return type
    -

    list

    +

    list

    @@ -1908,7 +1908,7 @@

    A dictionary of analysis queue factories, mapped by their targeted file type.

    Return type
    -

    dict

    +

    dict

    @@ -1952,7 +1952,7 @@

    The partial extension tree to merge with the full extension tree.

    Return type
    -

    dict

    +

    dict

    @@ -2047,11 +2047,11 @@
    Parameters
      -

    • path (str) – The path on storage the file_object is to be stored

      • +

    • path (str) – The path on storage the file_object is to be stored

    • file_object (AbstractFileWrapper) – The AbstractFileWrapper instance representing the file object to store.

      • -

    • links (dict) – The links that are going to be stored with the file.

      • -

    • printer_profile (dict) – The printer profile associated with the file.

      • +

    • links (dict) – The links that are going to be stored with the file.

      • +

    • printer_profile (dict) – The printer profile associated with the file.

    • allow_overwrite (boolean) – Whether to allow overwriting an existing file named the same or not.

    @@ -2059,7 +2059,7 @@

    The file_object as passed in or None, or a replaced version to use instead for further processing.

    Return type
    -

    AbstractFileWrapper or None

    +

    AbstractFileWrapper or None

    @@ -2114,7 +2114,7 @@

    Additional data to include

    Return type
    -

    dict

    +

    dict

    @@ -2149,13 +2149,13 @@ class will be instantiated.

    Parameters
    -

    components (dict) – System components to use for printer instance initialization

    +

    components (dict) – System components to use for printer instance initialization

    Returns

    The printer instance to use globally.

    Return type
    -

    PrinterInterface subclass or None

    +

    PrinterInterface subclass or None

    @@ -2183,7 +2183,7 @@

    True if OctoPrint should not proceed with the connect

    Return type
    -

    boolean or None

    +

    boolean or None

    @@ -2306,9 +2306,9 @@
    Parameters
      -

    • printer (object) – the PrinterInterface instance the hook was called from

      • -

    • filename (str) – filename on the local storage

      • -

    • path (str) – path of the file in the local file system

      • +

    • printer (object) – the PrinterInterface instance the hook was called from

      • +

    • filename (str) – filename on the local storage

      • +

    • path (str) – path of the file in the local file system

    • sd_upload_started (function) – callback for when the upload started

    • sd_upload_success (function) – callback for successful finish of upload

    • sd_upload_failure (function) – callback for failure of upload

      • @@ -2498,13 +2498,13 @@
      Parameters
      -

      current_max_body_sizes (list) – read-only list of the currently configured maximum body sizes

      +

      current_max_body_sizes (list) – read-only list of the currently configured maximum body sizes

      Returns

      A list of 3-tuples with additional request specific maximum body sizes as defined above

      Return type
      -

      list

      +

      list

    @@ -2631,13 +2631,13 @@
    Parameters
    -

    server_routes (list) – read-only list of the currently configured server routes

    +

    server_routes (list) – read-only list of the currently configured server routes

    Returns

    a list of 3-tuples with additional routes as defined above

    Return type
    -

    list

    +

    list

    @@ -2655,8 +2655,8 @@
    Parameters
      -

    • socket (object) – the socket object which is about to be registered

      • -

    • user (object) – the user that got authenticated on the socket, or None if the user got deauthenticated

      • +

    • socket (object) – the socket object which is about to be registered

      • +

    • user (object) – the user that got authenticated on the socket, or None if the user got deauthenticated

    @@ -2677,8 +2677,8 @@
    Parameters
      -

    • socket (object) – the socket object which is about to be registered

      • -

    • user (object) – the user currently authenticated on the socket - might be None

      • +

    • socket (object) – the socket object which is about to be registered

      • +

    • user (object) – the user currently authenticated on the socket - might be None

    Returns
    @@ -2704,10 +2704,10 @@
    Parameters
      -

    • socket (object) – the socket object on which a message is about to be emitted

      • -

    • user (object) – the user currently authenticated on the socket - might be None

      • +

    • socket (object) – the socket object on which a message is about to be emitted

      • +

    • user (object) – the user currently authenticated on the socket - might be None

    • message (string) – the message type about to be emitted

      • -

    • payload (dict) – the payload of the message about to be emitted (may be None)

      • +

    • payload (dict) – the payload of the message about to be emitted (may be None)

    Returns
    @@ -2808,7 +2808,7 @@

    a list of command specifications

    Return type
    -

    list

    +

    list

    @@ -2842,7 +2842,7 @@

    a dictionary mapping bundle file names to bundle file content

    Return type
    -

    dict

    +

    dict

    @@ -2873,7 +2873,7 @@

    a list of additional file extensions

    Return type
    -

    list

    +

    list

    @@ -3095,15 +3095,15 @@
    Parameters
      -

    • template_rules (dict) – read-only dictionary of currently configured template rules

      • -

    • template_sorting (dict) – read-only dictionary of currently configured template sorting specifications

      • +

    • template_rules (dict) – read-only dictionary of currently configured template rules

      • +

    • template_sorting (dict) – read-only dictionary of currently configured template sorting specifications

    Returns

    a list of 3-tuples (template type, rule, sorting spec)

    Return type
    -

    list

    +

    list

    @@ -3161,13 +3161,13 @@

    filename will be the future path of the frame to be saved.

    Parameters
    -

    filename (str) – The future path of the frame to be saved.

    +

    filename (str) – The future path of the frame to be saved.

    Returns

    None

    Return type
    -

    None

    +

    None

    @@ -3187,7 +3187,7 @@
    Parameters
      -

    • filename (str) – The path of the frame that should have been saved.

      • +

    • filename (str) – The path of the frame that should have been saved.

    • success (boolean) – Indicates whether the capture was successful or not.

    @@ -3195,7 +3195,7 @@

    None

    Return type
    -

    None

    +

    None

    @@ -3238,7 +3238,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/index.html b/1.8.7/plugins/index.html index d28709a10..9beedd082 100644 --- a/1.8.7/plugins/index.html +++ b/1.8.7/plugins/index.html @@ -99,7 +99,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -291,7 +291,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/injectedproperties.html b/1.8.7/plugins/injectedproperties.html index 85b9121db..f2dee9a4f 100644 --- a/1.8.7/plugins/injectedproperties.html +++ b/1.8.7/plugins/injectedproperties.html @@ -99,7 +99,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -148,7 +148,7 @@ data files etc). Plugins should not access this property directly but instead utilize get_plugin_data_folder() which will make sure the path actually does exist and if not create it before returning it.

    -
    self._logger

    A logging.Logger instance logging to the log target +

    self._logger

    A logging.Logger instance logging to the log target octoprint.plugin.<plugin identifier>.

    self._settings

    The plugin’s personalized settings manager, injected only into plugins that include the SettingsPlugin mixin. @@ -218,7 +218,7 @@

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/mixins.html b/1.8.7/plugins/mixins.html index 73893b9a9..9de53cc19 100644 --- a/1.8.7/plugins/mixins.html +++ b/1.8.7/plugins/mixins.html @@ -121,7 +121,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -481,7 +481,7 @@
    Parameters

    • host (string) – the host the server will listen on, may be 0.0.0.0

      • -

    • port (int) – the port the server will listen on

      • +

    • port (int) – the port the server will listen on

    @@ -620,7 +620,7 @@ getters, the second the preprocessors for setters

    Return type
    -

    (dict, dict)

    +

    (dict, dict)

    @@ -712,7 +712,7 @@ plugin’s configuration.

    Return type
    -

    int or None

    +

    int or None

    @@ -778,9 +778,9 @@
    Parameters
      -

    • target (int) – The settings format version the plugin requires, this should always be the same value as +

    • target (int) – The settings format version the plugin requires, this should always be the same value as returned by get_settings_version().

      • -

    • current (int or None) – The settings format version as currently stored in config.yaml. May be None if +

    • current (int or None) – The settings format version as currently stored in config.yaml. May be None if no version information can be found.

    @@ -804,13 +804,13 @@
    Parameters
    -

    data (dict) – The settings dictionary to be saved for the plugin

    +

    data (dict) – The settings dictionary to be saved for the plugin

    Returns

    The settings that differed from the defaults and were actually saved.

    Return type
    -

    dict

    +

    dict

    @@ -1294,7 +1294,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -1320,7 +1320,7 @@

    Return type
    -

    int or None

    +

    int or None

    @@ -1352,11 +1352,11 @@
    Parameters
      -

    • seen_wizards (dict) – A dictionary with information about already seen +

    • seen_wizards (dict) – A dictionary with information about already seen wizards and their versions. Mappings from the identifiers of the plugin providing the wizard to the reported wizard version (int or None) that was already seen by the user.

      • -

    • implementation (object) – The plugin implementation to check.

      • +

    • implementation (object) – The plugin implementation to check.

    Returns
    @@ -1367,7 +1367,7 @@

    Return type
    -

    bool

    +

    bool

    @@ -1396,7 +1396,7 @@

    Use this to do any clean up tasks necessary after wizard completion.

    Parameters
    -

    handled (bool) – True if the plugin’s wizard was previously reported as +

    handled (bool) – True if the plugin’s wizard was previously reported as required, not ignored and thus presented to the user, False otherwise

    @@ -1587,13 +1587,13 @@ via the parameter default_additional).

    Parameters
    -

    default_additional (list) – The list of default fields added to the ETag of the default UI

    +

    default_additional (list) – The list of default fields added to the ETag of the default UI

    Returns

    A list of additional fields for the ETag generation, or None

    Return type
    -

    (list)

    +

    (list)

    @@ -1615,7 +1615,7 @@

    Return type
    -

    list, tuple

    +

    list, tuple

    @@ -1640,7 +1640,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -1663,7 +1663,7 @@

    Return type
    -

    list

    +

    list

    @@ -1681,7 +1681,7 @@

    An alternatively calculated ETag value. Ignored if None is returned (default).

    Return type
    -

    str

    +

    str

    @@ -1699,7 +1699,7 @@

    An alternatively calculated LastModified value. Ignored if None is returned (default).

    Return type
    -

    int

    +

    int

    @@ -1744,7 +1744,7 @@

    Return type
    -

    list

    +

    list

    @@ -1762,7 +1762,7 @@

    Additional data to persist in the preemptive cache configuration.

    Return type
    -

    dict

    +

    dict

    @@ -1800,7 +1800,7 @@

    Whether to suppress a record (True) or not (False, default)

    Return type
    -

    bool

    +

    bool

    @@ -1819,7 +1819,7 @@

    Whether to enable preemptive caching (True, default) or not (False)

    Return type
    -

    bool

    +

    bool

    @@ -1920,12 +1920,12 @@
    Parameters
      -

    • now (datetime.datetime) – The datetime instance representing “now” +

    • now (datetime.datetime) – The datetime instance representing “now” for this request, in case your plugin implementation needs this information.

    • request (flask.Request) –

      A Flask Request object.

      • -

    • render_kwargs (dict) – The (cached) render keyword arguments that +

    • render_kwargs (dict) – The (cached) render keyword arguments that would usually be provided to the core UI render function.

    @@ -1968,7 +1968,7 @@

    Return type
    -

    bool

    +

    bool

    @@ -2107,7 +2107,7 @@
    Parameters

    • command (string) – the command with which the resource was called

      • -

    • data (dict) – the full request body of the POST request parsed from JSON into a Python dictionary

      • +

    • data (dict) – the full request body of the POST request parsed from JSON into a Python dictionary

    Returns
    @@ -2334,9 +2334,9 @@
    Parameters
      -

    • event (str) – The type of event that got fired, see the list of events +

    • event (str) – The type of event that got fired, see the list of events for possible values

      • -

    • payload (dict) – The payload as provided with the event

      • +

    • payload (dict) – The payload as provided with the event

    @@ -2362,7 +2362,7 @@

    • storage (string) – Location of the file

    • path (string) – Path of the file

      • -

    • progress (int) – Current progress as a value between 0 and 100

      • +

    • progress (int) – Current progress as a value between 0 and 100

    @@ -2380,7 +2380,7 @@

  • source_path (string) – Path of the source file

  • destination_location (string) – Location the destination file

  • destination_path (string) – Path of the destination file

    • -

  • progress (int) – Current progress as a value between 0 and 100

    • +

  • progress (int) – Current progress as a value between 0 and 100

    • @@ -2402,7 +2402,7 @@

    Cancels the slicing to the indicated file.

    Parameters
    -

    machinecode_path (str) – The absolute path to the machine code file to which to stop slicing to.

    +

    machinecode_path (str) – The absolute path to the machine code file to which to stop slicing to.

    @@ -2435,7 +2435,7 @@ should make sure to track the started jobs via the machinecode_path, if provided.

    The method should return a 2-tuple consisting of a boolean flag indicating whether the slicing job was finished successfully (True) or not (False) and a result depending on the success of the slicing job.

    -

    For jobs that finished successfully, result should be a dict containing additional information +

    For jobs that finished successfully, result should be a dict containing additional information about the slicing job under the following keys:

    analysis

    Analysis result of the generated machine code as returned by the slicer itself. This should match the @@ -2443,7 +2443,7 @@ GcodeAnalysisQueue for GCODE files.

    -

    For jobs that did not finish successfully (but not due to being cancelled!), result should be a str +

    For jobs that did not finish successfully (but not due to being cancelled!), result should be a str containing a human readable reason for the error.

    If the job gets cancelled, a SlicingCancelled exception should be raised.

    @@ -2451,7 +2451,7 @@

    A 2-tuple (boolean, object) as outlined above.

    Return type
    -

    tuple

    +

    tuple

    Raises

    SlicingCancelled – The slicing job was cancelled (via cancel_slicing()).

    @@ -2498,7 +2498,7 @@ indicated path.

    Parameters
    -

    path (str) – The absolute path from which to read the slicing profile.

    +

    path (str) – The absolute path from which to read the slicing profile.

    Returns

    The specified slicing profile.

    @@ -2518,7 +2518,7 @@ of the plugin implementation.

    Parameters
    -

    profile_path (str) – The base folder where OctoPrint stores this slicer plugin’s profiles

    +

    profile_path (str) – The base folder where OctoPrint stores this slicer plugin’s profiles

    @@ -2565,7 +2565,7 @@

    A dict describing the slicer as outlined above.

    Return type
    -

    dict

    +

    dict

    @@ -2584,16 +2584,16 @@ save_slicer_profile(path, profile, allow_overwrite=True, overrides=None)

    Should save the provided SlicingProfile to the indicated path, after applying any supplied overrides. If a profile is already saved under the indicated path and allow_overwrite is -set to False (defaults to True), an IOError should be raised.

    +set to False (defaults to True), an IOError should be raised.

    Parameters
      -

    • path (str) – The absolute path to which to save the profile.

      • +

    • path (str) – The absolute path to which to save the profile.

    • profile (SlicingProfile) – The profile to save.

    • allow_overwrite (boolean) – Whether to allow to overwrite an existing profile at the indicated path (True, default) or not (False). If a profile already exists on the path and this is False an -IOError should be raised.

      • -

    • overrides (dict) – Profile overrides to apply to the profile before saving it

      • +IOError should be raised.

      +

    • overrides (dict) – Profile overrides to apply to the profile before saving it

    @@ -2659,7 +2659,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/python3_migration.html b/1.8.7/plugins/python3_migration.html index c3d8e584f..9415d81b7 100644 --- a/1.8.7/plugins/python3_migration.html +++ b/1.8.7/plugins/python3_migration.html @@ -113,7 +113,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -486,7 +486,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/plugins/viewmodels.html b/1.8.7/plugins/viewmodels.html index f27c6ccfa..41dc14b58 100644 --- a/1.8.7/plugins/viewmodels.html +++ b/1.8.7/plugins/viewmodels.html @@ -109,7 +109,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -586,7 +586,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/py-modindex.html b/1.8.7/py-modindex.html index cb923bfeb..97baf21a4 100644 --- a/1.8.7/py-modindex.html +++ b/1.8.7/py-modindex.html @@ -88,7 +88,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -291,7 +291,7 @@

    Python Module Index

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.8.7/search.html b/1.8.7/search.html index c3f90cfc5..51fd8c501 100644 --- a/1.8.7/search.html +++ b/1.8.7/search.html @@ -88,7 +88,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -156,7 +156,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/_images/bundledplugins-action_command_notification-example.png b/1.9.3/_images/bundledplugins-action_command_notification-example.png similarity index 100% rename from 1.9.2/_images/bundledplugins-action_command_notification-example.png rename to 1.9.3/_images/bundledplugins-action_command_notification-example.png diff --git a/1.9.2/_images/bundledplugins-action_command_prompt-example.png b/1.9.3/_images/bundledplugins-action_command_prompt-example.png similarity index 100% rename from 1.9.2/_images/bundledplugins-action_command_prompt-example.png rename to 1.9.3/_images/bundledplugins-action_command_prompt-example.png diff --git a/1.9.2/_images/bundledplugins-action_command_prompt-example2.png b/1.9.3/_images/bundledplugins-action_command_prompt-example2.png similarity index 100% rename from 1.9.2/_images/bundledplugins-action_command_prompt-example2.png rename to 1.9.3/_images/bundledplugins-action_command_prompt-example2.png diff --git a/1.9.2/_images/bundledplugins-announcements-example1.png b/1.9.3/_images/bundledplugins-announcements-example1.png similarity index 100% rename from 1.9.2/_images/bundledplugins-announcements-example1.png rename to 1.9.3/_images/bundledplugins-announcements-example1.png diff --git a/1.9.2/_images/bundledplugins-announcements-example2.png b/1.9.3/_images/bundledplugins-announcements-example2.png similarity index 100% rename from 1.9.2/_images/bundledplugins-announcements-example2.png rename to 1.9.3/_images/bundledplugins-announcements-example2.png diff --git a/1.9.2/_images/bundledplugins-announcements-settings.png b/1.9.3/_images/bundledplugins-announcements-settings.png similarity index 100% rename from 1.9.2/_images/bundledplugins-announcements-settings.png rename to 1.9.3/_images/bundledplugins-announcements-settings.png diff --git a/1.9.2/_images/bundledplugins-appkeys-confirmation_prompt.png b/1.9.3/_images/bundledplugins-appkeys-confirmation_prompt.png similarity index 100% rename from 1.9.2/_images/bundledplugins-appkeys-confirmation_prompt.png rename to 1.9.3/_images/bundledplugins-appkeys-confirmation_prompt.png diff --git a/1.9.2/_images/bundledplugins-appkeys-settings.png b/1.9.3/_images/bundledplugins-appkeys-settings.png similarity index 100% rename from 1.9.2/_images/bundledplugins-appkeys-settings.png rename to 1.9.3/_images/bundledplugins-appkeys-settings.png diff --git a/1.9.2/_images/bundledplugins-appkeys-user_settings.png b/1.9.3/_images/bundledplugins-appkeys-user_settings.png similarity index 100% rename from 1.9.2/_images/bundledplugins-appkeys-user_settings.png rename to 1.9.3/_images/bundledplugins-appkeys-user_settings.png diff --git a/1.9.2/_images/bundledplugins-backup-settings.png b/1.9.3/_images/bundledplugins-backup-settings.png similarity index 100% rename from 1.9.2/_images/bundledplugins-backup-settings.png rename to 1.9.3/_images/bundledplugins-backup-settings.png diff --git a/1.9.2/_images/bundledplugins-discovery-windowsexplorer.png b/1.9.3/_images/bundledplugins-discovery-windowsexplorer.png similarity index 100% rename from 1.9.2/_images/bundledplugins-discovery-windowsexplorer.png rename to 1.9.3/_images/bundledplugins-discovery-windowsexplorer.png diff --git a/1.9.2/_images/bundledplugins-gcodeviewer-example.png b/1.9.3/_images/bundledplugins-gcodeviewer-example.png similarity index 100% rename from 1.9.2/_images/bundledplugins-gcodeviewer-example.png rename to 1.9.3/_images/bundledplugins-gcodeviewer-example.png diff --git a/1.9.2/_images/bundledplugins-logging-settings.png b/1.9.3/_images/bundledplugins-logging-settings.png similarity index 100% rename from 1.9.2/_images/bundledplugins-logging-settings.png rename to 1.9.3/_images/bundledplugins-logging-settings.png diff --git a/1.9.2/_images/bundledplugins-pluginmanager-installing.png b/1.9.3/_images/bundledplugins-pluginmanager-installing.png similarity index 100% rename from 1.9.2/_images/bundledplugins-pluginmanager-installing.png rename to 1.9.3/_images/bundledplugins-pluginmanager-installing.png diff --git a/1.9.2/_images/bundledplugins-pluginmanager-mainscreen.png b/1.9.3/_images/bundledplugins-pluginmanager-mainscreen.png similarity index 100% rename from 1.9.2/_images/bundledplugins-pluginmanager-mainscreen.png rename to 1.9.3/_images/bundledplugins-pluginmanager-mainscreen.png diff --git a/1.9.2/_images/bundledplugins-pluginmanager-repofilters.png b/1.9.3/_images/bundledplugins-pluginmanager-repofilters.png similarity index 100% rename from 1.9.2/_images/bundledplugins-pluginmanager-repofilters.png rename to 1.9.3/_images/bundledplugins-pluginmanager-repofilters.png diff --git a/1.9.2/_images/bundledplugins-softwareupdate-configuration.png b/1.9.3/_images/bundledplugins-softwareupdate-configuration.png similarity index 100% rename from 1.9.2/_images/bundledplugins-softwareupdate-configuration.png rename to 1.9.3/_images/bundledplugins-softwareupdate-configuration.png diff --git a/1.9.2/_images/change-password-api-key.png b/1.9.3/_images/change-password-api-key.png similarity index 100% rename from 1.9.2/_images/change-password-api-key.png rename to 1.9.3/_images/change-password-api-key.png diff --git a/1.9.2/_images/features-custom_controls-confirm.png b/1.9.3/_images/features-custom_controls-confirm.png similarity index 100% rename from 1.9.2/_images/features-custom_controls-confirm.png rename to 1.9.3/_images/features-custom_controls-confirm.png diff --git a/1.9.2/_images/features-custom_controls-example.png b/1.9.3/_images/features-custom_controls-example.png similarity index 100% rename from 1.9.2/_images/features-custom_controls-example.png rename to 1.9.3/_images/features-custom_controls-example.png diff --git a/1.9.2/_images/features-safemode-notification.png b/1.9.3/_images/features-safemode-notification.png similarity index 100% rename from 1.9.2/_images/features-safemode-notification.png rename to 1.9.3/_images/features-safemode-notification.png diff --git a/1.9.2/_images/features-safemode-systemmenu.png b/1.9.3/_images/features-safemode-systemmenu.png similarity index 100% rename from 1.9.2/_images/features-safemode-systemmenu.png rename to 1.9.3/_images/features-safemode-systemmenu.png diff --git a/1.9.2/_images/mermaid-143e9094a93916e3434fbbcc18888b96ac90031e.svg b/1.9.3/_images/mermaid-143e9094a93916e3434fbbcc18888b96ac90031e.svg similarity index 100% rename from 1.9.2/_images/mermaid-143e9094a93916e3434fbbcc18888b96ac90031e.svg rename to 1.9.3/_images/mermaid-143e9094a93916e3434fbbcc18888b96ac90031e.svg diff --git a/1.9.2/_images/mermaid-1e2a4354753c75597109db1548404e3800e6202d.svg b/1.9.3/_images/mermaid-1e2a4354753c75597109db1548404e3800e6202d.svg similarity index 100% rename from 1.9.2/_images/mermaid-1e2a4354753c75597109db1548404e3800e6202d.svg rename to 1.9.3/_images/mermaid-1e2a4354753c75597109db1548404e3800e6202d.svg diff --git a/1.9.2/_images/mermaid-29cc0989a08e3995529dfe636546bddf4d51634b.svg b/1.9.3/_images/mermaid-29cc0989a08e3995529dfe636546bddf4d51634b.svg similarity index 100% rename from 1.9.2/_images/mermaid-29cc0989a08e3995529dfe636546bddf4d51634b.svg rename to 1.9.3/_images/mermaid-29cc0989a08e3995529dfe636546bddf4d51634b.svg diff --git a/1.9.2/_images/mermaid-4fd41888a15fa9877db93b5414f72704048b4f41.svg b/1.9.3/_images/mermaid-4fd41888a15fa9877db93b5414f72704048b4f41.svg similarity index 100% rename from 1.9.2/_images/mermaid-4fd41888a15fa9877db93b5414f72704048b4f41.svg rename to 1.9.3/_images/mermaid-4fd41888a15fa9877db93b5414f72704048b4f41.svg diff --git a/1.9.2/_images/mermaid-b6a68afb5de22645f94737e480e580e570c977a7.svg b/1.9.3/_images/mermaid-b6a68afb5de22645f94737e480e580e570c977a7.svg similarity index 100% rename from 1.9.2/_images/mermaid-b6a68afb5de22645f94737e480e580e570c977a7.svg rename to 1.9.3/_images/mermaid-b6a68afb5de22645f94737e480e580e570c977a7.svg diff --git a/1.9.2/_images/octoprint-logo.png b/1.9.3/_images/octoprint-logo.png similarity index 100% rename from 1.9.2/_images/octoprint-logo.png rename to 1.9.3/_images/octoprint-logo.png diff --git a/1.9.2/_images/plugins_gettingstarted_helloworld_navbar.png b/1.9.3/_images/plugins_gettingstarted_helloworld_navbar.png similarity index 100% rename from 1.9.2/_images/plugins_gettingstarted_helloworld_navbar.png rename to 1.9.3/_images/plugins_gettingstarted_helloworld_navbar.png diff --git a/1.9.2/_images/plugins_gettingstarted_helloworld_settings.png b/1.9.3/_images/plugins_gettingstarted_helloworld_settings.png similarity index 100% rename from 1.9.2/_images/plugins_gettingstarted_helloworld_settings.png rename to 1.9.3/_images/plugins_gettingstarted_helloworld_settings.png diff --git a/1.9.2/_images/plugins_gettingstarted_helloworld_tab.png b/1.9.3/_images/plugins_gettingstarted_helloworld_tab.png similarity index 100% rename from 1.9.2/_images/plugins_gettingstarted_helloworld_tab.png rename to 1.9.3/_images/plugins_gettingstarted_helloworld_tab.png diff --git a/1.9.2/_images/plugins_lifecycle.svg b/1.9.3/_images/plugins_lifecycle.svg similarity index 100% rename from 1.9.2/_images/plugins_lifecycle.svg rename to 1.9.3/_images/plugins_lifecycle.svg diff --git a/1.9.2/_images/settings-api-cors.png b/1.9.3/_images/settings-api-cors.png similarity index 100% rename from 1.9.2/_images/settings-api-cors.png rename to 1.9.3/_images/settings-api-cors.png diff --git a/1.9.2/_images/settings-global-api-key.png b/1.9.3/_images/settings-global-api-key.png similarity index 100% rename from 1.9.2/_images/settings-global-api-key.png rename to 1.9.3/_images/settings-global-api-key.png diff --git a/1.9.2/_images/settings-user-api-key.png b/1.9.3/_images/settings-user-api-key.png similarity index 100% rename from 1.9.2/_images/settings-user-api-key.png rename to 1.9.3/_images/settings-user-api-key.png diff --git a/1.9.2/_images/template-plugin-types-main.png b/1.9.3/_images/template-plugin-types-main.png similarity index 100% rename from 1.9.2/_images/template-plugin-types-main.png rename to 1.9.3/_images/template-plugin-types-main.png diff --git a/1.9.2/_images/template-plugin-types-settings.png b/1.9.3/_images/template-plugin-types-settings.png similarity index 100% rename from 1.9.2/_images/template-plugin-types-settings.png rename to 1.9.3/_images/template-plugin-types-settings.png diff --git a/1.9.2/_sources/api/access.rst.txt b/1.9.3/_sources/api/access.rst.txt similarity index 100% rename from 1.9.2/_sources/api/access.rst.txt rename to 1.9.3/_sources/api/access.rst.txt diff --git a/1.9.2/_sources/api/connection.rst.txt b/1.9.3/_sources/api/connection.rst.txt similarity index 100% rename from 1.9.2/_sources/api/connection.rst.txt rename to 1.9.3/_sources/api/connection.rst.txt diff --git a/1.9.2/_sources/api/datamodel.rst.txt b/1.9.3/_sources/api/datamodel.rst.txt similarity index 100% rename from 1.9.2/_sources/api/datamodel.rst.txt rename to 1.9.3/_sources/api/datamodel.rst.txt diff --git a/1.9.2/_sources/api/files.rst.txt b/1.9.3/_sources/api/files.rst.txt similarity index 100% rename from 1.9.2/_sources/api/files.rst.txt rename to 1.9.3/_sources/api/files.rst.txt diff --git a/1.9.2/_sources/api/general.rst.txt b/1.9.3/_sources/api/general.rst.txt similarity index 100% rename from 1.9.2/_sources/api/general.rst.txt rename to 1.9.3/_sources/api/general.rst.txt diff --git a/1.9.2/_sources/api/index.rst.txt b/1.9.3/_sources/api/index.rst.txt similarity index 100% rename from 1.9.2/_sources/api/index.rst.txt rename to 1.9.3/_sources/api/index.rst.txt diff --git a/1.9.2/_sources/api/job.rst.txt b/1.9.3/_sources/api/job.rst.txt similarity index 100% rename from 1.9.2/_sources/api/job.rst.txt rename to 1.9.3/_sources/api/job.rst.txt diff --git a/1.9.2/_sources/api/languages.rst.txt b/1.9.3/_sources/api/languages.rst.txt similarity index 100% rename from 1.9.2/_sources/api/languages.rst.txt rename to 1.9.3/_sources/api/languages.rst.txt diff --git a/1.9.2/_sources/api/logs.rst.txt b/1.9.3/_sources/api/logs.rst.txt similarity index 100% rename from 1.9.2/_sources/api/logs.rst.txt rename to 1.9.3/_sources/api/logs.rst.txt diff --git a/1.9.2/_sources/api/printer.rst.txt b/1.9.3/_sources/api/printer.rst.txt similarity index 100% rename from 1.9.2/_sources/api/printer.rst.txt rename to 1.9.3/_sources/api/printer.rst.txt diff --git a/1.9.2/_sources/api/printerprofiles.rst.txt b/1.9.3/_sources/api/printerprofiles.rst.txt similarity index 100% rename from 1.9.2/_sources/api/printerprofiles.rst.txt rename to 1.9.3/_sources/api/printerprofiles.rst.txt diff --git a/1.9.2/_sources/api/push.rst.txt b/1.9.3/_sources/api/push.rst.txt similarity index 100% rename from 1.9.2/_sources/api/push.rst.txt rename to 1.9.3/_sources/api/push.rst.txt diff --git a/1.9.2/_sources/api/server.rst.txt b/1.9.3/_sources/api/server.rst.txt similarity index 100% rename from 1.9.2/_sources/api/server.rst.txt rename to 1.9.3/_sources/api/server.rst.txt diff --git a/1.9.2/_sources/api/settings.rst.txt b/1.9.3/_sources/api/settings.rst.txt similarity index 100% rename from 1.9.2/_sources/api/settings.rst.txt rename to 1.9.3/_sources/api/settings.rst.txt diff --git a/1.9.2/_sources/api/slicing.rst.txt b/1.9.3/_sources/api/slicing.rst.txt similarity index 100% rename from 1.9.2/_sources/api/slicing.rst.txt rename to 1.9.3/_sources/api/slicing.rst.txt diff --git a/1.9.2/_sources/api/system.rst.txt b/1.9.3/_sources/api/system.rst.txt similarity index 100% rename from 1.9.2/_sources/api/system.rst.txt rename to 1.9.3/_sources/api/system.rst.txt diff --git a/1.9.2/_sources/api/timelapse.rst.txt b/1.9.3/_sources/api/timelapse.rst.txt similarity index 100% rename from 1.9.2/_sources/api/timelapse.rst.txt rename to 1.9.3/_sources/api/timelapse.rst.txt diff --git a/1.9.2/_sources/api/util.rst.txt b/1.9.3/_sources/api/util.rst.txt similarity index 100% rename from 1.9.2/_sources/api/util.rst.txt rename to 1.9.3/_sources/api/util.rst.txt diff --git a/1.9.2/_sources/api/version.rst.txt b/1.9.3/_sources/api/version.rst.txt similarity index 100% rename from 1.9.2/_sources/api/version.rst.txt rename to 1.9.3/_sources/api/version.rst.txt diff --git a/1.9.2/_sources/api/wizard.rst.txt b/1.9.3/_sources/api/wizard.rst.txt similarity index 100% rename from 1.9.2/_sources/api/wizard.rst.txt rename to 1.9.3/_sources/api/wizard.rst.txt diff --git a/1.9.2/_sources/bundledplugins/action_command_notification.rst.txt b/1.9.3/_sources/bundledplugins/action_command_notification.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/action_command_notification.rst.txt rename to 1.9.3/_sources/bundledplugins/action_command_notification.rst.txt diff --git a/1.9.2/_sources/bundledplugins/action_command_prompt.rst.txt b/1.9.3/_sources/bundledplugins/action_command_prompt.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/action_command_prompt.rst.txt rename to 1.9.3/_sources/bundledplugins/action_command_prompt.rst.txt diff --git a/1.9.2/_sources/bundledplugins/announcements.rst.txt b/1.9.3/_sources/bundledplugins/announcements.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/announcements.rst.txt rename to 1.9.3/_sources/bundledplugins/announcements.rst.txt diff --git a/1.9.2/_sources/bundledplugins/appkeys.rst.txt b/1.9.3/_sources/bundledplugins/appkeys.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/appkeys.rst.txt rename to 1.9.3/_sources/bundledplugins/appkeys.rst.txt diff --git a/1.9.2/_sources/bundledplugins/backup.rst.txt b/1.9.3/_sources/bundledplugins/backup.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/backup.rst.txt rename to 1.9.3/_sources/bundledplugins/backup.rst.txt diff --git a/1.9.2/_sources/bundledplugins/discovery.rst.txt b/1.9.3/_sources/bundledplugins/discovery.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/discovery.rst.txt rename to 1.9.3/_sources/bundledplugins/discovery.rst.txt diff --git a/1.9.2/_sources/bundledplugins/errortracking.rst.txt b/1.9.3/_sources/bundledplugins/errortracking.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/errortracking.rst.txt rename to 1.9.3/_sources/bundledplugins/errortracking.rst.txt diff --git a/1.9.2/_sources/bundledplugins/file_check.rst.txt b/1.9.3/_sources/bundledplugins/file_check.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/file_check.rst.txt rename to 1.9.3/_sources/bundledplugins/file_check.rst.txt diff --git a/1.9.2/_sources/bundledplugins/firmware_check.rst.txt b/1.9.3/_sources/bundledplugins/firmware_check.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/firmware_check.rst.txt rename to 1.9.3/_sources/bundledplugins/firmware_check.rst.txt diff --git a/1.9.2/_sources/bundledplugins/gcodeviewer.rst.txt b/1.9.3/_sources/bundledplugins/gcodeviewer.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/gcodeviewer.rst.txt rename to 1.9.3/_sources/bundledplugins/gcodeviewer.rst.txt diff --git a/1.9.2/_sources/bundledplugins/index.rst.txt b/1.9.3/_sources/bundledplugins/index.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/index.rst.txt rename to 1.9.3/_sources/bundledplugins/index.rst.txt diff --git a/1.9.2/_sources/bundledplugins/logging.rst.txt b/1.9.3/_sources/bundledplugins/logging.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/logging.rst.txt rename to 1.9.3/_sources/bundledplugins/logging.rst.txt diff --git a/1.9.2/_sources/bundledplugins/pluginmanager.rst.txt b/1.9.3/_sources/bundledplugins/pluginmanager.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/pluginmanager.rst.txt rename to 1.9.3/_sources/bundledplugins/pluginmanager.rst.txt diff --git a/1.9.2/_sources/bundledplugins/softwareupdate.rst.txt b/1.9.3/_sources/bundledplugins/softwareupdate.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/softwareupdate.rst.txt rename to 1.9.3/_sources/bundledplugins/softwareupdate.rst.txt diff --git a/1.9.2/_sources/bundledplugins/tracking.rst.txt b/1.9.3/_sources/bundledplugins/tracking.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/tracking.rst.txt rename to 1.9.3/_sources/bundledplugins/tracking.rst.txt diff --git a/1.9.2/_sources/bundledplugins/virtual_printer.rst.txt b/1.9.3/_sources/bundledplugins/virtual_printer.rst.txt similarity index 100% rename from 1.9.2/_sources/bundledplugins/virtual_printer.rst.txt rename to 1.9.3/_sources/bundledplugins/virtual_printer.rst.txt diff --git a/1.9.2/_sources/configuration/cli.rst.txt b/1.9.3/_sources/configuration/cli.rst.txt similarity index 100% rename from 1.9.2/_sources/configuration/cli.rst.txt rename to 1.9.3/_sources/configuration/cli.rst.txt diff --git a/1.9.2/_sources/configuration/config_yaml.rst.txt b/1.9.3/_sources/configuration/config_yaml.rst.txt similarity index 100% rename from 1.9.2/_sources/configuration/config_yaml.rst.txt rename to 1.9.3/_sources/configuration/config_yaml.rst.txt diff --git a/1.9.2/_sources/configuration/index.rst.txt b/1.9.3/_sources/configuration/index.rst.txt similarity index 100% rename from 1.9.2/_sources/configuration/index.rst.txt rename to 1.9.3/_sources/configuration/index.rst.txt diff --git a/1.9.2/_sources/configuration/logging_yaml.rst.txt b/1.9.3/_sources/configuration/logging_yaml.rst.txt similarity index 100% rename from 1.9.2/_sources/configuration/logging_yaml.rst.txt rename to 1.9.3/_sources/configuration/logging_yaml.rst.txt diff --git a/1.9.2/_sources/configuration/yaml.rst.txt b/1.9.3/_sources/configuration/yaml.rst.txt similarity index 100% rename from 1.9.2/_sources/configuration/yaml.rst.txt rename to 1.9.3/_sources/configuration/yaml.rst.txt diff --git a/1.9.2/_sources/development/branches.rst.txt b/1.9.3/_sources/development/branches.rst.txt similarity index 100% rename from 1.9.2/_sources/development/branches.rst.txt rename to 1.9.3/_sources/development/branches.rst.txt diff --git a/1.9.2/_sources/development/environment.rst.txt b/1.9.3/_sources/development/environment.rst.txt similarity index 100% rename from 1.9.2/_sources/development/environment.rst.txt rename to 1.9.3/_sources/development/environment.rst.txt diff --git a/1.9.2/_sources/development/index.rst.txt b/1.9.3/_sources/development/index.rst.txt similarity index 100% rename from 1.9.2/_sources/development/index.rst.txt rename to 1.9.3/_sources/development/index.rst.txt diff --git a/1.9.2/_sources/development/request-profiling.rst.txt b/1.9.3/_sources/development/request-profiling.rst.txt similarity index 100% rename from 1.9.2/_sources/development/request-profiling.rst.txt rename to 1.9.3/_sources/development/request-profiling.rst.txt diff --git a/1.9.2/_sources/development/versioning.rst.txt b/1.9.3/_sources/development/versioning.rst.txt similarity index 100% rename from 1.9.2/_sources/development/versioning.rst.txt rename to 1.9.3/_sources/development/versioning.rst.txt diff --git a/1.9.2/_sources/development/virtual_printer.rst.txt b/1.9.3/_sources/development/virtual_printer.rst.txt similarity index 100% rename from 1.9.2/_sources/development/virtual_printer.rst.txt rename to 1.9.3/_sources/development/virtual_printer.rst.txt diff --git a/1.9.2/_sources/events/index.rst.txt b/1.9.3/_sources/events/index.rst.txt similarity index 100% rename from 1.9.2/_sources/events/index.rst.txt rename to 1.9.3/_sources/events/index.rst.txt diff --git a/1.9.2/_sources/features/accesscontrol.rst.txt b/1.9.3/_sources/features/accesscontrol.rst.txt similarity index 100% rename from 1.9.2/_sources/features/accesscontrol.rst.txt rename to 1.9.3/_sources/features/accesscontrol.rst.txt diff --git a/1.9.2/_sources/features/action_commands.rst.txt b/1.9.3/_sources/features/action_commands.rst.txt similarity index 100% rename from 1.9.2/_sources/features/action_commands.rst.txt rename to 1.9.3/_sources/features/action_commands.rst.txt diff --git a/1.9.2/_sources/features/atcommands.rst.txt b/1.9.3/_sources/features/atcommands.rst.txt similarity index 100% rename from 1.9.2/_sources/features/atcommands.rst.txt rename to 1.9.3/_sources/features/atcommands.rst.txt diff --git a/1.9.2/_sources/features/custom_controls.rst.txt b/1.9.3/_sources/features/custom_controls.rst.txt similarity index 100% rename from 1.9.2/_sources/features/custom_controls.rst.txt rename to 1.9.3/_sources/features/custom_controls.rst.txt diff --git a/1.9.2/_sources/features/gcode_scripts.rst.txt b/1.9.3/_sources/features/gcode_scripts.rst.txt similarity index 100% rename from 1.9.2/_sources/features/gcode_scripts.rst.txt rename to 1.9.3/_sources/features/gcode_scripts.rst.txt diff --git a/1.9.2/_sources/features/index.rst.txt b/1.9.3/_sources/features/index.rst.txt similarity index 100% rename from 1.9.2/_sources/features/index.rst.txt rename to 1.9.3/_sources/features/index.rst.txt diff --git a/1.9.2/_sources/features/plugins.rst.txt b/1.9.3/_sources/features/plugins.rst.txt similarity index 100% rename from 1.9.2/_sources/features/plugins.rst.txt rename to 1.9.3/_sources/features/plugins.rst.txt diff --git a/1.9.2/_sources/features/safemode.rst.txt b/1.9.3/_sources/features/safemode.rst.txt similarity index 100% rename from 1.9.2/_sources/features/safemode.rst.txt rename to 1.9.3/_sources/features/safemode.rst.txt diff --git a/1.9.2/_sources/index.rst.txt b/1.9.3/_sources/index.rst.txt similarity index 100% rename from 1.9.2/_sources/index.rst.txt rename to 1.9.3/_sources/index.rst.txt diff --git a/1.9.2/_sources/jsclientlib/base.rst.txt b/1.9.3/_sources/jsclientlib/base.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/base.rst.txt rename to 1.9.3/_sources/jsclientlib/base.rst.txt diff --git a/1.9.2/_sources/jsclientlib/browser.rst.txt b/1.9.3/_sources/jsclientlib/browser.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/browser.rst.txt rename to 1.9.3/_sources/jsclientlib/browser.rst.txt diff --git a/1.9.2/_sources/jsclientlib/connection.rst.txt b/1.9.3/_sources/jsclientlib/connection.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/connection.rst.txt rename to 1.9.3/_sources/jsclientlib/connection.rst.txt diff --git a/1.9.2/_sources/jsclientlib/control.rst.txt b/1.9.3/_sources/jsclientlib/control.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/control.rst.txt rename to 1.9.3/_sources/jsclientlib/control.rst.txt diff --git a/1.9.2/_sources/jsclientlib/files.rst.txt b/1.9.3/_sources/jsclientlib/files.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/files.rst.txt rename to 1.9.3/_sources/jsclientlib/files.rst.txt diff --git a/1.9.2/_sources/jsclientlib/index.rst.txt b/1.9.3/_sources/jsclientlib/index.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/index.rst.txt rename to 1.9.3/_sources/jsclientlib/index.rst.txt diff --git a/1.9.2/_sources/jsclientlib/job.rst.txt b/1.9.3/_sources/jsclientlib/job.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/job.rst.txt rename to 1.9.3/_sources/jsclientlib/job.rst.txt diff --git a/1.9.2/_sources/jsclientlib/languages.rst.txt b/1.9.3/_sources/jsclientlib/languages.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/languages.rst.txt rename to 1.9.3/_sources/jsclientlib/languages.rst.txt diff --git a/1.9.2/_sources/jsclientlib/logs.rst.txt b/1.9.3/_sources/jsclientlib/logs.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/logs.rst.txt rename to 1.9.3/_sources/jsclientlib/logs.rst.txt diff --git a/1.9.2/_sources/jsclientlib/printer.rst.txt b/1.9.3/_sources/jsclientlib/printer.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/printer.rst.txt rename to 1.9.3/_sources/jsclientlib/printer.rst.txt diff --git a/1.9.2/_sources/jsclientlib/printerprofiles.rst.txt b/1.9.3/_sources/jsclientlib/printerprofiles.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/printerprofiles.rst.txt rename to 1.9.3/_sources/jsclientlib/printerprofiles.rst.txt diff --git a/1.9.2/_sources/jsclientlib/settings.rst.txt b/1.9.3/_sources/jsclientlib/settings.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/settings.rst.txt rename to 1.9.3/_sources/jsclientlib/settings.rst.txt diff --git a/1.9.2/_sources/jsclientlib/slicing.rst.txt b/1.9.3/_sources/jsclientlib/slicing.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/slicing.rst.txt rename to 1.9.3/_sources/jsclientlib/slicing.rst.txt diff --git a/1.9.2/_sources/jsclientlib/socket.rst.txt b/1.9.3/_sources/jsclientlib/socket.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/socket.rst.txt rename to 1.9.3/_sources/jsclientlib/socket.rst.txt diff --git a/1.9.2/_sources/jsclientlib/system.rst.txt b/1.9.3/_sources/jsclientlib/system.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/system.rst.txt rename to 1.9.3/_sources/jsclientlib/system.rst.txt diff --git a/1.9.2/_sources/jsclientlib/timelapse.rst.txt b/1.9.3/_sources/jsclientlib/timelapse.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/timelapse.rst.txt rename to 1.9.3/_sources/jsclientlib/timelapse.rst.txt diff --git a/1.9.2/_sources/jsclientlib/users.rst.txt b/1.9.3/_sources/jsclientlib/users.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/users.rst.txt rename to 1.9.3/_sources/jsclientlib/users.rst.txt diff --git a/1.9.2/_sources/jsclientlib/util.rst.txt b/1.9.3/_sources/jsclientlib/util.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/util.rst.txt rename to 1.9.3/_sources/jsclientlib/util.rst.txt diff --git a/1.9.2/_sources/jsclientlib/wizard.rst.txt b/1.9.3/_sources/jsclientlib/wizard.rst.txt similarity index 100% rename from 1.9.2/_sources/jsclientlib/wizard.rst.txt rename to 1.9.3/_sources/jsclientlib/wizard.rst.txt diff --git a/1.9.2/_sources/modules/access.rst.txt b/1.9.3/_sources/modules/access.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/access.rst.txt rename to 1.9.3/_sources/modules/access.rst.txt diff --git a/1.9.2/_sources/modules/cli.rst.txt b/1.9.3/_sources/modules/cli.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/cli.rst.txt rename to 1.9.3/_sources/modules/cli.rst.txt diff --git a/1.9.2/_sources/modules/filemanager.rst.txt b/1.9.3/_sources/modules/filemanager.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/filemanager.rst.txt rename to 1.9.3/_sources/modules/filemanager.rst.txt diff --git a/1.9.2/_sources/modules/index.rst.txt b/1.9.3/_sources/modules/index.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/index.rst.txt rename to 1.9.3/_sources/modules/index.rst.txt diff --git a/1.9.2/_sources/modules/plugin.rst.txt b/1.9.3/_sources/modules/plugin.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/plugin.rst.txt rename to 1.9.3/_sources/modules/plugin.rst.txt diff --git a/1.9.2/_sources/modules/printer.rst.txt b/1.9.3/_sources/modules/printer.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/printer.rst.txt rename to 1.9.3/_sources/modules/printer.rst.txt diff --git a/1.9.2/_sources/modules/schema.rst.txt b/1.9.3/_sources/modules/schema.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/schema.rst.txt rename to 1.9.3/_sources/modules/schema.rst.txt diff --git a/1.9.2/_sources/modules/server.rst.txt b/1.9.3/_sources/modules/server.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/server.rst.txt rename to 1.9.3/_sources/modules/server.rst.txt diff --git a/1.9.2/_sources/modules/settings.rst.txt b/1.9.3/_sources/modules/settings.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/settings.rst.txt rename to 1.9.3/_sources/modules/settings.rst.txt diff --git a/1.9.2/_sources/modules/slicing.rst.txt b/1.9.3/_sources/modules/slicing.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/slicing.rst.txt rename to 1.9.3/_sources/modules/slicing.rst.txt diff --git a/1.9.2/_sources/modules/util.rst.txt b/1.9.3/_sources/modules/util.rst.txt similarity index 100% rename from 1.9.2/_sources/modules/util.rst.txt rename to 1.9.3/_sources/modules/util.rst.txt diff --git a/1.9.2/_sources/plugins/concepts.rst.txt b/1.9.3/_sources/plugins/concepts.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/concepts.rst.txt rename to 1.9.3/_sources/plugins/concepts.rst.txt diff --git a/1.9.2/_sources/plugins/controlproperties.rst.txt b/1.9.3/_sources/plugins/controlproperties.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/controlproperties.rst.txt rename to 1.9.3/_sources/plugins/controlproperties.rst.txt diff --git a/1.9.2/_sources/plugins/distributing.rst.txt b/1.9.3/_sources/plugins/distributing.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/distributing.rst.txt rename to 1.9.3/_sources/plugins/distributing.rst.txt diff --git a/1.9.2/_sources/plugins/gettingstarted.rst.txt b/1.9.3/_sources/plugins/gettingstarted.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/gettingstarted.rst.txt rename to 1.9.3/_sources/plugins/gettingstarted.rst.txt diff --git a/1.9.2/_sources/plugins/helpers.rst.txt b/1.9.3/_sources/plugins/helpers.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/helpers.rst.txt rename to 1.9.3/_sources/plugins/helpers.rst.txt diff --git a/1.9.2/_sources/plugins/hooks.rst.txt b/1.9.3/_sources/plugins/hooks.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/hooks.rst.txt rename to 1.9.3/_sources/plugins/hooks.rst.txt diff --git a/1.9.2/_sources/plugins/index.rst.txt b/1.9.3/_sources/plugins/index.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/index.rst.txt rename to 1.9.3/_sources/plugins/index.rst.txt diff --git a/1.9.2/_sources/plugins/injectedproperties.rst.txt b/1.9.3/_sources/plugins/injectedproperties.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/injectedproperties.rst.txt rename to 1.9.3/_sources/plugins/injectedproperties.rst.txt diff --git a/1.9.2/_sources/plugins/mixins.rst.txt b/1.9.3/_sources/plugins/mixins.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/mixins.rst.txt rename to 1.9.3/_sources/plugins/mixins.rst.txt diff --git a/1.9.2/_sources/plugins/python3_migration.rst.txt b/1.9.3/_sources/plugins/python3_migration.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/python3_migration.rst.txt rename to 1.9.3/_sources/plugins/python3_migration.rst.txt diff --git a/1.9.2/_sources/plugins/viewmodels.rst.txt b/1.9.3/_sources/plugins/viewmodels.rst.txt similarity index 100% rename from 1.9.2/_sources/plugins/viewmodels.rst.txt rename to 1.9.3/_sources/plugins/viewmodels.rst.txt diff --git a/1.9.2/_static/basic.css b/1.9.3/_static/basic.css similarity index 100% rename from 1.9.2/_static/basic.css rename to 1.9.3/_static/basic.css diff --git a/1.9.2/_static/css/badge_only.css b/1.9.3/_static/css/badge_only.css similarity index 100% rename from 1.9.2/_static/css/badge_only.css rename to 1.9.3/_static/css/badge_only.css diff --git a/1.9.2/_static/css/fonts/Roboto-Slab-Bold.woff b/1.9.3/_static/css/fonts/Roboto-Slab-Bold.woff similarity index 100% rename from 1.9.2/_static/css/fonts/Roboto-Slab-Bold.woff rename to 1.9.3/_static/css/fonts/Roboto-Slab-Bold.woff diff --git a/1.9.2/_static/css/fonts/Roboto-Slab-Bold.woff2 b/1.9.3/_static/css/fonts/Roboto-Slab-Bold.woff2 similarity index 100% rename from 1.9.2/_static/css/fonts/Roboto-Slab-Bold.woff2 rename to 1.9.3/_static/css/fonts/Roboto-Slab-Bold.woff2 diff --git a/1.9.2/_static/css/fonts/Roboto-Slab-Regular.woff b/1.9.3/_static/css/fonts/Roboto-Slab-Regular.woff similarity index 100% rename from 1.9.2/_static/css/fonts/Roboto-Slab-Regular.woff rename to 1.9.3/_static/css/fonts/Roboto-Slab-Regular.woff diff --git a/1.9.2/_static/css/fonts/Roboto-Slab-Regular.woff2 b/1.9.3/_static/css/fonts/Roboto-Slab-Regular.woff2 similarity index 100% rename from 1.9.2/_static/css/fonts/Roboto-Slab-Regular.woff2 rename to 1.9.3/_static/css/fonts/Roboto-Slab-Regular.woff2 diff --git a/1.9.2/_static/css/fonts/fontawesome-webfont.eot b/1.9.3/_static/css/fonts/fontawesome-webfont.eot similarity index 100% rename from 1.9.2/_static/css/fonts/fontawesome-webfont.eot rename to 1.9.3/_static/css/fonts/fontawesome-webfont.eot diff --git a/1.9.2/_static/css/fonts/fontawesome-webfont.svg b/1.9.3/_static/css/fonts/fontawesome-webfont.svg similarity index 100% rename from 1.9.2/_static/css/fonts/fontawesome-webfont.svg rename to 1.9.3/_static/css/fonts/fontawesome-webfont.svg diff --git a/1.9.2/_static/css/fonts/fontawesome-webfont.ttf b/1.9.3/_static/css/fonts/fontawesome-webfont.ttf similarity index 100% rename from 1.9.2/_static/css/fonts/fontawesome-webfont.ttf rename to 1.9.3/_static/css/fonts/fontawesome-webfont.ttf diff --git a/1.9.2/_static/css/fonts/fontawesome-webfont.woff b/1.9.3/_static/css/fonts/fontawesome-webfont.woff similarity index 100% rename from 1.9.2/_static/css/fonts/fontawesome-webfont.woff rename to 1.9.3/_static/css/fonts/fontawesome-webfont.woff diff --git a/1.9.2/_static/css/fonts/fontawesome-webfont.woff2 b/1.9.3/_static/css/fonts/fontawesome-webfont.woff2 similarity index 100% rename from 1.9.2/_static/css/fonts/fontawesome-webfont.woff2 rename to 1.9.3/_static/css/fonts/fontawesome-webfont.woff2 diff --git a/1.9.2/_static/css/fonts/lato-bold-italic.woff b/1.9.3/_static/css/fonts/lato-bold-italic.woff similarity index 100% rename from 1.9.2/_static/css/fonts/lato-bold-italic.woff rename to 1.9.3/_static/css/fonts/lato-bold-italic.woff diff --git a/1.9.2/_static/css/fonts/lato-bold-italic.woff2 b/1.9.3/_static/css/fonts/lato-bold-italic.woff2 similarity index 100% rename from 1.9.2/_static/css/fonts/lato-bold-italic.woff2 rename to 1.9.3/_static/css/fonts/lato-bold-italic.woff2 diff --git a/1.9.2/_static/css/fonts/lato-bold.woff b/1.9.3/_static/css/fonts/lato-bold.woff similarity index 100% rename from 1.9.2/_static/css/fonts/lato-bold.woff rename to 1.9.3/_static/css/fonts/lato-bold.woff diff --git a/1.9.2/_static/css/fonts/lato-bold.woff2 b/1.9.3/_static/css/fonts/lato-bold.woff2 similarity index 100% rename from 1.9.2/_static/css/fonts/lato-bold.woff2 rename to 1.9.3/_static/css/fonts/lato-bold.woff2 diff --git a/1.9.2/_static/css/fonts/lato-normal-italic.woff b/1.9.3/_static/css/fonts/lato-normal-italic.woff similarity index 100% rename from 1.9.2/_static/css/fonts/lato-normal-italic.woff rename to 1.9.3/_static/css/fonts/lato-normal-italic.woff diff --git a/1.9.2/_static/css/fonts/lato-normal-italic.woff2 b/1.9.3/_static/css/fonts/lato-normal-italic.woff2 similarity index 100% rename from 1.9.2/_static/css/fonts/lato-normal-italic.woff2 rename to 1.9.3/_static/css/fonts/lato-normal-italic.woff2 diff --git a/1.9.2/_static/css/fonts/lato-normal.woff b/1.9.3/_static/css/fonts/lato-normal.woff similarity index 100% rename from 1.9.2/_static/css/fonts/lato-normal.woff rename to 1.9.3/_static/css/fonts/lato-normal.woff diff --git a/1.9.2/_static/css/fonts/lato-normal.woff2 b/1.9.3/_static/css/fonts/lato-normal.woff2 similarity index 100% rename from 1.9.2/_static/css/fonts/lato-normal.woff2 rename to 1.9.3/_static/css/fonts/lato-normal.woff2 diff --git a/1.9.2/_static/css/theme.css b/1.9.3/_static/css/theme.css similarity index 100% rename from 1.9.2/_static/css/theme.css rename to 1.9.3/_static/css/theme.css diff --git a/1.9.2/_static/doctools.js b/1.9.3/_static/doctools.js similarity index 100% rename from 1.9.2/_static/doctools.js rename to 1.9.3/_static/doctools.js diff --git a/1.9.2/_static/documentation_options.js b/1.9.3/_static/documentation_options.js similarity index 94% rename from 1.9.2/_static/documentation_options.js rename to 1.9.3/_static/documentation_options.js index 21f87fa6e..d2015dea8 100644 --- a/1.9.2/_static/documentation_options.js +++ b/1.9.3/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '1.9.2', + VERSION: '1.9.3', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/1.9.2/_static/file.png b/1.9.3/_static/file.png similarity index 100% rename from 1.9.2/_static/file.png rename to 1.9.3/_static/file.png diff --git a/1.9.2/_static/jquery-3.5.1.js b/1.9.3/_static/jquery-3.5.1.js similarity index 100% rename from 1.9.2/_static/jquery-3.5.1.js rename to 1.9.3/_static/jquery-3.5.1.js diff --git a/1.9.2/_static/jquery.js b/1.9.3/_static/jquery.js similarity index 100% rename from 1.9.2/_static/jquery.js rename to 1.9.3/_static/jquery.js diff --git a/1.9.2/_static/js/badge_only.js b/1.9.3/_static/js/badge_only.js similarity index 100% rename from 1.9.2/_static/js/badge_only.js rename to 1.9.3/_static/js/badge_only.js diff --git a/1.9.2/_static/js/html5shiv-printshiv.min.js b/1.9.3/_static/js/html5shiv-printshiv.min.js similarity index 100% rename from 1.9.2/_static/js/html5shiv-printshiv.min.js rename to 1.9.3/_static/js/html5shiv-printshiv.min.js diff --git a/1.9.2/_static/js/html5shiv.min.js b/1.9.3/_static/js/html5shiv.min.js similarity index 100% rename from 1.9.2/_static/js/html5shiv.min.js rename to 1.9.3/_static/js/html5shiv.min.js diff --git a/1.9.2/_static/js/theme.js b/1.9.3/_static/js/theme.js similarity index 100% rename from 1.9.2/_static/js/theme.js rename to 1.9.3/_static/js/theme.js diff --git a/1.9.2/_static/language_data.js b/1.9.3/_static/language_data.js similarity index 100% rename from 1.9.2/_static/language_data.js rename to 1.9.3/_static/language_data.js diff --git a/1.9.2/_static/mermaid.min.js b/1.9.3/_static/mermaid.min.js similarity index 100% rename from 1.9.2/_static/mermaid.min.js rename to 1.9.3/_static/mermaid.min.js diff --git a/1.9.2/_static/minus.png b/1.9.3/_static/minus.png similarity index 100% rename from 1.9.2/_static/minus.png rename to 1.9.3/_static/minus.png diff --git a/1.9.2/_static/plus.png b/1.9.3/_static/plus.png similarity index 100% rename from 1.9.2/_static/plus.png rename to 1.9.3/_static/plus.png diff --git a/1.9.2/_static/pygments.css b/1.9.3/_static/pygments.css similarity index 100% rename from 1.9.2/_static/pygments.css rename to 1.9.3/_static/pygments.css diff --git a/1.9.2/_static/searchtools.js b/1.9.3/_static/searchtools.js similarity index 100% rename from 1.9.2/_static/searchtools.js rename to 1.9.3/_static/searchtools.js diff --git a/1.9.2/_static/theme_overrides.css b/1.9.3/_static/theme_overrides.css similarity index 100% rename from 1.9.2/_static/theme_overrides.css rename to 1.9.3/_static/theme_overrides.css diff --git a/1.9.2/_static/underscore-1.13.1.js b/1.9.3/_static/underscore-1.13.1.js similarity index 100% rename from 1.9.2/_static/underscore-1.13.1.js rename to 1.9.3/_static/underscore-1.13.1.js diff --git a/1.9.2/_static/underscore.js b/1.9.3/_static/underscore.js similarity index 100% rename from 1.9.2/_static/underscore.js rename to 1.9.3/_static/underscore.js diff --git a/1.9.2/api/access.html b/1.9.3/api/access.html similarity index 99% rename from 1.9.2/api/access.html rename to 1.9.3/api/access.html index a982cfe4f..6f96dc8e5 100644 --- a/1.9.2/api/access.html +++ b/1.9.3/api/access.html @@ -4,7 +4,7 @@ - Access control — OctoPrint 1.9.2 documentation + Access control — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -934,13 +934,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/connection.html b/1.9.3/api/connection.html similarity index 99% rename from 1.9.2/api/connection.html rename to 1.9.3/api/connection.html index aab9b5ba1..ff0565998 100644 --- a/1.9.2/api/connection.html +++ b/1.9.3/api/connection.html @@ -4,7 +4,7 @@ - Connection handling — OctoPrint 1.9.2 documentation + Connection handling — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -335,13 +335,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/datamodel.html b/1.9.3/api/datamodel.html similarity index 99% rename from 1.9.2/api/datamodel.html rename to 1.9.3/api/datamodel.html index 0f24bcc1f..cda521217 100644 --- a/1.9.2/api/datamodel.html +++ b/1.9.3/api/datamodel.html @@ -4,7 +4,7 @@ - Common data model — OctoPrint 1.9.2 documentation + Common data model — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -1248,13 +1248,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/files.html b/1.9.3/api/files.html similarity index 99% rename from 1.9.2/api/files.html rename to 1.9.3/api/files.html index 4f37bd3e4..1672ffc7a 100644 --- a/1.9.2/api/files.html +++ b/1.9.3/api/files.html @@ -4,7 +4,7 @@ - File operations — OctoPrint 1.9.2 documentation + File operations — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -1118,13 +1118,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/general.html b/1.9.3/api/general.html similarity index 99% rename from 1.9.2/api/general.html rename to 1.9.3/api/general.html index 4b3e667b4..675205a86 100644 --- a/1.9.2/api/general.html +++ b/1.9.3/api/general.html @@ -4,7 +4,7 @@ - General information — OctoPrint 1.9.2 documentation + General information — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -490,13 +490,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/index.html b/1.9.3/api/index.html similarity index 99% rename from 1.9.2/api/index.html rename to 1.9.3/api/index.html index ac5eba525..e325ac1a6 100644 --- a/1.9.2/api/index.html +++ b/1.9.3/api/index.html @@ -4,7 +4,7 @@ - REST API — OctoPrint 1.9.2 documentation + REST API — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -302,13 +302,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/job.html b/1.9.3/api/job.html similarity index 99% rename from 1.9.2/api/job.html rename to 1.9.3/api/job.html index b22f4f840..b1c919d18 100644 --- a/1.9.2/api/job.html +++ b/1.9.3/api/job.html @@ -4,7 +4,7 @@ - Job operations — OctoPrint 1.9.2 documentation + Job operations — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -437,13 +437,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/languages.html b/1.9.3/api/languages.html similarity index 99% rename from 1.9.2/api/languages.html rename to 1.9.3/api/languages.html index a02dca960..a1dde4da8 100644 --- a/1.9.2/api/languages.html +++ b/1.9.3/api/languages.html @@ -4,7 +4,7 @@ - Languages — OctoPrint 1.9.2 documentation + Languages — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -453,13 +453,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/logs.html b/1.9.3/api/logs.html similarity index 97% rename from 1.9.2/api/logs.html rename to 1.9.3/api/logs.html index 36b72a8ac..ee35ebc82 100644 --- a/1.9.2/api/logs.html +++ b/1.9.3/api/logs.html @@ -4,7 +4,7 @@ - Log file management — OctoPrint 1.9.2 documentation + Log file management — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -173,13 +173,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/printer.html b/1.9.3/api/printer.html similarity index 99% rename from 1.9.2/api/printer.html rename to 1.9.3/api/printer.html index c671d8f09..f383d23a6 100644 --- a/1.9.2/api/printer.html +++ b/1.9.3/api/printer.html @@ -4,7 +4,7 @@ - Printer operations — OctoPrint 1.9.2 documentation + Printer operations — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -1480,13 +1480,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/printerprofiles.html b/1.9.3/api/printerprofiles.html similarity index 99% rename from 1.9.2/api/printerprofiles.html rename to 1.9.3/api/printerprofiles.html index 0a6fa27ec..bb5077ccd 100644 --- a/1.9.2/api/printerprofiles.html +++ b/1.9.3/api/printerprofiles.html @@ -4,7 +4,7 @@ - Printer profile operations — OctoPrint 1.9.2 documentation + Printer profile operations — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -862,13 +862,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/push.html b/1.9.3/api/push.html similarity index 99% rename from 1.9.2/api/push.html rename to 1.9.3/api/push.html index 63f1e0ae7..52694be00 100644 --- a/1.9.2/api/push.html +++ b/1.9.3/api/push.html @@ -4,7 +4,7 @@ - Push updates — OctoPrint 1.9.2 documentation + Push updates — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -548,13 +548,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/server.html b/1.9.3/api/server.html similarity index 98% rename from 1.9.2/api/server.html rename to 1.9.3/api/server.html index ac5a8659a..5e0513202 100644 --- a/1.9.2/api/server.html +++ b/1.9.3/api/server.html @@ -4,7 +4,7 @@ - Server information — OctoPrint 1.9.2 documentation + Server information — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -203,13 +203,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/settings.html b/1.9.3/api/settings.html similarity index 99% rename from 1.9.2/api/settings.html rename to 1.9.3/api/settings.html index 8a62f7468..eec85548e 100644 --- a/1.9.2/api/settings.html +++ b/1.9.3/api/settings.html @@ -4,7 +4,7 @@ - Settings — OctoPrint 1.9.2 documentation + Settings — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -621,13 +621,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/slicing.html b/1.9.3/api/slicing.html similarity index 99% rename from 1.9.2/api/slicing.html rename to 1.9.3/api/slicing.html index 39bf4e4b5..15cbe72f4 100644 --- a/1.9.2/api/slicing.html +++ b/1.9.3/api/slicing.html @@ -4,7 +4,7 @@ - Slicing — OctoPrint 1.9.2 documentation + Slicing — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -675,13 +675,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/system.html b/1.9.3/api/system.html similarity index 99% rename from 1.9.2/api/system.html rename to 1.9.3/api/system.html index 4299ec43e..fe165509e 100644 --- a/1.9.2/api/system.html +++ b/1.9.3/api/system.html @@ -4,7 +4,7 @@ - System — OctoPrint 1.9.2 documentation + System — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -481,13 +481,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/timelapse.html b/1.9.3/api/timelapse.html similarity index 99% rename from 1.9.2/api/timelapse.html rename to 1.9.3/api/timelapse.html index 0f7c72431..61db3b615 100644 --- a/1.9.2/api/timelapse.html +++ b/1.9.3/api/timelapse.html @@ -4,7 +4,7 @@ - Timelapse — OctoPrint 1.9.2 documentation + Timelapse — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -556,13 +556,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/util.html b/1.9.3/api/util.html similarity index 99% rename from 1.9.2/api/util.html rename to 1.9.3/api/util.html index 3f35f7771..19817141e 100644 --- a/1.9.2/api/util.html +++ b/1.9.3/api/util.html @@ -4,7 +4,7 @@ - Util — OctoPrint 1.9.2 documentation + Util — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -755,13 +755,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/version.html b/1.9.3/api/version.html similarity index 98% rename from 1.9.2/api/version.html rename to 1.9.3/api/version.html index 33c2e4788..e473526c1 100644 --- a/1.9.2/api/version.html +++ b/1.9.3/api/version.html @@ -4,7 +4,7 @@ - Version information — OctoPrint 1.9.2 documentation + Version information — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -200,13 +200,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/api/wizard.html b/1.9.3/api/wizard.html similarity index 98% rename from 1.9.2/api/wizard.html rename to 1.9.3/api/wizard.html index 09a280f73..4d87f6c44 100644 --- a/1.9.2/api/wizard.html +++ b/1.9.3/api/wizard.html @@ -4,7 +4,7 @@ - Wizard — OctoPrint 1.9.2 documentation + Wizard — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -270,13 +270,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/action_command_notification.html b/1.9.3/bundledplugins/action_command_notification.html similarity index 98% rename from 1.9.2/bundledplugins/action_command_notification.html rename to 1.9.3/bundledplugins/action_command_notification.html index fa6a15ba5..4e0e42b81 100644 --- a/1.9.2/bundledplugins/action_command_notification.html +++ b/1.9.3/bundledplugins/action_command_notification.html @@ -4,7 +4,7 @@ - Action Command Notification support — OctoPrint 1.9.2 documentation + Action Command Notification support — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -214,13 +214,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/action_command_prompt.html b/1.9.3/bundledplugins/action_command_prompt.html similarity index 98% rename from 1.9.2/bundledplugins/action_command_prompt.html rename to 1.9.3/bundledplugins/action_command_prompt.html index a94efbea0..d126026b5 100644 --- a/1.9.2/bundledplugins/action_command_prompt.html +++ b/1.9.3/bundledplugins/action_command_prompt.html @@ -4,7 +4,7 @@ - Action Command Prompt support — OctoPrint 1.9.2 documentation + Action Command Prompt support — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -250,13 +250,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/announcements.html b/1.9.3/bundledplugins/announcements.html similarity index 98% rename from 1.9.2/bundledplugins/announcements.html rename to 1.9.3/bundledplugins/announcements.html index 50d37cb1a..c0d366036 100644 --- a/1.9.2/bundledplugins/announcements.html +++ b/1.9.3/bundledplugins/announcements.html @@ -4,7 +4,7 @@ - Announcement Plugin — OctoPrint 1.9.2 documentation + Announcement Plugin — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -225,13 +225,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/appkeys.html b/1.9.3/bundledplugins/appkeys.html similarity index 99% rename from 1.9.2/bundledplugins/appkeys.html rename to 1.9.3/bundledplugins/appkeys.html index bf2981a6b..21ac05282 100644 --- a/1.9.2/bundledplugins/appkeys.html +++ b/1.9.3/bundledplugins/appkeys.html @@ -4,7 +4,7 @@ - Application Keys Plugin — OctoPrint 1.9.2 documentation + Application Keys Plugin — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -987,13 +987,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/backup.html b/1.9.3/bundledplugins/backup.html similarity index 98% rename from 1.9.2/bundledplugins/backup.html rename to 1.9.3/bundledplugins/backup.html index 594630902..18468225b 100644 --- a/1.9.2/bundledplugins/backup.html +++ b/1.9.3/bundledplugins/backup.html @@ -4,7 +4,7 @@ - Backup Plugin — OctoPrint 1.9.2 documentation + Backup Plugin — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -307,7 +307,7 @@

    A list of paths to exclude, relative to your plugin’s data folder

    Return type
    -

    list

    +

    list

    @@ -403,8 +403,8 @@
    Parameters
      -

    • exclude (list) – Names of data folders to exclude, defaults to None

      • -

    • filename (str) – Name of backup to be created, if None (default) the backup +

    • exclude (list) – Names of data folders to exclude, defaults to None

      • +

    • filename (str) – Name of backup to be created, if None (default) the backup name will be auto-generated. This should use a .zip extension.

    @@ -442,7 +442,7 @@
    Parameters
    -

    filename (str) – The name of the backup to delete

    +

    filename (str) – The name of the backup to delete

    @@ -499,13 +499,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/discovery.html b/1.9.3/bundledplugins/discovery.html similarity index 99% rename from 1.9.2/bundledplugins/discovery.html rename to 1.9.3/bundledplugins/discovery.html index 6f5da2f80..6299f5c1b 100644 --- a/1.9.2/bundledplugins/discovery.html +++ b/1.9.3/bundledplugins/discovery.html @@ -4,7 +4,7 @@ - Discovery Plugin — OctoPrint 1.9.2 documentation + Discovery Plugin — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -313,13 +313,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/errortracking.html b/1.9.3/bundledplugins/errortracking.html similarity index 98% rename from 1.9.2/bundledplugins/errortracking.html rename to 1.9.3/bundledplugins/errortracking.html index 0476baea3..3dfe76446 100644 --- a/1.9.2/bundledplugins/errortracking.html +++ b/1.9.3/bundledplugins/errortracking.html @@ -4,7 +4,7 @@ - Error Tracking Plugin — OctoPrint 1.9.2 documentation + Error Tracking Plugin — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -199,13 +199,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/file_check.html b/1.9.3/bundledplugins/file_check.html similarity index 97% rename from 1.9.2/bundledplugins/file_check.html rename to 1.9.3/bundledplugins/file_check.html index a5db592ab..8d93cdfde 100644 --- a/1.9.2/bundledplugins/file_check.html +++ b/1.9.3/bundledplugins/file_check.html @@ -4,7 +4,7 @@ - File Check — OctoPrint 1.9.2 documentation + File Check — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -169,13 +169,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/firmware_check.html b/1.9.3/bundledplugins/firmware_check.html similarity index 97% rename from 1.9.2/bundledplugins/firmware_check.html rename to 1.9.3/bundledplugins/firmware_check.html index faaf69dcd..855b02ff8 100644 --- a/1.9.2/bundledplugins/firmware_check.html +++ b/1.9.3/bundledplugins/firmware_check.html @@ -4,7 +4,7 @@ - Firmware Check — OctoPrint 1.9.2 documentation + Firmware Check — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -170,13 +170,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/gcodeviewer.html b/1.9.3/bundledplugins/gcodeviewer.html similarity index 98% rename from 1.9.2/bundledplugins/gcodeviewer.html rename to 1.9.3/bundledplugins/gcodeviewer.html index 5119f6fa6..0dde8353c 100644 --- a/1.9.2/bundledplugins/gcodeviewer.html +++ b/1.9.3/bundledplugins/gcodeviewer.html @@ -4,7 +4,7 @@ - GCode Viewer Plugin — OctoPrint 1.9.2 documentation + GCode Viewer Plugin — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -197,13 +197,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/index.html b/1.9.3/bundledplugins/index.html similarity index 98% rename from 1.9.2/bundledplugins/index.html rename to 1.9.3/bundledplugins/index.html index 81fc795cd..d50a227ea 100644 --- a/1.9.2/bundledplugins/index.html +++ b/1.9.3/bundledplugins/index.html @@ -4,7 +4,7 @@ - Bundled Plugins — OctoPrint 1.9.2 documentation + Bundled Plugins — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -255,13 +255,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/logging.html b/1.9.3/bundledplugins/logging.html similarity index 99% rename from 1.9.2/bundledplugins/logging.html rename to 1.9.3/bundledplugins/logging.html index 6489eed9f..07886a8a9 100644 --- a/1.9.2/bundledplugins/logging.html +++ b/1.9.3/bundledplugins/logging.html @@ -4,7 +4,7 @@ - Logging — OctoPrint 1.9.2 documentation + Logging — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -456,13 +456,13 @@

    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/pluginmanager.html b/1.9.3/bundledplugins/pluginmanager.html similarity index 99% rename from 1.9.2/bundledplugins/pluginmanager.html rename to 1.9.3/bundledplugins/pluginmanager.html index e75c9074e..8ffd551d2 100644 --- a/1.9.2/bundledplugins/pluginmanager.html +++ b/1.9.3/bundledplugins/pluginmanager.html @@ -4,7 +4,7 @@ - Plugin Manager — OctoPrint 1.9.2 documentation + Plugin Manager — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -336,13 +336,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/softwareupdate.html b/1.9.3/bundledplugins/softwareupdate.html similarity index 99% rename from 1.9.2/bundledplugins/softwareupdate.html rename to 1.9.3/bundledplugins/softwareupdate.html index 1410f0f4d..3a1c66568 100644 --- a/1.9.2/bundledplugins/softwareupdate.html +++ b/1.9.3/bundledplugins/softwareupdate.html @@ -4,7 +4,7 @@ - Software Update Plugin — OctoPrint 1.9.2 documentation + Software Update Plugin — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -794,7 +794,7 @@

    A dictionary of check configurations as described above

    Return type
    -

    dict

    +

    dict

    @@ -857,13 +857,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/tracking.html b/1.9.3/bundledplugins/tracking.html similarity index 98% rename from 1.9.2/bundledplugins/tracking.html rename to 1.9.3/bundledplugins/tracking.html index f02cf06de..e380a8d28 100644 --- a/1.9.2/bundledplugins/tracking.html +++ b/1.9.3/bundledplugins/tracking.html @@ -4,7 +4,7 @@ - Anonymous Usage Tracking Plugin — OctoPrint 1.9.2 documentation + Anonymous Usage Tracking Plugin — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -207,13 +207,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/bundledplugins/virtual_printer.html b/1.9.3/bundledplugins/virtual_printer.html similarity index 97% rename from 1.9.2/bundledplugins/virtual_printer.html rename to 1.9.3/bundledplugins/virtual_printer.html index c890f3928..82c2c5092 100644 --- a/1.9.2/bundledplugins/virtual_printer.html +++ b/1.9.3/bundledplugins/virtual_printer.html @@ -4,7 +4,7 @@ - Virtual Printer — OctoPrint 1.9.2 documentation + Virtual Printer — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -185,13 +185,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/configuration/cli.html b/1.9.3/configuration/cli.html similarity index 98% rename from 1.9.2/configuration/cli.html rename to 1.9.3/configuration/cli.html index 7030d1772..8c973bd56 100644 --- a/1.9.2/configuration/cli.html +++ b/1.9.3/configuration/cli.html @@ -4,7 +4,7 @@ - CLI — OctoPrint 1.9.2 documentation + CLI — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -251,13 +251,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/configuration/config_yaml.html b/1.9.3/configuration/config_yaml.html similarity index 99% rename from 1.9.2/configuration/config_yaml.html rename to 1.9.3/configuration/config_yaml.html index 74ee0484d..44c729308 100644 --- a/1.9.2/configuration/config_yaml.html +++ b/1.9.3/configuration/config_yaml.html @@ -4,7 +4,7 @@ - config.yaml — OctoPrint 1.9.2 documentation + config.yaml — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -1342,13 +1342,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/configuration/index.html b/1.9.3/configuration/index.html similarity index 98% rename from 1.9.2/configuration/index.html rename to 1.9.3/configuration/index.html index e7ae15e1c..7bdd0c7d5 100644 --- a/1.9.2/configuration/index.html +++ b/1.9.3/configuration/index.html @@ -4,7 +4,7 @@ - Configuration — OctoPrint 1.9.2 documentation + Configuration — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -192,13 +192,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/configuration/logging_yaml.html b/1.9.3/configuration/logging_yaml.html similarity index 98% rename from 1.9.2/configuration/logging_yaml.html rename to 1.9.3/configuration/logging_yaml.html index 6ee15e8ba..bd7072109 100644 --- a/1.9.2/configuration/logging_yaml.html +++ b/1.9.3/configuration/logging_yaml.html @@ -4,7 +4,7 @@ - logging.yaml — OctoPrint 1.9.2 documentation + logging.yaml — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -200,7 +200,7 @@

    Changing logging handlerslogging.handlers.

    +logging.handlers.

    Changing logging formatters

    @@ -212,7 +212,7 @@

    Changing logging formattersPython documentation on LogRecord attributes.

    +Python documentation on LogRecord attributes.

    @@ -244,13 +244,13 @@

    Changing logging formatters Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/configuration/yaml.html b/1.9.3/configuration/yaml.html similarity index 99% rename from 1.9.2/configuration/yaml.html rename to 1.9.3/configuration/yaml.html index 11db19604..f21f077cf 100644 --- a/1.9.2/configuration/yaml.html +++ b/1.9.3/configuration/yaml.html @@ -4,7 +4,7 @@ - A YAML Primer — OctoPrint 1.9.2 documentation + A YAML Primer — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -338,13 +338,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/development/branches.html b/1.9.3/development/branches.html similarity index 98% rename from 1.9.2/development/branches.html rename to 1.9.3/development/branches.html index 287111334..d4356b0e0 100644 --- a/1.9.2/development/branches.html +++ b/1.9.3/development/branches.html @@ -4,7 +4,7 @@ - OctoPrint’s branching model — OctoPrint 1.9.2 documentation + OctoPrint’s branching model — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -223,13 +223,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/development/environment.html b/1.9.3/development/environment.html similarity index 99% rename from 1.9.2/development/environment.html rename to 1.9.3/development/environment.html index 16b50dea8..a764314d6 100644 --- a/1.9.2/development/environment.html +++ b/1.9.3/development/environment.html @@ -4,7 +4,7 @@ - Setting up a Development environment — OctoPrint 1.9.2 documentation + Setting up a Development environment — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -586,13 +586,13 @@

    Visual Studio Code (vscode) Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/development/index.html b/1.9.3/development/index.html similarity index 97% rename from 1.9.2/development/index.html rename to 1.9.3/development/index.html index 8c5d31c68..a9631262b 100644 --- a/1.9.2/development/index.html +++ b/1.9.3/development/index.html @@ -4,7 +4,7 @@ - Development — OctoPrint 1.9.2 documentation + Development — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -185,13 +185,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/development/request-profiling.html b/1.9.3/development/request-profiling.html similarity index 97% rename from 1.9.2/development/request-profiling.html rename to 1.9.3/development/request-profiling.html index cfe691dc9..900c10083 100644 --- a/1.9.2/development/request-profiling.html +++ b/1.9.3/development/request-profiling.html @@ -4,7 +4,7 @@ - Profiling requests — OctoPrint 1.9.2 documentation + Profiling requests — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -170,13 +170,13 @@

    Errors Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/development/versioning.html b/1.9.3/development/versioning.html similarity index 98% rename from 1.9.2/development/versioning.html rename to 1.9.3/development/versioning.html index 7e2509ddd..fa9a0bdfb 100644 --- a/1.9.2/development/versioning.html +++ b/1.9.3/development/versioning.html @@ -4,7 +4,7 @@ - OctoPrint’s versioning strategy — OctoPrint 1.9.2 documentation + OctoPrint’s versioning strategy — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -178,13 +178,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/development/virtual_printer.html b/1.9.3/development/virtual_printer.html similarity index 99% rename from 1.9.2/development/virtual_printer.html rename to 1.9.3/development/virtual_printer.html index c1671131b..f6c38f4a0 100644 --- a/1.9.2/development/virtual_printer.html +++ b/1.9.3/development/virtual_printer.html @@ -4,7 +4,7 @@ - Setting up the virtual printer for debugging — OctoPrint 1.9.2 documentation + Setting up the virtual printer for debugging — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -459,13 +459,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/events/index.html b/1.9.3/events/index.html similarity index 99% rename from 1.9.2/events/index.html rename to 1.9.3/events/index.html index 76ae642a1..5047f4193 100644 --- a/1.9.2/events/index.html +++ b/1.9.3/events/index.html @@ -4,7 +4,7 @@ - Events — OctoPrint 1.9.2 documentation + Events — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -1203,13 +1203,13 @@

    Example Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/features/accesscontrol.html b/1.9.3/features/accesscontrol.html similarity index 99% rename from 1.9.2/features/accesscontrol.html rename to 1.9.3/features/accesscontrol.html index 9128e89d3..724449cb1 100644 --- a/1.9.2/features/accesscontrol.html +++ b/1.9.3/features/accesscontrol.html @@ -4,7 +4,7 @@ - Access Control — OctoPrint 1.9.2 documentation + Access Control — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -383,13 +383,13 @@

    If you are using a VPN and your setup ABSOLUTELY REQUIRES disabling internal
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/features/action_commands.html b/1.9.3/features/action_commands.html similarity index 98% rename from 1.9.2/features/action_commands.html rename to 1.9.3/features/action_commands.html index ab703ae00..2c3cfeaaf 100644 --- a/1.9.2/features/action_commands.html +++ b/1.9.3/features/action_commands.html @@ -4,7 +4,7 @@ - Action Commands — OctoPrint 1.9.2 documentation + Action Commands — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -232,13 +232,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/features/atcommands.html b/1.9.3/features/atcommands.html similarity index 97% rename from 1.9.2/features/atcommands.html rename to 1.9.3/features/atcommands.html index f42493101..924a59e08 100644 --- a/1.9.2/features/atcommands.html +++ b/1.9.3/features/atcommands.html @@ -4,7 +4,7 @@ - @ Commands — OctoPrint 1.9.2 documentation + @ Commands — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -179,13 +179,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/features/custom_controls.html b/1.9.3/features/custom_controls.html similarity index 99% rename from 1.9.2/features/custom_controls.html rename to 1.9.3/features/custom_controls.html index fc6357877..1a4ac1599 100644 --- a/1.9.2/features/custom_controls.html +++ b/1.9.3/features/custom_controls.html @@ -4,7 +4,7 @@ - Custom Controls — OctoPrint 1.9.2 documentation + Custom Controls — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -372,7 +372,7 @@

    -

    (Optional) Step size per slider “tick”, defaults to 1.

    regex

    (Optional) A regular expression to +

    (Optional) A regular expression to match against lines received from the printer to retrieve information from it (e.g. specific output). Together with template this allows rendition of received data from the printer within the UI.

    Please also read the note below.

    @@ -380,7 +380,7 @@

    template

    (Optional) A template to use for rendering the match of regex. May contain placeholders in -Python Format String Syntax for either named +Python Format String Syntax for either named groups within the regex (e.g. Temperature: {temperature} for a regex T:\s*(?P<temperature>\d+(\.\d*)) or positional groups within the regex (e.g. Position: X={0}, Y={1}, Z={2}, E={3} for a regex X:([0-9.]+) Y:([0-9.]+) Z:([0-9.]+) E:([0-9.]+)).

    @@ -501,13 +501,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/features/gcode_scripts.html b/1.9.3/features/gcode_scripts.html similarity index 99% rename from 1.9.2/features/gcode_scripts.html rename to 1.9.3/features/gcode_scripts.html index db2fe9dd6..3add92b18 100644 --- a/1.9.2/features/gcode_scripts.html +++ b/1.9.3/features/gcode_scripts.html @@ -4,7 +4,7 @@ - GCODE Scripts — OctoPrint 1.9.2 documentation + GCODE Scripts — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -445,13 +445,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/features/index.html b/1.9.3/features/index.html similarity index 98% rename from 1.9.2/features/index.html rename to 1.9.3/features/index.html index aa3e4ff31..b200e4302 100644 --- a/1.9.2/features/index.html +++ b/1.9.3/features/index.html @@ -4,7 +4,7 @@ - Features — OctoPrint 1.9.2 documentation + Features — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -194,13 +194,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/features/plugins.html b/1.9.3/features/plugins.html similarity index 98% rename from 1.9.2/features/plugins.html rename to 1.9.3/features/plugins.html index 11a15104f..bf9d1e422 100644 --- a/1.9.2/features/plugins.html +++ b/1.9.3/features/plugins.html @@ -4,7 +4,7 @@ - Plugins — OctoPrint 1.9.2 documentation + Plugins — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -226,13 +226,13 @@

    Manual Installation Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/features/safemode.html b/1.9.3/features/safemode.html similarity index 98% rename from 1.9.2/features/safemode.html rename to 1.9.3/features/safemode.html index 6354e7fef..24414f340 100644 --- a/1.9.2/features/safemode.html +++ b/1.9.3/features/safemode.html @@ -4,7 +4,7 @@ - Safe mode — OctoPrint 1.9.2 documentation + Safe mode — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -251,13 +251,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/genindex.html b/1.9.3/genindex.html similarity index 99% rename from 1.9.2/genindex.html rename to 1.9.3/genindex.html index 814c7ca1e..d89a891db 100644 --- a/1.9.2/genindex.html +++ b/1.9.3/genindex.html @@ -3,7 +3,7 @@ - Index — OctoPrint 1.9.2 documentation + Index — OctoPrint 1.9.3 documentation @@ -34,7 +34,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -3847,13 +3847,13 @@

    Z

    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/http-routingtable.html b/1.9.3/http-routingtable.html similarity index 99% rename from 1.9.2/http-routingtable.html rename to 1.9.3/http-routingtable.html index 5397d42ad..6446edd1f 100644 --- a/1.9.2/http-routingtable.html +++ b/1.9.3/http-routingtable.html @@ -3,7 +3,7 @@ - HTTP Routing Table — OctoPrint 1.9.2 documentation + HTTP Routing Table — OctoPrint 1.9.3 documentation @@ -41,7 +41,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -559,13 +559,13 @@

    HTTP Routing Table

    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/index.html b/1.9.3/index.html similarity index 99% rename from 1.9.2/index.html rename to 1.9.3/index.html index 8bcd187fc..2a8e2fbb6 100644 --- a/1.9.2/index.html +++ b/1.9.3/index.html @@ -4,7 +4,7 @@ - Welcome to OctoPrint’s documentation! — OctoPrint 1.9.2 documentation + Welcome to OctoPrint’s documentation! — OctoPrint 1.9.3 documentation @@ -36,7 +36,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -301,13 +301,13 @@

    Contents Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/base.html b/1.9.3/jsclientlib/base.html similarity index 99% rename from 1.9.2/jsclientlib/base.html rename to 1.9.3/jsclientlib/base.html index e13757640..601366ebf 100644 --- a/1.9.2/jsclientlib/base.html +++ b/1.9.3/jsclientlib/base.html @@ -4,7 +4,7 @@ - OctoPrintClient — OctoPrint 1.9.2 documentation + OctoPrintClient — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -769,13 +769,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/browser.html b/1.9.3/jsclientlib/browser.html similarity index 98% rename from 1.9.2/jsclientlib/browser.html rename to 1.9.3/jsclientlib/browser.html index 089df037d..d529e0bea 100644 --- a/1.9.2/jsclientlib/browser.html +++ b/1.9.3/jsclientlib/browser.html @@ -4,7 +4,7 @@ - OctoPrintClient.browser — OctoPrint 1.9.2 documentation + OctoPrintClient.browser — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -245,13 +245,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/connection.html b/1.9.3/jsclientlib/connection.html similarity index 98% rename from 1.9.2/jsclientlib/connection.html rename to 1.9.3/jsclientlib/connection.html index f8a4cf6ce..a42c53328 100644 --- a/1.9.2/jsclientlib/connection.html +++ b/1.9.3/jsclientlib/connection.html @@ -4,7 +4,7 @@ - OctoPrintClient.connection — OctoPrint 1.9.2 documentation + OctoPrintClient.connection — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -246,13 +246,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/control.html b/1.9.3/jsclientlib/control.html similarity index 99% rename from 1.9.2/jsclientlib/control.html rename to 1.9.3/jsclientlib/control.html index 7d5d3cf84..54e40531f 100644 --- a/1.9.2/jsclientlib/control.html +++ b/1.9.3/jsclientlib/control.html @@ -4,7 +4,7 @@ - OctoPrintClient.control — OctoPrint 1.9.2 documentation + OctoPrintClient.control — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -262,13 +262,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/files.html b/1.9.3/jsclientlib/files.html similarity index 99% rename from 1.9.2/jsclientlib/files.html rename to 1.9.3/jsclientlib/files.html index 6b742974d..e44233296 100644 --- a/1.9.2/jsclientlib/files.html +++ b/1.9.3/jsclientlib/files.html @@ -4,7 +4,7 @@ - OctoPrintClient.files — OctoPrint 1.9.2 documentation + OctoPrintClient.files — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -520,13 +520,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/index.html b/1.9.3/jsclientlib/index.html similarity index 99% rename from 1.9.2/jsclientlib/index.html rename to 1.9.3/jsclientlib/index.html index a2567fc9d..bc869c3e8 100644 --- a/1.9.2/jsclientlib/index.html +++ b/1.9.3/jsclientlib/index.html @@ -4,7 +4,7 @@ - JavaScript Client Library — OctoPrint 1.9.2 documentation + JavaScript Client Library — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -267,13 +267,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/job.html b/1.9.3/jsclientlib/job.html similarity index 99% rename from 1.9.2/jsclientlib/job.html rename to 1.9.3/jsclientlib/job.html index 5dd383c3b..89decbf34 100644 --- a/1.9.2/jsclientlib/job.html +++ b/1.9.3/jsclientlib/job.html @@ -4,7 +4,7 @@ - OctoPrintClient.job — OctoPrint 1.9.2 documentation + OctoPrintClient.job — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -298,13 +298,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/languages.html b/1.9.3/jsclientlib/languages.html similarity index 98% rename from 1.9.2/jsclientlib/languages.html rename to 1.9.3/jsclientlib/languages.html index c8fea1823..00e0249cd 100644 --- a/1.9.2/jsclientlib/languages.html +++ b/1.9.3/jsclientlib/languages.html @@ -4,7 +4,7 @@ - OctoPrintClient.languages — OctoPrint 1.9.2 documentation + OctoPrintClient.languages — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -229,13 +229,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/logs.html b/1.9.3/jsclientlib/logs.html similarity index 98% rename from 1.9.2/jsclientlib/logs.html rename to 1.9.3/jsclientlib/logs.html index 13404ef92..89c79ac53 100644 --- a/1.9.2/jsclientlib/logs.html +++ b/1.9.3/jsclientlib/logs.html @@ -4,7 +4,7 @@ - OctoPrintClient.logs — OctoPrint 1.9.2 documentation + OctoPrintClient.logs — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -172,13 +172,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/printer.html b/1.9.3/jsclientlib/printer.html similarity index 99% rename from 1.9.2/jsclientlib/printer.html rename to 1.9.3/jsclientlib/printer.html index a44438aef..9a321e6bf 100644 --- a/1.9.2/jsclientlib/printer.html +++ b/1.9.3/jsclientlib/printer.html @@ -4,7 +4,7 @@ - OctoPrintClient.printer — OctoPrint 1.9.2 documentation + OctoPrintClient.printer — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -659,13 +659,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/printerprofiles.html b/1.9.3/jsclientlib/printerprofiles.html similarity index 98% rename from 1.9.2/jsclientlib/printerprofiles.html rename to 1.9.3/jsclientlib/printerprofiles.html index d42309747..8751a3751 100644 --- a/1.9.2/jsclientlib/printerprofiles.html +++ b/1.9.3/jsclientlib/printerprofiles.html @@ -4,7 +4,7 @@ - OctoPrintClient.printerprofiles — OctoPrint 1.9.2 documentation + OctoPrintClient.printerprofiles — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -259,13 +259,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/settings.html b/1.9.3/jsclientlib/settings.html similarity index 98% rename from 1.9.2/jsclientlib/settings.html rename to 1.9.3/jsclientlib/settings.html index 22c9d578d..81a933aa9 100644 --- a/1.9.2/jsclientlib/settings.html +++ b/1.9.3/jsclientlib/settings.html @@ -4,7 +4,7 @@ - OctoPrintClient.settings — OctoPrint 1.9.2 documentation + OctoPrintClient.settings — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -258,13 +258,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/slicing.html b/1.9.3/jsclientlib/slicing.html similarity index 99% rename from 1.9.2/jsclientlib/slicing.html rename to 1.9.3/jsclientlib/slicing.html index 3c5809481..d86d42232 100644 --- a/1.9.2/jsclientlib/slicing.html +++ b/1.9.3/jsclientlib/slicing.html @@ -4,7 +4,7 @@ - OctoPrintClient.slicing — OctoPrint 1.9.2 documentation + OctoPrintClient.slicing — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -279,13 +279,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/socket.html b/1.9.3/jsclientlib/socket.html similarity index 99% rename from 1.9.2/jsclientlib/socket.html rename to 1.9.3/jsclientlib/socket.html index 0659de9ff..4acd85fdb 100644 --- a/1.9.2/jsclientlib/socket.html +++ b/1.9.3/jsclientlib/socket.html @@ -4,7 +4,7 @@ - OctoPrintClient.socket — OctoPrint 1.9.2 documentation + OctoPrintClient.socket — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -377,13 +377,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/system.html b/1.9.3/jsclientlib/system.html similarity index 98% rename from 1.9.2/jsclientlib/system.html rename to 1.9.3/jsclientlib/system.html index 6aaceef79..35549b50b 100644 --- a/1.9.2/jsclientlib/system.html +++ b/1.9.3/jsclientlib/system.html @@ -4,7 +4,7 @@ - OctoPrintClient.system — OctoPrint 1.9.2 documentation + OctoPrintClient.system — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -230,13 +230,13 @@

    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/timelapse.html b/1.9.3/jsclientlib/timelapse.html similarity index 99% rename from 1.9.2/jsclientlib/timelapse.html rename to 1.9.3/jsclientlib/timelapse.html index 9e3e35006..0f1bdbac4 100644 --- a/1.9.2/jsclientlib/timelapse.html +++ b/1.9.3/jsclientlib/timelapse.html @@ -4,7 +4,7 @@ - OctoPrintClient.timelapse — OctoPrint 1.9.2 documentation + OctoPrintClient.timelapse — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -344,13 +344,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/users.html b/1.9.3/jsclientlib/users.html similarity index 99% rename from 1.9.2/jsclientlib/users.html rename to 1.9.3/jsclientlib/users.html index 65c41089b..22560f8ca 100644 --- a/1.9.2/jsclientlib/users.html +++ b/1.9.3/jsclientlib/users.html @@ -4,7 +4,7 @@ - OctoPrintClient.users — OctoPrint 1.9.2 documentation + OctoPrintClient.users — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -357,13 +357,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/util.html b/1.9.3/jsclientlib/util.html similarity index 99% rename from 1.9.2/jsclientlib/util.html rename to 1.9.3/jsclientlib/util.html index 73baf4ee2..8437fea88 100644 --- a/1.9.2/jsclientlib/util.html +++ b/1.9.3/jsclientlib/util.html @@ -4,7 +4,7 @@ - OctoPrintClient.util — OctoPrint 1.9.2 documentation + OctoPrintClient.util — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -421,13 +421,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/jsclientlib/wizard.html b/1.9.3/jsclientlib/wizard.html similarity index 98% rename from 1.9.2/jsclientlib/wizard.html rename to 1.9.3/jsclientlib/wizard.html index d88bad661..945b01aaf 100644 --- a/1.9.2/jsclientlib/wizard.html +++ b/1.9.3/jsclientlib/wizard.html @@ -4,7 +4,7 @@ - OctoPrintClient.wizard — OctoPrint 1.9.2 documentation + OctoPrintClient.wizard — OctoPrint 1.9.3 documentation @@ -36,7 +36,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -210,13 +210,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/modules/access.html b/1.9.3/modules/access.html similarity index 98% rename from 1.9.2/modules/access.html rename to 1.9.3/modules/access.html index 11a44976a..dc96936ce 100644 --- a/1.9.2/modules/access.html +++ b/1.9.3/modules/access.html @@ -4,7 +4,7 @@ - octoprint.access.users — OctoPrint 1.9.2 documentation + octoprint.access.users — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -226,13 +226,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/modules/cli.html b/1.9.3/modules/cli.html similarity index 94% rename from 1.9.2/modules/cli.html rename to 1.9.3/modules/cli.html index 030821b90..78c2a42f2 100644 --- a/1.9.2/modules/cli.html +++ b/1.9.3/modules/cli.html @@ -4,7 +4,7 @@ - octoprint.cli — OctoPrint 1.9.2 documentation + octoprint.cli — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -150,7 +150,7 @@

    octoprint.cli

    -class octoprint.cli.HiddenOption(param_decls: Optional[Sequence[str]] = None, show_default: Optional[Union[bool, str]] = None, prompt: Union[bool, str] = False, confirmation_prompt: Union[bool, str] = False, prompt_required: bool = True, hide_input: bool = False, is_flag: Optional[bool] = None, flag_value: Optional[Any] = None, multiple: bool = False, count: bool = False, allow_from_autoenv: bool = True, type: Optional[Union[click.types.ParamType, Any]] = None, help: Optional[str] = None, hidden: bool = False, show_choices: bool = True, show_envvar: bool = False, **attrs: Any)
    +class octoprint.cli.HiddenOption(param_decls: Optional[Sequence[str]] = None, show_default: Optional[Union[bool, str]] = None, prompt: Union[bool, str] = False, confirmation_prompt: Union[bool, str] = False, prompt_required: bool = True, hide_input: bool = False, is_flag: Optional[bool] = None, flag_value: Optional[Any] = None, multiple: bool = False, count: bool = False, allow_from_autoenv: bool = True, type: Optional[Union[click.types.ParamType, Any]] = None, help: Optional[str] = None, hidden: bool = False, show_choices: bool = True, show_envvar: bool = False, **attrs: Any)

    Custom option sub class with empty help.

    @@ -340,13 +340,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/modules/filemanager.html b/1.9.3/modules/filemanager.html similarity index 98% rename from 1.9.2/modules/filemanager.html rename to 1.9.3/modules/filemanager.html index 42faea65b..03b7e5294 100644 --- a/1.9.2/modules/filemanager.html +++ b/1.9.3/modules/filemanager.html @@ -4,7 +4,7 @@ - octoprint.filemanager — OctoPrint 1.9.2 documentation + octoprint.filemanager — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -210,7 +210,7 @@ overridden by sub classes.

    Parameters
    -

    high_priority (bool) – Whether the current entry has high priority or not.

    +

    high_priority (bool) – Whether the current entry has high priority or not.

    Returns

    @@ -220,7 +220,7 @@

    Return type
    -

    object

    +

    object

    @@ -284,7 +284,7 @@
    class octoprint.filemanager.analysis.GcodeAnalysisQueue(finished_callback)
    -

    A queue to analyze GCODE files. Analysis results are dict instances structured as follows:

    +

    A queue to analyze GCODE files. Analysis results are dict instances structured as follows:

    @@ -385,14 +385,14 @@
    Parameters
      -

    • name (str) – Name of the file to analyze.

      • -

    • path (str) – Storage location specific path to the file to analyze.

      • -

    • type (str) – Type of file to analyze, necessary to map to the correct AbstractAnalysisQueue sub class. +

    • name (str) – Name of the file to analyze.

      • +

    • path (str) – Storage location specific path to the file to analyze.

      • +

    • type (str) – Type of file to analyze, necessary to map to the correct AbstractAnalysisQueue sub class. At the moment, only gcode is supported here.

      • -

    • location (str) – Location the file is located on.

      • -

    • absolute_path (str) – Absolute path on disk through which to access the file.

      • +

    • location (str) – Location the file is located on.

      • +

    • absolute_path (str) – Absolute path on disk through which to access the file.

    • printer_profile (PrinterProfile) – PrinterProfile which to use for analysis.

      • -

    • analysis (dict) – GcodeAnalysisQueue results from prior analysis, or None if there is none.

      • +

    • analysis (dict) – GcodeAnalysisQueue results from prior analysis, or None if there is none.

    @@ -419,13 +419,13 @@
    Parameters

    • path (string) – the file’s new path, will be sanitized

      • -

    • file_object (object) – a file object that provides a save method which will be called with the destination path +

    • file_object (object) – a file object that provides a save method which will be called with the destination path where the object should then store its contents

      • -

    • printer_profile (object) – the printer profile associated with this file (if any)

      • -

    • links (list) – any links to add with the file

      • -

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file +

    • printer_profile (object) – the printer profile associated with this file (if any)

      • +

    • links (list) – any links to add with the file

      • +

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file and its metadata will just be silently overwritten

      • -

    • display (str) – display name of the file

      • +

    • display (str) – display name of the file

    Returns
    @@ -443,8 +443,8 @@
    Parameters

    • path (string) – the path of the new folder

      • -

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • -

    • display (str) – display name of the folder

      • +

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • +

    • display (str) – display name of the folder

    Returns
    @@ -629,9 +629,9 @@
    Parameters
      -

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or +

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or set to None, defatuls to storage root.

      • -

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or +

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or the whole path’s subtree (True).

    @@ -701,7 +701,7 @@ from root of base folder

  • filter (function) – a filter that matches the files that are to be returned, may be left out in which case no filtering will take place

    • -

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only +

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only do one step down into sub folders to be able to populate the children.

    • @@ -765,7 +765,7 @@ path_on_disk(path)

    Retrieves the path on disk for path.

    Note: if the storage is not on disk and there exists no path on disk to refer to it, this method should -raise an io.UnsupportedOperation

    +raise an io.UnsupportedOperation

    Opposite of path_in_storage().

    Parameters
    @@ -812,7 +812,7 @@
    Parameters

    • path (string) – the path of the folder to remove

      • -

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will +

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will be raised if the folder is not empty (apart from any metadata files) when it’s to be removed

    @@ -856,7 +856,7 @@
    sanitize_name(name)
    -

    Raises a ValueError for a name containing / or \. Otherwise +

    Raises a ValueError for a name containing / or \. Otherwise sanitizes the given name using octoprint.files.sanitize_filename. Also strips any leading ..

    @@ -912,13 +912,13 @@
    Parameters

    • path (string) – the file’s new path, will be sanitized

      • -

    • file_object (object) – a file object that provides a save method which will be called with the destination path +

    • file_object (object) – a file object that provides a save method which will be called with the destination path where the object should then store its contents

      • -

    • printer_profile (object) – the printer profile associated with this file (if any)

      • -

    • links (list) – any links to add with the file

      • -

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file +

    • printer_profile (object) – the printer profile associated with this file (if any)

      • +

    • links (list) – any links to add with the file

      • +

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file and its metadata will just be silently overwritten

      • -

    • display (str) – display name of the file

      • +

    • display (str) – display name of the file

    Returns
    @@ -936,8 +936,8 @@
    Parameters

    • path (string) – the path of the new folder

      • -

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • -

    • display (str) – display name of the folder

      • +

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • +

    • display (str) – display name of the folder

    Returns
    @@ -1122,9 +1122,9 @@
    Parameters
      -

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or +

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or set to None, defatuls to storage root.

      • -

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or +

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or the whole path’s subtree (True).

    @@ -1194,7 +1194,7 @@ from root of base folder

  • filter (function) – a filter that matches the files that are to be returned, may be left out in which case no filtering will take place

    • -

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only +

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only do one step down into sub folders to be able to populate the children.

    • @@ -1258,7 +1258,7 @@ path_on_disk(path)

    Retrieves the path on disk for path.

    Note: if the storage is not on disk and there exists no path on disk to refer to it, this method should -raise an io.UnsupportedOperation

    +raise an io.UnsupportedOperation

    Opposite of path_in_storage().

    Parameters
    @@ -1305,7 +1305,7 @@
    Parameters

    • path (string) – the path of the folder to remove

      • -

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will +

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will be raised if the folder is not empty (apart from any metadata files) when it’s to be removed

    @@ -1398,7 +1398,7 @@

    Wrapper for file representations to save to storages.

    Parameters
    -

    filename (str) – The file’s name

    +

    filename (str) – The file’s name

    @@ -1408,8 +1408,8 @@
    Parameters
      -

    • path (str) – The absolute path to where to save the file

      • -

    • permissions (int) – The permissions to set on the file

      • +

    • path (str) – The absolute path to where to save the file

      • +

    • permissions (int) – The permissions to set on the file

    @@ -1424,7 +1424,7 @@

    The file’s contents as a stream.

    Return type
    -

    io.IOBase

    +

    io.IOBase

    @@ -1440,8 +1440,8 @@
    Parameters
      -

    • filename (str) – The file’s name

      • -

    • path (str) – The file’s absolute path

      • +

    • filename (str) – The file’s name

      • +

    • path (str) – The file’s absolute path

    • move (boolean) – Whether to move the file upon saving (True, default) or copying.

    @@ -1453,8 +1453,8 @@
    Parameters
      -

    • path (str) – The absolute path to where to save the file

      • -

    • permissions (int) – The permissions to set on the file

      • +

    • path (str) – The absolute path to where to save the file

      • +

    • permissions (int) – The permissions to set on the file

    @@ -1469,7 +1469,7 @@

    The file’s contents as a stream.

    Return type
    -

    io.IOBase

    +

    io.IOBase

    @@ -1486,7 +1486,7 @@ to do the decoding yourself.

    Parameters
    -

    input_stream (io.RawIOBase) – The stream to process on the fly.

    +

    input_stream (io.RawIOBase) – The stream to process on the fly.

    @@ -1504,7 +1504,7 @@ wrapper input_stream.

    Parameters
    -

    line (bytes) – The line as read from self.input_stream in byte representation

    +

    line (bytes) – The line as read from self.input_stream in byte representation

    Returns

    @@ -1514,7 +1514,7 @@

    Return type
    -

    bytes or None

    +

    bytes or None

    @@ -1550,7 +1550,7 @@ their contents in the order they are provided to the constructor.

    Parameters
    -

    *streams – One or more io.IOBase streams to concatenate.

    +

    *streams – One or more io.IOBase streams to concatenate.

    @@ -1590,7 +1590,7 @@

    A wrapper allowing processing of one or more consecutive streams.

    Parameters
    -

    *streams – One or more io.IOBase streams to process one after another to save to storage.

    +

    *streams – One or more io.IOBase streams to process one after another to save to storage.

    @@ -1639,13 +1639,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/modules/index.html b/1.9.3/modules/index.html similarity index 98% rename from 1.9.2/modules/index.html rename to 1.9.3/modules/index.html index f0f11d9b6..0a716f5f3 100644 --- a/1.9.2/modules/index.html +++ b/1.9.3/modules/index.html @@ -4,7 +4,7 @@ - Internal Modules — OctoPrint 1.9.2 documentation + Internal Modules — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -209,13 +209,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/modules/plugin.html b/1.9.3/modules/plugin.html similarity index 97% rename from 1.9.2/modules/plugin.html rename to 1.9.3/modules/plugin.html index 109f65ecf..1e21ce7fb 100644 --- a/1.9.2/modules/plugin.html +++ b/1.9.3/modules/plugin.html @@ -4,7 +4,7 @@ - octoprint.plugin — OctoPrint 1.9.2 documentation + octoprint.plugin — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -159,31 +159,31 @@
    Parameters

    • init (boolean) – A flag indicating whether this is the initial call to construct the singleton (True) or not -(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError +(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError will be raised. The same will happen if the plugin manager has not yet been initialized and this is set to False.

      • -

    • plugin_folders (list) – A list of folders (as strings containing the absolute path to them) in which to look for +

    • plugin_folders (list) – A list of folders (as strings containing the absolute path to them) in which to look for potential plugin modules. If not provided this defaults to the configured plugins base folder and src/plugins within OctoPrint’s code base.

      • -

    • plugin_bases (list) – A list of recognized plugin base classes for which to look for provided implementations. If not +

    • plugin_bases (list) – A list of recognized plugin base classes for which to look for provided implementations. If not provided this defaults to OctoPrintPlugin.

      • -

    • plugin_entry_points (list) – A list of entry points pointing to modules which to load as plugins. If not provided +

    • plugin_entry_points (list) – A list of entry points pointing to modules which to load as plugins. If not provided this defaults to the entry point octoprint.plugin.

      • -

    • plugin_disabled_list (list) – A list of plugin identifiers that are currently disabled. If not provided this +

    • plugin_disabled_list (list) – A list of plugin identifiers that are currently disabled. If not provided this defaults to all plugins for which enabled is set to False in the settings.

      • -

    • plugin_sorting_order (dict) – A dict containing a custom sorting orders for plugins. The keys are plugin identifiers, +

    • plugin_sorting_order (dict) – A dict containing a custom sorting orders for plugins. The keys are plugin identifiers, mapped to dictionaries containing the sorting contexts as key and the custom sorting value as value.

      • -

    • plugin_blacklist (list) – A list of plugin identifiers/identifier-requirement tuples +

    • plugin_blacklist (list) – A list of plugin identifiers/identifier-requirement tuples that are currently blacklisted.

      • -

    • plugin_restart_needing_hooks (list) – A list of hook namespaces which cause a plugin to need a restart in order +

    • plugin_restart_needing_hooks (list) – A list of hook namespaces which cause a plugin to need a restart in order be enabled/disabled. Does not have to contain full hook identifiers, will be matched with startswith similar to logging handlers

      • -

    • plugin_obsolete_hooks (list) – A list of hooks that have been declared obsolete. Plugins implementing them will +

    • plugin_obsolete_hooks (list) – A list of hooks that have been declared obsolete. Plugins implementing them will not be enabled since they might depend on functionality that is no longer available.

      • -

    • plugin_considered_bundled (list) – A list of plugin identifiers that are considered bundled plugins even if +

    • plugin_considered_bundled (list) – A list of plugin identifiers that are considered bundled plugins even if installed separately.

      • -

    • plugin_validators (list) – A list of additional plugin validators through which to process each plugin.

      • -

    • compatibility_ignored_list (list) – A list of plugin keys for which it will be ignored if they are flagged as +

    • plugin_validators (list) – A list of additional plugin validators through which to process each plugin.

      • +

    • compatibility_ignored_list (list) – A list of plugin keys for which it will be ignored if they are flagged as incompatible. This is for development purposes only and should not be used in production.

    @@ -198,7 +198,7 @@

    PluginManager

    Raises
    -

    ValueError – init was True although the plugin manager was already initialized, or it was False although +

    ValueError – init was True although the plugin manager was already initialized, or it was False although the plugin manager was not yet initialized.

    @@ -212,9 +212,9 @@
    Parameters

    • plugin_key (string) – The plugin identifier for which to create the settings instance.

      • -

    • defaults (dict) – The default settings for the plugin, if different from get_settings_defaults.

      • -

    • get_preprocessors (dict) – The getter preprocessors for the plugin.

      • -

    • set_preprocessors (dict) – The setter preprocessors for the plugin.

      • +

    • defaults (dict) – The default settings for the plugin, if different from get_settings_defaults.

      • +

    • get_preprocessors (dict) – The getter preprocessors for the plugin.

      • +

    • set_preprocessors (dict) – The setter preprocessors for the plugin.

    • settings (octoprint.settings.Settings) – The settings instance to use.

    @@ -256,10 +256,10 @@
    Parameters
      -

    • types (list) – A list of plugin implementation types to match against.

      • +

    • types (list) – A list of plugin implementation types to match against.

    • method (string) – Name of the method to call on all matching implementations.

      • -

    • args (tuple) – A tuple containing the arguments to supply to the called method. Optional.

      • -

    • kwargs (dict) – A dictionary containing the keyword arguments to supply to the called method. Optional.

      • +

    • args (tuple) – A tuple containing the arguments to supply to the called method. Optional.

      • +

    • kwargs (dict) – A dictionary containing the keyword arguments to supply to the called method. Optional.

    • callback (function) – A callback to invoke after an implementation has been called successfully. Will be called with the three arguments name, plugin and result. name will be the plugin identifier, plugin the plugin implementation instance itself and result the result returned from the @@ -286,8 +286,8 @@

      Parameters

      • settings (Settings) – The Settings instance on which to operate.

        • -

      • plugin_key (str) – The plugin identifier of the plugin for which to create this instance.

        • -

      • defaults (dict) – The plugin’s defaults settings, will be used to determine valid paths within the plugin’s +

      • plugin_key (str) – The plugin identifier of the plugin for which to create this instance.

        • +

      • defaults (dict) – The plugin’s defaults settings, will be used to determine valid paths within the plugin’s settings structure

      @@ -300,7 +300,7 @@
      Parameters
        -

      • path (list, tuple) – The path for which to retrieve the value.

        • +

      • path (list, tuple) – The path for which to retrieve the value.

      • merged (boolean) – Whether to merge the returned result with the default settings (True) or not (False, default).

      @@ -309,7 +309,7 @@

      The retrieved settings value.

      Return type
      -

      object

      +

      object

    @@ -343,8 +343,8 @@
    Parameters
      -

    • path (list, tuple) – The path for which to retrieve the value.

      • -

    • value (object) – The value to set.

      • +

    • path (list, tuple) – The path for which to retrieve the value.

      • +

    • value (object) – The value to set.

    • force (boolean) – If set to True, the modified configuration will even be written back to disk if the value didn’t change.

    @@ -399,13 +399,13 @@
    Parameters
      -

    • overlay (dict) – Overlay dict to add

      • +

    • overlay (dict) – Overlay dict to add

    • at_end (boolean) – Whether to add overlay at end or start (default) of config hierarchy

      • -

    • key (str) – Key to use to identify overlay. If not set one will be built based on the overlay’s hash

      • +

    • key (str) – Key to use to identify overlay. If not set one will be built based on the overlay’s hash

    Return type
    -

    str

    +

    str

    @@ -417,7 +417,7 @@ removed, False otherwise.

    Parameters
    -

    key (str) – The key of the overlay to remove

    +

    key (str) – The key of the overlay to remove

    Return type

    boolean

    @@ -443,7 +443,7 @@ want to create a log file for logging the output of the slicing engine itself if some debug flag is set.

    Parameters
    -

    postfix (str) – Postfix of the logfile for which to create the path. If set, the file name of the log file +

    postfix (str) – Postfix of the logfile for which to create the path. If set, the file name of the log file will be plugin_<plugin identifier>_<postfix>.log, if not it will be plugin_<plugin identifier>.log.

    @@ -451,7 +451,7 @@

    Absolute path to the log file, directly usable by the plugin.

    Return type
    -

    str

    +

    str

    @@ -554,7 +554,7 @@

    A list of all found and matching implementations.

    Return type
    -

    list

    +

    list

    @@ -563,12 +563,12 @@
    get_helpers(name, *helpers)

    Retrieves the named helpers for the plugin with identifier name.

    -

    If the plugin is not available, returns None. Otherwise returns a dict with the requested plugin +

    If the plugin is not available, returns None. Otherwise returns a dict with the requested plugin helper names mapped to the method - if a helper could not be resolved, it will be missing from the dict.

    Parameters
      -

    • name (str) – Identifier of the plugin for which to look up the helpers.

      • +

    • name (str) – Identifier of the plugin for which to look up the helpers.

    • helpers (one or more str) – Identifiers of the helpers of plugin name to return.

    @@ -580,7 +580,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -591,13 +591,13 @@

    Retrieves all registered handlers for the specified hook.

    Parameters
    -

    hook (str) – The hook for which to retrieve the handlers.

    +

    hook (str) – The hook for which to retrieve the handlers.

    Returns

    A dict containing all registered handlers mapped by their plugin’s identifier.

    Return type
    -

    dict

    +

    dict

    @@ -614,7 +614,7 @@

    A list of all found implementations

    Return type
    -

    list

    +

    list

    @@ -627,7 +627,7 @@
    Parameters
      -

    • identifier (str) – The identifier of the plugin to retrieve.

      • +

    • identifier (str) – The identifier of the plugin to retrieve.

    • require_enabled (boolean) – Whether to only return the plugin if is enabled (True, default) or also if it’s disabled.

    @@ -649,7 +649,7 @@
    Parameters
      -

    • identifier (str) – The identifier of the plugin to retrieve.

      • +

    • identifier (str) – The identifier of the plugin to retrieve.

    • require_enabled (boolean) – Whether to only return the plugin if is enabled (True, default) or also if it’s disabled.

    @@ -683,7 +683,7 @@

    Return type
    -

    (bool)

    +

    (bool)

    @@ -708,7 +708,7 @@

    Return type
    -

    (bool)

    +

    (bool)

    @@ -738,7 +738,7 @@

    hook is expected to be an exact hook name.

    hooks is expected to be a list containing one or more hook names or patterns. That can be either an exact hook name or an -fnmatch.fnmatch() pattern.

    +fnmatch.fnmatch() pattern.

    Parameters
      @@ -750,7 +750,7 @@

      True if the hook matches any of the hooks, False otherwise.

      Return type
      -

      (bool)

      +

      (bool)

    @@ -768,8 +768,8 @@
    Parameters
      -

    • name (str) – the plugin’s identifier

      • -

    • flag (str) – the flag to check

      • +

    • name (str) – the plugin’s identifier

      • +

    • flag (str) – the flag to check

    Returns
    @@ -800,8 +800,8 @@
    Parameters
      -

    • name (str) – plugin identifier

      • -

    • **flags (dict) – dictionary of flag names and values

      • +

    • name (str) – plugin identifier

      • +

    • **flags (dict) – dictionary of flag names and values

    @@ -838,7 +838,7 @@

    • startup (boolean) – whether this is called during startup of the platform

    • initialize_implementations (boolean) – whether plugin implementations should be initialized

      • -

    • force_reload (list) – list of plugin identifiers which should be force reloaded

      • +

    • force_reload (list) – list of plugin identifiers which should be force reloaded

    @@ -852,9 +852,9 @@
    Parameters
      -

    • plugin (str) – The sending plugin’s identifier.

      • -

    • data (object) – The message.

      • -

    • permissions (list) – A list of permissions to test against in the client.

      • +

    • plugin (str) – The sending plugin’s identifier.

      • +

    • data (object) – The message.

      • +

    • permissions (list) – A list of permissions to test against in the client.

    @@ -879,15 +879,15 @@
    Parameters
      -

    • key (str) – Identifier of the plugin

      • -

    • location (str) – Installation folder of the plugin

      • +

    • key (str) – Identifier of the plugin

      • +

    • location (str) – Installation folder of the plugin

    • instance (module) – Plugin module instance - this may be None if the plugin has been blacklisted!

      • -

    • name (str) – Human readable name of the plugin

      • -

    • version (str) – Version of the plugin

      • -

    • description (str) – Description of the plugin

      • -

    • author (str) – Author of the plugin

      • -

    • url (str) – URL of the website of the plugin

      • -

    • license (str) – License of the plugin

      • +

    • name (str) – Human readable name of the plugin

      • +

    • version (str) – Version of the plugin

      • +

    • description (str) – Description of the plugin

      • +

    • author (str) – Author of the plugin

      • +

    • url (str) – URL of the website of the plugin

      • +

    • license (str) – License of the plugin

    @@ -901,7 +901,7 @@

    Author of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -948,7 +948,7 @@

    Description of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -979,7 +979,7 @@

    Reason why disabling this plugin is discouraged (only for bundled plugins)

    Return type
    -

    str or None

    +

    str or None

    @@ -1016,7 +1016,7 @@ get_hook(hook)
    Parameters
    -

    hook (str) – Hook to return.

    +

    hook (str) – Hook to return.

    Returns

    Handler for the requested hook or None if no handler is registered.

    @@ -1032,13 +1032,13 @@ get_implementation(*types)
    Parameters
    -

    types (list) – List of Plugin sub classes the implementation needs to implement.

    +

    types (list) – List of Plugin sub classes the implementation needs to implement.

    Returns

    The plugin’s implementation if it matches all of the requested types, None otherwise.

    Return type
    -

    object

    +

    object

    @@ -1053,7 +1053,7 @@

    Helpers provided by the plugin.

    Return type
    -

    dict

    +

    dict

    @@ -1067,7 +1067,7 @@

    Whether the plugin should be flagged as hidden or not

    Return type
    -

    bool

    +

    bool

    @@ -1082,7 +1082,7 @@

    Hooks provided by the plugin.

    Return type
    -

    dict

    +

    dict

    @@ -1097,7 +1097,7 @@

    Implementation provided by the plugin.

    Return type
    -

    object

    +

    object

    @@ -1124,7 +1124,7 @@

    License of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1172,18 +1172,18 @@
    Parameters

    • show_enabled (boolean) – whether to show the enabled part

      • -

    • enabled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the enabled state

      • +

    • enabled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the enabled state

    • show_bundled (boolean) – whether to show the bundled part

      • -

    • bundled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the bundled state

      • +

    • bundled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the bundled state

    • show_location (boolean) – whether to show the location part

      • -

    • location_str (str) – the format string to use for displaying the plugin’s installation location

      • +

    • location_str (str) – the format string to use for displaying the plugin’s installation location

    Returns

    The long string representation of the plugin as described above

    Return type
    -

    str

    +

    str

    @@ -1210,7 +1210,7 @@

    Name of the plugin, fallback is the plugin’s identifier.

    Return type
    -

    str

    +

    str

    @@ -1244,7 +1244,7 @@

    Privacy Policy URL of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1259,7 +1259,7 @@

    Python compatibility string of the plugin

    Return type
    -

    str

    +

    str

    @@ -1289,7 +1289,7 @@

    Website URL for the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1312,7 +1312,7 @@

    Version of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1395,7 +1395,7 @@ not None sorted by that.

    Parameters
    -

    context (str) – The sorting context for which to provide the +

    context (str) – The sorting context for which to provide the sorting key value.

    Returns
    @@ -1407,7 +1407,7 @@

    Return type
    -

    int or None

    +

    int or None

    @@ -1566,13 +1566,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/modules/printer.html b/1.9.3/modules/printer.html similarity index 97% rename from 1.9.2/modules/printer.html rename to 1.9.3/modules/printer.html index 0b734691b..2a92a6929 100644 --- a/1.9.2/modules/printer.html +++ b/1.9.3/modules/printer.html @@ -4,7 +4,7 @@ - octoprint.printer — OctoPrint 1.9.2 documentation + octoprint.printer — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -187,8 +187,8 @@
    Parameters
      -

    • path (str) – path in storage of the file to check

      • -

    • sd (bool) – True if to check against SD storage, False otherwise

      • +

    • path (str) – path in storage of the file to check

      • +

    • sd (bool) – True if to check against SD storage, False otherwise

    Returns
    @@ -215,7 +215,7 @@
    Parameters
      -

    • tool (str) – The tool to switch to, matching the regex “tool[0-9]+” (e.g. “tool0”, “tool1”, …)

      • +

    • tool (str) – The tool to switch to, matching the regex “tool[0-9]+” (e.g. “tool0”, “tool1”, …)

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -229,10 +229,10 @@
    Parameters
      -

    • commands (str, list) – The commands to send. Might be a single command provided just as a string or a list +

    • commands (str, list) – The commands to send. Might be a single command provided just as a string or a list of multiple commands to send in order.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      • -

    • force (bool) – Whether to force sending of the command right away or allow queuing while printing

      • +

    • force (bool) – Whether to force sending of the command right away or allow queuing while printing

    @@ -247,9 +247,9 @@
    Parameters
      -

    • port (str) – Name of the serial port to connect to. If not provided, an auto detection will be attempted.

      • -

    • baudrate (int) – Baudrate to connect with. If not provided, an auto detection will be attempted.

      • -

    • profile (str) – Name of the printer profile to use for this connection. If not provided, the default +

    • port (str) – Name of the serial port to connect to. If not provided, an auto detection will be attempted.

      • +

    • baudrate (int) – Baudrate to connect with. If not provided, an auto detection will be attempted.

      • +

    • profile (str) – Name of the printer profile to use for this connection. If not provided, the default will be retrieved from the PrinterProfileManager.

    @@ -269,8 +269,8 @@
    Parameters
      -

    • amount (int, float) – The amount of material to extrude in mm

      • -

    • speed (int, None) – Speed at which to extrude (F parameter). If set to None (or left out)

      • +

    • amount (int, float) – The amount of material to extrude in mm

      • +

    • speed (int, None) – Speed at which to extrude (F parameter). If set to None (or left out)

    • used. (the maximum speed of E axis from the printer profile will be) –

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -293,7 +293,7 @@
    Parameters
      -

    • factor (int, float) – The factor for the feed rate to send to the firmware. Percentage expressed as either an +

    • factor (int, float) – The factor for the feed rate to send to the firmware. Percentage expressed as either an int between 0 and 100 or a float between 0 and 1.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -308,7 +308,7 @@
    Parameters
      -

    • factor (int, float) – The factor for the flow rate to send to the firmware. Percentage expressed as either an +

    • factor (int, float) – The factor for the flow rate to send to the firmware. Percentage expressed as either an int between 0 and 100 or a float between 0 and 1.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -333,7 +333,7 @@

    A dictionary holding the connection options in the structure specified above

    Return type
    -

    (dict)

    +

    (dict)

    @@ -443,7 +443,7 @@

    The communication layer’s transport object

    Return type
    -

    object

    +

    object

    @@ -455,7 +455,7 @@
    Parameters
      -

    • axes (str, list) – The axis or axes to home, each of which must converted to lower case must match one of +

    • axes (str, list) – The axis or axes to home, each of which must converted to lower case must match one of “x”, “y”, “z” and “e”

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -503,8 +503,8 @@
    Parameters
      -

    • path (str) – path in storage of the file to check

      • -

    • sd (bool) – True if to check against SD storage, False otherwise

      • +

    • path (str) – path in storage of the file to check

      • +

    • sd (bool) – True if to check against SD storage, False otherwise

    Returns
    @@ -593,7 +593,7 @@ if the lock can’t be acquired.

    Parameters
    -

    blocking (bool) – Whether to block while attempting to acquire the lock (default) or not

    +

    blocking (bool) – Whether to block while attempting to acquire the lock (default) or not

    @@ -605,10 +605,10 @@
    Parameters
      -

    • axes (dict) – Axes and distances to jog, keys are axes (“x”, “y”, “z”), values are distances in mm

      • -

    • relative (bool) – Whether to interpret the distance values as relative (true, default) or absolute (false) +

    • axes (dict) – Axes and distances to jog, keys are axes (“x”, “y”, “z”), values are distances in mm

      • +

    • relative (bool) – Whether to interpret the distance values as relative (true, default) or absolute (false) coordinates

      • -

    • speed (int, bool or None) – Speed at which to jog (F parameter). If set to False no speed will be set +

    • speed (int, bool or None) – Speed at which to jog (F parameter). If set to False no speed will be set specifically. If set to None (or left out) the minimum of all involved axes speeds from the printer profile will be used.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      • @@ -667,8 +667,8 @@
      Parameters
        -

      • name (str) – The name of the GCODE script to render.

        • -

      • context (dict) – An optional context of additional template variables to provide to the renderer.

        • +

      • name (str) – The name of the GCODE script to render.

        • +

      • context (dict) – An optional context of additional template variables to provide to the renderer.

      • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      @@ -686,7 +686,7 @@
      Parameters
        -

      • path (str) – The path to select for printing. Either an absolute path or relative path to a local file in +

      • path (str) – The path to select for printing. Either an absolute path or relative path to a local file in the uploads folder or a filename on the printer’s SD card.

      • sd (boolean) – Indicates whether the file is on the printer’s SD card or not.

      • printAfterSelect (boolean) – Indicates whether a print should be started @@ -738,8 +738,8 @@

        Parameters
          -

        • value (bool) – The value to set

          • -

        • blocking (bool) – Whether to block while attempting to set the value (default) or not

          • +

        • value (bool) – The value to set

          • +

        • blocking (bool) – Whether to block while attempting to set the value (default) or not

        Returns
        @@ -755,10 +755,10 @@
        Parameters
          -

        • heater (str) – The heater for which to set the target temperature. Either “bed” for setting the bed +

        • heater (str) – The heater for which to set the target temperature. Either “bed” for setting the bed temperature or something matching the regular expression “tool[0-9]+” (e.g. “tool0”, “tool1”, …) for the hotends of the printer

          • -

        • value (int, float) – The temperature in celsius to set the target temperature to.

          • +

        • value (int, float) – The temperature in celsius to set the target temperature to.

        • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

        @@ -772,7 +772,7 @@
        Parameters
          -

        • offsets (dict) – A dictionary specifying the offsets to apply. Keys must match the format for the heater +

        • offsets (dict) – A dictionary specifying the offsets to apply. Keys must match the format for the heater parameter to set_temperature(), so “bed” for the offset for the bed target temperature and “tool[0-9]+” for the offsets to the hotend target temperatures.

        • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

          • @@ -849,7 +849,7 @@

          Called when the PrinterInterface receives a new communication log entry from the communication layer.

          Parameters
          -

          data (str) – The received log line.

          +

          data (str) – The received log line.

        @@ -860,7 +860,7 @@

        Called when the PrinterInterface receives a new message from the communication layer.

        Parameters
        -

        data (str) – The received message.

        +

        data (str) – The received message.

        @@ -884,7 +884,7 @@
    Parameters
    -

    data (dict) – A dict of all current temperatures in the format as specified above

    +

    data (dict) – A dict of all current temperatures in the format as specified above

    @@ -896,8 +896,8 @@
    Parameters
      -

    • name (str) – Name of the registered message (e.g. the feedback command)

      • -

    • output (str) – Output for the registered message

      • +

    • name (str) – Name of the registered message (e.g. the feedback command)

      • +

    • output (str) – Output for the registered message

    @@ -942,7 +942,7 @@
    Parameters
    -

    data (dict) – The current data in the format as specified above.

    +

    data (dict) – The current data in the format as specified above.

    @@ -969,7 +969,7 @@
    Parameters
    -

    data (dict) – The initial data in the format as specified above.

    +

    data (dict) – The initial data in the format as specified above.

    @@ -1240,13 +1240,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/modules/schema.html b/1.9.3/modules/schema.html similarity index 92% rename from 1.9.2/modules/schema.html rename to 1.9.3/modules/schema.html index def5f802f..ed77a37e0 100644 --- a/1.9.2/modules/schema.html +++ b/1.9.3/modules/schema.html @@ -4,7 +4,7 @@ - octoprint.schema — OctoPrint 1.9.2 documentation + octoprint.schema — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -278,34 +278,34 @@
    -class octoprint.schema.config.access_control.AccessControlConfig(*, salt: Optional[str] = None, userManager: str = 'octoprint.access.users.FilebasedUserManager', groupManager: str = 'octoprint.access.groups.FilebasedGroupManager', permissionManager: str = 'octoprint.access.permissions.PermissionManager', userfile: Optional[str] = None, groupfile: Optional[str] = None, autologinLocal: bool = False, localNetworks: List[str] = ['127.0.0.0/8', '::1/128'], autologinAs: Optional[str] = None, trustBasicAuthentication: bool = False, checkBasicAuthenticationPassword: bool = True, trustRemoteUser: bool = False, remoteUserHeader: str = 'REMOTE_USER', addRemoteUsers: bool = False)
    +class octoprint.schema.config.access_control.AccessControlConfig(*, salt: Optional[str] = None, userManager: str = 'octoprint.access.users.FilebasedUserManager', groupManager: str = 'octoprint.access.groups.FilebasedGroupManager', permissionManager: str = 'octoprint.access.permissions.PermissionManager', userfile: Optional[str] = None, groupfile: Optional[str] = None, autologinLocal: bool = False, localNetworks: List[str] = ['127.0.0.0/8', '::1/128'], autologinAs: Optional[str] = None, trustBasicAuthentication: bool = False, checkBasicAuthenticationPassword: bool = True, trustRemoteUser: bool = False, remoteUserHeader: str = 'REMOTE_USER', addRemoteUsers: bool = False)
    -addRemoteUsers: bool
    +addRemoteUsers: bool

    If a remote user is not found, add them. Use this only if all users from the remote system can use OctoPrint.

    -autologinAs: Optional[str]
    +autologinAs: Optional[str]

    The name of the user to automatically log on clients originating from localNetworks as. Must be the name of one of your configured users.

    -autologinLocal: bool
    +autologinLocal: bool

    If set to true, will automatically log on clients originating from any of the networks defined in localNetworks as the user defined in autologinAs.

    -checkBasicAuthenticationPassword: bool
    +checkBasicAuthenticationPassword: bool

    Whether to also check the password provided through Basic Authentication, if the Basic Authentication header is to be trusted. Disabling this will only match the user name in the Basic Authentication header and login the user without further checks, thus disable with caution.

    -groupManager: str
    +groupManager: str

    groups.yaml in the default configuration folder).

    Type
    @@ -316,49 +316,49 @@
    -groupfile: Optional[str]
    +groupfile: Optional[str]

    The YAML group file to use. If left out defaults to groups.yaml in the default configuration folder.

    -localNetworks: List[str]
    +localNetworks: List[str]

    A list of networks or IPs for which an automatic logon as the user defined in autologinAs will take place. If available OctoPrint will evaluate the X-Forwarded-For HTTP header for determining the client’s IP address. Defaults to anything originating from localhost.

    -permissionManager: str
    +permissionManager: str

    The permission manager implementation to use.

    -remoteUserHeader: str
    +remoteUserHeader: str

    Header used by the reverse proxy to convey the authenticated user.

    -salt: Optional[str]
    +salt: Optional[str]

    Secret salt used for password hashing. DO NOT TOUCH! If changed you will no longer be able to log in with your existing accounts. Default unset, generated on first run.

    -trustBasicAuthentication: bool
    +trustBasicAuthentication: bool

    Whether to trust Basic Authentication headers. If you have setup Basic Authentication in front of OctoPrint and the user names you use there match OctoPrint accounts, by setting this to true users will be logged into OctoPrint as the user user during Basic Authentication. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through Basic Authentication!

    -trustRemoteUser: bool
    +trustRemoteUser: bool

    Whether to trust remote user headers. If you have setup authentication in front of OctoPrint and the user names you use there match OctoPrint accounts, by setting this to true users will be logged into OctoPrint as the user provided in the header. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through an authenticating reverse proxy!

    -userManager: str
    +userManager: str

    users.yaml in the default configuration folder).

    Type
    @@ -369,7 +369,7 @@
    -userfile: Optional[str]
    +userfile: Optional[str]

    The YAML user file to use. If left out defaults to users.yaml in the default configuration folder.

    @@ -377,21 +377,21 @@
    -class octoprint.schema.config.api.ApiConfig(*, key: Optional[str] = None, apps: Dict[str, str] = {}, allowCrossOrigin: bool = False)
    +class octoprint.schema.config.api.ApiConfig(*, key: Optional[str] = None, apps: Dict[str, str] = {}, allowCrossOrigin: bool = False)
    -allowCrossOrigin: bool
    +allowCrossOrigin: bool

    Whether to allow cross origin access to the API or not.

    -apps: Dict[str, str]
    +apps: Dict[str, str]
    -key: Optional[str]
    +key: Optional[str]

    Global API key, deprecated, use User API keys instead. Unset by default, will be generated on first run.

    @@ -399,10 +399,10 @@
    -class octoprint.schema.config.appearance.AppearanceConfig(*, name: str = '', color: octoprint.schema.config.appearance.ColorEnum = ColorEnum.default, colorTransparent: bool = False, colorIcon: bool = True, defaultLanguage: str = '_default', showFahrenheitAlso: bool = False, fuzzyTimes: bool = True, closeModalsWithClick: bool = True, showInternalFilename: bool = True, components: octoprint.schema.config.appearance.ComponentConfig = ComponentConfig(order=ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic=[]), disabled=ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[])))
    +class octoprint.schema.config.appearance.AppearanceConfig(*, name: str = '', color: octoprint.schema.config.appearance.ColorEnum = ColorEnum.default, colorTransparent: bool = False, colorIcon: bool = True, defaultLanguage: str = '_default', showFahrenheitAlso: bool = False, fuzzyTimes: bool = True, closeModalsWithClick: bool = True, showInternalFilename: bool = True, components: octoprint.schema.config.appearance.ComponentConfig = ComponentConfig(order=ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic=[]), disabled=ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[])))
    -closeModalsWithClick: bool
    +closeModalsWithClick: bool
    @@ -413,12 +413,12 @@
    -colorIcon: bool
    +colorIcon: bool
    -colorTransparent: bool
    +colorTransparent: bool

    Makes the color of the navigation bar “transparent”. In case your printer uses acrylic for its frame 😉.

    @@ -430,18 +430,18 @@
    -defaultLanguage: str
    +defaultLanguage: str

    Default language of OctoPrint. If left unset OctoPrint will try to match up available languages with the user’s browser settings.

    -fuzzyTimes: bool
    +fuzzyTimes: bool
    -name: str
    +name: str

    <>”)

    Type
    @@ -452,12 +452,12 @@
    -showFahrenheitAlso: bool
    +showFahrenheitAlso: bool
    -showInternalFilename: bool
    +showInternalFilename: bool

    Show the internal filename in the files sidebar, if necessary.

    @@ -523,52 +523,52 @@
    -class octoprint.schema.config.appearance.ComponentDisabledConfig(*, navbar: List[str] = [], sidebar: List[str] = [], tab: List[str] = [], settings: List[str] = [], usersettings: List[str] = [], wizard: List[str] = [], about: List[str] = [], generic: List[str] = [])
    +class octoprint.schema.config.appearance.ComponentDisabledConfig(*, navbar: List[str] = [], sidebar: List[str] = [], tab: List[str] = [], settings: List[str] = [], usersettings: List[str] = [], wizard: List[str] = [], about: List[str] = [], generic: List[str] = [])
    -about: List[str]
    +about: List[str]

    Disabled about dialog items.

    -generic: List[str]
    +generic: List[str]

    Disabled generic items.

    -navbar: List[str]
    +navbar: List[str]

    Disabled navbar items.

    -settings: List[str]
    +settings: List[str]

    Disabled settings.

    -sidebar: List[str]
    +sidebar: List[str]

    Disabled sidebar items.

    -tab: List[str]
    +tab: List[str]

    Disabled tabs.

    -usersettings: List[str]
    +usersettings: List[str]

    Disabled user settings.

    -wizard: List[str]
    +wizard: List[str]

    Disabled wizards.

    @@ -576,52 +576,52 @@
    -class octoprint.schema.config.appearance.ComponentOrderConfig(*, navbar: List[str] = ['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar: List[str] = ['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab: List[str] = ['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings: List[str] = ['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings: List[str] = ['access', 'interface'], wizard: List[str] = ['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about: List[str] = ['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic: List[str] = [])
    +class octoprint.schema.config.appearance.ComponentOrderConfig(*, navbar: List[str] = ['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar: List[str] = ['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab: List[str] = ['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings: List[str] = ['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings: List[str] = ['access', 'interface'], wizard: List[str] = ['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about: List[str] = ['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic: List[str] = [])
    -about: List[str]
    +about: List[str]

    Order of about dialog items.

    -generic: List[str]
    +generic: List[str]

    Order of generic items.

    -navbar: List[str]
    +navbar: List[str]

    Order of navbar items.

    -settings: List[str]
    +settings: List[str]

    Order of settings.

    -sidebar: List[str]
    +sidebar: List[str]

    Order of sidebar items.

    -tab: List[str]
    +tab: List[str]

    Order of tabs.

    -usersettings: List[str]
    +usersettings: List[str]

    Order of user settings.

    -wizard: List[str]
    +wizard: List[str]

    Order of wizards.

    @@ -629,7 +629,7 @@
    -class octoprint.schema.config.controls.ContainerConfig(*, children: List[Union[ContainerConfig, ControlConfig]] = [], name: Optional[str] = None, layout: octoprint.schema.config.controls.LayoutEnum = LayoutEnum.vertical)
    +class octoprint.schema.config.controls.ContainerConfig(*, children: List[Union[ContainerConfig, ControlConfig]] = [], name: Optional[str] = None, layout: octoprint.schema.config.controls.LayoutEnum = LayoutEnum.vertical)
    children: List[Union[octoprint.schema.config.controls.ContainerConfig, octoprint.schema.config.controls.ControlConfig]]
    @@ -644,7 +644,7 @@
    -name: Optional[str]
    +name: Optional[str]

    A name to display above the container, basically a section header.

    @@ -652,34 +652,34 @@
    -class octoprint.schema.config.controls.ControlConfig(*, name: str, command: Optional[str] = None, commands: Optional[List[str]] = None, script: Optional[str] = None, javascript: Optional[str] = None, additionalClasses: Optional[str] = None, enabled: Optional[str] = None, input: Optional[List[octoprint.schema.config.controls.ControlInputConfig]] = [], regex: Optional[str] = None, template: Optional[str] = None, confirm: Optional[str] = None)
    +class octoprint.schema.config.controls.ControlConfig(*, name: str, command: Optional[str] = None, commands: Optional[List[str]] = None, script: Optional[str] = None, javascript: Optional[str] = None, additionalClasses: Optional[str] = None, enabled: Optional[str] = None, input: Optional[List[octoprint.schema.config.controls.ControlInputConfig]] = [], regex: Optional[str] = None, template: Optional[str] = None, confirm: Optional[str] = None)
    -additionalClasses: Optional[str]
    +additionalClasses: Optional[str]

    Additional classes to apply to the button of a command, commands, script or javascript control, other than the default btn. Can be used to visually style the button, e.g. set to btn-danger to turn the button red.

    -command: Optional[str]
    +command: Optional[str]

    A single GCODE command to send to the printer. Will be rendered as a button which sends the command to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with commands and script. The rendered button be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met.

    -commands: Optional[List[str]]
    +commands: Optional[List[str]]

    A list of GCODE commands to send to the printer. Will be rendered as a button which sends the commands to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with command and script. The rendered button will be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met.

    -confirm: Optional[str]
    +confirm: Optional[str]

    A text to display to the user to confirm his button press. Can be used with sensitive custom controls like changing EEPROM values in order to prevent accidental clicks. The text will be displayed in a confirmation dialog.

    -enabled: Optional[str]
    +enabled: Optional[str]

    A JavaScript snippet returning either true or false determining whether the control should be enabled or not. This allows to override the default logic for the enable state of the control (disabled if printer is offline). The JavaScript snippet is eval’d and processed in a context where the control it is part of is provided as local variable data and the ControlViewModel is available as self.

    @@ -691,19 +691,19 @@
    -javascript: Optional[str]
    +javascript: Optional[str]

    A JavaScript snippet to be executed when the button rendered for command or commands is clicked. This allows to override the direct sending of the command or commands to the printer with more sophisticated behaviour. The JavaScript snippet is eval’d and processed in a context where the control it is part of is provided as local variable data and the ControlViewModel is available as self.

    -name: str
    +name: str

    The name of the control, will be displayed either on the button if it’s a control sending a command or as a label for controls which only display output.

    -regex: Optional[str]
    +regex: Optional[str]

    //docs.python.org/3/library/re.html#regular-expression-syntax) to match against lines received from the printer to retrieve information from it (e.g. specific output). Together with template this allows rendition of received data from the printer within the UI.

    Type
    @@ -714,13 +714,13 @@
    -script: Optional[str]
    +script: Optional[str]

    The name of a full blown [GCODE script]() to send to the printer. Will be rendered as a button which sends the script to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with command and commands. The rendered button will be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met. Values of input parameters will be available in the template context under the parameter variable (e.g. an input parameter speed will be available in the script template as parameter.speed). On top of that all other variables defined in the [GCODE template context]() will be available.

    -template: Optional[str]
    +template: Optional[str]

    {temperature}` for a regex T:s*(?P<temperature>d+(.d*)) or positional groups within the regex (e.g. Position: X={0}, Y={1}, Z={2}, E={3} for a regex X:([0-9.]+) Y:([0-9.]+) Z:([0-9.]+) E:([0-9.]+)).

    Type
    @@ -736,22 +736,22 @@
    -class octoprint.schema.config.controls.ControlInputConfig(*, name: str, parameter: str, default: Union[str, int, float, bool], slider: Optional[octoprint.schema.config.controls.ControlSliderInputConfig] = None)
    +class octoprint.schema.config.controls.ControlInputConfig(*, name: str, parameter: str, default: Union[str, int, float, bool], slider: Optional[octoprint.schema.config.controls.ControlSliderInputConfig] = None)
    -default: Union[str, int, float, bool]
    +default: Union[str, int, float, bool]

    Default value for the input field.

    -name: str
    +name: str

    Name to display for the input field.

    -parameter: str
    +parameter: str

    Internal parameter name for the input field, used as a placeholder in command/commands.

    @@ -765,22 +765,22 @@
    -class octoprint.schema.config.controls.ControlSliderInputConfig(*, min: int = 0, max: int = 255, step: int = 1)
    +class octoprint.schema.config.controls.ControlSliderInputConfig(*, min: int = 0, max: int = 255, step: int = 1)
    -max: int
    +max: int

    Maximum value of the slider.

    -min: int
    +min: int

    Minimum value of the slider.

    -step: int
    +step: int

    Step size per slider tick.

    @@ -804,16 +804,16 @@
    -class octoprint.schema.config.devel.DevelCacheConfig(*, enabled: bool = True, preemptive: bool = True)
    +class octoprint.schema.config.devel.DevelCacheConfig(*, enabled: bool = True, preemptive: bool = True)
    -enabled: bool
    +enabled: bool

    Whether to enable caching. Defaults to true. Setting it to false will cause the UI to always be fully rerendered on request to / on the server.

    -preemptive: bool
    +preemptive: bool

    Whether to enable the preemptive cache.

    @@ -821,7 +821,7 @@
    -class octoprint.schema.config.devel.DevelConfig(*, stylesheet: octoprint.schema.config.devel.StylesheetEnum = StylesheetEnum.css, cache: octoprint.schema.config.devel.DevelCacheConfig = DevelCacheConfig(enabled=True, preemptive=True), webassets: octoprint.schema.config.devel.DevelWebassetsConfig = DevelWebassetsConfig(bundle=True, clean_on_startup=True, minify=True, minify_plugins=False), useFrozenDictForPrinterState: bool = True, showLoadingAnimation: bool = True, sockJsConnectTimeout: float = 30, pluginTimings: bool = False, enableRateLimiter: bool = True, enableCsrfProtection: bool = True)
    +class octoprint.schema.config.devel.DevelConfig(*, stylesheet: octoprint.schema.config.devel.StylesheetEnum = StylesheetEnum.css, cache: octoprint.schema.config.devel.DevelCacheConfig = DevelCacheConfig(enabled=True, preemptive=True), webassets: octoprint.schema.config.devel.DevelWebassetsConfig = DevelWebassetsConfig(bundle=True, clean_on_startup=True, minify=True, minify_plugins=False), useFrozenDictForPrinterState: bool = True, showLoadingAnimation: bool = True, sockJsConnectTimeout: float = 30, pluginTimings: bool = False, enableRateLimiter: bool = True, enableCsrfProtection: bool = True)
    cache: octoprint.schema.config.devel.DevelCacheConfig
    @@ -830,30 +830,30 @@
    -enableCsrfProtection: bool
    +enableCsrfProtection: bool

    Enable or disable the CSRF protection. Careful, disabling this reduces security.

    -enableRateLimiter: bool
    +enableRateLimiter: bool

    Enable or disable the rate limiter. Careful, disabling this reduces security.

    -pluginTimings: bool
    +pluginTimings: bool
    -showLoadingAnimation: bool
    +showLoadingAnimation: bool

    Enable or disable the loading animation.

    -sockJsConnectTimeout: float
    +sockJsConnectTimeout: float
    @@ -864,7 +864,7 @@
    -useFrozenDictForPrinterState: bool
    +useFrozenDictForPrinterState: bool
    @@ -877,10 +877,10 @@
    -class octoprint.schema.config.devel.DevelWebassetsConfig(*, bundle: bool = True, clean_on_startup: bool = True, minify: bool = True, minify_plugins: bool = False)
    +class octoprint.schema.config.devel.DevelWebassetsConfig(*, bundle: bool = True, clean_on_startup: bool = True, minify: bool = True, minify_plugins: bool = False)
    -bundle: bool
    +bundle: bool

    if this is set to false, no minification will take place regardless of the minify setting.

    Type
    @@ -891,13 +891,13 @@
    -clean_on_startup: bool
    +clean_on_startup: bool

    Whether to delete generated web assets on server startup (forcing a regeneration).

    -minify: bool
    +minify: bool

    if bundle is set to false, no minification will take place either.

    Type
    @@ -908,7 +908,7 @@
    -minify_plugins: bool
    +minify_plugins: bool

    if bundle or minify are set to false, no minification of the plugin assets will take place either.

    Type
    @@ -948,34 +948,34 @@
    -class octoprint.schema.config.estimation.PrintTimeEstimationConfig(*, statsWeighingUntil: float = 0.5, validityRange: float = 0.15, forceDumbFromPercent: float = 0.3, forceDumbAfterMin: float = 30.0, stableThreshold: int = 60)
    +class octoprint.schema.config.estimation.PrintTimeEstimationConfig(*, statsWeighingUntil: float = 0.5, validityRange: float = 0.15, forceDumbFromPercent: float = 0.3, forceDumbAfterMin: float = 30.0, stableThreshold: int = 60)
    -forceDumbAfterMin: float
    +forceDumbAfterMin: float

    If no estimate could be calculated until this many minutes into the print and no statistical data is available, use dumb linear estimate.

    -forceDumbFromPercent: float
    +forceDumbFromPercent: float

    If no estimate could be calculated until this percentage and no statistical data is available, use dumb linear estimate. Value between 0 and 1.0.

    -stableThreshold: int
    +stableThreshold: int

    Average fluctuation between individual calculated estimates to consider in stable range. Seconds of difference.

    -statsWeighingUntil: float
    +statsWeighingUntil: float

    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.

    -validityRange: float
    +validityRange: float

    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.

    @@ -983,34 +983,34 @@
    -class octoprint.schema.config.events.EventSubscription(*, event: str, name: Optional[str] = None, command: str, type: octoprint.schema.config.events.SubscriptionTypeEnum, enabled: bool = True, debug: bool = False)
    +class octoprint.schema.config.events.EventSubscription(*, event: str, name: Optional[str] = None, command: str, type: octoprint.schema.config.events.SubscriptionTypeEnum, enabled: bool = True, debug: bool = False)
    -command: str
    +command: str

    The command to execute when the event is triggered, either a GCODE or a system command.

    -debug: bool
    +debug: bool

    If set to true, OctoPrint will log the command after performing all placeholder replacements.

    -enabled: bool
    +enabled: bool

    Whether the event subscription should be enabled.

    -event: str
    +event: str

    The event to subscribe to.

    -name: Optional[str]
    +name: Optional[str]

    The event name to show on the UI

    @@ -1024,10 +1024,10 @@
    -class octoprint.schema.config.events.EventsConfig(*, enabled: bool = True, subscriptions: List[octoprint.schema.config.events.EventSubscription] = [])
    +class octoprint.schema.config.events.EventsConfig(*, enabled: bool = True, subscriptions: List[octoprint.schema.config.events.EventSubscription] = [])
    -enabled: bool
    +enabled: bool

    Whether event subscriptions should be enabled or not.

    @@ -1057,158 +1057,158 @@
    -class octoprint.schema.config.feature.FeatureConfig(*, temperatureGraph: bool = True, sdSupport: bool = True, keyboardControl: bool = True, pollWatched: bool = False, modelSizeDetection: bool = True, rememberFileFolder: bool = False, printStartConfirmation: bool = False, printCancelConfirmation: bool = True, uploadOverwriteConfirmation: bool = True, autoUppercaseBlacklist: List[str] = ['M117', 'M118'], g90InfluencesExtruder: bool = False, enforceReallyUniversalFilenames: bool = False)
    +class octoprint.schema.config.feature.FeatureConfig(*, temperatureGraph: bool = True, sdSupport: bool = True, keyboardControl: bool = True, pollWatched: bool = False, modelSizeDetection: bool = True, rememberFileFolder: bool = False, printStartConfirmation: bool = False, printCancelConfirmation: bool = True, uploadOverwriteConfirmation: bool = True, autoUppercaseBlacklist: List[str] = ['M117', 'M118'], g90InfluencesExtruder: bool = False, enforceReallyUniversalFilenames: bool = False)
    -autoUppercaseBlacklist: List[str]
    +autoUppercaseBlacklist: List[str]

    Commands that should never be auto-uppercased when sent to the printer through the Terminal tab.

    -enforceReallyUniversalFilenames: bool
    +enforceReallyUniversalFilenames: bool

    Replace all special characters and spaces with text equivalent to make them universally compatible. Most OS filesystems work fine with unicode characters, but just in case you can revert to the older behaviour by setting this to true.

    -g90InfluencesExtruder: bool
    +g90InfluencesExtruder: bool

    Whether G90/G91 also influence absolute/relative mode of extruders.

    -keyboardControl: bool
    +keyboardControl: bool

    Whether to enable the keyboard control feature in the control tab.

    -modelSizeDetection: bool
    +modelSizeDetection: bool

    Whether to enable model size detection and warning (true) or not (false).

    -pollWatched: bool
    +pollWatched: bool

    Whether to actively poll the watched folder (true) or to rely on the OS’s file system notifications instead (false).

    -printCancelConfirmation: bool
    +printCancelConfirmation: bool

    Whether to show a confirmation on print cancelling (true) or not (false)

    -printStartConfirmation: bool
    +printStartConfirmation: bool

    Whether to show a confirmation on print start (true) or not (false)

    -rememberFileFolder: bool
    +rememberFileFolder: bool

    Whether to remember the selected folder on the file manager.

    -sdSupport: bool
    +sdSupport: bool

    Specifies whether support for SD printing and file management should be enabled.

    -temperatureGraph: bool
    +temperatureGraph: bool

    Whether to enable the temperature graph in the UI or not.

    -uploadOverwriteConfirmation: bool
    +uploadOverwriteConfirmation: bool
    -class octoprint.schema.config.folder.FolderConfig(*, uploads: Optional[str] = None, timelapse: Optional[str] = None, timelapse_tmp: Optional[str] = None, logs: Optional[str] = None, virtualSd: Optional[str] = None, watched: Optional[str] = None, plugins: Optional[str] = None, slicingProfiles: Optional[str] = None, printerProfiles: Optional[str] = None, scripts: Optional[str] = None, translations: Optional[str] = None, generated: Optional[str] = None, data: Optional[str] = None)
    +class octoprint.schema.config.folder.FolderConfig(*, uploads: Optional[str] = None, timelapse: Optional[str] = None, timelapse_tmp: Optional[str] = None, logs: Optional[str] = None, virtualSd: Optional[str] = None, watched: Optional[str] = None, plugins: Optional[str] = None, slicingProfiles: Optional[str] = None, printerProfiles: Optional[str] = None, scripts: Optional[str] = None, translations: Optional[str] = None, generated: Optional[str] = None, data: Optional[str] = None)
    -data: Optional[str]
    +data: Optional[str]

    Absolute path where to store additional data. Defaults to the data folder in OctoPrint’s base folder.

    -generated: Optional[str]
    +generated: Optional[str]

    Absolute path where to store generated files. Defaults to the generated folder in OctoPrint’s base folder.

    -logs: Optional[str]
    +logs: Optional[str]

    Absolute path where to store logs. Defaults to the logs folder in OctoPrint’s base folder.

    -plugins: Optional[str]
    +plugins: Optional[str]

    Absolute path where to locate and install single file plugins. Defaults to the plugins folder in OctoPrint’s base folder.

    -printerProfiles: Optional[str]
    +printerProfiles: Optional[str]

    Absolute path where to store printer profiles. Defaults to the printerProfiles folder in OctoPrint’s base folder.

    -scripts: Optional[str]
    +scripts: Optional[str]

    Absolute path where to store (GCODE) scripts. Defaults to the scripts folder in OctoPrint’s base folder.

    -slicingProfiles: Optional[str]
    +slicingProfiles: Optional[str]

    Absolute path where to store slicing profiles. Defaults to the slicingProfiles folder in OctoPrint’s base folder.

    -timelapse: Optional[str]
    +timelapse: Optional[str]

    Absolute path where to store finished timelase recordings. Defaults to the timelapse folder in OctoPrint’s base folder.

    -timelapse_tmp: Optional[str]
    +timelapse_tmp: Optional[str]

    Absolute path where to store temporary timelapse snapshots. Defaults to the timelapse/tmp folder in OctoPrint’s base folder.

    -translations: Optional[str]
    +translations: Optional[str]

    Absolute path where to store additional translations. Defaults to the translations folder in OctoPrint’s base folder.

    -uploads: Optional[str]
    +uploads: Optional[str]

    Absolute path where to store gcode uploads. Defaults to the uploads folder in OctoPrint’s base folder.

    -virtualSd: Optional[str]
    +virtualSd: Optional[str]

    Absolute path where to store the virtual printer’s SD card files. Defaults to the virtualSd folder in OctoPrint’s base folder.

    -watched: Optional[str]
    +watched: Optional[str]

    Absolute path to the watched folder. Defaults to the watched folder in OctoPrint’s base folder.

    @@ -1216,16 +1216,16 @@
    -class octoprint.schema.config.gcode_analysis.GcodeAnalysisConfig(*, maxExtruders: int = 10, throttle_normalprio: float = 0.01, throttle_highprio: float = 0.0, throttle_lines: int = 100, runAt: octoprint.schema.config.gcode_analysis.RunAtEnum = RunAtEnum.idle, bedZ: float = 0.0)
    +class octoprint.schema.config.gcode_analysis.GcodeAnalysisConfig(*, maxExtruders: int = 10, throttle_normalprio: float = 0.01, throttle_highprio: float = 0.0, throttle_lines: int = 100, runAt: octoprint.schema.config.gcode_analysis.RunAtEnum = RunAtEnum.idle, bedZ: float = 0.0)
    -bedZ: float
    +bedZ: float

    Z position considered the location of the bed.

    -maxExtruders: int
    +maxExtruders: int

    Maximum number of extruders to support/to sanity check for.

    @@ -1237,19 +1237,19 @@
    -throttle_highprio: float
    +throttle_highprio: float

    Pause between each processed GCODE line batch in high priority mode (e.g. on fresh uploads), seconds.

    -throttle_lines: int
    +throttle_lines: int

    GCODE line batch size.

    -throttle_normalprio: float
    +throttle_normalprio: float

    Pause between each processed GCODE line batch in normal priority mode, seconds.

    @@ -1278,22 +1278,22 @@
    -class octoprint.schema.config.plugins.PluginsConfig(*, _disabled: List[str] = [], _forcedCompatible: List[str] = [], _sortingOrder: Dict[str, Dict[str, int]] = {})
    +class octoprint.schema.config.plugins.PluginsConfig(*, _disabled: List[str] = [], _forcedCompatible: List[str] = [], _sortingOrder: Dict[str, Dict[str, int]] = {})
    -disabled: List[str]
    +disabled: List[str]

    Identifiers of installed but disabled plugins.

    -forced_compatible: List[str]
    +forced_compatible: List[str]

    Identifiers of plugins for which python compatibility information will be ignored and the plugin considered compatible in any case. Only for development, do NOT use in production.

    -sorting_order: Dict[str, Dict[str, int]]
    +sorting_order: Dict[str, Dict[str, int]]

    Custom sorting of hooks and implementations provided by plugins. Two-tiered dictionary structure, plugin identifier mapping to a dictionary of order overrides mapped by sorting context/hook name.

    @@ -1301,20 +1301,20 @@
    -class octoprint.schema.config.printer_parameters.PrinterParametersConfig(*, pauseTriggers: List[str] = [])
    +class octoprint.schema.config.printer_parameters.PrinterParametersConfig(*, pauseTriggers: List[str] = [])
    -pauseTriggers: List[str]
    +pauseTriggers: List[str]
    -class octoprint.schema.config.printer_profiles.PrinterProfilesConfig(*, default: Optional[str] = None)
    +class octoprint.schema.config.printer_profiles.PrinterProfilesConfig(*, default: Optional[str] = None)
    -default: Optional[str]
    +default: Optional[str]

    Name of the printer profile to default to.

    @@ -1322,55 +1322,55 @@
    -class octoprint.schema.config.scripts.GcodeScriptsConfig(*, afterPrinterConnected: Optional[str] = None, beforePrinterDisconnected: Optional[str] = None, beforePrintStarted: Optional[str] = None, afterPrintCancelled: Optional[str] = "; disable motors\nM84\n\n;disable all heaters\n{% snippet 'disable_hotends' %}\n{% snippet 'disable_bed' %}\n;disable fan\nM106 S0", afterPrintDone: Optional[str] = None, beforePrintPaused: Optional[str] = None, afterPrintResumed: Optional[str] = None, beforeToolChange: Optional[str] = None, afterToolChange: Optional[str] = None, snippets: Dict[str, str] = {'disable_bed': '{% if printer_profile.heatedBed %}M140 S0\n{% endif %}', 'disable_hotends': '{% if printer_profile.extruder.sharedNozzle %}M104 T0 S0\n{% else %}{% for tool in range(printer_profile.extruder.count) %}M104 T{{ tool }} S0\n{% endfor %}{% endif %}'})
    +class octoprint.schema.config.scripts.GcodeScriptsConfig(*, afterPrinterConnected: Optional[str] = None, beforePrinterDisconnected: Optional[str] = None, beforePrintStarted: Optional[str] = None, afterPrintCancelled: Optional[str] = "; disable motors\nM84\n\n;disable all heaters\n{% snippet 'disable_hotends' %}\n{% snippet 'disable_bed' %}\n;disable fan\nM106 S0", afterPrintDone: Optional[str] = None, beforePrintPaused: Optional[str] = None, afterPrintResumed: Optional[str] = None, beforeToolChange: Optional[str] = None, afterToolChange: Optional[str] = None, snippets: Dict[str, str] = {'disable_bed': '{% if printer_profile.heatedBed %}M140 S0\n{% endif %}', 'disable_hotends': '{% if printer_profile.extruder.sharedNozzle %}M104 T0 S0\n{% else %}{% for tool in range(printer_profile.extruder.count) %}M104 T{{ tool }} S0\n{% endfor %}{% endif %}'})
    -afterPrintCancelled: Optional[str]
    +afterPrintCancelled: Optional[str]
    -afterPrintDone: Optional[str]
    +afterPrintDone: Optional[str]
    -afterPrintResumed: Optional[str]
    +afterPrintResumed: Optional[str]
    -afterPrinterConnected: Optional[str]
    +afterPrinterConnected: Optional[str]
    -afterToolChange: Optional[str]
    +afterToolChange: Optional[str]
    -beforePrintPaused: Optional[str]
    +beforePrintPaused: Optional[str]
    -beforePrintStarted: Optional[str]
    +beforePrintStarted: Optional[str]
    -beforePrinterDisconnected: Optional[str]
    +beforePrinterDisconnected: Optional[str]
    -beforeToolChange: Optional[str]
    +beforeToolChange: Optional[str]
    -snippets: Dict[str, str]
    +snippets: Dict[str, str]
    @@ -1429,46 +1429,46 @@
    -class octoprint.schema.config.serial.SerialCapabilities(*, autoreport_temp: bool = True, autoreport_sdstatus: bool = True, autoreport_pos: bool = True, busy_protocol: bool = True, emergency_parser: bool = True, extended_m20: bool = True, lfn_write: bool = True)
    +class octoprint.schema.config.serial.SerialCapabilities(*, autoreport_temp: bool = True, autoreport_sdstatus: bool = True, autoreport_pos: bool = True, busy_protocol: bool = True, emergency_parser: bool = True, extended_m20: bool = True, lfn_write: bool = True)
    -autoreport_pos: bool
    +autoreport_pos: bool

    Whether to enable position autoreport in the firmware if its support is detected

    -autoreport_sdstatus: bool
    +autoreport_sdstatus: bool

    Whether to enable SD printing autoreport in the firmware if its support is detected

    -autoreport_temp: bool
    +autoreport_temp: bool

    Whether to enable temperature autoreport in the firmware if its support is detected

    -busy_protocol: bool
    +busy_protocol: bool

    Whether to shorten the communication timeout if the firmware seems to support the busy protocol

    -emergency_parser: bool
    +emergency_parser: bool

    Whether to send emergency commands out of band if the firmware seems to support the emergency parser

    -extended_m20: bool
    +extended_m20: bool

    Whether to request extended M20 (file list) output from the firmware if its support is detected

    -lfn_write: bool
    +lfn_write: bool

    Whether to enable long filename support for SD card writes if the firmware reports support for it

    @@ -1476,26 +1476,26 @@
    -class octoprint.schema.config.serial.SerialConfig(*, port: Optional[str] = None, baudrate: Optional[int] = None, exclusive: bool = True, lowLatency: bool = False, autoconnect: bool = False, autorefresh: bool = True, autorefreshInterval: int = 1, log: bool = False, timeout: octoprint.schema.config.serial.SerialTimeoutConfig = SerialTimeoutConfig(detectionFirst=10.0, detectionConsecutive=2.0, connection=10.0, communication=30.0, communicationBusy=3.0, temperature=5.0, temperatureTargetSet=2.0, temperatureAutoreport=2.0, sdStatus=1.0, sdStatusAutoreport=1.0, posAutoreport=5.0, resendOk=0.5, baudrateDetectionPause=1.0, positionLogWait=10.0), maxCommunicationTimeouts: octoprint.schema.config.serial.SerialMaxTimeouts = SerialMaxTimeouts(idle=2, printing=5, long=5), maxWritePasses: int = 5, additionalPorts: List[str] = [], additionalBaudrates: List[int] = [], blacklistedPorts: List[str] = [], blacklistedBaudrates: List[int] = [], longRunningCommands: List[str] = ['G4', 'G28', 'G29', 'G30', 'G32', 'M400', 'M226', 'M600'], blockedCommands: List[str] = ['M0', 'M1'], ignoredCommands: List[str] = [], pausingCommands: List[str] = ['M0', 'M1', 'M25'], emergencyCommands: List[str] = ['M112', 'M108', 'M410'], checksumRequiringCommands: List[str] = ['M110'], helloCommand: str = 'M110 N0', disconnectOnErrors: bool = True, ignoreErrorsFromFirmware: bool = False, terminalLogSize: int = 20, lastLineBufferSize: int = 50, logResends: bool = True, supportResendsWithoutOk: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', logPositionOnPause: bool = True, logPositionOnCancel: bool = False, abortHeatupOnCancel: bool = True, waitForStartOnConnect: bool = False, waitToLoadSdFileList: bool = True, alwaysSendChecksum: bool = False, neverSendChecksum: bool = False, sendChecksumWithUnknownCommands: bool = False, unknownCommandsNeedAck: bool = False, sdRelativePath: bool = False, sdAlwaysAvailable: bool = False, sdLowerCase: bool = False, sdCancelCommand: str = 'M25', maxNotSdPrinting: int = 2, swallowOkAfterResend: bool = True, repetierTargetTemp: bool = False, externalHeatupDetection: bool = True, supportWait: bool = True, ignoreIdenticalResends: bool = False, identicalResendsCountdown: int = 7, supportFAsCommand: bool = False, firmwareDetection: bool = True, blockWhileDwelling: bool = False, useParityWorkaround: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', maxConsecutiveResends: int = 10, sendM112OnError: bool = True, disableSdPrintingDetection: bool = False, ackMax: int = 1, sanityCheckTools: bool = True, notifySuppressedCommands: octoprint.schema.config.serial.InfoWarnNeverEnum = 'warn', capabilities: octoprint.schema.config.serial.SerialCapabilities = SerialCapabilities(autoreport_temp=True, autoreport_sdstatus=True, autoreport_pos=True, busy_protocol=True, emergency_parser=True, extended_m20=True, lfn_write=True), resendRatioThreshold: int = 10, resendRatioStart: int = 100, ignoreEmptyPorts: bool = False, encoding: str = 'ascii', enableShutdownActionCommand: bool = False, triggerOkForM29: bool = True)
    +class octoprint.schema.config.serial.SerialConfig(*, port: Optional[str] = None, baudrate: Optional[int] = None, exclusive: bool = True, lowLatency: bool = False, autoconnect: bool = False, autorefresh: bool = True, autorefreshInterval: int = 1, log: bool = False, timeout: octoprint.schema.config.serial.SerialTimeoutConfig = SerialTimeoutConfig(detectionFirst=10.0, detectionConsecutive=2.0, connection=10.0, communication=30.0, communicationBusy=3.0, temperature=5.0, temperatureTargetSet=2.0, temperatureAutoreport=2.0, sdStatus=1.0, sdStatusAutoreport=1.0, posAutoreport=5.0, resendOk=0.5, baudrateDetectionPause=1.0, positionLogWait=10.0), maxCommunicationTimeouts: octoprint.schema.config.serial.SerialMaxTimeouts = SerialMaxTimeouts(idle=2, printing=5, long=5), maxWritePasses: int = 5, additionalPorts: List[str] = [], additionalBaudrates: List[int] = [], blacklistedPorts: List[str] = [], blacklistedBaudrates: List[int] = [], longRunningCommands: List[str] = ['G4', 'G28', 'G29', 'G30', 'G32', 'M400', 'M226', 'M600'], blockedCommands: List[str] = ['M0', 'M1'], ignoredCommands: List[str] = [], pausingCommands: List[str] = ['M0', 'M1', 'M25'], emergencyCommands: List[str] = ['M112', 'M108', 'M410'], checksumRequiringCommands: List[str] = ['M110'], helloCommand: str = 'M110 N0', disconnectOnErrors: bool = True, ignoreErrorsFromFirmware: bool = False, terminalLogSize: int = 20, lastLineBufferSize: int = 50, logResends: bool = True, supportResendsWithoutOk: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', logPositionOnPause: bool = True, logPositionOnCancel: bool = False, abortHeatupOnCancel: bool = True, waitForStartOnConnect: bool = False, waitToLoadSdFileList: bool = True, alwaysSendChecksum: bool = False, neverSendChecksum: bool = False, sendChecksumWithUnknownCommands: bool = False, unknownCommandsNeedAck: bool = False, sdRelativePath: bool = False, sdAlwaysAvailable: bool = False, sdLowerCase: bool = False, sdCancelCommand: str = 'M25', maxNotSdPrinting: int = 2, swallowOkAfterResend: bool = True, repetierTargetTemp: bool = False, externalHeatupDetection: bool = True, supportWait: bool = True, ignoreIdenticalResends: bool = False, identicalResendsCountdown: int = 7, supportFAsCommand: bool = False, firmwareDetection: bool = True, blockWhileDwelling: bool = False, useParityWorkaround: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', maxConsecutiveResends: int = 10, sendM112OnError: bool = True, disableSdPrintingDetection: bool = False, ackMax: int = 1, sanityCheckTools: bool = True, notifySuppressedCommands: octoprint.schema.config.serial.InfoWarnNeverEnum = 'warn', capabilities: octoprint.schema.config.serial.SerialCapabilities = SerialCapabilities(autoreport_temp=True, autoreport_sdstatus=True, autoreport_pos=True, busy_protocol=True, emergency_parser=True, extended_m20=True, lfn_write=True), resendRatioThreshold: int = 10, resendRatioStart: int = 100, ignoreEmptyPorts: bool = False, encoding: str = 'ascii', enableShutdownActionCommand: bool = False, triggerOkForM29: bool = True)
    -abortHeatupOnCancel: bool
    +abortHeatupOnCancel: bool
    -ackMax: int
    +ackMax: int
    -additionalBaudrates: List[int]
    +additionalBaudrates: List[int]

    Use this to define additional baud rates to offer for connecting to serial ports. Must be a valid integer

    -additionalPorts: List[str]
    +additionalPorts: List[str]

    //docs.python.org/3/library/glob.html)

    Type
    @@ -1506,53 +1506,53 @@
    -alwaysSendChecksum: bool
    +alwaysSendChecksum: bool

    Specifies whether OctoPrint should send linenumber + checksum with every printer command. Needed for successful communication with Repetier firmware.

    -autoconnect: bool
    +autoconnect: bool

    Whether to try to automatically connect to the printer on startup or not

    -autorefresh: bool
    +autorefresh: bool

    Whether to automatically refresh the port list while no connection is established

    -autorefreshInterval: int
    +autorefreshInterval: int

    Interval in seconds at which to refresh the port list while no connection is established

    -baudrate: Optional[int]
    +baudrate: Optional[int]

    The default baudrate to use to connect to the printer. If unset or set to 0, the baudrate will be auto-detected.

    -blacklistedBaudrates: List[int]
    +blacklistedBaudrates: List[int]
    -blacklistedPorts: List[str]
    +blacklistedPorts: List[str]
    -blockWhileDwelling: bool
    +blockWhileDwelling: bool

    Whether to block all sending to the printer while a G4 (dwell) command is active (true, repetier) or not (false).

    -blockedCommands: List[str]
    +blockedCommands: List[str]

    Commands which should not be sent to the printer, e.g. because they are known to block serial communication until physical interaction with the printer as is the case on most firmwares with the default M0 and M1.

    @@ -1563,35 +1563,35 @@
    -checksumRequiringCommands: List[str]
    +checksumRequiringCommands: List[str]

    Commands which need to always be send with a checksum.

    -disableSdPrintingDetection: bool
    +disableSdPrintingDetection: bool
    -disconnectOnErrors: bool
    +disconnectOnErrors: bool

    Whether to disconnect from the printer on errors or not.

    -emergencyCommands: List[str]
    +emergencyCommands: List[str]
    -enableShutdownActionCommand: bool
    +enableShutdownActionCommand: bool

    Whether to enable support for the shutdown action command, allowing the printer to shut down OctoPrint and the system it’s running on.

    -encoding: str
    +encoding: str

    //docs.python.org/3/library/codecs.html#standard-encodings).

    Type
    @@ -1602,65 +1602,65 @@
    -exclusive: bool
    +exclusive: bool

    Whether to request the serial port exclusively or not

    -externalHeatupDetection: bool
    +externalHeatupDetection: bool

    Whether to enable external heatup detection (to detect heatup triggered e.g. through the printer’s LCD panel or while printing from SD) or not. Causes issues with Repetier’s “first ok then response” approach to communication, so disable for printers running Repetier firmware.

    -firmwareDetection: bool
    +firmwareDetection: bool

    Whether to attempt to auto detect the firmware of the printer and adjust settings accordingly (true) or not and rely on manual configuration (false).

    -helloCommand: str
    +helloCommand: str

    Command to send in order to initiate a handshake with the printer.

    -identicalResendsCountdown: int
    +identicalResendsCountdown: int

    If ignoreIdenticalResends is true, how many consecutive identical resends to ignore.

    -ignoreEmptyPorts: bool
    +ignoreEmptyPorts: bool
    -ignoreErrorsFromFirmware: bool
    +ignoreErrorsFromFirmware: bool

    Whether to completely ignore errors from the firmware or not.

    -ignoreIdenticalResends: bool
    +ignoreIdenticalResends: bool

    Whether to ignore identical resends from the printer (true, repetier) or not (false).

    -ignoredCommands: List[str]
    +ignoredCommands: List[str]

    Commands which should not be sent to the printer and just silently ignored. An example of when you may wish to use this could be useful if you wish to manually change a filament on M600, by using that as a Pausing command.

    -lastLineBufferSize: int
    +lastLineBufferSize: int
    -log: bool
    +log: bool

    might decrease performance)

    Type
    @@ -1671,29 +1671,29 @@
    -logPositionOnCancel: bool
    +logPositionOnCancel: bool
    -logPositionOnPause: bool
    +logPositionOnPause: bool
    -logResends: bool
    +logResends: bool

    Whether to log resends to octoprint.log or not. Invaluable debug tool without performance impact, leave on if possible please.

    -longRunningCommands: List[str]
    +longRunningCommands: List[str]

    Commands which are known to take a long time to be acknowledged by the firmware, e.g. homing, dwelling, auto leveling etc.

    -lowLatency: bool
    +lowLatency: bool

    Whether to request low latency mode on the serial port or not

    @@ -1704,23 +1704,23 @@
    -maxConsecutiveResends: int
    +maxConsecutiveResends: int
    -maxNotSdPrinting: int
    +maxNotSdPrinting: int
    -maxWritePasses: int
    +maxWritePasses: int

    Maximum number of write attempts to serial during which nothing can be written before the communication with the printer is considered dead and OctoPrint will disconnect with an error

    -neverSendChecksum: bool
    +neverSendChecksum: bool
    @@ -1730,19 +1730,19 @@
    -pausingCommands: List[str]
    +pausingCommands: List[str]

    Commands which should cause OctoPrint to pause any ongoing prints.

    -port: Optional[str]
    +port: Optional[str]

    The default port to use to connect to the printer. If unset or set to AUTO, the port will be auto-detected.

    -repetierTargetTemp: bool
    +repetierTargetTemp: bool

    <temperature>` instead of attaching that information to the regular M105 responses.

    Type
    @@ -1753,56 +1753,56 @@
    -resendRatioStart: int
    +resendRatioStart: int
    -resendRatioThreshold: int
    +resendRatioThreshold: int

    Percentage of resend requests among all sent lines that should be considered critical.

    -sanityCheckTools: bool
    +sanityCheckTools: bool
    -sdAlwaysAvailable: bool
    +sdAlwaysAvailable: bool

    Whether to always assume that an SD card is present in the printer. Needed by some firmwares which don’t report the SD card status properly.

    -sdCancelCommand: str
    +sdCancelCommand: str
    -sdLowerCase: bool
    +sdLowerCase: bool
    -sdRelativePath: bool
    +sdRelativePath: bool

    Specifies whether firmware expects relative paths for selecting SD files.

    -sendChecksumWithUnknownCommands: bool
    +sendChecksumWithUnknownCommands: bool

    Specifies whether OctoPrint should also send linenumber + checksum with commands that are not detected as valid GCODE (as in, they do not match the regular expression ^s*([GM]d+|T)).

    -sendM112OnError: bool
    +sendM112OnError: bool
    -supportFAsCommand: bool
    +supportFAsCommand: bool

    Whether to support F on its own as a valid GCODE command (true) or not (false).

    @@ -1814,17 +1814,17 @@
    -supportWait: bool
    +supportWait: bool
    -swallowOkAfterResend: bool
    +swallowOkAfterResend: bool
    -terminalLogSize: int
    +terminalLogSize: int
    @@ -1835,13 +1835,13 @@
    -triggerOkForM29: bool
    +triggerOkForM29: bool

    Whether to automatically trigger an ok for M29 (a lot of versions of this command are buggy and the response skips on the ok).

    -unknownCommandsNeedAck: bool
    +unknownCommandsNeedAck: bool

    Specifies whether OctoPrint should also use up acknowledgments (ok) for commands that are not detected as valid GCODE (as in, they do not match the regular expression ^s*([GM]d+|T)).

    @@ -1852,13 +1852,13 @@
    -waitForStartOnConnect: bool
    +waitForStartOnConnect: bool

    Whether OctoPrint should wait for the start response from the printer before trying to send commands during connect.

    -waitToLoadSdFileList: bool
    +waitToLoadSdFileList: bool

    Specifies whether OctoPrint should wait to load the SD card file list until the first firmware capability report is processed.

    @@ -1866,22 +1866,22 @@
    -class octoprint.schema.config.serial.SerialMaxTimeouts(*, idle: int = 2, printing: int = 5, long: int = 5)
    +class octoprint.schema.config.serial.SerialMaxTimeouts(*, idle: int = 2, printing: int = 5, long: int = 5)
    -idle: int
    +idle: int

    Max. timeouts when the printer is idle

    -long: int
    +long: int

    Max. timeouts when a long running command is active

    -printing: int
    +printing: int

    Max. timeouts when the printer is printing

    @@ -1889,80 +1889,80 @@
    -class octoprint.schema.config.serial.SerialTimeoutConfig(*, detectionFirst: float = 10.0, detectionConsecutive: float = 2.0, connection: float = 10.0, communication: float = 30.0, communicationBusy: float = 3.0, temperature: float = 5.0, temperatureTargetSet: float = 2.0, temperatureAutoreport: float = 2.0, sdStatus: float = 1.0, sdStatusAutoreport: float = 1.0, posAutoreport: float = 5.0, resendOk: float = 0.5, baudrateDetectionPause: float = 1.0, positionLogWait: float = 10.0)
    +class octoprint.schema.config.serial.SerialTimeoutConfig(*, detectionFirst: float = 10.0, detectionConsecutive: float = 2.0, connection: float = 10.0, communication: float = 30.0, communicationBusy: float = 3.0, temperature: float = 5.0, temperatureTargetSet: float = 2.0, temperatureAutoreport: float = 2.0, sdStatus: float = 1.0, sdStatusAutoreport: float = 1.0, posAutoreport: float = 5.0, resendOk: float = 0.5, baudrateDetectionPause: float = 1.0, positionLogWait: float = 10.0)
    -baudrateDetectionPause: float
    +baudrateDetectionPause: float
    -communication: float
    +communication: float

    Timeout during serial communication, in seconds

    -communicationBusy: float
    +communicationBusy: float

    Timeout during serial communication when busy protocol support is detected, in seconds

    -connection: float
    +connection: float

    Timeout for waiting to establish a connection with the selected port, in seconds

    -detectionConsecutive: float
    +detectionConsecutive: float
    -detectionFirst: float
    +detectionFirst: float
    -posAutoreport: float
    +posAutoreport: float
    -positionLogWait: float
    +positionLogWait: float
    -resendOk: float
    +resendOk: float
    -sdStatus: float
    +sdStatus: float

    Timeout after which to query the SD status while SD printing

    -sdStatusAutoreport: float
    +sdStatusAutoreport: float
    -temperature: float
    +temperature: float

    Timeout after which to query temperature when no target is set

    -temperatureAutoreport: float
    +temperatureAutoreport: float
    -temperatureTargetSet: float
    +temperatureTargetSet: float

    Timeout after which to query temperature when a target is set

    @@ -1970,28 +1970,28 @@
    -class octoprint.schema.config.server.CommandsConfig(*, systemShutdownCommand: Optional[str] = None, systemRestartCommand: Optional[str] = None, serverRestartCommand: Optional[str] = None, localPipCommand: Optional[str] = None)
    +class octoprint.schema.config.server.CommandsConfig(*, systemShutdownCommand: Optional[str] = None, systemRestartCommand: Optional[str] = None, serverRestartCommand: Optional[str] = None, localPipCommand: Optional[str] = None)
    -localPipCommand: Optional[str]
    +localPipCommand: Optional[str]

    pip command associated with OctoPrint, used for installing plugins and updates, if unset (default) the command will be autodetected based on the current python executable - unless you have a really special setup this is the right way to do it and there should be no need to ever touch this setting.

    -serverRestartCommand: Optional[str]
    +serverRestartCommand: Optional[str]

    Command to restart OctoPrint.

    -systemRestartCommand: Optional[str]
    +systemRestartCommand: Optional[str]

    Command to restart the system OctoPrint is running on.

    -systemShutdownCommand: Optional[str]
    +systemShutdownCommand: Optional[str]

    Command to shut down the system OctoPrint is running on.

    @@ -1999,7 +1999,7 @@
    -class octoprint.schema.config.server.CookiesConfig(*, secure: bool = False, samesite: Optional[octoprint.schema.config.server.SameSiteEnum] = SameSiteEnum.lax)
    +class octoprint.schema.config.server.CookiesConfig(*, secure: bool = False, samesite: Optional[octoprint.schema.config.server.SameSiteEnum] = SameSiteEnum.lax)
    samesite: Optional[octoprint.schema.config.server.SameSiteEnum]
    @@ -2016,7 +2016,7 @@
    -secure: bool
    +secure: bool

    Whether to set the Secure flag to true on cookies. Only set to true if you are running OctoPrint behind a reverse proxy taking care of SSL termination.

    @@ -2024,16 +2024,16 @@
    -class octoprint.schema.config.server.DiskspaceConfig(*, warning: int = 524288000, critical: int = 209715200)
    +class octoprint.schema.config.server.DiskspaceConfig(*, warning: int = 524288000, critical: int = 209715200)
    -critical: int
    +critical: int

    Threshold (bytes) after which to consider disk space becoming critical, defaults to 200MB.

    -warning: int
    +warning: int

    Threshold (bytes) after which to consider disk space becoming sparse, defaults to 500MB.

    @@ -2041,16 +2041,16 @@
    -class octoprint.schema.config.server.IpCheckConfig(*, enabled: bool = True, trustedSubnets: List[str] = [])
    +class octoprint.schema.config.server.IpCheckConfig(*, enabled: bool = True, trustedSubnets: List[str] = [])
    -enabled: bool
    +enabled: bool

    Whether to enable the check.

    -trustedSubnets: List[str]
    +trustedSubnets: List[str]

    Additional non-local subnets to consider trusted, in CIDR notation, e.g. 192.168.1.0/24.

    @@ -2058,34 +2058,34 @@
    -class octoprint.schema.config.server.OnlineCheckConfig(*, enabled: Optional[bool] = None, interval: int = 900, host: str = '1.1.1.1', port: int = 53, name: str = 'octoprint.org')
    +class octoprint.schema.config.server.OnlineCheckConfig(*, enabled: Optional[bool] = None, interval: int = 900, host: str = '1.1.1.1', port: int = 53, name: str = 'octoprint.org')
    -enabled: Optional[bool]
    +enabled: Optional[bool]

    Whether the online check is enabled. Ships unset, the user will be asked to make a decision as part of the setup wizard.

    -host: str
    +host: str

    DNS host against which to check, defaults to Cloudflare’s DNS.

    -interval: int
    +interval: int

    Interval in which to check for online connectivity (in seconds), defaults to 15 minutes.

    -name: str
    +name: str

    Host name for which to check name resolution, defaults to OctoPrint’s main domain.

    -port: int
    +port: int

    DNS port against which to check, defaults to the standard DNS port.

    @@ -2093,16 +2093,16 @@
    -class octoprint.schema.config.server.PluginBlacklistConfig(*, enabled: Optional[bool] = None, url: str = 'https://plugins.octoprint.org/blacklist.json', ttl: int = 900, timeout: float = 3.05)
    +class octoprint.schema.config.server.PluginBlacklistConfig(*, enabled: Optional[bool] = None, url: str = 'https://plugins.octoprint.org/blacklist.json', ttl: int = 900, timeout: float = 3.05)
    -enabled: Optional[bool]
    +enabled: Optional[bool]

    Whether use of the blacklist is enabled. If unset, the user will be asked to make a decision as part of the setup wizard.

    -timeout: float
    +timeout: float

    3.05 seconds).

    Type
    @@ -2113,7 +2113,7 @@
    -ttl: int
    +ttl: int

    15 minutes).

    Type
    @@ -2124,7 +2124,7 @@
    -url: str
    +url: str

    The URL from which to fetch the blacklist.

    @@ -2132,16 +2132,16 @@
    -class octoprint.schema.config.server.PreemptiveCacheConfig(*, exceptions: List[str] = [], until: int = 7)
    +class octoprint.schema.config.server.PreemptiveCacheConfig(*, exceptions: List[str] = [], until: int = 7)
    -exceptions: List[str]
    +exceptions: List[str]

    Which server paths to exclude from the preemptive cache, e.g. /some/path.

    -until: int
    +until: int

    How many days to leave unused entries in the preemptive cache config.

    @@ -2149,66 +2149,66 @@
    -class octoprint.schema.config.server.ReverseProxyConfig(*, prefixHeader: Optional[str] = None, schemeHeader: Optional[str] = None, hostHeader: Optional[str] = None, serverHeader: Optional[str] = None, portHeader: Optional[str] = None, prefixFallback: Optional[str] = None, schemeFallback: Optional[str] = None, hostFallback: Optional[str] = None, serverFallback: Optional[str] = None, portFallback: Optional[str] = None, trustedDownstream: List[str] = [])
    +class octoprint.schema.config.server.ReverseProxyConfig(*, prefixHeader: Optional[str] = None, schemeHeader: Optional[str] = None, hostHeader: Optional[str] = None, serverHeader: Optional[str] = None, portHeader: Optional[str] = None, prefixFallback: Optional[str] = None, schemeFallback: Optional[str] = None, hostFallback: Optional[str] = None, serverFallback: Optional[str] = None, portFallback: Optional[str] = None, trustedDownstream: List[str] = [])
    -hostFallback: Optional[str]
    +hostFallback: Optional[str]

    Use this option to define an optional forced host under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy with a different hostname than OctoPrint itself but can’t configure said reverse proxy to send a host HTTP header (X-Forwarded-Host by default, see above) with forwarded requests.

    -hostHeader: Optional[str]
    +hostHeader: Optional[str]

    The request header from which to determine the host under which OctoPrint is served by the reverse proxy.

    -portFallback: Optional[str]
    +portFallback: Optional[str]
    -portHeader: Optional[str]
    +portHeader: Optional[str]
    -prefixFallback: Optional[str]
    +prefixFallback: Optional[str]

    Use this option to define an optional URL prefix (with a leading /, so absolute to your server’s root) under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy under a different root endpoint than / and can’t configure said reverse proxy to send a prefix HTTP header (X-Script-Name by default, see above) with forwarded requests.

    -prefixHeader: Optional[str]
    +prefixHeader: Optional[str]

    The request header from which to determine the URL prefix under which OctoPrint is served by the reverse proxy.

    -schemeFallback: Optional[str]
    +schemeFallback: Optional[str]

    Use this option to define an optional forced scheme (http or https) under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy that also does HTTPS determination but can’t configure said reverse proxy to send a scheme HTTP header (X-Scheme by default, see above) with forwarded requests.

    -schemeHeader: Optional[str]
    +schemeHeader: Optional[str]

    The request header from which to determine the scheme (http or https) under which a specific request to OctoPrint was made to the reverse proxy.

    -serverFallback: Optional[str]
    +serverFallback: Optional[str]
    -serverHeader: Optional[str]
    +serverHeader: Optional[str]
    -trustedDownstream: List[str]
    +trustedDownstream: List[str]

    List of trusted downstream servers for which to ignore the IP address when trying to determine the connecting client’s IP address. If you have OctoPrint behind more than one reverse proxy you should add their IPs here so that they won’t be interpreted as the client’s IP. One reverse proxy will be handled correctly by default.

    @@ -2240,13 +2240,13 @@ class octoprint.schema.config.server.ServerConfig(*, host: typing.Optional[str] = None, port: int = 5000, firstRun: bool = True, startOnceInSafeMode: bool = False, ignoreIncompleteStartup: bool = False, incompleteStartup: bool = False, seenWizards: typing.Dict[str, str] = {}, secretKey: typing.Optional[str] = None, heartbeat: int = 900, reverseProxy: octoprint.schema.config.server.ReverseProxyConfig = ReverseProxyConfig(prefixHeader=None, schemeHeader=None, hostHeader=None, serverHeader=None, portHeader=None, prefixFallback=None, schemeFallback=None, hostFallback=None, serverFallback=None, portFallback=None, trustedDownstream=[]), uploads: octoprint.schema.config.server.UploadsConfig = UploadsConfig(maxSize=1073741824, nameSuffix='name', pathSuffix='path'), maxSize: int = 102400, commands: octoprint.schema.config.server.CommandsConfig = CommandsConfig(systemShutdownCommand=None, systemRestartCommand=None, serverRestartCommand=None, localPipCommand=None), onlineCheck: octoprint.schema.config.server.OnlineCheckConfig = OnlineCheckConfig(enabled=None, interval=900, host='1.1.1.1', port=53, name='octoprint.org'), pluginBlacklist: octoprint.schema.config.server.PluginBlacklistConfig = PluginBlacklistConfig(enabled=None, url='https://plugins.octoprint.org/blacklist.json', ttl=900, timeout=3.05), diskspace: octoprint.schema.config.server.DiskspaceConfig = DiskspaceConfig(warning=524288000, critical=209715200), preemptiveCache: octoprint.schema.config.server.PreemptiveCacheConfig = PreemptiveCacheConfig(exceptions=[], until=7), ipCheck: octoprint.schema.config.server.IpCheckConfig = IpCheckConfig(enabled=True, trustedSubnets=[]), allowFraming: bool = False, cookies: octoprint.schema.config.server.CookiesConfig = CookiesConfig(secure=False, samesite=<SameSiteEnum.lax: 'Lax'>), allowedLoginRedirectPaths: typing.List[str] = [])
    -allowFraming: bool
    +allowFraming: bool

    Whether to allow OctoPrint to be embedded in a frame or not. Note that depending on your setup you might have to set SameSite to None, Secure to true and serve OctoPrint through a reverse proxy that enables https for cookies and thus logging in to work.

    -allowedLoginRedirectPaths: List[str]
    +allowedLoginRedirectPaths: List[str]

    List of paths that are allowed to be used as redirect targets for the login page, in addition to the default ones (/, /recovery/ and /plugin/appkeys/auth/)

    @@ -2270,30 +2270,30 @@
    -firstRun: bool
    +firstRun: bool

    If this option is true, OctoPrint will show the First Run wizard and set the setting to false after that completes.

    -heartbeat: int
    +heartbeat: int
    -host: Optional[str]
    +host: Optional[str]

    Use this option to define the host to which to bind the server. If unset, OctoPrint will attempt to bind on all available interfaces, IPv4 and v6 unless either is disabled.

    -ignoreIncompleteStartup: bool
    +ignoreIncompleteStartup: bool

    Set this to true to make OctoPrint ignore incomplete startups. Helpful for development.

    -incompleteStartup: bool
    +incompleteStartup: bool

    Signals to OctoPrint that the last startup was incomplete. OctoPrint will then startup in safe mode.

    @@ -2305,7 +2305,7 @@
    -maxSize: int
    +maxSize: int

    Maximum size of requests other than file uploads in bytes, defaults to 100KB.

    @@ -2323,7 +2323,7 @@
    -port: int
    +port: int

    Use this option to define the port to which to bind the server.

    @@ -2346,18 +2346,18 @@
    -secretKey: Optional[str]
    +secretKey: Optional[str]

    Secret key for encrypting cookies and such, randomly generated on first run.

    -seenWizards: Dict[str, str]
    +seenWizards: Dict[str, str]
    -startOnceInSafeMode: bool
    +startOnceInSafeMode: bool

    If this option is true, OctoPrint will enable safe mode on the next server start and reset the setting to false

    @@ -2371,22 +2371,22 @@
    -class octoprint.schema.config.server.UploadsConfig(*, maxSize: int = 1073741824, nameSuffix: str = 'name', pathSuffix: str = 'path')
    +class octoprint.schema.config.server.UploadsConfig(*, maxSize: int = 1073741824, nameSuffix: str = 'name', pathSuffix: str = 'path')
    -maxSize: int
    +maxSize: int

    Maximum size of uploaded files in bytes, defaults to 1GB.

    -nameSuffix: str
    +nameSuffix: str

    Suffix used for storing the filename in the file upload headers when streaming uploads.

    -pathSuffix: str
    +pathSuffix: str

    Suffix used for storing the path to the temporary file in the file upload headers when streaming uploads.

    @@ -2394,22 +2394,22 @@
    -class octoprint.schema.config.slicing.SlicingConfig(*, enabled: bool = True, defaultSlicer: Optional[str] = None, defaultProfiles: Dict[str, str] = {})
    +class octoprint.schema.config.slicing.SlicingConfig(*, enabled: bool = True, defaultSlicer: Optional[str] = None, defaultProfiles: Dict[str, str] = {})
    -defaultProfiles: Dict[str, str]
    +defaultProfiles: Dict[str, str]

    Default slicing profiles per slicer, maps slicer identifier to profile identifier.

    -defaultSlicer: Optional[str]
    +defaultSlicer: Optional[str]

    Default slicer to use.

    -enabled: bool
    +enabled: bool

    Whether to enable slicing support or not.

    @@ -2417,34 +2417,34 @@
    -class octoprint.schema.config.system.ActionConfig(*, action: str, name: Optional[str] = None, command: Optional[str] = None, confirm: Optional[str] = None, **extra_data: Any)
    +class octoprint.schema.config.system.ActionConfig(*, action: str, name: Optional[str] = None, command: Optional[str] = None, confirm: Optional[str] = None, **extra_data: Any)
    -action: str
    +action: str

    The identifier used internally to identify the action. Set to divider to generate a divider in the menu.

    -async_: bool
    +async_: bool

    Whether to run the command asynchronously.

    -command: Optional[str]
    +command: Optional[str]

    The command to execute when the action is selected. Must be set if the action is not a divider.

    -confirm: Optional[str]
    +confirm: Optional[str]

    An optional confirmation message to show before executing the command.

    -name: Optional[str]
    +name: Optional[str]

    The name of the action that will be shown on the menu. Must be set if the action is not a divider.

    @@ -2452,7 +2452,7 @@
    -class octoprint.schema.config.system.SystemConfig(*, actions: List[octoprint.schema.config.system.ActionConfig] = [])
    +class octoprint.schema.config.system.SystemConfig(*, actions: List[octoprint.schema.config.system.ActionConfig] = [])
    actions: List[octoprint.schema.config.system.ActionConfig]
    @@ -2463,10 +2463,10 @@
    -class octoprint.schema.config.temperature.TemperatureConfig(*, profiles: List[octoprint.schema.config.temperature.TemperatureProfile] = [TemperatureProfile(name='ABS', extruder=210, bed=100), TemperatureProfile(name='PLA', extruder=180, bed=60)], cutoff: int = 30, sendAutomatically: bool = False, sendAutomaticallyAfter: int = 1)
    +class octoprint.schema.config.temperature.TemperatureConfig(*, profiles: List[octoprint.schema.config.temperature.TemperatureProfile] = [TemperatureProfile(name='ABS', extruder=210, bed=100), TemperatureProfile(name='PLA', extruder=180, bed=60)], cutoff: int = 30, sendAutomatically: bool = False, sendAutomaticallyAfter: int = 1)
    -cutoff: int
    +cutoff: int

    Cut off time for the temperature data, in minutes.

    @@ -2478,13 +2478,13 @@
    -sendAutomatically: bool
    +sendAutomatically: bool

    Whether to send new temperature settings made in the UI automatically.

    -sendAutomaticallyAfter: int
    +sendAutomaticallyAfter: int

    After what time to send the new temperature settings automatically, in seconds.

    @@ -2492,22 +2492,22 @@
    -class octoprint.schema.config.temperature.TemperatureProfile(*, name: str, extruder: int, bed: int)
    +class octoprint.schema.config.temperature.TemperatureProfile(*, name: str, extruder: int, bed: int)
    -bed: int
    +bed: int

    Bed temperature to set with the profile.

    -extruder: int
    +extruder: int

    Hotend temperature to set with the profile.

    -name: str
    +name: str

    Name of the profile.

    @@ -2515,16 +2515,16 @@
    -class octoprint.schema.config.terminalfilters.TerminalFilterEntry(*, name: str, regex: str)
    +class octoprint.schema.config.terminalfilters.TerminalFilterEntry(*, name: str, regex: str)
    -name: str
    +name: str

    The name of the filter.

    -regex: str
    +regex: str

    //developer.mozilla.org/en/docs/Web/JavaScript/Guide/Regular_Expressions).

    Type
    @@ -2537,10 +2537,10 @@
    -class octoprint.schema.config.webcam.TimelapseConfig(*, type: octoprint.schema.config.webcam.TimelapseTypeEnum = TimelapseTypeEnum.off, fps: int = 25, postRoll: int = 0, options: octoprint.schema.config.webcam.TimelapseOptions = TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None))
    +class octoprint.schema.config.webcam.TimelapseConfig(*, type: octoprint.schema.config.webcam.TimelapseTypeEnum = TimelapseTypeEnum.off, fps: int = 25, postRoll: int = 0, options: octoprint.schema.config.webcam.TimelapseOptions = TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None))
    -fps: int
    +fps: int

    The framerate at which to render the movie.

    @@ -2552,7 +2552,7 @@
    -postRoll: int
    +postRoll: int

    The number of seconds in the rendered video to add after a finished print. The exact way how the additional images will be recorded depends on timelapse type. zchange timelapses will take one final picture and add it fps * postRoll times. timed timelapses continue to record just like at the beginning, so the recording will continue another fps * postRoll * interval seconds. This behaviour can be overridden by setting the capturePostRoll option to false, in which case the post roll will be created identically to zchange mode.

    @@ -2566,10 +2566,10 @@
    -class octoprint.schema.config.webcam.TimelapseOptions(*, interval: Optional[int] = None, capturePostRoll: Optional[bool] = None, retractionZHop: Optional[float] = None)
    +class octoprint.schema.config.webcam.TimelapseOptions(*, interval: Optional[int] = None, capturePostRoll: Optional[bool] = None, retractionZHop: Optional[float] = None)
    -capturePostRoll: Optional[bool]
    +capturePostRoll: Optional[bool]

    Whether to capture the snapshots for the post roll (true) or just copy the last captured snapshot from the print over and over again (false).

    Type
    @@ -2580,7 +2580,7 @@
    -interval: Optional[int]
    +interval: Optional[int]

    The interval which to leave between images in seconds.

    Type
    @@ -2591,7 +2591,7 @@
    -retractionZHop: Optional[float]
    +retractionZHop: Optional[float]

    z-hop height during retractions to ignore for capturing snapshots.

    Type
    @@ -2628,53 +2628,53 @@ class octoprint.schema.config.webcam.WebcamConfig(*, webcamEnabled: bool = True, timelapseEnabled: bool = True, ffmpeg: typing.Optional[str] = None, ffmpegThreads: int = 1, ffmpegVideoCodec: str = 'libx264', bitrate: str = '10000k', watermark: bool = True, ffmpegCommandline: str = '{ffmpeg} -framerate {fps} -i "{input}" -vcodec {videocodec} -threads {threads} -b:v {bitrate} -f {containerformat} -y {filters} "{output}"', ffmpegThumbnailCommandline: str = '{ffmpeg} -sseof -1 -i "{input}" -update 1 -q:v 0.7 "{output}"', timelapse: octoprint.schema.config.webcam.TimelapseConfig = TimelapseConfig(type=<TimelapseTypeEnum.off: 'off'>, fps=25, postRoll=0, options=TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None)), cleanTmpAfterDays: int = 7, defaultWebcam: str = 'classic', snapshotWebcam: str = 'classic')
    -bitrate: str
    +bitrate: str

    The bitrate to use for rendering the timelapse video. This gets directly passed to ffmpeg.

    -cleanTmpAfterDays: int
    +cleanTmpAfterDays: int

    After how many days unrendered timelapses will be deleted.

    -defaultWebcam: str
    +defaultWebcam: str

    The name of the default webcam

    -ffmpeg: Optional[str]
    +ffmpeg: Optional[str]

    Path to ffmpeg binary to use for creating timelapse recordings. Timelapse support will be disabled if not set.

    -ffmpegCommandline: str
    +ffmpegCommandline: str
    -ffmpegThreads: int
    +ffmpegThreads: int

    Number of how many threads to instruct ffmpeg to use for encoding.

    -ffmpegThumbnailCommandline: str
    +ffmpegThumbnailCommandline: str
    -ffmpegVideoCodec: str
    +ffmpegVideoCodec: str

    Videocodec to be used for encoding.

    -snapshotWebcam: str
    +snapshotWebcam: str

    The name of the default webcam to use for snapshots

    @@ -2686,19 +2686,19 @@
    -timelapseEnabled: bool
    +timelapseEnabled: bool

    Use this option to enable timelapse support via snapshot, e.g. via MJPG-Streamer. Timelapse support will be disabled if not set.

    -watermark: bool
    +watermark: bool

    Whether to include a “created with OctoPrint” watermark in the generated timelapse recordings.

    -webcamEnabled: bool
    +webcamEnabled: bool

    Use this option to enable display of a webcam stream in the UI, e.g. via MJPG-Streamer. Webcam support will be disabled if not set.

    @@ -2725,10 +2725,10 @@
    -class octoprint.schema.webcam.Webcam(*, name: str, displayName: str, canSnapshot: bool = False, snapshotDisplay: str = None, flipH: bool = False, flipV: bool = False, rotate90: bool = False, extras: dict = {}, compat: Optional[octoprint.schema.webcam.WebcamCompatibility] = None)
    +class octoprint.schema.webcam.Webcam(*, name: str, displayName: str, canSnapshot: bool = False, snapshotDisplay: str = None, flipH: bool = False, flipV: bool = False, rotate90: bool = False, extras: dict = {}, compat: Optional[octoprint.schema.webcam.WebcamCompatibility] = None)
    -canSnapshot: bool
    +canSnapshot: bool

    Whether this webcam can take a snapshot.

    @@ -2740,43 +2740,43 @@
    -displayName: str
    +displayName: str

    Displayable name for this webcam

    -extras: dict
    +extras: dict

    Unstructured data describing this webcam

    -flipH: bool
    +flipH: bool

    Whether to flip the webcam horizontally.

    -flipV: bool
    +flipV: bool

    Whether to flip the webcam vertically.

    -name: str
    +name: str

    Identifier of this webcam

    -rotate90: bool
    +rotate90: bool

    Whether to rotate the webcam 90° counter clockwise.

    -snapshotDisplay: str
    +snapshotDisplay: str

    Human readable information about how a snapshot is captured or a HTTP URL from which the snapshot is loaded (optional, only for user reference)

    @@ -2784,34 +2784,34 @@
    -class octoprint.schema.webcam.WebcamCompatibility(*, streamTimeout: int = 5, streamRatio: octoprint.schema.webcam.RatioEnum = RatioEnum.sixteen_nine, streamWebrtcIceServers: List[str] = ['stun:stun.l.google.com:19302'], cacheBuster: bool = False, stream: str, snapshot: str = None, snapshotTimeout: int = 5, snapshotSslValidation: bool = True)
    +class octoprint.schema.webcam.WebcamCompatibility(*, streamTimeout: int = 5, streamRatio: octoprint.schema.webcam.RatioEnum = RatioEnum.sixteen_nine, streamWebrtcIceServers: List[str] = ['stun:stun.l.google.com:19302'], cacheBuster: bool = False, stream: str, snapshot: str = None, snapshotTimeout: int = 5, snapshotSslValidation: bool = True)
    -cacheBuster: bool
    +cacheBuster: bool

    Whether the the URL should be randomized to bust caches

    -snapshot: str
    +snapshot: str

    The URL to get the snapshot from

    -snapshotSslValidation: bool
    +snapshotSslValidation: bool

    Whether to validate SSL certificates when retrieving a snapshot

    -snapshotTimeout: int
    +snapshotTimeout: int

    The timeout when retrieving snapshots

    -stream: str
    +stream: str

    The URL to get an MJPEG stream from

    @@ -2823,13 +2823,13 @@
    -streamTimeout: int
    +streamTimeout: int

    The timeout of the stream in seconds

    -streamWebrtcIceServers: List[str]
    +streamWebrtcIceServers: List[str]

    The WebRTC STUN and TURN servers

    @@ -2865,13 +2865,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/modules/server.html b/1.9.3/modules/server.html similarity index 96% rename from 1.9.2/modules/server.html rename to 1.9.3/modules/server.html index 8e57fcd83..c21c9789a 100644 --- a/1.9.2/modules/server.html +++ b/1.9.3/modules/server.html @@ -4,7 +4,7 @@ - octoprint.server — OctoPrint 1.9.2 documentation + octoprint.server — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -293,8 +293,8 @@
    Parameters
      -

    • url (str) – URL to validate

      • -

    • allowed_paths (List[str]) – List of allowed paths, only paths contained +

    • url (str) – URL to validate

      • +

    • allowed_paths (List[str]) – List of allowed paths, only paths contained or prefixed (if allowed path ends with “*”) will be considered valid.

    @@ -302,7 +302,7 @@

    Whether the url passed validation or not.

    Return type
    -

    bool

    +

    bool

    @@ -405,7 +405,7 @@
    property cookies
    -

    A dict with the contents of all cookies transmitted with +

    A dict with the contents of all cookies transmitted with the request.

    @@ -425,7 +425,7 @@
    -class octoprint.server.util.flask.OctoPrintFlaskResponse(response: Optional[Union[Iterable[bytes], bytes, Iterable[str], str]] = None, status: Optional[Union[int, str, http.HTTPStatus]] = None, headers: Optional[Union[Mapping[str, Union[str, int, Iterable[Union[str, int]]]], Iterable[Tuple[str, Union[str, int]]]]] = None, mimetype: Optional[str] = None, content_type: Optional[str] = None, direct_passthrough: bool = False)
    +class octoprint.server.util.flask.OctoPrintFlaskResponse(response: Optional[Union[Iterable[bytes], bytes, Iterable[str], str]] = None, status: Optional[Union[int, str, http.HTTPStatus]] = None, headers: Optional[Union[Mapping[str, Union[str, int, Iterable[Union[str, int]]]], Iterable[Tuple[str, Union[str, int]]]]] = None, mimetype: Optional[str] = None, content_type: Optional[str] = None, direct_passthrough: bool = False)
    @@ -487,16 +487,16 @@ class octoprint.server.util.flask.OctoPrintJsonProvider(app: Flask)
    -dumps(obj: Any, **kwargs: Any) → str
    +dumps(obj: Any, **kwargs: Any) → str

    Serialize data as JSON to a string.

    -

    Keyword arguments are passed to json.dumps(). Sets some +

    Keyword arguments are passed to json.dumps(). Sets some parameter defaults from the default, ensure_ascii, and sort_keys attributes.

    Parameters
    @@ -591,7 +591,7 @@
    -octoprint.server.util.flask.check_lastmodified(lastmodified: Union[int, float, datetime.datetime]) → bool
    +octoprint.server.util.flask.check_lastmodified(lastmodified: Union[int, float, datetime.datetime]) → bool

    Compares the provided lastmodified value with the value of the If-Modified-Since header.

    If lastmodified is an int or float, it’s assumed to be a Unix timestamp and converted to a timezone aware datetime instance in UTC.

    @@ -599,16 +599,16 @@ result will always be False.

    Parameters
    -

    lastmodified (Union[int, float, datetime]) – The last modified value to compare against

    +

    lastmodified (Union[int, float, datetime]) – The last modified value to compare against

    Raises
    -

    ValueError – If anything but an int, float or datetime instance is passed

    +

    ValueError – If anything but an int, float or datetime instance is passed

    Returns

    true if the values indicate that the document is still up to date

    Return type
    -

    bool

    +

    bool

    @@ -764,7 +764,7 @@

    octoprint.server.util.tornado

    -class octoprint.server.util.tornado.CorsSupportMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.CorsSupportMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    tornado.web.RequestHandler mixin that makes sure to set CORS headers similarly to the Flask backed API endpoints.

    @@ -796,7 +796,7 @@
    -class octoprint.server.util.tornado.CustomHTTP1ServerConnection(stream: tornado.iostream.IOStream, params: Optional[tornado.http1connection.HTTP1ConnectionParameters] = None, context: Optional[object] = None)
    +class octoprint.server.util.tornado.CustomHTTP1ServerConnection(stream: tornado.iostream.IOStream, params: Optional[tornado.http1connection.HTTP1ConnectionParameters] = None, context: Optional[object] = None)

    A custom implementation of tornado.http1connection.HTTP1ServerConnection which utilizes a CustomHTTP1Connection instead of a tornado.http1connection.HTTP1Connection in _server_request_loop. The implementation logic is otherwise the same as tornado.http1connection.HTTP1ServerConnection.

    @@ -804,7 +804,7 @@
    -class octoprint.server.util.tornado.CustomHTTPServer(*args: Any, **kwargs: Any)
    +class octoprint.server.util.tornado.CustomHTTPServer(*args: Any, **kwargs: Any)

    Custom implementation of tornado.httpserver.HTTPServer that allows defining max body sizes depending on path and method.

    The implementation is mostly taken from tornado.httpserver.HTTPServer, the only difference is the creation @@ -835,19 +835,19 @@

    -class octoprint.server.util.tornado.DeprecatedEndpointHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.DeprecatedEndpointHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    tornado.web.RequestHandler that redirects to another url and logs a deprecation warning.

    Parameters
    -

    url (str) – URL to which to redirect

    +

    url (str) – URL to which to redirect

    -class octoprint.server.util.tornado.DynamicZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.DynamicZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    @@ -857,21 +857,21 @@
    -class octoprint.server.util.tornado.LargeResponseHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.LargeResponseHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    Customized tornado.web.StaticFileHandler that allows delivery of the requested resource as attachment and access and request path validation through optional callbacks. Note that access validation takes place before path validation.

    Parameters
      -

    • path (str) – The system path from which to serve files (this will be forwarded to the initialize method of +

    • path (str) – The system path from which to serve files (this will be forwarded to the initialize method of :class:~tornado.web.StaticFileHandler)

      • -

    • default_filename (str) – The default filename to serve if none is explicitly specified and the request references +

    • default_filename (str) – The default filename to serve if none is explicitly specified and the request references a subdirectory of the served path (this will be forwarded to the initialize method of :class:~tornado.web.StaticFileHandler as the default_filename keyword parameter). Defaults to None.

      • -

    • as_attachment (bool) – Whether to serve requested files with Content-Disposition: attachment header (True) +

    • as_attachment (bool) – Whether to serve requested files with Content-Disposition: attachment header (True) or not. Defaults to False.

      • -

    • allow_client_caching (bool) – Whether to allow the client to cache (by not setting any Cache-Control or +

    • allow_client_caching (bool) – Whether to allow the client to cache (by not setting any Cache-Control or Expires headers on the response) or not.

    • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise @@ -889,7 +889,7 @@ called with the requested path as parameter.

    • mime_type_guesser (function) – Callback to guess the mime type to use for the content type encoding of the response. Will be called with the requested path on disk as parameter.

      • -

    • is_pre_compressed (bool) – if the file is expected to be pre-compressed, i.e, if there is a file in the same +

    • is_pre_compressed (bool) – if the file is expected to be pre-compressed, i.e, if there is a file in the same directory with the same name, but with ‘.gz’ appended and gzip-encoded

    @@ -946,7 +946,7 @@
    -class octoprint.server.util.tornado.RequestlessExceptionLoggingMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.RequestlessExceptionLoggingMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    log_exception(typ, value, tb, *args, **kwargs)
    @@ -964,14 +964,14 @@
    -class octoprint.server.util.tornado.StaticDataHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.StaticDataHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    tornado.web.RequestHandler that returns static data of a configured content_type.

    Parameters
      -

    • data (str) – The data with which to respond

      • -

    • content_type (str) – The content type with which to respond. Defaults to text/plain

      • +

    • data (str) – The data with which to respond

      • +

    • content_type (str) – The content type with which to respond. Defaults to text/plain

    @@ -979,17 +979,17 @@
    -class octoprint.server.util.tornado.StaticZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.StaticZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    -class octoprint.server.util.tornado.SystemInfoBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.SystemInfoBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    -class octoprint.server.util.tornado.UploadStorageFallbackHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.UploadStorageFallbackHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    A RequestHandler similar to tornado.web.FallbackHandler which fetches any files contained in the request bodies of content type multipart, stores them in temporary files and supplies the fallback with the file’s name, content_type, path and size instead via a rewritten body.

    @@ -1131,7 +1131,7 @@
    -class octoprint.server.util.tornado.UrlProxyHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.UrlProxyHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    tornado.web.RequestHandler that proxies requests to a preconfigured url and returns the response. Allows delivery of the requested content as attachment and access validation through an optional callback.

    @@ -1150,10 +1150,10 @@
    Parameters
      -

    • url (str) – URL to forward any requests to. A 404 response will be returned if this is not set. Defaults to None.

      • -

    • as_attachment (bool) – Whether to serve files with Content-Disposition: attachment header (True) +

    • url (str) – URL to forward any requests to. A 404 response will be returned if this is not set. Defaults to None.

      • +

    • as_attachment (bool) – Whether to serve files with Content-Disposition: attachment header (True) or not. Defaults to False.

      • -

    • basename (str) – base name of file names to return as part of the attachment header, see above. Defaults to None.

      • +

    • basename (str) – base name of file names to return as part of the attachment header, see above. Defaults to None.

    • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise a tornado.web.HTTPError if access is not allowed in which case the request will not be further processed. @@ -1276,13 +1276,13 @@

      Other Versions - v: 1.9.2 + v: 1.9.3
      Tags
      -
      1.9.2
      +
      1.9.3
      1.8.7
      diff --git a/1.9.2/modules/settings.html b/1.9.3/modules/settings.html similarity index 98% rename from 1.9.2/modules/settings.html rename to 1.9.3/modules/settings.html index 1dd8cf8eb..f72402f3f 100644 --- a/1.9.2/modules/settings.html +++ b/1.9.3/modules/settings.html @@ -4,7 +4,7 @@ - octoprint.settings — OctoPrint 1.9.2 documentation + octoprint.settings — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
      - 1.9.2 + 1.9.3
      @@ -173,15 +173,15 @@
      Parameters

      • init (boolean) – A flag indicating whether this is the initial call to construct the singleton (True) or not -(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError +(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError will be raised. The same will happen if the plugin manager has not yet been initialized and this is set to False.

        • -

      • basedir (str) – Path of the base directory for all of OctoPrint’s settings, log files, uploads etc. If not set +

      • basedir (str) – Path of the base directory for all of OctoPrint’s settings, log files, uploads etc. If not set the default will be used: ~/.octoprint on Linux, %APPDATA%/OctoPrint on Windows and ~/Library/Application Support/OctoPrint on MacOS.

        • -

      • configfile (str) – Path of the configuration file (config.yaml) to work on. If not set the default will +

      • configfile (str) – Path of the configuration file (config.yaml) to work on. If not set the default will be used: <basedir>/config.yaml for basedir as defined above.

        • -

      • overlays (list) – List of paths to config overlays to put between default settings and config.yaml

        • +

      • overlays (list) – List of paths to config overlays to put between default settings and config.yaml

      Returns
      @@ -191,7 +191,7 @@

      Settings

      Raises
      -

      ValueError – init is True but settings are already initialized or vice versa.

      +

      ValueError – init is True but settings are already initialized or vice versa.

    @@ -488,13 +488,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/modules/slicing.html b/1.9.3/modules/slicing.html similarity index 95% rename from 1.9.2/modules/slicing.html rename to 1.9.3/modules/slicing.html index ad99c9e3f..a0bdb1cb5 100644 --- a/1.9.2/modules/slicing.html +++ b/1.9.3/modules/slicing.html @@ -4,7 +4,7 @@ - octoprint.slicing — OctoPrint 1.9.2 documentation + octoprint.slicing — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -156,12 +156,12 @@
    Parameters
      -

    • slicer (str) – Identifier of the slicer this profile belongs to.

      • -

    • name (str) – Identifier of this slicing profile.

      • -

    • data (object) – Profile data, actual structure depends on individual slicer implementation.

      • -

    • display_name (str) – Displayable name for this slicing profile.

      • -

    • description (str) – Description of this slicing profile.

      • -

    • default (bool) – Whether this is the default slicing profile for the slicer.

      • +

    • slicer (str) – Identifier of the slicer this profile belongs to.

      • +

    • name (str) – Identifier of this slicing profile.

      • +

    • data (object) – Profile data, actual structure depends on individual slicer implementation.

      • +

    • display_name (str) – Displayable name for this slicing profile.

      • +

    • description (str) – Description of this slicing profile.

      • +

    • default (bool) – Whether this is the default slicing profile for the slicer.

    @@ -186,7 +186,7 @@ supplied overrides. This will be called according to the method signature of save_slicer_profile().

  • profile (SlicingProfile) – The profile from which to derive the temporary profile.

    • -

  • overrides (dict) – Optional overrides to apply to the profile for creation of the temporary profile.

    • +

  • overrides (dict) – Optional overrides to apply to the profile for creation of the temporary profile.

    • @@ -199,7 +199,7 @@
    Parameters
      -

    • profile_path (str) – Absolute path to the base folder where all slicing profiles are stored.

      • +

    • profile_path (str) – Absolute path to the base folder where all slicing profiles are stored.

    • printer_profile_manager (PrinterProfileManager) – PrinterProfileManager instance to use for accessing available printer profiles, most importantly the currently selected one.

    @@ -214,7 +214,7 @@
    Parameters
      -

    • slicer (str) – Identifier of the slicer for which to retrieve all slicer profiles

      • +

    • slicer (str) – Identifier of the slicer for which to retrieve all slicer profiles

    • require_configured (boolean) – Whether to require the slicer slicer to be already configured (True) or not (False, default). If False and the slicer is not yet configured, a SlicerNotConfigured exception will be raised.

      • @@ -242,9 +242,9 @@
      Parameters
        -

      • slicer_name (str) – Identifier of the slicer on which to cancel the job.

        • -

      • source_path (str) – The absolute path to the source file being sliced.

        • -

      • dest_path (str) – The absolute path to the destination file being sliced to.

        • +

      • slicer_name (str) – Identifier of the slicer on which to cancel the job.

        • +

      • source_path (str) – The absolute path to the source file being sliced.

        • +

      • dest_path (str) – The absolute path to the destination file being sliced to.

      Raises
      @@ -283,8 +283,8 @@
      Parameters
        -

      • slicer (str) – Identifier of the slicer for which to delete the profile.

        • -

      • name (str) – Identifier of the profile to delete.

        • +

      • slicer (str) – Identifier of the slicer for which to delete the profile.

        • +

      • name (str) – Identifier of the profile to delete.

      Raises
      @@ -305,8 +305,8 @@
      Parameters
        -

      • slicer (str) – Identifier of the slicer to which the profile belongs to.

        • -

      • name (str) – Identifier of the profile for which to retrieve the path.

        • +

      • slicer (str) – Identifier of the slicer to which the profile belongs to.

        • +

      • name (str) – Identifier of the profile for which to retrieve the path.

      • must_exist (boolean) – Whether the path must exist (True) or not (False, default).

      @@ -314,7 +314,7 @@

      The absolute path to the profile identified by name for slicer slicer.

      Return type
      -

      str

      +

      str

      Raises
        @@ -333,7 +333,7 @@
        Parameters
          -

        • slicer (str) – Identifier of the slicer to return

          • +

        • slicer (str) – Identifier of the slicer to return

        • require_configured (boolean) – Whether to raise an exception if the slicer has not been configured yet (True, the default), or also return an unconfigured slicer (False).

        @@ -353,13 +353,13 @@

        Retrieves the path where the profiles for slicer slicer are stored.

        Parameters
        -

        slicer (str) – Identifier of the slicer for which to retrieve the path.

        +

        slicer (str) – Identifier of the slicer for which to retrieve the path.

        Returns

        The absolute path to the folder where the slicer’s profiles are stored.

        Return type
        -

        str

        +

        str

        Raises

        UnknownSlicer – The slicer slicer is unknown.

        @@ -378,7 +378,7 @@
        load_profile(slicer, name, require_configured=True)

        Loads the slicing profile for slicer with the given profile name and returns it. If it can’t be loaded -due to an IOError None will be returned instead.

        +due to an IOError None will be returned instead.

        If require_configured is True (the default) a SlicerNotConfigured exception will be raised if the indicated slicer has not yet been configured.

        @@ -405,7 +405,7 @@

        Retrieves the last modification date of slicer’s profiles.

        Parameters
        -

        slicer (str) – the slicer for which to retrieve the last modification date

        +

        slicer (str) – the slicer for which to retrieve the last modification date

        Returns

        (float) the time stamp of the last modification of the slicer’s profiles

        @@ -431,11 +431,11 @@
        save_profile(slicer, name, profile, overrides=None, allow_overwrite=True, display_name=None, description=None)

        Saves the slicer profile profile for slicer slicer under name name.

        -

        profile may be either a SlicingProfile or a dict.

        +

        profile may be either a SlicingProfile or a dict.

        If it’s a SlicingProfile, its slicer`, name and - if provided - display_name and description attributes will be overwritten with the supplied values.

        -

        If it’s a dict, a new SlicingProfile instance will be created with the supplied meta data and +

        If it’s a dict, a new SlicingProfile instance will be created with the supplied meta data and the profile data as the data attribute.

        Note

        @@ -444,15 +444,15 @@
        Parameters
          -

        • slicer (str) – Identifier of the slicer for which to save the profile.

          • -

        • name (str) – Identifier under which to save the profile.

          • -

        • profile (SlicingProfile or dict) – The SlicingProfile or a dict containing the profile +

        • slicer (str) – Identifier of the slicer for which to save the profile.

          • +

        • name (str) – Identifier under which to save the profile.

          • +

        • profile (SlicingProfile or dict) – The SlicingProfile or a dict containing the profile data of the profile the save.

          • -

        • overrides (dict) – Overrides to apply to the profile before saving it.

          • +

        • overrides (dict) – Overrides to apply to the profile before saving it.

        • allow_overwrite (boolean) – If True (default) if a profile for the same slicer of the same name already exists, it will be overwritten. Otherwise an exception will be thrown.

          • -

        • display_name (str) – The name to display to the user for the profile.

          • -

        • description (str) – A description of the profile.

          • +

        • display_name (str) – The name to display to the user for the profile.

          • +

        • description (str) – A description of the profile.

        Returns
        @@ -463,7 +463,7 @@
        Raises
          -

        • ValueError – The supplied profile is neither a SlicingProfile nor a dict.

          • +

        • ValueError – The supplied profile is neither a SlicingProfile nor a dict.

        • UnknownSlicer – The slicer slicer is unknown.

        • ProfileAlreadyExists – A profile with name name already exists for slicer and allow_overwrite is False.

          • @@ -479,14 +479,14 @@
          Parameters
            -

          • slicer (str) – Identifier of the slicer for which to set the default +

          • slicer (str) – Identifier of the slicer for which to set the default profile.

            • -

          • name (str) – Identifier of the profile to set as default.

            • -

          • require_configured (bool) – Whether the slicer needs to be configured +

          • name (str) – Identifier of the profile to set as default.

            • +

          • require_configured (bool) – Whether the slicer needs to be configured for the action to succeed. Defaults to false. Will raise a SlicerNotConfigured error if true and the slicer has not been configured yet.

            • -

          • require_exists (bool) – Whether the profile is required to exist in +

          • require_exists (bool) – Whether the profile is required to exist in order to be set as default. Defaults to true. Will raise a UnknownProfile error if true and the profile is unknown.

          @@ -537,24 +537,24 @@
          Parameters
            -

          • slicer_name (str) – The identifier of the slicer to use for slicing.

            • -

          • source_path (str) – The absolute path to the source file to slice.

            • -

          • dest_path (str) – The absolute path to the destination file to slice to.

            • -

          • profile_name (str) – The name of the slicing profile to use.

            • +

          • slicer_name (str) – The identifier of the slicer to use for slicing.

            • +

          • source_path (str) – The absolute path to the source file to slice.

            • +

          • dest_path (str) – The absolute path to the destination file to slice to.

            • +

          • profile_name (str) – The name of the slicing profile to use.

          • callback (callable) – A callback to call after slicing has finished.

            • -

          • callback_args (list or tuple) – Arguments of the callback to call after slicing has finished. Defaults to +

          • callback_args (list or tuple) – Arguments of the callback to call after slicing has finished. Defaults to an empty list.

            • -

          • callback_kwargs (dict) – Keyword arguments for the callback to call after slicing has finished, will be +

          • callback_kwargs (dict) – Keyword arguments for the callback to call after slicing has finished, will be extended by _analysis, _error or _cancelled as described above! Defaults to an empty dictionary.

            • -

          • overrides (dict) – Overrides for the printer profile to apply.

            • +

          • overrides (dict) – Overrides for the printer profile to apply.

          • on_progress (callable) – Callback to call upon slicing progress.

            • -

          • on_progress_args (list or tuple) – Arguments of the progress callback. Defaults to an empty list.

            • -

          • on_progress_kwargs (dict) – Keyword arguments of the progress callback, will be extended by _progress +

          • on_progress_args (list or tuple) – Arguments of the progress callback. Defaults to an empty list.

            • +

          • on_progress_kwargs (dict) – Keyword arguments of the progress callback, will be extended by _progress as described above! Defaults to an empty dictionary.

            • -

          • printer_profile_id (str) – Identifier of the printer profile for which to slice, if another than the +

          • printer_profile_id (str) – Identifier of the printer profile for which to slice, if another than the one currently selected is to be used.

            • -

          • position (dict) – Dictionary containing the x and y coordinate in the print bed’s coordinate system +

          • position (dict) – Dictionary containing the x and y coordinate in the print bed’s coordinate system of the sliced model’s center. If not provided the model will be positioned at the print bed’s center. Example: dict(x=10,y=20).

          @@ -683,13 +683,13 @@
          Other Versions - v: 1.9.2 + v: 1.9.3
          Tags
          -
          1.9.2
          +
          1.9.3
          1.8.7
          diff --git a/1.9.2/modules/util.html b/1.9.3/modules/util.html similarity index 94% rename from 1.9.2/modules/util.html rename to 1.9.3/modules/util.html index 88bd0dba2..79a3f8e16 100644 --- a/1.9.2/modules/util.html +++ b/1.9.3/modules/util.html @@ -4,7 +4,7 @@ - octoprint.util — OctoPrint 1.9.2 documentation + octoprint.util — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
          - 1.9.2 + 1.9.3
          @@ -176,7 +176,7 @@
          class octoprint.util.RepeatedTimer(interval, function, args=None, kwargs=None, run_first=False, condition=None, on_condition_false=None, on_cancelled=None, on_finish=None, daemon=True)

          This class represents an action that should be run repeatedly in an interval. It is similar to python’s -own threading.Timer class, but instead of only running once the function will be run again and again, +own threading.Timer class, but instead of only running once the function will be run again and again, sleeping the stated interval in between.

          RepeatedTimers are started, as with threads, by calling their start() method. The timer can be stopped (in between runs) by calling the cancel() method. The interval the time waited before execution of a loop may @@ -218,11 +218,11 @@

          Parameters
            -

          • interval (float or callable) – The interval between each function call, in seconds. Can also be a callable +

          • interval (float or callable) – The interval between each function call, in seconds. Can also be a callable returning the interval to use, in case the interval is not static.

          • function (callable) – The function to call.

            • -

          • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

            • -

          • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

            • +

          • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

            • +

          • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

          • run_first (boolean) – If set to True, the function will be run for the first time before the first wait period. If set to False (the default), the function will be run for the first time after the first wait period.

          • condition (callable) – Condition that needs to be True for loop to continue. Defaults to lambda: True.

            • @@ -232,7 +232,7 @@ before the on_finish callback.

          • on_finish (callable) – Callback to call when the timer finishes, either due to being cancelled or since the condition became false.

            • -

          • daemon (bool) – daemon flag to set on underlying thread.

            • +

          • daemon (bool) – daemon flag to set on underlying thread.

          @@ -252,7 +252,7 @@
          class octoprint.util.ResettableTimer(interval, function, args=None, kwargs=None, on_reset=None, on_cancelled=None, daemon=True)

          This class represents an action that should be run after a specified amount of time. It is similar to python’s -own threading.Timer class, with the addition of being able to reset the counter to zero.

          +own threading.Timer class, with the addition of being able to reset the counter to zero.

          ResettableTimers are started, as with threads, by calling their start() method. The timer can be stopped (in between runs) by calling the cancel() method. Resetting the counter can be done with the reset() method.

          For example:

          @@ -270,14 +270,14 @@
          Parameters
            -

          • interval (float or callable) – The interval before calling function, in seconds. Can also be a callable +

          • interval (float or callable) – The interval before calling function, in seconds. Can also be a callable returning the interval to use, in case the interval is not static.

          • function (callable) – The function to call.

            • -

          • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

            • -

          • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

            • +

          • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

            • +

          • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

          • on_cancelled (callable) – Callback to call when the timer finishes due to being cancelled.

          • on_reset (callable) – Callback to call when the timer is reset.

            • -

          • daemon (bool) – daemon flag to set on underlying thread.

            • +

          • daemon (bool) – daemon flag to set on underlying thread.

          @@ -354,7 +354,7 @@
          Parameters

          • message (string) – The message to include in the deprecation warning.

            • -

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

            • @@ -382,8 +382,8 @@
            Parameters
              -

            • filename (str) – The file to deserialize from

              • -

            • encoding (str) – The encoding to use for the file, defaults to utf-8

              • +

            • filename (str) – The file to deserialize from

              • +

            • encoding (str) – The encoding to use for the file, defaults to utf-8

            Returns
            @@ -410,8 +410,8 @@
            Parameters
              -

            • a (dict) – The dictionary to clean against b.

              • -

            • b (dict) – The dictionary containing the key structure to clean from a.

              • +

            • a (dict) – The dictionary to clean against b.

              • +

            • b (dict) – The dictionary containing the key structure to clean from a.

            @@ -438,8 +438,8 @@
            Parameters
              -

            • a (dict) – The dictionary to check for the keys from b.

              • -

            • b (dict) – The dictionary whose keys to check a for.

              • +

            • a (dict) – The dictionary to check for the keys from b.

              • +

            • b (dict) – The dictionary whose keys to check a for.

            Returns
            @@ -480,7 +480,7 @@
            Parameters
              -

            • dictionary (dict) – The dictionary to filter

              • +

            • dictionary (dict) – The dictionary to filter

            • filter_function (callable) – The filter function to apply, called with key and value of an entry in the dictionary, must return True for values to keep and False for values to strip

              • @@ -494,7 +494,7 @@

            Return type
            -

            dict

            +

            dict

          @@ -566,8 +566,8 @@
          Parameters
            -

          • a (dict) – The dictionary to merge b into

            • -

          • b (dict) – The dictionary to merge into a

            • +

          • a (dict) – The dictionary to merge b into

            • +

          • b (dict) – The dictionary to merge into a

          • leaf_merger (callable) – An optional callable to use to merge leaves (non-dict values)

          • in_place (boolean) – If set to True, a will be merged with b in place, meaning a will be modified

          @@ -576,7 +576,7 @@

          b deep-merged into a

          Return type
          -

          dict

          +

          dict

          @@ -599,8 +599,8 @@
          Parameters
            -

          • source (dict) – Source dictionary

            • -

          • target (dict) – Dictionary to compare to source dictionary and derive diff for

            • +

          • source (dict) – Source dictionary

            • +

          • target (dict) – Dictionary to compare to source dictionary and derive diff for

          Returns
          @@ -611,7 +611,7 @@

          Return type
          -

          dict

          +

          dict

        @@ -634,8 +634,8 @@
        Parameters
          -

        • a (dict) – The dictionary to clean against b.

          • -

        • b (dict) – The dictionary containing the key structure to clean from a.

          • +

        • a (dict) – The dictionary to clean against b.

          • +

        • b (dict) – The dictionary containing the key structure to clean from a.

        @@ -710,10 +710,10 @@

        The class if it could be found.

        Return type
        -

        type

        +

        type

        Raises
        -

        ImportError –

        +

        ImportError –

        @@ -739,7 +739,7 @@

        Formats a datetime instance as “YYYY-mm-dd HH:MM” and returns the resulting string.

        Parameters
        -

        d (datetime.datetime) – The datetime instance to format

        +

        d (datetime.datetime) – The datetime instance to format

        Returns

        The datetime formatted as “YYYY-mm-dd HH:MM”

        @@ -758,7 +758,7 @@

        Based on http://stackoverflow.com/a/1094933/2028598

        Parameters
        -

        num (int) – The byte count to format

        +

        num (int) – The byte count to format

        Returns

        The formatted byte count.

        @@ -775,7 +775,7 @@

        Formats a timedelta instance as “HH:MM:ss” and returns the resulting string.

        Parameters
        -

        d (datetime.timedelta) – The timedelta instance to format

        +

        d (datetime.timedelta) – The timedelta instance to format

        Returns

        The timedelta formatted as “HH:MM:ss”

        @@ -809,7 +809,7 @@
        Parameters

        • filename (string) – The file name to check against the extensions.

          • -

        • extensions (list) – The extensions to check against, a list of strings

          • +

        • extensions (list) – The extensions to check against, a list of strings

        Returns
        @@ -833,7 +833,7 @@
        Parameters

        • message (string) – The message to include in the deprecation warning.

          • -

        • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

        • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

          • @@ -889,10 +889,10 @@
          Parameters
            -

          • filename (str) – The file to write to

            • -

          • data (object) – The data to serialize

            • -

          • encoding (str) – The encoding to use for the file

            • -

          • compressed (bool) – Whether to compress the data before writing it to the file

            • +

          • filename (str) – The file to write to

            • +

          • data (object) – The data to serialize

            • +

          • encoding (str) – The encoding to use for the file

            • +

          • compressed (bool) – Whether to compress the data before writing it to the file

          @@ -900,28 +900,28 @@
          -octoprint.util.to_bytes(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes
          +octoprint.util.to_bytes(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes

          Make sure s_or_u is a byte string.

          Parameters
          Returns

          converted bytes.

          Return type
          -

          bytes

          +

          bytes

          -octoprint.util.to_native_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str
          +octoprint.util.to_native_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str

          Deprecated since version 1.8.0: to_native_str is no longer needed, use to_unicode instead

          @@ -929,7 +929,7 @@
          -octoprint.util.to_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes
          +octoprint.util.to_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes

          Deprecated since version 1.3.11: to_str has been renamed to to_bytes and in a future version will become the new to_unicode

          @@ -937,21 +937,21 @@
          -octoprint.util.to_unicode(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str
          +octoprint.util.to_unicode(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str

          Make sure s_or_u is a string (str).

          Parameters
          Returns

          converted string.

          Return type
          -

          str

          +

          str

          @@ -966,7 +966,7 @@
          Parameters

          • message (string) – The message to include in the deprecation warning.

            • -

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

            • @@ -992,7 +992,7 @@
            Parameters

            • message (string) – The message to include in the deprecation warning.

              • -

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

              • @@ -1053,13 +1053,13 @@
    -call(command: Union[str, List[str], Tuple[str]], delimiter: bytes = b'\n', buffer_size: int = - 1, logged: bool = True, **kwargs) → Tuple[Optional[int], List[str], List[str]]
    +call(command: Union[str, List[str], Tuple[str]], delimiter: bytes = b'\n', buffer_size: int = - 1, logged: bool = True, **kwargs) → Tuple[Optional[int], List[str], List[str]]

    Calls a command

    Parameters
      -

    • command (list, tuple or str) – command to call

      • -

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, +

    • command (list, tuple or str) – command to call

      • +

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, stdout and stderr will be overwritten)

    @@ -1071,13 +1071,13 @@
    -checked_call(command: Union[str, List[str], Tuple[str]], **kwargs) → Tuple[int, List[str], List[str]]
    +checked_call(command: Union[str, List[str], Tuple[str]], **kwargs) → Tuple[int, List[str], List[str]]

    Calls a command and raises an error if it doesn’t return with return code 0

    Parameters
      -

    • command (list, tuple or str) – command to call

      • -

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, +

    • command (list, tuple or str) – command to call

      • +

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, stdout and stderr will be overwritten)

    @@ -1117,9 +1117,9 @@
    Parameters
      -

    • returncode (int) – the return code of the command

      • -

    • stdout (str) – the stdout output produced by the command

      • -

    • stderr (str) – the stderr output produced by the command

      • +

    • returncode (int) – the return code of the command

      • +

    • stdout (str) – the stdout output produced by the command

      • +

    • stderr (str) – the stderr output produced by the command

    @@ -1132,7 +1132,7 @@
    -octoprint.util.commandline.clean_ansi(line: Union[str, bytes]) → Union[str, bytes]
    +octoprint.util.commandline.clean_ansi(line: Union[str, bytes]) → Union[str, bytes]

    Removes ANSI control codes from line.

    Note: This function also still supports an input of bytes, leading to an output of bytes. This if for reasons of backwards compatibility only, @@ -1140,7 +1140,7 @@ a future version of OctoPrint. A warning will be logged.

    Parameters
    -

    line (str or bytes) – the line to process

    +

    line (str or bytes) – the line to process

    Returns

    (str or bytes) The line without any ANSI control codes

    @@ -1224,13 +1224,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/concepts.html b/1.9.3/plugins/concepts.html similarity index 98% rename from 1.9.2/plugins/concepts.html rename to 1.9.3/plugins/concepts.html index da98f2c9d..eec81bb85 100644 --- a/1.9.2/plugins/concepts.html +++ b/1.9.3/plugins/concepts.html @@ -4,7 +4,7 @@ - General Concepts — OctoPrint 1.9.2 documentation + General Concepts — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -132,7 +132,7 @@

    General Concepts

    -

    OctoPrint’s plugins are Python Packages which in their +

    OctoPrint’s plugins are Python Packages which in their top-level module define a bunch of control properties defining metadata (like name, version etc of the plugin) as well as information on how to initialize the plugin and into what parts of the system the plugin will actually plug in to perform its job.

    @@ -203,13 +203,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/controlproperties.html b/1.9.3/plugins/controlproperties.html similarity index 99% rename from 1.9.2/plugins/controlproperties.html rename to 1.9.3/plugins/controlproperties.html index 4e4b6419a..02c527777 100644 --- a/1.9.2/plugins/controlproperties.html +++ b/1.9.3/plugins/controlproperties.html @@ -4,7 +4,7 @@ - Control Properties — OctoPrint 1.9.2 documentation + Control Properties — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -293,13 +293,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/distributing.html b/1.9.3/plugins/distributing.html similarity index 98% rename from 1.9.2/plugins/distributing.html rename to 1.9.3/plugins/distributing.html index ea45df23e..97d9ba304 100644 --- a/1.9.2/plugins/distributing.html +++ b/1.9.3/plugins/distributing.html @@ -4,7 +4,7 @@ - Distributing your plugin — OctoPrint 1.9.2 documentation + Distributing your plugin — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -235,13 +235,13 @@

    Version management after the official plu
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/gettingstarted.html b/1.9.3/plugins/gettingstarted.html similarity index 99% rename from 1.9.2/plugins/gettingstarted.html rename to 1.9.3/plugins/gettingstarted.html index d5052e2d1..c7c1c89e2 100644 --- a/1.9.2/plugins/gettingstarted.html +++ b/1.9.3/plugins/gettingstarted.html @@ -4,7 +4,7 @@ - Plugin Tutorial — OctoPrint 1.9.2 documentation + Plugin Tutorial — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -248,7 +248,7 @@ up and ready to serve requests.

    You’ll also note that we are using self._logger for logging. Where did that one come from? OctoPrint’s plugin system injects a some useful objects into our plugin implementation classes, -one of those being a fully instantiated python logger ready to be +one of those being a fully instantiated python logger ready to be used by your plugin. As you can see in the log output above, that logger uses the namespace octoprint.plugins.helloworld for our little plugin here, or more generally octoprint.plugins.<plugin identifier>.

    @@ -1108,13 +1108,13 @@

    Where do we go from here? Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/helpers.html b/1.9.3/plugins/helpers.html similarity index 98% rename from 1.9.2/plugins/helpers.html rename to 1.9.3/plugins/helpers.html index 6636bd706..622525374 100644 --- a/1.9.2/plugins/helpers.html +++ b/1.9.3/plugins/helpers.html @@ -4,7 +4,7 @@ - Helpers — OctoPrint 1.9.2 documentation + Helpers — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -223,13 +223,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/hooks.html b/1.9.3/plugins/hooks.html similarity index 98% rename from 1.9.2/plugins/hooks.html rename to 1.9.3/plugins/hooks.html index 4dbbbcbe0..04315f076 100644 --- a/1.9.2/plugins/hooks.html +++ b/1.9.3/plugins/hooks.html @@ -4,7 +4,7 @@ - Hooks — OctoPrint 1.9.2 documentation + Hooks — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -575,7 +575,7 @@
    Parameters
      -

    • components (dict) – System components to use for user manager instance initialization

      • +

    • components (dict) – System components to use for user manager instance initialization

    • settings (SettingsManager) – The global settings manager instance to fetch configuration values from if necessary

    @@ -626,7 +626,7 @@
    Parameters
    -

    apikey (str) – The API key to validate

    +

    apikey (str) – The API key to validate

    Returns

    The user in whose name the request will be processed further

    @@ -788,7 +788,7 @@ OctoPrint’s CLI.

    Return type
    -

    list

    +

    list

    @@ -822,9 +822,9 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • firmware_name (str) – The parsed name of the firmware

      • -

    • firmware_data (dict) – All data contained in the M115 report

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • firmware_name (str) – The parsed name of the firmware

      • +

    • firmware_data (dict) – All data contained in the M115 report

    @@ -853,10 +853,10 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • capability (str) – The name of the parsed capability

      • -

    • enabled (bool) – Whether the capability is reported as enabled or disabled

      • -

    • already_defined (dict) – Already defined capabilities (capability name mapped to enabled flag)

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • capability (str) – The name of the parsed capability

      • +

    • enabled (bool) – Whether the capability is reported as enabled or disabled

      • +

    • already_defined (dict) – Already defined capabilities (capability name mapped to enabled flag)

    @@ -883,8 +883,8 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • firmware_capabilities (dict) – Reported capabilities (capability name mapped to enabled flag)

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • firmware_capabilities (dict) – Reported capabilities (capability name mapped to enabled flag)

    @@ -942,13 +942,13 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • line (str) – The complete line as received from the printer, format // action:<command>

      • -

    • action (str) – The parsed out action command incl. parameters, so for a line like // action:some_command key value this will be +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • line (str) – The complete line as received from the printer, format // action:<command>

      • +

    • action (str) – The parsed out action command incl. parameters, so for a line like // action:some_command key value this will be some_command key value

      • -

    • name (str) – The action command name, for a line like // action:some_command key value this will be +

    • name (str) – The action command name, for a line like // action:some_command key value this will be some_command

      • -

    • params (str) – The action command’s parameter, for a line like // action:some_command key value this will +

    • params (str) – The action command’s parameter, for a line like // action:some_command key value this will be key value

    @@ -1015,11 +1015,11 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • phase (str) – The current phase in the command progression, either queuing or sending. Will always +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • phase (str) – The current phase in the command progression, either queuing or sending. Will always match the <phase> of the hook.

      • -

    • cmd (str) – The @ command without the leading @

      • -

    • parameters (str) – Any parameters provided to the @ command. If none were provided this will be an empty string.

      • +

    • cmd (str) – The @ command without the leading @

      • +

    • parameters (str) – Any parameters provided to the @ command. If none were provided this will be an empty string.

    @@ -1198,15 +1198,15 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • phase (str) – The current phase in the command progression, either queuing, queued, sending or +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • phase (str) – The current phase in the command progression, either queuing, queued, sending or sent. Will always match the <phase> of the hook.

      • -

    • cmd (str) – The GCODE command for which the hook was triggered. This is the full command as taken either +

    • cmd (str) – The GCODE command for which the hook was triggered. This is the full command as taken either from the currently streamed GCODE file or via other means (e.g. user input our status polling).

      • -

    • cmd_type (str) – Type of command, e.g. temperature_poll for temperature polling or sd_status_poll for SD +

    • cmd_type (str) – Type of command, e.g. temperature_poll for temperature polling or sd_status_poll for SD printing status polling.

      • -

    • gcode (str) – Parsed GCODE command, e.g. G0 or M110, may also be None if no known command could be parsed

      • -

    • subcode (str) – Parsed subcode of the GCODE command, e.g. 1 for M80.1. Will be None if no subcode was provided +

    • gcode (str) – Parsed GCODE command, e.g. G0 or M110, may also be None if no known command could be parsed

      • +

    • subcode (str) – Parsed subcode of the GCODE command, e.g. 1 for M80.1. Will be None if no subcode was provided or no command could be parsed.

    • tags – Tags attached to the command

    @@ -1269,14 +1269,14 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • line (str) – The line received from the printer.

      • +

    • line (str) – The line received from the printer.

    Returns

    The received line or in any case, a modified version of it.

    Return type
    -

    str

    +

    str

    @@ -1329,14 +1329,14 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • error_message (str) – The error message received from the printer.

      • +

    • error_message (str) – The error message received from the printer.

    Returns

    True if the error was handled in the plugin and should not be processed further, False (or None) otherwise.

    Return type
    -

    bool

    +

    bool

    @@ -1408,15 +1408,15 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • script_type (str) – The type of the script for which the hook was called, currently only “gcode” is supported here.

      • -

    • script_name (str) – The name of the script for which the hook was called.

      • +

    • script_type (str) – The type of the script for which the hook was called, currently only “gcode” is supported here.

      • +

    • script_name (str) – The name of the script for which the hook was called.

    Returns

    A 2-tuple in the form (prefix, postfix), 3-tuple in the form (prefix, postfix, variables), or None

    Return type
    -

    tuple or None

    +

    tuple or None

    @@ -1482,13 +1482,13 @@

    For an example of use see the bundled virtual_printer plugin.

    Parameters
    -

    candidates (list) – The port names already found on the system available for connection.

    +

    candidates (list) – The port names already found on the system available for connection.

    Returns

    Additional port names to offer up for connection.

    Return type
    -

    list

    +

    list

    @@ -1559,11 +1559,11 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • port (str) – The port for which to construct a serial instance. May be None or AUTO in which case port +

    • port (str) – The port for which to construct a serial instance. May be None or AUTO in which case port auto detection is to be performed.

      • -

    • baudrate (int) – The baudrate for which to construct a serial instance. May be 0 in which case baudrate auto +

    • baudrate (int) – The baudrate for which to construct a serial instance. May be 0 in which case baudrate auto detection is to be performed.

      • -

    • read_timeout (int) – The read timeout to set on the serial port.

      • +

    • read_timeout (int) – The read timeout to set on the serial port.

    Returns
    @@ -1602,7 +1602,7 @@

    A list of custom events to register

    Return type
    -

    list

    +

    list

    @@ -1641,7 +1641,7 @@

    A dictionary of analysis queue factories, mapped by their targeted file type.

    Return type
    -

    dict

    +

    dict

    @@ -1680,7 +1680,7 @@

    The partial extension tree to merge with the full extension tree.

    Return type
    -

    dict

    +

    dict

    @@ -1743,11 +1743,11 @@
    Parameters
      -

    • path (str) – The path on storage the file_object is to be stored

      • +

    • path (str) – The path on storage the file_object is to be stored

    • file_object (AbstractFileWrapper) – The AbstractFileWrapper instance representing the file object to store.

      • -

    • links (dict) – The links that are going to be stored with the file.

      • -

    • printer_profile (dict) – The printer profile associated with the file.

      • +

    • links (dict) – The links that are going to be stored with the file.

      • +

    • printer_profile (dict) – The printer profile associated with the file.

    • allow_overwrite (boolean) – Whether to allow overwriting an existing file named the same or not.

    @@ -1838,7 +1838,7 @@

    Additional data to include

    Return type
    -

    dict

    +

    dict

    @@ -1873,7 +1873,7 @@ class will be instantiated.

    Parameters
    -

    components (dict) – System components to use for printer instance initialization

    +

    components (dict) – System components to use for printer instance initialization

    Returns

    The printer instance to use globally.

    @@ -2030,9 +2030,9 @@
    Parameters
      -

    • printer (object) – the PrinterInterface instance the hook was called from

      • -

    • filename (str) – filename on the local storage

      • -

    • path (str) – path of the file in the local file system

      • +

    • printer (object) – the PrinterInterface instance the hook was called from

      • +

    • filename (str) – filename on the local storage

      • +

    • path (str) – path of the file in the local file system

    • sd_upload_started (function) – callback for when the upload started

    • sd_upload_success (function) – callback for successful finish of upload

    • sd_upload_failure (function) – callback for failure of upload

      • @@ -2178,13 +2178,13 @@
    Parameters
    -

    current_max_body_sizes (list) – read-only list of the currently configured maximum body sizes

    +

    current_max_body_sizes (list) – read-only list of the currently configured maximum body sizes

    Returns

    A list of 3-tuples with additional request specific maximum body sizes as defined above

    Return type
    -

    list

    +

    list

    @@ -2281,13 +2281,13 @@
    Parameters
    -

    server_routes (list) – read-only list of the currently configured server routes

    +

    server_routes (list) – read-only list of the currently configured server routes

    Returns

    a list of 3-tuples with additional routes as defined above

    Return type
    -

    list

    +

    list

    @@ -2305,8 +2305,8 @@
    Parameters
      -

    • socket (object) – the socket object which is about to be registered

      • -

    • user (object) – the user that got authenticated on the socket, or None if the user got deauthenticated

      • +

    • socket (object) – the socket object which is about to be registered

      • +

    • user (object) – the user that got authenticated on the socket, or None if the user got deauthenticated

    @@ -2327,8 +2327,8 @@
    Parameters
      -

    • socket (object) – the socket object which is about to be registered

      • -

    • user (object) – the user currently authenticated on the socket - might be None

      • +

    • socket (object) – the socket object which is about to be registered

      • +

    • user (object) – the user currently authenticated on the socket - might be None

    Returns
    @@ -2354,10 +2354,10 @@
    Parameters
      -

    • socket (object) – the socket object on which a message is about to be emitted

      • -

    • user (object) – the user currently authenticated on the socket - might be None

      • +

    • socket (object) – the socket object on which a message is about to be emitted

      • +

    • user (object) – the user currently authenticated on the socket - might be None

    • message (string) – the message type about to be emitted

      • -

    • payload (dict) – the payload of the message about to be emitted (may be None)

      • +

    • payload (dict) – the payload of the message about to be emitted (may be None)

    Returns
    @@ -2458,7 +2458,7 @@

    a list of command specifications

    Return type
    -

    list

    +

    list

    @@ -2492,7 +2492,7 @@

    a dictionary mapping bundle file names to bundle file content

    Return type
    -

    dict

    +

    dict

    @@ -2523,7 +2523,7 @@

    a list of additional file extensions

    Return type
    -

    list

    +

    list

    @@ -2699,15 +2699,15 @@
    Parameters
      -

    • template_rules (dict) – read-only dictionary of currently configured template rules

      • -

    • template_sorting (dict) – read-only dictionary of currently configured template sorting specifications

      • +

    • template_rules (dict) – read-only dictionary of currently configured template rules

      • +

    • template_sorting (dict) – read-only dictionary of currently configured template sorting specifications

    Returns

    a list of 3-tuples (template type, rule, sorting spec)

    Return type
    -

    list

    +

    list

    @@ -2765,7 +2765,7 @@

    filename will be the future path of the frame to be saved.

    Parameters
    -

    filename (str) – The future path of the frame to be saved.

    +

    filename (str) – The future path of the frame to be saved.

    Returns

    None

    @@ -2791,7 +2791,7 @@
    Parameters
      -

    • filename (str) – The path of the frame that should have been saved.

      • +

    • filename (str) – The path of the frame that should have been saved.

    • success (boolean) – Indicates whether the capture was successful or not.

    @@ -2836,13 +2836,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/index.html b/1.9.3/plugins/index.html similarity index 99% rename from 1.9.2/plugins/index.html rename to 1.9.3/plugins/index.html index 5d60be2db..257ddee45 100644 --- a/1.9.2/plugins/index.html +++ b/1.9.3/plugins/index.html @@ -4,7 +4,7 @@ - Developing Plugins — OctoPrint 1.9.2 documentation + Developing Plugins — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -290,13 +290,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/injectedproperties.html b/1.9.3/plugins/injectedproperties.html similarity index 98% rename from 1.9.2/plugins/injectedproperties.html rename to 1.9.3/plugins/injectedproperties.html index a42482ac8..78ef23554 100644 --- a/1.9.2/plugins/injectedproperties.html +++ b/1.9.3/plugins/injectedproperties.html @@ -4,7 +4,7 @@ - Injected Properties — OctoPrint 1.9.2 documentation + Injected Properties — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -147,7 +147,7 @@ data files etc). Plugins should not access this property directly but instead utilize get_plugin_data_folder() which will make sure the path actually does exist and if not create it before returning it.

    -
    self._logger

    A logging.Logger instance logging to the log target +

    self._logger

    A logging.Logger instance logging to the log target octoprint.plugin.<plugin identifier>.

    self._settings

    The plugin’s personalized settings manager, injected only into plugins that include the SettingsPlugin mixin. @@ -211,13 +211,13 @@

    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/mixins.html b/1.9.3/plugins/mixins.html similarity index 99% rename from 1.9.2/plugins/mixins.html rename to 1.9.3/plugins/mixins.html index 22738b390..1dcb90a2c 100644 --- a/1.9.2/plugins/mixins.html +++ b/1.9.3/plugins/mixins.html @@ -4,7 +4,7 @@ - Mixins — OctoPrint 1.9.2 documentation + Mixins — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -623,9 +623,9 @@
    Parameters
      -

    • event (str) – The type of event that got fired, see the list of events +

    • event (str) – The type of event that got fired, see the list of events for possible values

      • -

    • payload (dict) – The payload as provided with the event

      • +

    • payload (dict) – The payload as provided with the event

    @@ -651,7 +651,7 @@

    • storage (string) – Location of the file

    • path (string) – Path of the file

      • -

    • progress (int) – Current progress as a value between 0 and 100

      • +

    • progress (int) – Current progress as a value between 0 and 100

    @@ -669,7 +669,7 @@

  • source_path (string) – Path of the source file

  • destination_location (string) – Location the destination file

  • destination_path (string) – Path of the destination file

    • -

  • progress (int) – Current progress as a value between 0 and 100

    • +

  • progress (int) – Current progress as a value between 0 and 100

    • @@ -803,7 +803,7 @@ getters, the second the preprocessors for setters

    Return type
    -

    (dict, dict)

    +

    (dict, dict)

    @@ -895,7 +895,7 @@ plugin’s configuration.

    Return type
    -

    int or None

    +

    int or None

    @@ -961,9 +961,9 @@
    Parameters
      -

    • target (int) – The settings format version the plugin requires, this should always be the same value as +

    • target (int) – The settings format version the plugin requires, this should always be the same value as returned by get_settings_version().

      • -

    • current (int or None) – The settings format version as currently stored in config.yaml. May be None if +

    • current (int or None) – The settings format version as currently stored in config.yaml. May be None if no version information can be found.

    @@ -987,13 +987,13 @@
    Parameters
    -

    data (dict) – The settings dictionary to be saved for the plugin

    +

    data (dict) – The settings dictionary to be saved for the plugin

    Returns

    The settings that differed from the defaults and were actually saved.

    Return type
    -

    dict

    +

    dict

    @@ -1133,7 +1133,7 @@
    Parameters

    • command (string) – the command with which the resource was called

      • -

    • data (dict) – the full request body of the POST request parsed from JSON into a Python dictionary

      • +

    • data (dict) – the full request body of the POST request parsed from JSON into a Python dictionary

    Returns
    @@ -1179,7 +1179,7 @@

    Cancels the slicing to the indicated file.

    Parameters
    -

    machinecode_path (str) – The absolute path to the machine code file to which to stop slicing to.

    +

    machinecode_path (str) – The absolute path to the machine code file to which to stop slicing to.

    @@ -1212,7 +1212,7 @@ should make sure to track the started jobs via the machinecode_path, if provided.

    The method should return a 2-tuple consisting of a boolean flag indicating whether the slicing job was finished successfully (True) or not (False) and a result depending on the success of the slicing job.

    -

    For jobs that finished successfully, result should be a dict containing additional information +

    For jobs that finished successfully, result should be a dict containing additional information about the slicing job under the following keys:

    analysis

    Analysis result of the generated machine code as returned by the slicer itself. This should match the @@ -1220,7 +1220,7 @@ GcodeAnalysisQueue for GCODE files.

    -

    For jobs that did not finish successfully (but not due to being cancelled!), result should be a str +

    For jobs that did not finish successfully (but not due to being cancelled!), result should be a str containing a human readable reason for the error.

    If the job gets cancelled, a SlicingCancelled exception should be raised.

    @@ -1228,7 +1228,7 @@

    A 2-tuple (boolean, object) as outlined above.

    Return type
    -

    tuple

    +

    tuple

    Raises

    SlicingCancelled – The slicing job was cancelled (via cancel_slicing()).

    @@ -1275,7 +1275,7 @@ indicated path.

    Parameters
    -

    path (str) – The absolute path from which to read the slicing profile.

    +

    path (str) – The absolute path from which to read the slicing profile.

    Returns

    The specified slicing profile.

    @@ -1295,7 +1295,7 @@ of the plugin implementation.

    Parameters
    -

    profile_path (str) – The base folder where OctoPrint stores this slicer plugin’s profiles

    +

    profile_path (str) – The base folder where OctoPrint stores this slicer plugin’s profiles

    @@ -1342,7 +1342,7 @@

    A dict describing the slicer as outlined above.

    Return type
    -

    dict

    +

    dict

    @@ -1361,16 +1361,16 @@ save_slicer_profile(path, profile, allow_overwrite=True, overrides=None)

    Should save the provided SlicingProfile to the indicated path, after applying any supplied overrides. If a profile is already saved under the indicated path and allow_overwrite is -set to False (defaults to True), an IOError should be raised.

    +set to False (defaults to True), an IOError should be raised.

    Parameters
      -

    • path (str) – The absolute path to which to save the profile.

      • +

    • path (str) – The absolute path to which to save the profile.

    • profile (SlicingProfile) – The profile to save.

    • allow_overwrite (boolean) – Whether to allow to overwrite an existing profile at the indicated path (True, default) or not (False). If a profile already exists on the path and this is False an -IOError should be raised.

      • -

    • overrides (dict) – Profile overrides to apply to the profile before saving it

      • +IOError should be raised.

      +

    • overrides (dict) – Profile overrides to apply to the profile before saving it

    @@ -1418,7 +1418,7 @@
    Parameters

    • host (string) – the host the server will listen on, may be 0.0.0.0

      • -

    • port (int) – the port the server will listen on

      • +

    • port (int) – the port the server will listen on

    @@ -1917,13 +1917,13 @@ via the parameter default_additional).

    Parameters
    -

    default_additional (list) – The list of default fields added to the ETag of the default UI

    +

    default_additional (list) – The list of default fields added to the ETag of the default UI

    Returns

    A list of additional fields for the ETag generation, or None

    Return type
    -

    (list)

    +

    (list)

    @@ -1945,7 +1945,7 @@

    Return type
    -

    list, tuple

    +

    list, tuple

    @@ -1970,7 +1970,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -1993,7 +1993,7 @@

    Return type
    -

    list

    +

    list

    @@ -2011,7 +2011,7 @@

    An alternatively calculated ETag value. Ignored if None is returned (default).

    Return type
    -

    str

    +

    str

    @@ -2029,7 +2029,7 @@

    An alternatively calculated LastModified value. Ignored if None is returned (default).

    Return type
    -

    int

    +

    int

    @@ -2074,7 +2074,7 @@

    Return type
    -

    list

    +

    list

    @@ -2092,7 +2092,7 @@

    Additional data to persist in the preemptive cache configuration.

    Return type
    -

    dict

    +

    dict

    @@ -2130,7 +2130,7 @@

    Whether to suppress a record (True) or not (False, default)

    Return type
    -

    bool

    +

    bool

    @@ -2149,7 +2149,7 @@

    Whether to enable preemptive caching (True, default) or not (False)

    Return type
    -

    bool

    +

    bool

    @@ -2250,12 +2250,12 @@
    Parameters
      -

    • now (datetime.datetime) – The datetime instance representing “now” +

    • now (datetime.datetime) – The datetime instance representing “now” for this request, in case your plugin implementation needs this information.

    • request (flask.Request) –

      A Flask Request object.

      • -

    • render_kwargs (dict) – The (cached) render keyword arguments that +

    • render_kwargs (dict) – The (cached) render keyword arguments that would usually be provided to the core UI render function.

    @@ -2298,7 +2298,7 @@

    Return type
    -

    bool

    +

    bool

    @@ -2428,7 +2428,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -2454,7 +2454,7 @@

    Return type
    -

    int or None

    +

    int or None

    @@ -2486,11 +2486,11 @@
    Parameters
      -

    • seen_wizards (dict) – A dictionary with information about already seen +

    • seen_wizards (dict) – A dictionary with information about already seen wizards and their versions. Mappings from the identifiers of the plugin providing the wizard to the reported wizard version (int or None) that was already seen by the user.

      • -

    • implementation (object) – The plugin implementation to check.

      • +

    • implementation (object) – The plugin implementation to check.

    Returns
    @@ -2501,7 +2501,7 @@

    Return type
    -

    bool

    +

    bool

    @@ -2530,7 +2530,7 @@

    Use this to do any clean up tasks necessary after wizard completion.

    Parameters
    -

    handled (bool) – True if the plugin’s wizard was previously reported as +

    handled (bool) – True if the plugin’s wizard was previously reported as required, not ignored and thus presented to the user, False otherwise

    @@ -2571,13 +2571,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/python3_migration.html b/1.9.3/plugins/python3_migration.html similarity index 99% rename from 1.9.2/plugins/python3_migration.html rename to 1.9.3/plugins/python3_migration.html index 5909f71b9..4023a95fe 100644 --- a/1.9.2/plugins/python3_migration.html +++ b/1.9.3/plugins/python3_migration.html @@ -4,7 +4,7 @@ - Migrating to Python 3 — OctoPrint 1.9.2 documentation + Migrating to Python 3 — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -479,13 +479,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/plugins/viewmodels.html b/1.9.3/plugins/viewmodels.html similarity index 99% rename from 1.9.2/plugins/viewmodels.html rename to 1.9.3/plugins/viewmodels.html index f885c7473..3e4b73d79 100644 --- a/1.9.2/plugins/viewmodels.html +++ b/1.9.3/plugins/viewmodels.html @@ -4,7 +4,7 @@ - Viewmodels — OctoPrint 1.9.2 documentation + Viewmodels — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -579,13 +579,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/py-modindex.html b/1.9.3/py-modindex.html similarity index 98% rename from 1.9.2/py-modindex.html rename to 1.9.3/py-modindex.html index ad5e41ba7..c4d434448 100644 --- a/1.9.2/py-modindex.html +++ b/1.9.3/py-modindex.html @@ -3,7 +3,7 @@ - Python Module Index — OctoPrint 1.9.2 documentation + Python Module Index — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -403,13 +403,13 @@

    Python Module Index

    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/search.html b/1.9.3/search.html similarity index 96% rename from 1.9.2/search.html rename to 1.9.3/search.html index d09711bdf..169b31fdd 100644 --- a/1.9.2/search.html +++ b/1.9.3/search.html @@ -3,7 +3,7 @@ - Search — OctoPrint 1.9.2 documentation + Search — OctoPrint 1.9.3 documentation @@ -37,7 +37,7 @@ OctoPrint
    - 1.9.2 + 1.9.3
    @@ -148,13 +148,13 @@
    Other Versions - v: 1.9.2 + v: 1.9.3
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/1.9.2/searchindex.js b/1.9.3/searchindex.js similarity index 100% rename from 1.9.2/searchindex.js rename to 1.9.3/searchindex.js diff --git a/devel/api/access.html b/devel/api/access.html index 9e264e6c8..146b939a5 100644 --- a/devel/api/access.html +++ b/devel/api/access.html @@ -145,7 +145,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -945,7 +945,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/connection.html b/devel/api/connection.html index 8088a9ec8..0b84c08f5 100644 --- a/devel/api/connection.html +++ b/devel/api/connection.html @@ -116,7 +116,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -346,7 +346,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/datamodel.html b/devel/api/datamodel.html index 5dce55f9e..b3e3734de 100644 --- a/devel/api/datamodel.html +++ b/devel/api/datamodel.html @@ -143,7 +143,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1259,7 +1259,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/files.html b/devel/api/files.html index a788238b1..2417b58df 100644 --- a/devel/api/files.html +++ b/devel/api/files.html @@ -125,7 +125,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1129,7 +1129,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/general.html b/devel/api/general.html index 2ab962d88..2b372edab 100644 --- a/devel/api/general.html +++ b/devel/api/general.html @@ -127,7 +127,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -487,7 +487,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/index.html b/devel/api/index.html index e1f98f13c..f2b343ee5 100644 --- a/devel/api/index.html +++ b/devel/api/index.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -312,7 +312,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/job.html b/devel/api/job.html index 90b6623c7..9a6bcd580 100644 --- a/devel/api/job.html +++ b/devel/api/job.html @@ -120,7 +120,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -448,7 +448,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/languages.html b/devel/api/languages.html index e08a84551..49ceec6a8 100644 --- a/devel/api/languages.html +++ b/devel/api/languages.html @@ -123,7 +123,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -464,7 +464,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/logs.html b/devel/api/logs.html index aa746f651..20562fe3e 100644 --- a/devel/api/logs.html +++ b/devel/api/logs.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -184,7 +184,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/printer.html b/devel/api/printer.html index 2eb857b2e..cb07668dc 100644 --- a/devel/api/printer.html +++ b/devel/api/printer.html @@ -134,7 +134,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1491,7 +1491,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/printerprofiles.html b/devel/api/printerprofiles.html index cc383d862..89d3dcd22 100644 --- a/devel/api/printerprofiles.html +++ b/devel/api/printerprofiles.html @@ -125,7 +125,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -873,7 +873,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/push.html b/devel/api/push.html index e0d623f0f..6fd5a2f3a 100644 --- a/devel/api/push.html +++ b/devel/api/push.html @@ -121,7 +121,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -559,7 +559,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/server.html b/devel/api/server.html index f300f7472..602d539d5 100644 --- a/devel/api/server.html +++ b/devel/api/server.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -214,7 +214,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/settings.html b/devel/api/settings.html index 067b23df4..b89d3d510 100644 --- a/devel/api/settings.html +++ b/devel/api/settings.html @@ -118,7 +118,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -610,7 +610,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/slicing.html b/devel/api/slicing.html index 2747afe66..f75658ac0 100644 --- a/devel/api/slicing.html +++ b/devel/api/slicing.html @@ -128,7 +128,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -686,7 +686,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/system.html b/devel/api/system.html index 137898fb1..f9a9880ac 100644 --- a/devel/api/system.html +++ b/devel/api/system.html @@ -123,7 +123,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -492,7 +492,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/timelapse.html b/devel/api/timelapse.html index 049df337f..4a2a7474c 100644 --- a/devel/api/timelapse.html +++ b/devel/api/timelapse.html @@ -126,7 +126,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -567,7 +567,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/util.html b/devel/api/util.html index 885862dde..28045ef37 100644 --- a/devel/api/util.html +++ b/devel/api/util.html @@ -123,7 +123,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -766,7 +766,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/version.html b/devel/api/version.html index 442cf5e22..8f8f0a4df 100644 --- a/devel/api/version.html +++ b/devel/api/version.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -211,7 +211,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/api/wizard.html b/devel/api/wizard.html index fbcc5005f..3ee8d5a73 100644 --- a/devel/api/wizard.html +++ b/devel/api/wizard.html @@ -120,7 +120,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -281,7 +281,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/action_command_notification.html b/devel/bundledplugins/action_command_notification.html index 048a2f78f..756f56bfa 100644 --- a/devel/bundledplugins/action_command_notification.html +++ b/devel/bundledplugins/action_command_notification.html @@ -114,7 +114,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -225,7 +225,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/action_command_prompt.html b/devel/bundledplugins/action_command_prompt.html index 049510a6e..3bd2f14db 100644 --- a/devel/bundledplugins/action_command_prompt.html +++ b/devel/bundledplugins/action_command_prompt.html @@ -114,7 +114,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -261,7 +261,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/announcements.html b/devel/bundledplugins/announcements.html index 6268dfd52..f0ad37d86 100644 --- a/devel/bundledplugins/announcements.html +++ b/devel/bundledplugins/announcements.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -236,7 +236,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/appkeys.html b/devel/bundledplugins/appkeys.html index 3a7aab7d2..4360c39a6 100644 --- a/devel/bundledplugins/appkeys.html +++ b/devel/bundledplugins/appkeys.html @@ -133,7 +133,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -998,7 +998,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/backup.html b/devel/bundledplugins/backup.html index 928d10fff..c3293b781 100644 --- a/devel/bundledplugins/backup.html +++ b/devel/bundledplugins/backup.html @@ -127,7 +127,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -312,7 +312,7 @@

    A list of paths to exclude, relative to your plugin’s data folder

    Return type
    -

    list

    +

    list

    @@ -408,8 +408,8 @@
    Parameters
      -

    • exclude (list) – Names of data folders to exclude, defaults to None

      • -

    • filename (str) – Name of backup to be created, if None (default) the backup +

    • exclude (list) – Names of data folders to exclude, defaults to None

      • +

    • filename (str) – Name of backup to be created, if None (default) the backup name will be auto-generated. This should use a .zip extension.

    @@ -447,7 +447,7 @@
    Parameters
    -

    filename (str) – The name of the backup to delete

    +

    filename (str) – The name of the backup to delete

    @@ -510,7 +510,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/discovery.html b/devel/bundledplugins/discovery.html index e5990ccf5..ea942e327 100644 --- a/devel/bundledplugins/discovery.html +++ b/devel/bundledplugins/discovery.html @@ -121,7 +121,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -324,7 +324,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/errortracking.html b/devel/bundledplugins/errortracking.html index f5428ecc2..e14b09ad4 100644 --- a/devel/bundledplugins/errortracking.html +++ b/devel/bundledplugins/errortracking.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -210,7 +210,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/file_check.html b/devel/bundledplugins/file_check.html index 9f2bbb043..6234c2fc9 100644 --- a/devel/bundledplugins/file_check.html +++ b/devel/bundledplugins/file_check.html @@ -108,7 +108,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -180,7 +180,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/firmware_check.html b/devel/bundledplugins/firmware_check.html index 4eae20bdd..4e5dfc9da 100644 --- a/devel/bundledplugins/firmware_check.html +++ b/devel/bundledplugins/firmware_check.html @@ -108,7 +108,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -181,7 +181,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/gcodeviewer.html b/devel/bundledplugins/gcodeviewer.html index 66077232c..435b6c4d7 100644 --- a/devel/bundledplugins/gcodeviewer.html +++ b/devel/bundledplugins/gcodeviewer.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -208,7 +208,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/index.html b/devel/bundledplugins/index.html index d3d52bda3..626c93ba5 100644 --- a/devel/bundledplugins/index.html +++ b/devel/bundledplugins/index.html @@ -108,7 +108,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -266,7 +266,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/logging.html b/devel/bundledplugins/logging.html index ee620ed5d..833f5d9db 100644 --- a/devel/bundledplugins/logging.html +++ b/devel/bundledplugins/logging.html @@ -119,7 +119,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -467,7 +467,7 @@

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/pluginmanager.html b/devel/bundledplugins/pluginmanager.html index 7beec3dad..23971083d 100644 --- a/devel/bundledplugins/pluginmanager.html +++ b/devel/bundledplugins/pluginmanager.html @@ -117,7 +117,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -347,7 +347,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/softwareupdate.html b/devel/bundledplugins/softwareupdate.html index 06e570032..77a5db876 100644 --- a/devel/bundledplugins/softwareupdate.html +++ b/devel/bundledplugins/softwareupdate.html @@ -132,7 +132,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -799,7 +799,7 @@

    A dictionary of check configurations as described above

    Return type
    -

    dict

    +

    dict

    @@ -868,7 +868,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/tracking.html b/devel/bundledplugins/tracking.html index 8f8a31df0..39a625105 100644 --- a/devel/bundledplugins/tracking.html +++ b/devel/bundledplugins/tracking.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -218,7 +218,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/bundledplugins/virtual_printer.html b/devel/bundledplugins/virtual_printer.html index b1d9ddce9..1f77945c1 100644 --- a/devel/bundledplugins/virtual_printer.html +++ b/devel/bundledplugins/virtual_printer.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -196,7 +196,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/configuration/cli.html b/devel/configuration/cli.html index 2f3c631fd..5a15f6124 100644 --- a/devel/configuration/cli.html +++ b/devel/configuration/cli.html @@ -97,7 +97,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -262,7 +262,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/configuration/config_yaml.html b/devel/configuration/config_yaml.html index 282a416d2..ff6e94fea 100644 --- a/devel/configuration/config_yaml.html +++ b/devel/configuration/config_yaml.html @@ -120,7 +120,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1349,7 +1349,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/configuration/index.html b/devel/configuration/index.html index 4cdda644d..ec5c60717 100644 --- a/devel/configuration/index.html +++ b/devel/configuration/index.html @@ -97,7 +97,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -203,7 +203,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/configuration/logging_yaml.html b/devel/configuration/logging_yaml.html index 16f0befba..214f7f186 100644 --- a/devel/configuration/logging_yaml.html +++ b/devel/configuration/logging_yaml.html @@ -102,7 +102,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -205,7 +205,7 @@

    Changing logging handlerslogging.handlers.

    +logging.handlers.

    Changing logging formatters

    @@ -217,7 +217,7 @@

    Changing logging formattersPython documentation on LogRecord attributes.

    +Python documentation on LogRecord attributes.

    @@ -255,7 +255,7 @@

    Changing logging formatters
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/configuration/yaml.html b/devel/configuration/yaml.html index 97200aca1..380e9ccb4 100644 --- a/devel/configuration/yaml.html +++ b/devel/configuration/yaml.html @@ -107,7 +107,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -349,7 +349,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/development/branches.html b/devel/development/branches.html index b21102603..8e973ef11 100644 --- a/devel/development/branches.html +++ b/devel/development/branches.html @@ -98,7 +98,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -234,7 +234,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/development/environment.html b/devel/development/environment.html index 83ca5225a..776b0f6bd 100644 --- a/devel/development/environment.html +++ b/devel/development/environment.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -597,7 +597,7 @@

    Visual Studio Code (vscode)
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/development/index.html b/devel/development/index.html index 5020f295c..9239296c0 100644 --- a/devel/development/index.html +++ b/devel/development/index.html @@ -98,7 +98,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -196,7 +196,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/development/request-profiling.html b/devel/development/request-profiling.html index a1d5d4d1b..b722adf46 100644 --- a/devel/development/request-profiling.html +++ b/devel/development/request-profiling.html @@ -101,7 +101,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -181,7 +181,7 @@

    Errors
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/development/versioning.html b/devel/development/versioning.html index c9133aa81..426aad5a8 100644 --- a/devel/development/versioning.html +++ b/devel/development/versioning.html @@ -98,7 +98,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -189,7 +189,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/development/virtual_printer.html b/devel/development/virtual_printer.html index f3a336de8..121e8d5ac 100644 --- a/devel/development/virtual_printer.html +++ b/devel/development/virtual_printer.html @@ -104,7 +104,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -479,7 +479,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/events/index.html b/devel/events/index.html index e7894e27b..bddc5738e 100644 --- a/devel/events/index.html +++ b/devel/events/index.html @@ -110,7 +110,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1221,7 +1221,7 @@

    Example
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/features/accesscontrol.html b/devel/features/accesscontrol.html index 93c507c50..3601e2ce5 100644 --- a/devel/features/accesscontrol.html +++ b/devel/features/accesscontrol.html @@ -114,7 +114,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -394,7 +394,7 @@

    If you are using a VPN and your setup ABSOLUTELY REQUIRES disabling internal
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/features/action_commands.html b/devel/features/action_commands.html index a402c32b3..abcafddc1 100644 --- a/devel/features/action_commands.html +++ b/devel/features/action_commands.html @@ -100,7 +100,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -243,7 +243,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/features/atcommands.html b/devel/features/atcommands.html index 4be632c60..b3673c14e 100644 --- a/devel/features/atcommands.html +++ b/devel/features/atcommands.html @@ -100,7 +100,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -190,7 +190,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/features/custom_controls.html b/devel/features/custom_controls.html index 2aa785dcf..4491da999 100644 --- a/devel/features/custom_controls.html +++ b/devel/features/custom_controls.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -377,7 +377,7 @@

    -

    (Optional) Step size per slider “tick”, defaults to 1.

    regex

    (Optional) A regular expression to +

    (Optional) A regular expression to match against lines received from the printer to retrieve information from it (e.g. specific output). Together with template this allows rendition of received data from the printer within the UI.

    Please also read the note below.

    @@ -385,7 +385,7 @@

    template

    (Optional) A template to use for rendering the match of regex. May contain placeholders in -Python Format String Syntax for either named +Python Format String Syntax for either named groups within the regex (e.g. Temperature: {temperature} for a regex T:\s*(?P<temperature>\d+(\.\d*)) or positional groups within the regex (e.g. Position: X={0}, Y={1}, Z={2}, E={3} for a regex X:([0-9.]+) Y:([0-9.]+) Z:([0-9.]+) E:([0-9.]+)).

    @@ -512,7 +512,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/features/gcode_scripts.html b/devel/features/gcode_scripts.html index dd7a0fe9c..635377ac2 100644 --- a/devel/features/gcode_scripts.html +++ b/devel/features/gcode_scripts.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -459,7 +459,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/features/index.html b/devel/features/index.html index 4479725f9..053cd44e1 100644 --- a/devel/features/index.html +++ b/devel/features/index.html @@ -100,7 +100,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -205,7 +205,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/features/plugins.html b/devel/features/plugins.html index 130e77fe9..b9560b12e 100644 --- a/devel/features/plugins.html +++ b/devel/features/plugins.html @@ -108,7 +108,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -237,7 +237,7 @@

    Manual Installation
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/features/safemode.html b/devel/features/safemode.html index 7b3bad4d9..d982d9f5c 100644 --- a/devel/features/safemode.html +++ b/devel/features/safemode.html @@ -104,7 +104,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -262,7 +262,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/genindex.html b/devel/genindex.html index b57ac0986..3c0b479bb 100644 --- a/devel/genindex.html +++ b/devel/genindex.html @@ -88,7 +88,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -3854,7 +3854,7 @@

    Z

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/http-routingtable.html b/devel/http-routingtable.html index 352b12c1e..2c6c65436 100644 --- a/devel/http-routingtable.html +++ b/devel/http-routingtable.html @@ -95,7 +95,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -565,7 +565,7 @@

    HTTP Routing Table

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/index.html b/devel/index.html index 8ab2c9d2a..f1419ee82 100644 --- a/devel/index.html +++ b/devel/index.html @@ -90,7 +90,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -312,7 +312,7 @@

    Contents
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/base.html b/devel/jsclientlib/base.html index 84d79140c..a42dc886e 100644 --- a/devel/jsclientlib/base.html +++ b/devel/jsclientlib/base.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -780,7 +780,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/browser.html b/devel/jsclientlib/browser.html index 53ad845a9..4d6eaa82a 100644 --- a/devel/jsclientlib/browser.html +++ b/devel/jsclientlib/browser.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -256,7 +256,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/connection.html b/devel/jsclientlib/connection.html index a45b99df3..be14e5e55 100644 --- a/devel/jsclientlib/connection.html +++ b/devel/jsclientlib/connection.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -257,7 +257,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/control.html b/devel/jsclientlib/control.html index 4248b75ee..d06dc0fa3 100644 --- a/devel/jsclientlib/control.html +++ b/devel/jsclientlib/control.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -273,7 +273,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/files.html b/devel/jsclientlib/files.html index eb47117a6..24b2b3f1f 100644 --- a/devel/jsclientlib/files.html +++ b/devel/jsclientlib/files.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -531,7 +531,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/index.html b/devel/jsclientlib/index.html index bd089cf86..042cc4489 100644 --- a/devel/jsclientlib/index.html +++ b/devel/jsclientlib/index.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -278,7 +278,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/job.html b/devel/jsclientlib/job.html index c590b1734..8c01b75b1 100644 --- a/devel/jsclientlib/job.html +++ b/devel/jsclientlib/job.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -309,7 +309,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/languages.html b/devel/jsclientlib/languages.html index 6c32fbc11..cfe3b5f46 100644 --- a/devel/jsclientlib/languages.html +++ b/devel/jsclientlib/languages.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -240,7 +240,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/logs.html b/devel/jsclientlib/logs.html index 2b2c1d5b8..9f3246a97 100644 --- a/devel/jsclientlib/logs.html +++ b/devel/jsclientlib/logs.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -183,7 +183,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/printer.html b/devel/jsclientlib/printer.html index 4bdf3d827..6713b2986 100644 --- a/devel/jsclientlib/printer.html +++ b/devel/jsclientlib/printer.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -670,7 +670,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/printerprofiles.html b/devel/jsclientlib/printerprofiles.html index 18da3f899..416903fb9 100644 --- a/devel/jsclientlib/printerprofiles.html +++ b/devel/jsclientlib/printerprofiles.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -270,7 +270,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/settings.html b/devel/jsclientlib/settings.html index 264ecccad..7d9fbbbd7 100644 --- a/devel/jsclientlib/settings.html +++ b/devel/jsclientlib/settings.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -269,7 +269,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/slicing.html b/devel/jsclientlib/slicing.html index 7ddd0d1dd..2761ec3be 100644 --- a/devel/jsclientlib/slicing.html +++ b/devel/jsclientlib/slicing.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -290,7 +290,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/socket.html b/devel/jsclientlib/socket.html index 4d505638d..3defbdf95 100644 --- a/devel/jsclientlib/socket.html +++ b/devel/jsclientlib/socket.html @@ -115,7 +115,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -388,7 +388,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/system.html b/devel/jsclientlib/system.html index f553bfead..5b614b817 100644 --- a/devel/jsclientlib/system.html +++ b/devel/jsclientlib/system.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -241,7 +241,7 @@

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/timelapse.html b/devel/jsclientlib/timelapse.html index 141aba9c0..449a8faac 100644 --- a/devel/jsclientlib/timelapse.html +++ b/devel/jsclientlib/timelapse.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -355,7 +355,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/users.html b/devel/jsclientlib/users.html index 218f065fa..c6c4982e5 100644 --- a/devel/jsclientlib/users.html +++ b/devel/jsclientlib/users.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -368,7 +368,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/util.html b/devel/jsclientlib/util.html index afc4d9993..38a634da5 100644 --- a/devel/jsclientlib/util.html +++ b/devel/jsclientlib/util.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -432,7 +432,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/jsclientlib/wizard.html b/devel/jsclientlib/wizard.html index 5bc05128e..f5f746ced 100644 --- a/devel/jsclientlib/wizard.html +++ b/devel/jsclientlib/wizard.html @@ -110,7 +110,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -221,7 +221,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/modules/access.html b/devel/modules/access.html index d2ca2732b..d62b14b20 100644 --- a/devel/modules/access.html +++ b/devel/modules/access.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -237,7 +237,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/modules/cli.html b/devel/modules/cli.html index 735ad90cf..fc44a573f 100644 --- a/devel/modules/cli.html +++ b/devel/modules/cli.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -155,7 +155,7 @@

    octoprint.cli

    -class octoprint.cli.HiddenOption(param_decls: Optional[Sequence[str]] = None, show_default: Optional[Union[bool, str]] = None, prompt: Union[bool, str] = False, confirmation_prompt: Union[bool, str] = False, prompt_required: bool = True, hide_input: bool = False, is_flag: Optional[bool] = None, flag_value: Optional[Any] = None, multiple: bool = False, count: bool = False, allow_from_autoenv: bool = True, type: Optional[Union[click.types.ParamType, Any]] = None, help: Optional[str] = None, hidden: bool = False, show_choices: bool = True, show_envvar: bool = False, **attrs: Any)
    +class octoprint.cli.HiddenOption(param_decls: Optional[Sequence[str]] = None, show_default: Optional[Union[bool, str]] = None, prompt: Union[bool, str] = False, confirmation_prompt: Union[bool, str] = False, prompt_required: bool = True, hide_input: bool = False, is_flag: Optional[bool] = None, flag_value: Optional[Any] = None, multiple: bool = False, count: bool = False, allow_from_autoenv: bool = True, type: Optional[Union[click.types.ParamType, Any]] = None, help: Optional[str] = None, hidden: bool = False, show_choices: bool = True, show_envvar: bool = False, **attrs: Any)

    Custom option sub class with empty help.

    @@ -351,7 +351,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/modules/filemanager.html b/devel/modules/filemanager.html index c990b817b..47d6696aa 100644 --- a/devel/modules/filemanager.html +++ b/devel/modules/filemanager.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -215,7 +215,7 @@ overridden by sub classes.

    Parameters
    -

    high_priority (bool) – Whether the current entry has high priority or not.

    +

    high_priority (bool) – Whether the current entry has high priority or not.

    Returns

    @@ -225,7 +225,7 @@

    Return type
    -

    object

    +

    object

    @@ -289,7 +289,7 @@
    class octoprint.filemanager.analysis.GcodeAnalysisQueue(finished_callback)
    -

    A queue to analyze GCODE files. Analysis results are dict instances structured as follows:

    +

    A queue to analyze GCODE files. Analysis results are dict instances structured as follows:

    @@ -390,14 +390,14 @@
    Parameters
      -

    • name (str) – Name of the file to analyze.

      • -

    • path (str) – Storage location specific path to the file to analyze.

      • -

    • type (str) – Type of file to analyze, necessary to map to the correct AbstractAnalysisQueue sub class. +

    • name (str) – Name of the file to analyze.

      • +

    • path (str) – Storage location specific path to the file to analyze.

      • +

    • type (str) – Type of file to analyze, necessary to map to the correct AbstractAnalysisQueue sub class. At the moment, only gcode is supported here.

      • -

    • location (str) – Location the file is located on.

      • -

    • absolute_path (str) – Absolute path on disk through which to access the file.

      • +

    • location (str) – Location the file is located on.

      • +

    • absolute_path (str) – Absolute path on disk through which to access the file.

    • printer_profile (PrinterProfile) – PrinterProfile which to use for analysis.

      • -

    • analysis (dict) – GcodeAnalysisQueue results from prior analysis, or None if there is none.

      • +

    • analysis (dict) – GcodeAnalysisQueue results from prior analysis, or None if there is none.

    @@ -424,13 +424,13 @@
    Parameters

    • path (string) – the file’s new path, will be sanitized

      • -

    • file_object (object) – a file object that provides a save method which will be called with the destination path +

    • file_object (object) – a file object that provides a save method which will be called with the destination path where the object should then store its contents

      • -

    • printer_profile (object) – the printer profile associated with this file (if any)

      • -

    • links (list) – any links to add with the file

      • -

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file +

    • printer_profile (object) – the printer profile associated with this file (if any)

      • +

    • links (list) – any links to add with the file

      • +

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file and its metadata will just be silently overwritten

      • -

    • display (str) – display name of the file

      • +

    • display (str) – display name of the file

    Returns
    @@ -448,8 +448,8 @@
    Parameters

    • path (string) – the path of the new folder

      • -

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • -

    • display (str) – display name of the folder

      • +

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • +

    • display (str) – display name of the folder

    Returns
    @@ -634,9 +634,9 @@
    Parameters
      -

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or +

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or set to None, defatuls to storage root.

      • -

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or +

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or the whole path’s subtree (True).

    @@ -706,7 +706,7 @@ from root of base folder

  • filter (function) – a filter that matches the files that are to be returned, may be left out in which case no filtering will take place

    • -

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only +

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only do one step down into sub folders to be able to populate the children.

    • @@ -770,7 +770,7 @@ path_on_disk(path)

    Retrieves the path on disk for path.

    Note: if the storage is not on disk and there exists no path on disk to refer to it, this method should -raise an io.UnsupportedOperation

    +raise an io.UnsupportedOperation

    Opposite of path_in_storage().

    Parameters
    @@ -817,7 +817,7 @@
    Parameters

    • path (string) – the path of the folder to remove

      • -

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will +

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will be raised if the folder is not empty (apart from any metadata files) when it’s to be removed

    @@ -861,7 +861,7 @@
    sanitize_name(name)
    -

    Raises a ValueError for a name containing / or \. Otherwise +

    Raises a ValueError for a name containing / or \. Otherwise sanitizes the given name using octoprint.files.sanitize_filename. Also strips any leading ..

    @@ -917,13 +917,13 @@
    Parameters

    • path (string) – the file’s new path, will be sanitized

      • -

    • file_object (object) – a file object that provides a save method which will be called with the destination path +

    • file_object (object) – a file object that provides a save method which will be called with the destination path where the object should then store its contents

      • -

    • printer_profile (object) – the printer profile associated with this file (if any)

      • -

    • links (list) – any links to add with the file

      • -

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file +

    • printer_profile (object) – the printer profile associated with this file (if any)

      • +

    • links (list) – any links to add with the file

      • +

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file and its metadata will just be silently overwritten

      • -

    • display (str) – display name of the file

      • +

    • display (str) – display name of the file

    Returns
    @@ -941,8 +941,8 @@
    Parameters

    • path (string) – the path of the new folder

      • -

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • -

    • display (str) – display name of the folder

      • +

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • +

    • display (str) – display name of the folder

    Returns
    @@ -1127,9 +1127,9 @@
    Parameters
      -

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or +

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or set to None, defatuls to storage root.

      • -

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or +

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or the whole path’s subtree (True).

    @@ -1199,7 +1199,7 @@ from root of base folder

  • filter (function) – a filter that matches the files that are to be returned, may be left out in which case no filtering will take place

    • -

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only +

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only do one step down into sub folders to be able to populate the children.

    • @@ -1263,7 +1263,7 @@ path_on_disk(path)

    Retrieves the path on disk for path.

    Note: if the storage is not on disk and there exists no path on disk to refer to it, this method should -raise an io.UnsupportedOperation

    +raise an io.UnsupportedOperation

    Opposite of path_in_storage().

    Parameters
    @@ -1310,7 +1310,7 @@
    Parameters

    • path (string) – the path of the folder to remove

      • -

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will +

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will be raised if the folder is not empty (apart from any metadata files) when it’s to be removed

    @@ -1403,7 +1403,7 @@

    Wrapper for file representations to save to storages.

    Parameters
    -

    filename (str) – The file’s name

    +

    filename (str) – The file’s name

    @@ -1413,8 +1413,8 @@
    Parameters
      -

    • path (str) – The absolute path to where to save the file

      • -

    • permissions (int) – The permissions to set on the file

      • +

    • path (str) – The absolute path to where to save the file

      • +

    • permissions (int) – The permissions to set on the file

    @@ -1429,7 +1429,7 @@

    The file’s contents as a stream.

    Return type
    -

    io.IOBase

    +

    io.IOBase

    @@ -1445,8 +1445,8 @@
    Parameters
      -

    • filename (str) – The file’s name

      • -

    • path (str) – The file’s absolute path

      • +

    • filename (str) – The file’s name

      • +

    • path (str) – The file’s absolute path

    • move (boolean) – Whether to move the file upon saving (True, default) or copying.

    @@ -1458,8 +1458,8 @@
    Parameters
      -

    • path (str) – The absolute path to where to save the file

      • -

    • permissions (int) – The permissions to set on the file

      • +

    • path (str) – The absolute path to where to save the file

      • +

    • permissions (int) – The permissions to set on the file

    @@ -1474,7 +1474,7 @@

    The file’s contents as a stream.

    Return type
    -

    io.IOBase

    +

    io.IOBase

    @@ -1491,7 +1491,7 @@ to do the decoding yourself.

    Parameters
    -

    input_stream (io.RawIOBase) – The stream to process on the fly.

    +

    input_stream (io.RawIOBase) – The stream to process on the fly.

    @@ -1509,7 +1509,7 @@ wrapper input_stream.

    Parameters
    -

    line (bytes) – The line as read from self.input_stream in byte representation

    +

    line (bytes) – The line as read from self.input_stream in byte representation

    Returns

    @@ -1519,7 +1519,7 @@

    Return type
    -

    bytes or None

    +

    bytes or None

    @@ -1555,7 +1555,7 @@ their contents in the order they are provided to the constructor.

    Parameters
    -

    *streams – One or more io.IOBase streams to concatenate.

    +

    *streams – One or more io.IOBase streams to concatenate.

    @@ -1595,7 +1595,7 @@

    A wrapper allowing processing of one or more consecutive streams.

    Parameters
    -

    *streams – One or more io.IOBase streams to process one after another to save to storage.

    +

    *streams – One or more io.IOBase streams to process one after another to save to storage.

    @@ -1650,7 +1650,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/modules/index.html b/devel/modules/index.html index ba4f1f1bc..93dc2ba8e 100644 --- a/devel/modules/index.html +++ b/devel/modules/index.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -220,7 +220,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/modules/plugin.html b/devel/modules/plugin.html index a5cee1342..205c1ca35 100644 --- a/devel/modules/plugin.html +++ b/devel/modules/plugin.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -164,31 +164,31 @@
    Parameters

    • init (boolean) – A flag indicating whether this is the initial call to construct the singleton (True) or not -(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError +(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError will be raised. The same will happen if the plugin manager has not yet been initialized and this is set to False.

      • -

    • plugin_folders (list) – A list of folders (as strings containing the absolute path to them) in which to look for +

    • plugin_folders (list) – A list of folders (as strings containing the absolute path to them) in which to look for potential plugin modules. If not provided this defaults to the configured plugins base folder and src/plugins within OctoPrint’s code base.

      • -

    • plugin_bases (list) – A list of recognized plugin base classes for which to look for provided implementations. If not +

    • plugin_bases (list) – A list of recognized plugin base classes for which to look for provided implementations. If not provided this defaults to OctoPrintPlugin.

      • -

    • plugin_entry_points (list) – A list of entry points pointing to modules which to load as plugins. If not provided +

    • plugin_entry_points (list) – A list of entry points pointing to modules which to load as plugins. If not provided this defaults to the entry point octoprint.plugin.

      • -

    • plugin_disabled_list (list) – A list of plugin identifiers that are currently disabled. If not provided this +

    • plugin_disabled_list (list) – A list of plugin identifiers that are currently disabled. If not provided this defaults to all plugins for which enabled is set to False in the settings.

      • -

    • plugin_sorting_order (dict) – A dict containing a custom sorting orders for plugins. The keys are plugin identifiers, +

    • plugin_sorting_order (dict) – A dict containing a custom sorting orders for plugins. The keys are plugin identifiers, mapped to dictionaries containing the sorting contexts as key and the custom sorting value as value.

      • -

    • plugin_blacklist (list) – A list of plugin identifiers/identifier-requirement tuples +

    • plugin_blacklist (list) – A list of plugin identifiers/identifier-requirement tuples that are currently blacklisted.

      • -

    • plugin_restart_needing_hooks (list) – A list of hook namespaces which cause a plugin to need a restart in order +

    • plugin_restart_needing_hooks (list) – A list of hook namespaces which cause a plugin to need a restart in order be enabled/disabled. Does not have to contain full hook identifiers, will be matched with startswith similar to logging handlers

      • -

    • plugin_obsolete_hooks (list) – A list of hooks that have been declared obsolete. Plugins implementing them will +

    • plugin_obsolete_hooks (list) – A list of hooks that have been declared obsolete. Plugins implementing them will not be enabled since they might depend on functionality that is no longer available.

      • -

    • plugin_considered_bundled (list) – A list of plugin identifiers that are considered bundled plugins even if +

    • plugin_considered_bundled (list) – A list of plugin identifiers that are considered bundled plugins even if installed separately.

      • -

    • plugin_validators (list) – A list of additional plugin validators through which to process each plugin.

      • -

    • compatibility_ignored_list (list) – A list of plugin keys for which it will be ignored if they are flagged as +

    • plugin_validators (list) – A list of additional plugin validators through which to process each plugin.

      • +

    • compatibility_ignored_list (list) – A list of plugin keys for which it will be ignored if they are flagged as incompatible. This is for development purposes only and should not be used in production.

    @@ -203,7 +203,7 @@

    PluginManager

    Raises
    -

    ValueError – init was True although the plugin manager was already initialized, or it was False although +

    ValueError – init was True although the plugin manager was already initialized, or it was False although the plugin manager was not yet initialized.

    @@ -217,9 +217,9 @@
    Parameters

    • plugin_key (string) – The plugin identifier for which to create the settings instance.

      • -

    • defaults (dict) – The default settings for the plugin, if different from get_settings_defaults.

      • -

    • get_preprocessors (dict) – The getter preprocessors for the plugin.

      • -

    • set_preprocessors (dict) – The setter preprocessors for the plugin.

      • +

    • defaults (dict) – The default settings for the plugin, if different from get_settings_defaults.

      • +

    • get_preprocessors (dict) – The getter preprocessors for the plugin.

      • +

    • set_preprocessors (dict) – The setter preprocessors for the plugin.

    • settings (octoprint.settings.Settings) – The settings instance to use.

    @@ -261,10 +261,10 @@
    Parameters
      -

    • types (list) – A list of plugin implementation types to match against.

      • +

    • types (list) – A list of plugin implementation types to match against.

    • method (string) – Name of the method to call on all matching implementations.

      • -

    • args (tuple) – A tuple containing the arguments to supply to the called method. Optional.

      • -

    • kwargs (dict) – A dictionary containing the keyword arguments to supply to the called method. Optional.

      • +

    • args (tuple) – A tuple containing the arguments to supply to the called method. Optional.

      • +

    • kwargs (dict) – A dictionary containing the keyword arguments to supply to the called method. Optional.

    • callback (function) – A callback to invoke after an implementation has been called successfully. Will be called with the three arguments name, plugin and result. name will be the plugin identifier, plugin the plugin implementation instance itself and result the result returned from the @@ -291,8 +291,8 @@

      Parameters

      • settings (Settings) – The Settings instance on which to operate.

        • -

      • plugin_key (str) – The plugin identifier of the plugin for which to create this instance.

        • -

      • defaults (dict) – The plugin’s defaults settings, will be used to determine valid paths within the plugin’s +

      • plugin_key (str) – The plugin identifier of the plugin for which to create this instance.

        • +

      • defaults (dict) – The plugin’s defaults settings, will be used to determine valid paths within the plugin’s settings structure

      @@ -305,7 +305,7 @@
      Parameters
        -

      • path (list, tuple) – The path for which to retrieve the value.

        • +

      • path (list, tuple) – The path for which to retrieve the value.

      • merged (boolean) – Whether to merge the returned result with the default settings (True) or not (False, default).

      @@ -314,7 +314,7 @@

      The retrieved settings value.

      Return type
      -

      object

      +

      object

    @@ -348,8 +348,8 @@
    Parameters
      -

    • path (list, tuple) – The path for which to retrieve the value.

      • -

    • value (object) – The value to set.

      • +

    • path (list, tuple) – The path for which to retrieve the value.

      • +

    • value (object) – The value to set.

    • force (boolean) – If set to True, the modified configuration will even be written back to disk if the value didn’t change.

    @@ -404,13 +404,13 @@
    Parameters
      -

    • overlay (dict) – Overlay dict to add

      • +

    • overlay (dict) – Overlay dict to add

    • at_end (boolean) – Whether to add overlay at end or start (default) of config hierarchy

      • -

    • key (str) – Key to use to identify overlay. If not set one will be built based on the overlay’s hash

      • +

    • key (str) – Key to use to identify overlay. If not set one will be built based on the overlay’s hash

    Return type
    -

    str

    +

    str

    @@ -422,7 +422,7 @@ removed, False otherwise.

    Parameters
    -

    key (str) – The key of the overlay to remove

    +

    key (str) – The key of the overlay to remove

    Return type

    boolean

    @@ -448,7 +448,7 @@ want to create a log file for logging the output of the slicing engine itself if some debug flag is set.

    Parameters
    -

    postfix (str) – Postfix of the logfile for which to create the path. If set, the file name of the log file +

    postfix (str) – Postfix of the logfile for which to create the path. If set, the file name of the log file will be plugin_<plugin identifier>_<postfix>.log, if not it will be plugin_<plugin identifier>.log.

    @@ -456,7 +456,7 @@

    Absolute path to the log file, directly usable by the plugin.

    Return type
    -

    str

    +

    str

    @@ -559,7 +559,7 @@

    A list of all found and matching implementations.

    Return type
    -

    list

    +

    list

    @@ -568,12 +568,12 @@
    get_helpers(name, *helpers)

    Retrieves the named helpers for the plugin with identifier name.

    -

    If the plugin is not available, returns None. Otherwise returns a dict with the requested plugin +

    If the plugin is not available, returns None. Otherwise returns a dict with the requested plugin helper names mapped to the method - if a helper could not be resolved, it will be missing from the dict.

    Parameters
      -

    • name (str) – Identifier of the plugin for which to look up the helpers.

      • +

    • name (str) – Identifier of the plugin for which to look up the helpers.

    • helpers (one or more str) – Identifiers of the helpers of plugin name to return.

    @@ -585,7 +585,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -596,13 +596,13 @@

    Retrieves all registered handlers for the specified hook.

    Parameters
    -

    hook (str) – The hook for which to retrieve the handlers.

    +

    hook (str) – The hook for which to retrieve the handlers.

    Returns

    A dict containing all registered handlers mapped by their plugin’s identifier.

    Return type
    -

    dict

    +

    dict

    @@ -619,7 +619,7 @@

    A list of all found implementations

    Return type
    -

    list

    +

    list

    @@ -632,7 +632,7 @@
    Parameters
      -

    • identifier (str) – The identifier of the plugin to retrieve.

      • +

    • identifier (str) – The identifier of the plugin to retrieve.

    • require_enabled (boolean) – Whether to only return the plugin if is enabled (True, default) or also if it’s disabled.

    @@ -654,7 +654,7 @@
    Parameters
      -

    • identifier (str) – The identifier of the plugin to retrieve.

      • +

    • identifier (str) – The identifier of the plugin to retrieve.

    • require_enabled (boolean) – Whether to only return the plugin if is enabled (True, default) or also if it’s disabled.

    @@ -688,7 +688,7 @@

    Return type
    -

    (bool)

    +

    (bool)

    @@ -713,7 +713,7 @@

    Return type
    -

    (bool)

    +

    (bool)

    @@ -743,7 +743,7 @@

    hook is expected to be an exact hook name.

    hooks is expected to be a list containing one or more hook names or patterns. That can be either an exact hook name or an -fnmatch.fnmatch() pattern.

    +fnmatch.fnmatch() pattern.

    Parameters
      @@ -755,7 +755,7 @@

      True if the hook matches any of the hooks, False otherwise.

      Return type
      -

      (bool)

      +

      (bool)

    @@ -773,8 +773,8 @@
    Parameters
      -

    • name (str) – the plugin’s identifier

      • -

    • flag (str) – the flag to check

      • +

    • name (str) – the plugin’s identifier

      • +

    • flag (str) – the flag to check

    Returns
    @@ -805,8 +805,8 @@
    Parameters
      -

    • name (str) – plugin identifier

      • -

    • **flags (dict) – dictionary of flag names and values

      • +

    • name (str) – plugin identifier

      • +

    • **flags (dict) – dictionary of flag names and values

    @@ -843,7 +843,7 @@

    • startup (boolean) – whether this is called during startup of the platform

    • initialize_implementations (boolean) – whether plugin implementations should be initialized

      • -

    • force_reload (list) – list of plugin identifiers which should be force reloaded

      • +

    • force_reload (list) – list of plugin identifiers which should be force reloaded

    @@ -857,9 +857,9 @@
    Parameters
      -

    • plugin (str) – The sending plugin’s identifier.

      • -

    • data (object) – The message.

      • -

    • permissions (list) – A list of permissions to test against in the client.

      • +

    • plugin (str) – The sending plugin’s identifier.

      • +

    • data (object) – The message.

      • +

    • permissions (list) – A list of permissions to test against in the client.

    @@ -884,15 +884,15 @@
    Parameters
      -

    • key (str) – Identifier of the plugin

      • -

    • location (str) – Installation folder of the plugin

      • +

    • key (str) – Identifier of the plugin

      • +

    • location (str) – Installation folder of the plugin

    • instance (module) – Plugin module instance - this may be None if the plugin has been blacklisted!

      • -

    • name (str) – Human readable name of the plugin

      • -

    • version (str) – Version of the plugin

      • -

    • description (str) – Description of the plugin

      • -

    • author (str) – Author of the plugin

      • -

    • url (str) – URL of the website of the plugin

      • -

    • license (str) – License of the plugin

      • +

    • name (str) – Human readable name of the plugin

      • +

    • version (str) – Version of the plugin

      • +

    • description (str) – Description of the plugin

      • +

    • author (str) – Author of the plugin

      • +

    • url (str) – URL of the website of the plugin

      • +

    • license (str) – License of the plugin

    @@ -906,7 +906,7 @@

    Author of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -953,7 +953,7 @@

    Description of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -984,7 +984,7 @@

    Reason why disabling this plugin is discouraged (only for bundled plugins)

    Return type
    -

    str or None

    +

    str or None

    @@ -1021,7 +1021,7 @@ get_hook(hook)
    Parameters
    -

    hook (str) – Hook to return.

    +

    hook (str) – Hook to return.

    Returns

    Handler for the requested hook or None if no handler is registered.

    @@ -1037,13 +1037,13 @@ get_implementation(*types)
    Parameters
    -

    types (list) – List of Plugin sub classes the implementation needs to implement.

    +

    types (list) – List of Plugin sub classes the implementation needs to implement.

    Returns

    The plugin’s implementation if it matches all of the requested types, None otherwise.

    Return type
    -

    object

    +

    object

    @@ -1058,7 +1058,7 @@

    Helpers provided by the plugin.

    Return type
    -

    dict

    +

    dict

    @@ -1072,7 +1072,7 @@

    Whether the plugin should be flagged as hidden or not

    Return type
    -

    bool

    +

    bool

    @@ -1087,7 +1087,7 @@

    Hooks provided by the plugin.

    Return type
    -

    dict

    +

    dict

    @@ -1102,7 +1102,7 @@

    Implementation provided by the plugin.

    Return type
    -

    object

    +

    object

    @@ -1129,7 +1129,7 @@

    License of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1177,18 +1177,18 @@
    Parameters

    • show_enabled (boolean) – whether to show the enabled part

      • -

    • enabled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the enabled state

      • +

    • enabled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the enabled state

    • show_bundled (boolean) – whether to show the bundled part

      • -

    • bundled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the bundled state

      • +

    • bundled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the bundled state

    • show_location (boolean) – whether to show the location part

      • -

    • location_str (str) – the format string to use for displaying the plugin’s installation location

      • +

    • location_str (str) – the format string to use for displaying the plugin’s installation location

    Returns

    The long string representation of the plugin as described above

    Return type
    -

    str

    +

    str

    @@ -1215,7 +1215,7 @@

    Name of the plugin, fallback is the plugin’s identifier.

    Return type
    -

    str

    +

    str

    @@ -1249,7 +1249,7 @@

    Privacy Policy URL of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1264,7 +1264,7 @@

    Python compatibility string of the plugin

    Return type
    -

    str

    +

    str

    @@ -1294,7 +1294,7 @@

    Website URL for the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1317,7 +1317,7 @@

    Version of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1400,7 +1400,7 @@ not None sorted by that.

    Parameters
    -

    context (str) – The sorting context for which to provide the +

    context (str) – The sorting context for which to provide the sorting key value.

    Returns
    @@ -1412,7 +1412,7 @@

    Return type
    -

    int or None

    +

    int or None

    @@ -1577,7 +1577,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/modules/printer.html b/devel/modules/printer.html index 1e3ded1e7..00a7be7d0 100644 --- a/devel/modules/printer.html +++ b/devel/modules/printer.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -192,8 +192,8 @@
    Parameters
      -

    • path (str) – path in storage of the file to check

      • -

    • sd (bool) – True if to check against SD storage, False otherwise

      • +

    • path (str) – path in storage of the file to check

      • +

    • sd (bool) – True if to check against SD storage, False otherwise

    Returns
    @@ -220,7 +220,7 @@
    Parameters
      -

    • tool (str) – The tool to switch to, matching the regex “tool[0-9]+” (e.g. “tool0”, “tool1”, …)

      • +

    • tool (str) – The tool to switch to, matching the regex “tool[0-9]+” (e.g. “tool0”, “tool1”, …)

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -234,10 +234,10 @@
    Parameters
      -

    • commands (str, list) – The commands to send. Might be a single command provided just as a string or a list +

    • commands (str, list) – The commands to send. Might be a single command provided just as a string or a list of multiple commands to send in order.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      • -

    • force (bool) – Whether to force sending of the command right away or allow queuing while printing

      • +

    • force (bool) – Whether to force sending of the command right away or allow queuing while printing

    @@ -252,9 +252,9 @@
    Parameters
      -

    • port (str) – Name of the serial port to connect to. If not provided, an auto detection will be attempted.

      • -

    • baudrate (int) – Baudrate to connect with. If not provided, an auto detection will be attempted.

      • -

    • profile (str) – Name of the printer profile to use for this connection. If not provided, the default +

    • port (str) – Name of the serial port to connect to. If not provided, an auto detection will be attempted.

      • +

    • baudrate (int) – Baudrate to connect with. If not provided, an auto detection will be attempted.

      • +

    • profile (str) – Name of the printer profile to use for this connection. If not provided, the default will be retrieved from the PrinterProfileManager.

    @@ -274,8 +274,8 @@
    Parameters
      -

    • amount (int, float) – The amount of material to extrude in mm

      • -

    • speed (int, None) – Speed at which to extrude (F parameter). If set to None (or left out)

      • +

    • amount (int, float) – The amount of material to extrude in mm

      • +

    • speed (int, None) – Speed at which to extrude (F parameter). If set to None (or left out)

    • used. (the maximum speed of E axis from the printer profile will be) –

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -298,7 +298,7 @@
    Parameters
      -

    • factor (int, float) – The factor for the feed rate to send to the firmware. Percentage expressed as either an +

    • factor (int, float) – The factor for the feed rate to send to the firmware. Percentage expressed as either an int between 0 and 100 or a float between 0 and 1.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -313,7 +313,7 @@
    Parameters
      -

    • factor (int, float) – The factor for the flow rate to send to the firmware. Percentage expressed as either an +

    • factor (int, float) – The factor for the flow rate to send to the firmware. Percentage expressed as either an int between 0 and 100 or a float between 0 and 1.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -338,7 +338,7 @@

    A dictionary holding the connection options in the structure specified above

    Return type
    -

    (dict)

    +

    (dict)

    @@ -448,7 +448,7 @@

    The communication layer’s transport object

    Return type
    -

    object

    +

    object

    @@ -460,7 +460,7 @@
    Parameters
      -

    • axes (str, list) – The axis or axes to home, each of which must converted to lower case must match one of +

    • axes (str, list) – The axis or axes to home, each of which must converted to lower case must match one of “x”, “y”, “z” and “e”

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -508,8 +508,8 @@
    Parameters
      -

    • path (str) – path in storage of the file to check

      • -

    • sd (bool) – True if to check against SD storage, False otherwise

      • +

    • path (str) – path in storage of the file to check

      • +

    • sd (bool) – True if to check against SD storage, False otherwise

    Returns
    @@ -598,7 +598,7 @@ if the lock can’t be acquired.

    Parameters
    -

    blocking (bool) – Whether to block while attempting to acquire the lock (default) or not

    +

    blocking (bool) – Whether to block while attempting to acquire the lock (default) or not

    @@ -610,10 +610,10 @@
    Parameters
      -

    • axes (dict) – Axes and distances to jog, keys are axes (“x”, “y”, “z”), values are distances in mm

      • -

    • relative (bool) – Whether to interpret the distance values as relative (true, default) or absolute (false) +

    • axes (dict) – Axes and distances to jog, keys are axes (“x”, “y”, “z”), values are distances in mm

      • +

    • relative (bool) – Whether to interpret the distance values as relative (true, default) or absolute (false) coordinates

      • -

    • speed (int, bool or None) – Speed at which to jog (F parameter). If set to False no speed will be set +

    • speed (int, bool or None) – Speed at which to jog (F parameter). If set to False no speed will be set specifically. If set to None (or left out) the minimum of all involved axes speeds from the printer profile will be used.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      • @@ -672,8 +672,8 @@
      Parameters
        -

      • name (str) – The name of the GCODE script to render.

        • -

      • context (dict) – An optional context of additional template variables to provide to the renderer.

        • +

      • name (str) – The name of the GCODE script to render.

        • +

      • context (dict) – An optional context of additional template variables to provide to the renderer.

      • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      @@ -691,7 +691,7 @@
      Parameters
        -

      • path (str) – The path to select for printing. Either an absolute path or relative path to a local file in +

      • path (str) – The path to select for printing. Either an absolute path or relative path to a local file in the uploads folder or a filename on the printer’s SD card.

      • sd (boolean) – Indicates whether the file is on the printer’s SD card or not.

      • printAfterSelect (boolean) – Indicates whether a print should be started @@ -743,8 +743,8 @@

        Parameters
          -

        • value (bool) – The value to set

          • -

        • blocking (bool) – Whether to block while attempting to set the value (default) or not

          • +

        • value (bool) – The value to set

          • +

        • blocking (bool) – Whether to block while attempting to set the value (default) or not

        Returns
        @@ -760,12 +760,12 @@
        Parameters
          -

        • heater (str) – The heater for which to set the target temperature. Either “bed” for setting the bed +

        • heater (str) – The heater for which to set the target temperature. Either “bed” for setting the bed temperature, “chamber” for setting the temperature of the heated enclosure or something matching the regular expression “tool[0-9]+” (e.g. “tool0”, “tool1”, …) for the hotends of the printer. However, addressing components that are disabled or unconfigured in the printer profile will result in a “Suppressed command” error popup message.

          • -

        • value (int, float) – The temperature in celsius to set the target temperature to.

          • +

        • value (int, float) – The temperature in celsius to set the target temperature to.

        • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle.

        @@ -779,7 +779,7 @@
        Parameters
          -

        • offsets (dict) – A dictionary specifying the offsets to apply. Keys must match the format for the heater +

        • offsets (dict) – A dictionary specifying the offsets to apply. Keys must match the format for the heater parameter to set_temperature(), so “bed” for the offset for the bed target temperature and “tool[0-9]+” for the offsets to the hotend target temperatures.

        • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

          • @@ -856,7 +856,7 @@

          Called when the PrinterInterface receives a new communication log entry from the communication layer.

          Parameters
          -

          data (str) – The received log line.

          +

          data (str) – The received log line.

        @@ -867,7 +867,7 @@

        Called when the PrinterInterface receives a new message from the communication layer.

        Parameters
        -

        data (str) – The received message.

        +

        data (str) – The received message.

        @@ -891,7 +891,7 @@
    Parameters
    -

    data (dict) – A dict of all current temperatures in the format as specified above

    +

    data (dict) – A dict of all current temperatures in the format as specified above

    @@ -903,8 +903,8 @@
    Parameters
      -

    • name (str) – Name of the registered message (e.g. the feedback command)

      • -

    • output (str) – Output for the registered message

      • +

    • name (str) – Name of the registered message (e.g. the feedback command)

      • +

    • output (str) – Output for the registered message

    @@ -949,7 +949,7 @@
    Parameters
    -

    data (dict) – The current data in the format as specified above.

    +

    data (dict) – The current data in the format as specified above.

    @@ -976,7 +976,7 @@
    Parameters
    -

    data (dict) – The initial data in the format as specified above.

    +

    data (dict) – The initial data in the format as specified above.

    @@ -1253,7 +1253,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/modules/schema.html b/devel/modules/schema.html index 31463bd1d..4775f2d16 100644 --- a/devel/modules/schema.html +++ b/devel/modules/schema.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -283,34 +283,34 @@
    -class octoprint.schema.config.access_control.AccessControlConfig(*, salt: Optional[str] = None, userManager: str = 'octoprint.access.users.FilebasedUserManager', groupManager: str = 'octoprint.access.groups.FilebasedGroupManager', permissionManager: str = 'octoprint.access.permissions.PermissionManager', userfile: Optional[str] = None, groupfile: Optional[str] = None, autologinLocal: bool = False, localNetworks: List[str] = ['127.0.0.0/8', '::1/128'], autologinAs: Optional[str] = None, trustBasicAuthentication: bool = False, checkBasicAuthenticationPassword: bool = True, trustRemoteUser: bool = False, remoteUserHeader: str = 'REMOTE_USER', addRemoteUsers: bool = False)
    +class octoprint.schema.config.access_control.AccessControlConfig(*, salt: Optional[str] = None, userManager: str = 'octoprint.access.users.FilebasedUserManager', groupManager: str = 'octoprint.access.groups.FilebasedGroupManager', permissionManager: str = 'octoprint.access.permissions.PermissionManager', userfile: Optional[str] = None, groupfile: Optional[str] = None, autologinLocal: bool = False, localNetworks: List[str] = ['127.0.0.0/8', '::1/128'], autologinAs: Optional[str] = None, trustBasicAuthentication: bool = False, checkBasicAuthenticationPassword: bool = True, trustRemoteUser: bool = False, remoteUserHeader: str = 'REMOTE_USER', addRemoteUsers: bool = False)
    -addRemoteUsers: bool
    +addRemoteUsers: bool

    If a remote user is not found, add them. Use this only if all users from the remote system can use OctoPrint.

    -autologinAs: Optional[str]
    +autologinAs: Optional[str]

    The name of the user to automatically log on clients originating from localNetworks as. Must be the name of one of your configured users.

    -autologinLocal: bool
    +autologinLocal: bool

    If set to true, will automatically log on clients originating from any of the networks defined in localNetworks as the user defined in autologinAs.

    -checkBasicAuthenticationPassword: bool
    +checkBasicAuthenticationPassword: bool

    Whether to also check the password provided through Basic Authentication, if the Basic Authentication header is to be trusted. Disabling this will only match the user name in the Basic Authentication header and login the user without further checks, thus disable with caution.

    -groupManager: str
    +groupManager: str

    groups.yaml in the default configuration folder).

    Type
    @@ -321,49 +321,49 @@
    -groupfile: Optional[str]
    +groupfile: Optional[str]

    The YAML group file to use. If left out defaults to groups.yaml in the default configuration folder.

    -localNetworks: List[str]
    +localNetworks: List[str]

    A list of networks or IPs for which an automatic logon as the user defined in autologinAs will take place. If available OctoPrint will evaluate the X-Forwarded-For HTTP header for determining the client’s IP address. Defaults to anything originating from localhost.

    -permissionManager: str
    +permissionManager: str

    The permission manager implementation to use.

    -remoteUserHeader: str
    +remoteUserHeader: str

    Header used by the reverse proxy to convey the authenticated user.

    -salt: Optional[str]
    +salt: Optional[str]

    Secret salt used for password hashing. DO NOT TOUCH! If changed you will no longer be able to log in with your existing accounts. Default unset, generated on first run.

    -trustBasicAuthentication: bool
    +trustBasicAuthentication: bool

    Whether to trust Basic Authentication headers. If you have setup Basic Authentication in front of OctoPrint and the user names you use there match OctoPrint accounts, by setting this to true users will be logged into OctoPrint as the user during Basic Authentication. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through Basic Authentication!

    -trustRemoteUser: bool
    +trustRemoteUser: bool

    Whether to trust remote user headers. If you have setup authentication in front of OctoPrint and the user names you use there match OctoPrint accounts, by setting this to true users will be logged into OctoPrint as the user provided in the header. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through an authenticating reverse proxy!

    -userManager: str
    +userManager: str

    users.yaml in the default configuration folder).

    Type
    @@ -374,7 +374,7 @@
    -userfile: Optional[str]
    +userfile: Optional[str]

    The YAML user file to use. If left out defaults to users.yaml in the default configuration folder.

    @@ -382,10 +382,10 @@
    -class octoprint.schema.config.api.ApiConfig(*, allowCrossOrigin: bool = False)
    +class octoprint.schema.config.api.ApiConfig(*, allowCrossOrigin: bool = False)
    -allowCrossOrigin: bool
    +allowCrossOrigin: bool

    Whether to allow cross origin access to the API or not.

    @@ -393,10 +393,10 @@
    -class octoprint.schema.config.appearance.AppearanceConfig(*, name: str = '', color: octoprint.schema.config.appearance.ColorEnum = ColorEnum.default, colorTransparent: bool = False, colorIcon: bool = True, defaultLanguage: str = '_default', showFahrenheitAlso: bool = False, fuzzyTimes: bool = True, closeModalsWithClick: bool = True, showInternalFilename: bool = True, components: octoprint.schema.config.appearance.ComponentConfig = ComponentConfig(order=ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic=[]), disabled=ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[])))
    +class octoprint.schema.config.appearance.AppearanceConfig(*, name: str = '', color: octoprint.schema.config.appearance.ColorEnum = ColorEnum.default, colorTransparent: bool = False, colorIcon: bool = True, defaultLanguage: str = '_default', showFahrenheitAlso: bool = False, fuzzyTimes: bool = True, closeModalsWithClick: bool = True, showInternalFilename: bool = True, components: octoprint.schema.config.appearance.ComponentConfig = ComponentConfig(order=ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic=[]), disabled=ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[])))
    -closeModalsWithClick: bool
    +closeModalsWithClick: bool
    @@ -407,12 +407,12 @@
    -colorIcon: bool
    +colorIcon: bool
    -colorTransparent: bool
    +colorTransparent: bool

    Makes the color of the navigation bar “transparent”. In case your printer uses acrylic for its frame 😉.

    @@ -424,18 +424,18 @@
    -defaultLanguage: str
    +defaultLanguage: str

    Default language of OctoPrint. If left unset OctoPrint will try to match up available languages with the user’s browser settings.

    -fuzzyTimes: bool
    +fuzzyTimes: bool
    -name: str
    +name: str

    <>”)

    Type
    @@ -446,12 +446,12 @@
    -showFahrenheitAlso: bool
    +showFahrenheitAlso: bool
    -showInternalFilename: bool
    +showInternalFilename: bool

    Show the internal filename in the files sidebar, if necessary.

    @@ -517,52 +517,52 @@
    -class octoprint.schema.config.appearance.ComponentDisabledConfig(*, navbar: List[str] = [], sidebar: List[str] = [], tab: List[str] = [], settings: List[str] = [], usersettings: List[str] = [], wizard: List[str] = [], about: List[str] = [], generic: List[str] = [])
    +class octoprint.schema.config.appearance.ComponentDisabledConfig(*, navbar: List[str] = [], sidebar: List[str] = [], tab: List[str] = [], settings: List[str] = [], usersettings: List[str] = [], wizard: List[str] = [], about: List[str] = [], generic: List[str] = [])
    -about: List[str]
    +about: List[str]

    Disabled about dialog items.

    -generic: List[str]
    +generic: List[str]

    Disabled generic items.

    -navbar: List[str]
    +navbar: List[str]

    Disabled navbar items.

    -settings: List[str]
    +settings: List[str]

    Disabled settings.

    -sidebar: List[str]
    +sidebar: List[str]

    Disabled sidebar items.

    -tab: List[str]
    +tab: List[str]

    Disabled tabs.

    -usersettings: List[str]
    +usersettings: List[str]

    Disabled user settings.

    -wizard: List[str]
    +wizard: List[str]

    Disabled wizards.

    @@ -570,52 +570,52 @@
    -class octoprint.schema.config.appearance.ComponentOrderConfig(*, navbar: List[str] = ['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar: List[str] = ['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab: List[str] = ['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings: List[str] = ['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings: List[str] = ['access', 'interface'], wizard: List[str] = ['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about: List[str] = ['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic: List[str] = [])
    +class octoprint.schema.config.appearance.ComponentOrderConfig(*, navbar: List[str] = ['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar: List[str] = ['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab: List[str] = ['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings: List[str] = ['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings: List[str] = ['access', 'interface'], wizard: List[str] = ['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about: List[str] = ['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic: List[str] = [])
    -about: List[str]
    +about: List[str]

    Order of about dialog items.

    -generic: List[str]
    +generic: List[str]

    Order of generic items.

    -navbar: List[str]
    +navbar: List[str]

    Order of navbar items.

    -settings: List[str]
    +settings: List[str]

    Order of settings.

    -sidebar: List[str]
    +sidebar: List[str]

    Order of sidebar items.

    -tab: List[str]
    +tab: List[str]

    Order of tabs.

    -usersettings: List[str]
    +usersettings: List[str]

    Order of user settings.

    -wizard: List[str]
    +wizard: List[str]

    Order of wizards.

    @@ -623,7 +623,7 @@
    -class octoprint.schema.config.controls.ContainerConfig(*, children: List[Union[ContainerConfig, ControlConfig]] = [], name: Optional[str] = None, layout: octoprint.schema.config.controls.LayoutEnum = LayoutEnum.vertical)
    +class octoprint.schema.config.controls.ContainerConfig(*, children: List[Union[ContainerConfig, ControlConfig]] = [], name: Optional[str] = None, layout: octoprint.schema.config.controls.LayoutEnum = LayoutEnum.vertical)
    children: List[Union[octoprint.schema.config.controls.ContainerConfig, octoprint.schema.config.controls.ControlConfig]]
    @@ -638,7 +638,7 @@
    -name: Optional[str]
    +name: Optional[str]

    A name to display above the container, basically a section header.

    @@ -646,34 +646,34 @@
    -class octoprint.schema.config.controls.ControlConfig(*, name: str, command: Optional[str] = None, commands: Optional[List[str]] = None, script: Optional[str] = None, javascript: Optional[str] = None, additionalClasses: Optional[str] = None, enabled: Optional[str] = None, input: Optional[List[octoprint.schema.config.controls.ControlInputConfig]] = [], regex: Optional[str] = None, template: Optional[str] = None, confirm: Optional[str] = None)
    +class octoprint.schema.config.controls.ControlConfig(*, name: str, command: Optional[str] = None, commands: Optional[List[str]] = None, script: Optional[str] = None, javascript: Optional[str] = None, additionalClasses: Optional[str] = None, enabled: Optional[str] = None, input: Optional[List[octoprint.schema.config.controls.ControlInputConfig]] = [], regex: Optional[str] = None, template: Optional[str] = None, confirm: Optional[str] = None)
    -additionalClasses: Optional[str]
    +additionalClasses: Optional[str]

    Additional classes to apply to the button of a command, commands, script or javascript control, other than the default btn. Can be used to visually style the button, e.g. set to btn-danger to turn the button red.

    -command: Optional[str]
    +command: Optional[str]

    A single GCODE command to send to the printer. Will be rendered as a button which sends the command to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with commands and script. The rendered button be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met.

    -commands: Optional[List[str]]
    +commands: Optional[List[str]]

    A list of GCODE commands to send to the printer. Will be rendered as a button which sends the commands to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with command and script. The rendered button will be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met.

    -confirm: Optional[str]
    +confirm: Optional[str]

    A text to display to the user to confirm his button press. Can be used with sensitive custom controls like changing EEPROM values in order to prevent accidental clicks. The text will be displayed in a confirmation dialog.

    -enabled: Optional[str]
    +enabled: Optional[str]

    A JavaScript snippet returning either true or false determining whether the control should be enabled or not. This allows to override the default logic for the enable state of the control (disabled if printer is offline). The JavaScript snippet is eval’d and processed in a context where the control it is part of is provided as local variable data and the ControlViewModel is available as self.

    @@ -685,19 +685,19 @@
    -javascript: Optional[str]
    +javascript: Optional[str]

    A JavaScript snippet to be executed when the button rendered for command or commands is clicked. This allows to override the direct sending of the command or commands to the printer with more sophisticated behaviour. The JavaScript snippet is eval’d and processed in a context where the control it is part of is provided as local variable data and the ControlViewModel is available as self.

    -name: str
    +name: str

    The name of the control, will be displayed either on the button if it’s a control sending a command or as a label for controls which only display output.

    -regex: Optional[str]
    +regex: Optional[str]

    //docs.python.org/3/library/re.html#regular-expression-syntax) to match against lines received from the printer to retrieve information from it (e.g. specific output). Together with template this allows rendition of received data from the printer within the UI.

    Type
    @@ -708,13 +708,13 @@
    -script: Optional[str]
    +script: Optional[str]

    The name of a full blown [GCODE script]() to send to the printer. Will be rendered as a button which sends the script to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with command and commands. The rendered button will be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met. Values of input parameters will be available in the template context under the parameter variable (e.g. an input parameter speed will be available in the script template as parameter.speed). On top of that all other variables defined in the [GCODE template context]() will be available.

    -template: Optional[str]
    +template: Optional[str]

    {temperature}` for a regex T:s*(?P<temperature>d+(.d*)) or positional groups within the regex (e.g. Position: X={0}, Y={1}, Z={2}, E={3} for a regex X:([0-9.]+) Y:([0-9.]+) Z:([0-9.]+) E:([0-9.]+)).

    Type
    @@ -730,22 +730,22 @@
    -class octoprint.schema.config.controls.ControlInputConfig(*, name: str, parameter: str, default: Union[str, int, float, bool], slider: Optional[octoprint.schema.config.controls.ControlSliderInputConfig] = None)
    +class octoprint.schema.config.controls.ControlInputConfig(*, name: str, parameter: str, default: Union[str, int, float, bool], slider: Optional[octoprint.schema.config.controls.ControlSliderInputConfig] = None)
    -default: Union[str, int, float, bool]
    +default: Union[str, int, float, bool]

    Default value for the input field.

    -name: str
    +name: str

    Name to display for the input field.

    -parameter: str
    +parameter: str

    Internal parameter name for the input field, used as a placeholder in command/commands.

    @@ -759,22 +759,22 @@
    -class octoprint.schema.config.controls.ControlSliderInputConfig(*, min: int = 0, max: int = 255, step: int = 1)
    +class octoprint.schema.config.controls.ControlSliderInputConfig(*, min: int = 0, max: int = 255, step: int = 1)
    -max: int
    +max: int

    Maximum value of the slider.

    -min: int
    +min: int

    Minimum value of the slider.

    -step: int
    +step: int

    Step size per slider tick.

    @@ -798,16 +798,16 @@
    -class octoprint.schema.config.devel.DevelCacheConfig(*, enabled: bool = True, preemptive: bool = True)
    +class octoprint.schema.config.devel.DevelCacheConfig(*, enabled: bool = True, preemptive: bool = True)
    -enabled: bool
    +enabled: bool

    Whether to enable caching. Defaults to true. Setting it to false will cause the UI to always be fully rerendered on request to / on the server.

    -preemptive: bool
    +preemptive: bool

    Whether to enable the preemptive cache.

    @@ -815,7 +815,7 @@
    -class octoprint.schema.config.devel.DevelConfig(*, stylesheet: octoprint.schema.config.devel.StylesheetEnum = StylesheetEnum.css, cache: octoprint.schema.config.devel.DevelCacheConfig = DevelCacheConfig(enabled=True, preemptive=True), webassets: octoprint.schema.config.devel.DevelWebassetsConfig = DevelWebassetsConfig(bundle=True, clean_on_startup=True, minify=True, minify_plugins=False), useFrozenDictForPrinterState: bool = True, showLoadingAnimation: bool = True, sockJsConnectTimeout: float = 30, pluginTimings: bool = False, enableRateLimiter: bool = True, enableCsrfProtection: bool = True)
    +class octoprint.schema.config.devel.DevelConfig(*, stylesheet: octoprint.schema.config.devel.StylesheetEnum = StylesheetEnum.css, cache: octoprint.schema.config.devel.DevelCacheConfig = DevelCacheConfig(enabled=True, preemptive=True), webassets: octoprint.schema.config.devel.DevelWebassetsConfig = DevelWebassetsConfig(bundle=True, clean_on_startup=True, minify=True, minify_plugins=False), useFrozenDictForPrinterState: bool = True, showLoadingAnimation: bool = True, sockJsConnectTimeout: float = 30, pluginTimings: bool = False, enableRateLimiter: bool = True, enableCsrfProtection: bool = True)
    cache: octoprint.schema.config.devel.DevelCacheConfig
    @@ -824,30 +824,30 @@
    -enableCsrfProtection: bool
    +enableCsrfProtection: bool

    Enable or disable the CSRF protection. Careful, disabling this reduces security.

    -enableRateLimiter: bool
    +enableRateLimiter: bool

    Enable or disable the rate limiter. Careful, disabling this reduces security.

    -pluginTimings: bool
    +pluginTimings: bool
    -showLoadingAnimation: bool
    +showLoadingAnimation: bool

    Enable or disable the loading animation.

    -sockJsConnectTimeout: float
    +sockJsConnectTimeout: float
    @@ -858,7 +858,7 @@
    -useFrozenDictForPrinterState: bool
    +useFrozenDictForPrinterState: bool
    @@ -871,10 +871,10 @@
    -class octoprint.schema.config.devel.DevelWebassetsConfig(*, bundle: bool = True, clean_on_startup: bool = True, minify: bool = True, minify_plugins: bool = False)
    +class octoprint.schema.config.devel.DevelWebassetsConfig(*, bundle: bool = True, clean_on_startup: bool = True, minify: bool = True, minify_plugins: bool = False)
    -bundle: bool
    +bundle: bool

    if this is set to false, no minification will take place regardless of the minify setting.

    Type
    @@ -885,13 +885,13 @@
    -clean_on_startup: bool
    +clean_on_startup: bool

    Whether to delete generated web assets on server startup (forcing a regeneration).

    -minify: bool
    +minify: bool

    if bundle is set to false, no minification will take place either.

    Type
    @@ -902,7 +902,7 @@
    -minify_plugins: bool
    +minify_plugins: bool

    if bundle or minify are set to false, no minification of the plugin assets will take place either.

    Type
    @@ -942,34 +942,34 @@
    -class octoprint.schema.config.estimation.PrintTimeEstimationConfig(*, statsWeighingUntil: float = 0.5, validityRange: float = 0.15, forceDumbFromPercent: float = 0.3, forceDumbAfterMin: float = 30.0, stableThreshold: int = 60)
    +class octoprint.schema.config.estimation.PrintTimeEstimationConfig(*, statsWeighingUntil: float = 0.5, validityRange: float = 0.15, forceDumbFromPercent: float = 0.3, forceDumbAfterMin: float = 30.0, stableThreshold: int = 60)
    -forceDumbAfterMin: float
    +forceDumbAfterMin: float

    If no estimate could be calculated until this many minutes into the print and no statistical data is available, use dumb linear estimate.

    -forceDumbFromPercent: float
    +forceDumbFromPercent: float

    If no estimate could be calculated until this percentage and no statistical data is available, use dumb linear estimate. Value between 0 and 1.0.

    -stableThreshold: int
    +stableThreshold: int

    Average fluctuation between individual calculated estimates to consider in stable range. Seconds of difference.

    -statsWeighingUntil: float
    +statsWeighingUntil: float

    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.

    -validityRange: float
    +validityRange: float

    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.

    @@ -977,34 +977,34 @@
    -class octoprint.schema.config.events.EventSubscription(*, event: str, name: Optional[str] = None, command: str, type: octoprint.schema.config.events.SubscriptionTypeEnum, enabled: bool = True, debug: bool = False)
    +class octoprint.schema.config.events.EventSubscription(*, event: str, name: Optional[str] = None, command: str, type: octoprint.schema.config.events.SubscriptionTypeEnum, enabled: bool = True, debug: bool = False)
    -command: str
    +command: str

    The command to execute when the event is triggered, either a GCODE or a system command.

    -debug: bool
    +debug: bool

    If set to true, OctoPrint will log the command after performing all placeholder replacements.

    -enabled: bool
    +enabled: bool

    Whether the event subscription should be enabled.

    -event: str
    +event: str

    The event to subscribe to.

    -name: Optional[str]
    +name: Optional[str]

    The event name to show on the UI

    @@ -1018,10 +1018,10 @@
    -class octoprint.schema.config.events.EventsConfig(*, enabled: bool = True, subscriptions: List[octoprint.schema.config.events.EventSubscription] = [])
    +class octoprint.schema.config.events.EventsConfig(*, enabled: bool = True, subscriptions: List[octoprint.schema.config.events.EventSubscription] = [])
    -enabled: bool
    +enabled: bool

    Whether event subscriptions should be enabled or not.

    @@ -1051,164 +1051,164 @@
    -class octoprint.schema.config.feature.FeatureConfig(*, temperatureGraph: bool = True, sdSupport: bool = True, keyboardControl: bool = True, pollWatched: bool = False, modelSizeDetection: bool = True, rememberFileFolder: bool = False, printStartConfirmation: bool = False, printCancelConfirmation: bool = True, uploadOverwriteConfirmation: bool = True, autoUppercaseBlacklist: List[str] = ['M117', 'M118'], g90InfluencesExtruder: bool = False, enforceReallyUniversalFilenames: bool = False, enableDragDropUpload: bool = True)
    +class octoprint.schema.config.feature.FeatureConfig(*, temperatureGraph: bool = True, sdSupport: bool = True, keyboardControl: bool = True, pollWatched: bool = False, modelSizeDetection: bool = True, rememberFileFolder: bool = False, printStartConfirmation: bool = False, printCancelConfirmation: bool = True, uploadOverwriteConfirmation: bool = True, autoUppercaseBlacklist: List[str] = ['M117', 'M118'], g90InfluencesExtruder: bool = False, enforceReallyUniversalFilenames: bool = False, enableDragDropUpload: bool = True)
    -autoUppercaseBlacklist: List[str]
    +autoUppercaseBlacklist: List[str]

    Commands that should never be auto-uppercased when sent to the printer through the Terminal tab.

    -enableDragDropUpload: bool
    +enableDragDropUpload: bool

    Enable drag and drop upload overlay

    -enforceReallyUniversalFilenames: bool
    +enforceReallyUniversalFilenames: bool

    Replace all special characters and spaces with text equivalent to make them universally compatible. Most OS filesystems work fine with unicode characters, but just in case you can revert to the older behaviour by setting this to true.

    -g90InfluencesExtruder: bool
    +g90InfluencesExtruder: bool

    Whether G90/G91 also influence absolute/relative mode of extruders.

    -keyboardControl: bool
    +keyboardControl: bool

    Whether to enable the keyboard control feature in the control tab.

    -modelSizeDetection: bool
    +modelSizeDetection: bool

    Whether to enable model size detection and warning (true) or not (false).

    -pollWatched: bool
    +pollWatched: bool

    Whether to actively poll the watched folder (true) or to rely on the OS’s file system notifications instead (false).

    -printCancelConfirmation: bool
    +printCancelConfirmation: bool

    Whether to show a confirmation on print cancelling (true) or not (false)

    -printStartConfirmation: bool
    +printStartConfirmation: bool

    Whether to show a confirmation on print start (true) or not (false)

    -rememberFileFolder: bool
    +rememberFileFolder: bool

    Whether to remember the selected folder on the file manager.

    -sdSupport: bool
    +sdSupport: bool

    Specifies whether support for SD printing and file management should be enabled.

    -temperatureGraph: bool
    +temperatureGraph: bool

    Whether to enable the temperature graph in the UI or not.

    -uploadOverwriteConfirmation: bool
    +uploadOverwriteConfirmation: bool
    -class octoprint.schema.config.folder.FolderConfig(*, uploads: Optional[str] = None, timelapse: Optional[str] = None, timelapse_tmp: Optional[str] = None, logs: Optional[str] = None, virtualSd: Optional[str] = None, watched: Optional[str] = None, plugins: Optional[str] = None, slicingProfiles: Optional[str] = None, printerProfiles: Optional[str] = None, scripts: Optional[str] = None, translations: Optional[str] = None, generated: Optional[str] = None, data: Optional[str] = None)
    +class octoprint.schema.config.folder.FolderConfig(*, uploads: Optional[str] = None, timelapse: Optional[str] = None, timelapse_tmp: Optional[str] = None, logs: Optional[str] = None, virtualSd: Optional[str] = None, watched: Optional[str] = None, plugins: Optional[str] = None, slicingProfiles: Optional[str] = None, printerProfiles: Optional[str] = None, scripts: Optional[str] = None, translations: Optional[str] = None, generated: Optional[str] = None, data: Optional[str] = None)
    -data: Optional[str]
    +data: Optional[str]

    Absolute path where to store additional data. Defaults to the data folder in OctoPrint’s base folder.

    -generated: Optional[str]
    +generated: Optional[str]

    Absolute path where to store generated files. Defaults to the generated folder in OctoPrint’s base folder.

    -logs: Optional[str]
    +logs: Optional[str]

    Absolute path where to store logs. Defaults to the logs folder in OctoPrint’s base folder.

    -plugins: Optional[str]
    +plugins: Optional[str]

    Absolute path where to locate and install single file plugins. Defaults to the plugins folder in OctoPrint’s base folder.

    -printerProfiles: Optional[str]
    +printerProfiles: Optional[str]

    Absolute path where to store printer profiles. Defaults to the printerProfiles folder in OctoPrint’s base folder.

    -scripts: Optional[str]
    +scripts: Optional[str]

    Absolute path where to store (GCODE) scripts. Defaults to the scripts folder in OctoPrint’s base folder.

    -slicingProfiles: Optional[str]
    +slicingProfiles: Optional[str]

    Absolute path where to store slicing profiles. Defaults to the slicingProfiles folder in OctoPrint’s base folder.

    -timelapse: Optional[str]
    +timelapse: Optional[str]

    Absolute path where to store finished timelase recordings. Defaults to the timelapse folder in OctoPrint’s base folder.

    -timelapse_tmp: Optional[str]
    +timelapse_tmp: Optional[str]

    Absolute path where to store temporary timelapse snapshots. Defaults to the timelapse/tmp folder in OctoPrint’s base folder.

    -translations: Optional[str]
    +translations: Optional[str]

    Absolute path where to store additional translations. Defaults to the translations folder in OctoPrint’s base folder.

    -uploads: Optional[str]
    +uploads: Optional[str]

    Absolute path where to store gcode uploads. Defaults to the uploads folder in OctoPrint’s base folder.

    -virtualSd: Optional[str]
    +virtualSd: Optional[str]

    Absolute path where to store the virtual printer’s SD card files. Defaults to the virtualSd folder in OctoPrint’s base folder.

    -watched: Optional[str]
    +watched: Optional[str]

    Absolute path to the watched folder. Defaults to the watched folder in OctoPrint’s base folder.

    @@ -1216,16 +1216,16 @@
    -class octoprint.schema.config.gcode_analysis.GcodeAnalysisConfig(*, maxExtruders: int = 10, throttle_normalprio: float = 0.01, throttle_highprio: float = 0.0, throttle_lines: int = 100, runAt: octoprint.schema.config.gcode_analysis.RunAtEnum = RunAtEnum.idle, bedZ: float = 0.0)
    +class octoprint.schema.config.gcode_analysis.GcodeAnalysisConfig(*, maxExtruders: int = 10, throttle_normalprio: float = 0.01, throttle_highprio: float = 0.0, throttle_lines: int = 100, runAt: octoprint.schema.config.gcode_analysis.RunAtEnum = RunAtEnum.idle, bedZ: float = 0.0)
    -bedZ: float
    +bedZ: float

    Z position considered the location of the bed.

    -maxExtruders: int
    +maxExtruders: int

    Maximum number of extruders to support/to sanity check for.

    @@ -1237,19 +1237,19 @@
    -throttle_highprio: float
    +throttle_highprio: float

    Pause between each processed GCODE line batch in high priority mode (e.g. on fresh uploads), seconds.

    -throttle_lines: int
    +throttle_lines: int

    GCODE line batch size.

    -throttle_normalprio: float
    +throttle_normalprio: float

    Pause between each processed GCODE line batch in normal priority mode, seconds.

    @@ -1278,22 +1278,22 @@
    -class octoprint.schema.config.plugins.PluginsConfig(*, _disabled: List[str] = [], _forcedCompatible: List[str] = [], _sortingOrder: Dict[str, Dict[str, int]] = {})
    +class octoprint.schema.config.plugins.PluginsConfig(*, _disabled: List[str] = [], _forcedCompatible: List[str] = [], _sortingOrder: Dict[str, Dict[str, int]] = {})
    -disabled: List[str]
    +disabled: List[str]

    Identifiers of installed but disabled plugins.

    -forced_compatible: List[str]
    +forced_compatible: List[str]

    Identifiers of plugins for which python compatibility information will be ignored and the plugin considered compatible in any case. Only for development, do NOT use in production.

    -sorting_order: Dict[str, Dict[str, int]]
    +sorting_order: Dict[str, Dict[str, int]]

    Custom sorting of hooks and implementations provided by plugins. Two-tiered dictionary structure, plugin identifier mapping to a dictionary of order overrides mapped by sorting context/hook name.

    @@ -1301,20 +1301,20 @@
    -class octoprint.schema.config.printer_parameters.PrinterParametersConfig(*, pauseTriggers: List[str] = [])
    +class octoprint.schema.config.printer_parameters.PrinterParametersConfig(*, pauseTriggers: List[str] = [])
    -pauseTriggers: List[str]
    +pauseTriggers: List[str]
    -class octoprint.schema.config.printer_profiles.PrinterProfilesConfig(*, default: Optional[str] = None)
    +class octoprint.schema.config.printer_profiles.PrinterProfilesConfig(*, default: Optional[str] = None)
    -default: Optional[str]
    +default: Optional[str]

    Name of the printer profile to default to.

    @@ -1322,55 +1322,55 @@
    -class octoprint.schema.config.scripts.GcodeScriptsConfig(*, afterPrinterConnected: Optional[str] = None, beforePrinterDisconnected: Optional[str] = None, beforePrintStarted: Optional[str] = None, afterPrintCancelled: Optional[str] = "; disable motors\nM84\n\n;disable all heaters\n{% snippet 'disable_hotends' %}\n{% snippet 'disable_bed' %}\n;disable fan\nM106 S0", afterPrintDone: Optional[str] = None, beforePrintPaused: Optional[str] = None, afterPrintResumed: Optional[str] = None, beforeToolChange: Optional[str] = None, afterToolChange: Optional[str] = None, snippets: Dict[str, str] = {'disable_bed': '{% if printer_profile.heatedBed %}M140 S0\n{% endif %}', 'disable_hotends': '{% if printer_profile.extruder.sharedNozzle %}M104 T0 S0\n{% else %}{% for tool in range(printer_profile.extruder.count) %}M104 T{{ tool }} S0\n{% endfor %}{% endif %}'})
    +class octoprint.schema.config.scripts.GcodeScriptsConfig(*, afterPrinterConnected: Optional[str] = None, beforePrinterDisconnected: Optional[str] = None, beforePrintStarted: Optional[str] = None, afterPrintCancelled: Optional[str] = "; disable motors\nM84\n\n;disable all heaters\n{% snippet 'disable_hotends' %}\n{% snippet 'disable_bed' %}\n;disable fan\nM106 S0", afterPrintDone: Optional[str] = None, beforePrintPaused: Optional[str] = None, afterPrintResumed: Optional[str] = None, beforeToolChange: Optional[str] = None, afterToolChange: Optional[str] = None, snippets: Dict[str, str] = {'disable_bed': '{% if printer_profile.heatedBed %}M140 S0\n{% endif %}', 'disable_hotends': '{% if printer_profile.extruder.sharedNozzle %}M104 T0 S0\n{% else %}{% for tool in range(printer_profile.extruder.count) %}M104 T{{ tool }} S0\n{% endfor %}{% endif %}'})
    -afterPrintCancelled: Optional[str]
    +afterPrintCancelled: Optional[str]
    -afterPrintDone: Optional[str]
    +afterPrintDone: Optional[str]
    -afterPrintResumed: Optional[str]
    +afterPrintResumed: Optional[str]
    -afterPrinterConnected: Optional[str]
    +afterPrinterConnected: Optional[str]
    -afterToolChange: Optional[str]
    +afterToolChange: Optional[str]
    -beforePrintPaused: Optional[str]
    +beforePrintPaused: Optional[str]
    -beforePrintStarted: Optional[str]
    +beforePrintStarted: Optional[str]
    -beforePrinterDisconnected: Optional[str]
    +beforePrinterDisconnected: Optional[str]
    -beforeToolChange: Optional[str]
    +beforeToolChange: Optional[str]
    -snippets: Dict[str, str]
    +snippets: Dict[str, str]
    @@ -1429,46 +1429,46 @@
    -class octoprint.schema.config.serial.SerialCapabilities(*, autoreport_temp: bool = True, autoreport_sdstatus: bool = True, autoreport_pos: bool = True, busy_protocol: bool = True, emergency_parser: bool = True, extended_m20: bool = True, lfn_write: bool = True)
    +class octoprint.schema.config.serial.SerialCapabilities(*, autoreport_temp: bool = True, autoreport_sdstatus: bool = True, autoreport_pos: bool = True, busy_protocol: bool = True, emergency_parser: bool = True, extended_m20: bool = True, lfn_write: bool = True)
    -autoreport_pos: bool
    +autoreport_pos: bool

    Whether to enable position autoreport in the firmware if its support is detected

    -autoreport_sdstatus: bool
    +autoreport_sdstatus: bool

    Whether to enable SD printing autoreport in the firmware if its support is detected

    -autoreport_temp: bool
    +autoreport_temp: bool

    Whether to enable temperature autoreport in the firmware if its support is detected

    -busy_protocol: bool
    +busy_protocol: bool

    Whether to shorten the communication timeout if the firmware seems to support the busy protocol

    -emergency_parser: bool
    +emergency_parser: bool

    Whether to send emergency commands out of band if the firmware seems to support the emergency parser

    -extended_m20: bool
    +extended_m20: bool

    Whether to request extended M20 (file list) output from the firmware if its support is detected

    -lfn_write: bool
    +lfn_write: bool

    Whether to enable long filename support for SD card writes if the firmware reports support for it

    @@ -1476,26 +1476,26 @@
    -class octoprint.schema.config.serial.SerialConfig(*, port: Optional[str] = None, baudrate: Optional[int] = None, exclusive: bool = True, lowLatency: bool = False, autoconnect: bool = False, autorefresh: bool = True, autorefreshInterval: int = 1, log: bool = False, timeout: octoprint.schema.config.serial.SerialTimeoutConfig = SerialTimeoutConfig(detectionFirst=10.0, detectionConsecutive=2.0, connection=10.0, communication=30.0, communicationBusy=3.0, temperature=5.0, temperatureTargetSet=2.0, temperatureAutoreport=2.0, sdStatus=1.0, sdStatusAutoreport=1.0, posAutoreport=5.0, resendOk=0.5, baudrateDetectionPause=1.0, positionLogWait=10.0), maxCommunicationTimeouts: octoprint.schema.config.serial.SerialMaxTimeouts = SerialMaxTimeouts(idle=2, printing=5, long=5), maxWritePasses: int = 5, additionalPorts: List[str] = [], additionalBaudrates: List[int] = [], blacklistedPorts: List[str] = [], blacklistedBaudrates: List[int] = [], longRunningCommands: List[str] = ['G4', 'G28', 'G29', 'G30', 'G32', 'M400', 'M226', 'M600'], blockedCommands: List[str] = ['M0', 'M1'], ignoredCommands: List[str] = [], pausingCommands: List[str] = ['M0', 'M1', 'M25'], emergencyCommands: List[str] = ['M112', 'M108', 'M410'], checksumRequiringCommands: List[str] = ['M110'], helloCommand: str = 'M110 N0', disconnectOnErrors: bool = True, ignoreErrorsFromFirmware: bool = False, terminalLogSize: int = 20, lastLineBufferSize: int = 50, logResends: bool = True, supportResendsWithoutOk: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', logPositionOnPause: bool = True, logPositionOnCancel: bool = False, abortHeatupOnCancel: bool = True, waitForStartOnConnect: bool = False, waitToLoadSdFileList: bool = True, alwaysSendChecksum: bool = False, neverSendChecksum: bool = False, sendChecksumWithUnknownCommands: bool = False, unknownCommandsNeedAck: bool = False, sdRelativePath: bool = False, sdAlwaysAvailable: bool = False, sdLowerCase: bool = False, sdCancelCommand: str = 'M25', maxNotSdPrinting: int = 2, swallowOkAfterResend: bool = True, repetierTargetTemp: bool = False, externalHeatupDetection: bool = True, supportWait: bool = True, ignoreIdenticalResends: bool = False, identicalResendsCountdown: int = 7, supportFAsCommand: bool = False, firmwareDetection: bool = True, blockWhileDwelling: bool = False, useParityWorkaround: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', maxConsecutiveResends: int = 10, sendM112OnError: bool = True, disableSdPrintingDetection: bool = False, ackMax: int = 1, sanityCheckTools: bool = True, notifySuppressedCommands: octoprint.schema.config.serial.InfoWarnNeverEnum = 'warn', capabilities: octoprint.schema.config.serial.SerialCapabilities = SerialCapabilities(autoreport_temp=True, autoreport_sdstatus=True, autoreport_pos=True, busy_protocol=True, emergency_parser=True, extended_m20=True, lfn_write=True), resendRatioThreshold: int = 10, resendRatioStart: int = 100, ignoreEmptyPorts: bool = False, encoding: str = 'ascii', enableShutdownActionCommand: bool = False, triggerOkForM29: bool = True)
    +class octoprint.schema.config.serial.SerialConfig(*, port: Optional[str] = None, baudrate: Optional[int] = None, exclusive: bool = True, lowLatency: bool = False, autoconnect: bool = False, autorefresh: bool = True, autorefreshInterval: int = 1, log: bool = False, timeout: octoprint.schema.config.serial.SerialTimeoutConfig = SerialTimeoutConfig(detectionFirst=10.0, detectionConsecutive=2.0, connection=10.0, communication=30.0, communicationBusy=3.0, temperature=5.0, temperatureTargetSet=2.0, temperatureAutoreport=2.0, sdStatus=1.0, sdStatusAutoreport=1.0, posAutoreport=5.0, resendOk=0.5, baudrateDetectionPause=1.0, positionLogWait=10.0), maxCommunicationTimeouts: octoprint.schema.config.serial.SerialMaxTimeouts = SerialMaxTimeouts(idle=2, printing=5, long=5), maxWritePasses: int = 5, additionalPorts: List[str] = [], additionalBaudrates: List[int] = [], blacklistedPorts: List[str] = [], blacklistedBaudrates: List[int] = [], longRunningCommands: List[str] = ['G4', 'G28', 'G29', 'G30', 'G32', 'M400', 'M226', 'M600'], blockedCommands: List[str] = ['M0', 'M1'], ignoredCommands: List[str] = [], pausingCommands: List[str] = ['M0', 'M1', 'M25'], emergencyCommands: List[str] = ['M112', 'M108', 'M410'], checksumRequiringCommands: List[str] = ['M110'], helloCommand: str = 'M110 N0', disconnectOnErrors: bool = True, ignoreErrorsFromFirmware: bool = False, terminalLogSize: int = 20, lastLineBufferSize: int = 50, logResends: bool = True, supportResendsWithoutOk: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', logPositionOnPause: bool = True, logPositionOnCancel: bool = False, abortHeatupOnCancel: bool = True, waitForStartOnConnect: bool = False, waitToLoadSdFileList: bool = True, alwaysSendChecksum: bool = False, neverSendChecksum: bool = False, sendChecksumWithUnknownCommands: bool = False, unknownCommandsNeedAck: bool = False, sdRelativePath: bool = False, sdAlwaysAvailable: bool = False, sdLowerCase: bool = False, sdCancelCommand: str = 'M25', maxNotSdPrinting: int = 2, swallowOkAfterResend: bool = True, repetierTargetTemp: bool = False, externalHeatupDetection: bool = True, supportWait: bool = True, ignoreIdenticalResends: bool = False, identicalResendsCountdown: int = 7, supportFAsCommand: bool = False, firmwareDetection: bool = True, blockWhileDwelling: bool = False, useParityWorkaround: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', maxConsecutiveResends: int = 10, sendM112OnError: bool = True, disableSdPrintingDetection: bool = False, ackMax: int = 1, sanityCheckTools: bool = True, notifySuppressedCommands: octoprint.schema.config.serial.InfoWarnNeverEnum = 'warn', capabilities: octoprint.schema.config.serial.SerialCapabilities = SerialCapabilities(autoreport_temp=True, autoreport_sdstatus=True, autoreport_pos=True, busy_protocol=True, emergency_parser=True, extended_m20=True, lfn_write=True), resendRatioThreshold: int = 10, resendRatioStart: int = 100, ignoreEmptyPorts: bool = False, encoding: str = 'ascii', enableShutdownActionCommand: bool = False, triggerOkForM29: bool = True)
    -abortHeatupOnCancel: bool
    +abortHeatupOnCancel: bool
    -ackMax: int
    +ackMax: int
    -additionalBaudrates: List[int]
    +additionalBaudrates: List[int]

    Use this to define additional baud rates to offer for connecting to serial ports. Must be a valid integer

    -additionalPorts: List[str]
    +additionalPorts: List[str]

    //docs.python.org/3/library/glob.html)

    Type
    @@ -1506,53 +1506,53 @@
    -alwaysSendChecksum: bool
    +alwaysSendChecksum: bool

    Specifies whether OctoPrint should send linenumber + checksum with every printer command. Needed for successful communication with Repetier firmware.

    -autoconnect: bool
    +autoconnect: bool

    Whether to try to automatically connect to the printer on startup or not

    -autorefresh: bool
    +autorefresh: bool

    Whether to automatically refresh the port list while no connection is established

    -autorefreshInterval: int
    +autorefreshInterval: int

    Interval in seconds at which to refresh the port list while no connection is established

    -baudrate: Optional[int]
    +baudrate: Optional[int]

    The default baudrate to use to connect to the printer. If unset or set to 0, the baudrate will be auto-detected.

    -blacklistedBaudrates: List[int]
    +blacklistedBaudrates: List[int]
    -blacklistedPorts: List[str]
    +blacklistedPorts: List[str]
    -blockWhileDwelling: bool
    +blockWhileDwelling: bool

    Whether to block all sending to the printer while a G4 (dwell) command is active (true, repetier) or not (false).

    -blockedCommands: List[str]
    +blockedCommands: List[str]

    Commands which should not be sent to the printer, e.g. because they are known to block serial communication until physical interaction with the printer as is the case on most firmwares with the default M0 and M1.

    @@ -1563,35 +1563,35 @@
    -checksumRequiringCommands: List[str]
    +checksumRequiringCommands: List[str]

    Commands which need to always be send with a checksum.

    -disableSdPrintingDetection: bool
    +disableSdPrintingDetection: bool
    -disconnectOnErrors: bool
    +disconnectOnErrors: bool

    Whether to disconnect from the printer on errors or not.

    -emergencyCommands: List[str]
    +emergencyCommands: List[str]
    -enableShutdownActionCommand: bool
    +enableShutdownActionCommand: bool

    Whether to enable support for the shutdown action command, allowing the printer to shut down OctoPrint and the system it’s running on.

    -encoding: str
    +encoding: str

    //docs.python.org/3/library/codecs.html#standard-encodings).

    Type
    @@ -1602,65 +1602,65 @@
    -exclusive: bool
    +exclusive: bool

    Whether to request the serial port exclusively or not

    -externalHeatupDetection: bool
    +externalHeatupDetection: bool

    Whether to enable external heatup detection (to detect heatup triggered e.g. through the printer’s LCD panel or while printing from SD) or not. Causes issues with Repetier’s “first ok then response” approach to communication, so disable for printers running Repetier firmware.

    -firmwareDetection: bool
    +firmwareDetection: bool

    Whether to attempt to auto detect the firmware of the printer and adjust settings accordingly (true) or not and rely on manual configuration (false).

    -helloCommand: str
    +helloCommand: str

    Command to send in order to initiate a handshake with the printer.

    -identicalResendsCountdown: int
    +identicalResendsCountdown: int

    If ignoreIdenticalResends is true, how many consecutive identical resends to ignore.

    -ignoreEmptyPorts: bool
    +ignoreEmptyPorts: bool
    -ignoreErrorsFromFirmware: bool
    +ignoreErrorsFromFirmware: bool

    Whether to completely ignore errors from the firmware or not.

    -ignoreIdenticalResends: bool
    +ignoreIdenticalResends: bool

    Whether to ignore identical resends from the printer (true, repetier) or not (false).

    -ignoredCommands: List[str]
    +ignoredCommands: List[str]

    Commands which should not be sent to the printer and just silently ignored. An example of when you may wish to use this could be useful if you wish to manually change a filament on M600, by using that as a Pausing command.

    -lastLineBufferSize: int
    +lastLineBufferSize: int
    -log: bool
    +log: bool

    might decrease performance)

    Type
    @@ -1671,29 +1671,29 @@
    -logPositionOnCancel: bool
    +logPositionOnCancel: bool
    -logPositionOnPause: bool
    +logPositionOnPause: bool
    -logResends: bool
    +logResends: bool

    Whether to log resends to octoprint.log or not. Invaluable debug tool without performance impact, leave on if possible please.

    -longRunningCommands: List[str]
    +longRunningCommands: List[str]

    Commands which are known to take a long time to be acknowledged by the firmware, e.g. homing, dwelling, auto leveling etc.

    -lowLatency: bool
    +lowLatency: bool

    Whether to request low latency mode on the serial port or not

    @@ -1704,23 +1704,23 @@
    -maxConsecutiveResends: int
    +maxConsecutiveResends: int
    -maxNotSdPrinting: int
    +maxNotSdPrinting: int
    -maxWritePasses: int
    +maxWritePasses: int

    Maximum number of write attempts to serial during which nothing can be written before the communication with the printer is considered dead and OctoPrint will disconnect with an error

    -neverSendChecksum: bool
    +neverSendChecksum: bool
    @@ -1730,19 +1730,19 @@
    -pausingCommands: List[str]
    +pausingCommands: List[str]

    Commands which should cause OctoPrint to pause any ongoing prints.

    -port: Optional[str]
    +port: Optional[str]

    The default port to use to connect to the printer. If unset or set to AUTO, the port will be auto-detected.

    -repetierTargetTemp: bool
    +repetierTargetTemp: bool

    <temperature>` instead of attaching that information to the regular M105 responses.

    Type
    @@ -1753,56 +1753,56 @@
    -resendRatioStart: int
    +resendRatioStart: int
    -resendRatioThreshold: int
    +resendRatioThreshold: int

    Percentage of resend requests among all sent lines that should be considered critical.

    -sanityCheckTools: bool
    +sanityCheckTools: bool
    -sdAlwaysAvailable: bool
    +sdAlwaysAvailable: bool

    Whether to always assume that an SD card is present in the printer. Needed by some firmwares which don’t report the SD card status properly.

    -sdCancelCommand: str
    +sdCancelCommand: str
    -sdLowerCase: bool
    +sdLowerCase: bool
    -sdRelativePath: bool
    +sdRelativePath: bool

    Specifies whether firmware expects relative paths for selecting SD files.

    -sendChecksumWithUnknownCommands: bool
    +sendChecksumWithUnknownCommands: bool

    Specifies whether OctoPrint should also send linenumber + checksum with commands that are not detected as valid GCODE (as in, they do not match the regular expression ^s*([GM]d+|T)).

    -sendM112OnError: bool
    +sendM112OnError: bool
    -supportFAsCommand: bool
    +supportFAsCommand: bool

    Whether to support F on its own as a valid GCODE command (true) or not (false).

    @@ -1814,17 +1814,17 @@
    -supportWait: bool
    +supportWait: bool
    -swallowOkAfterResend: bool
    +swallowOkAfterResend: bool
    -terminalLogSize: int
    +terminalLogSize: int
    @@ -1835,13 +1835,13 @@
    -triggerOkForM29: bool
    +triggerOkForM29: bool

    Whether to automatically trigger an ok for M29 (a lot of versions of this command are buggy and the response skips on the ok).

    -unknownCommandsNeedAck: bool
    +unknownCommandsNeedAck: bool

    Specifies whether OctoPrint should also use up acknowledgments (ok) for commands that are not detected as valid GCODE (as in, they do not match the regular expression ^s*([GM]d+|T)).

    @@ -1852,13 +1852,13 @@
    -waitForStartOnConnect: bool
    +waitForStartOnConnect: bool

    Whether OctoPrint should wait for the start response from the printer before trying to send commands during connect.

    -waitToLoadSdFileList: bool
    +waitToLoadSdFileList: bool

    Specifies whether OctoPrint should wait to load the SD card file list until the first firmware capability report is processed.

    @@ -1866,22 +1866,22 @@
    -class octoprint.schema.config.serial.SerialMaxTimeouts(*, idle: int = 2, printing: int = 5, long: int = 5)
    +class octoprint.schema.config.serial.SerialMaxTimeouts(*, idle: int = 2, printing: int = 5, long: int = 5)
    -idle: int
    +idle: int

    Max. timeouts when the printer is idle

    -long: int
    +long: int

    Max. timeouts when a long running command is active

    -printing: int
    +printing: int

    Max. timeouts when the printer is printing

    @@ -1889,80 +1889,80 @@
    -class octoprint.schema.config.serial.SerialTimeoutConfig(*, detectionFirst: float = 10.0, detectionConsecutive: float = 2.0, connection: float = 10.0, communication: float = 30.0, communicationBusy: float = 3.0, temperature: float = 5.0, temperatureTargetSet: float = 2.0, temperatureAutoreport: float = 2.0, sdStatus: float = 1.0, sdStatusAutoreport: float = 1.0, posAutoreport: float = 5.0, resendOk: float = 0.5, baudrateDetectionPause: float = 1.0, positionLogWait: float = 10.0)
    +class octoprint.schema.config.serial.SerialTimeoutConfig(*, detectionFirst: float = 10.0, detectionConsecutive: float = 2.0, connection: float = 10.0, communication: float = 30.0, communicationBusy: float = 3.0, temperature: float = 5.0, temperatureTargetSet: float = 2.0, temperatureAutoreport: float = 2.0, sdStatus: float = 1.0, sdStatusAutoreport: float = 1.0, posAutoreport: float = 5.0, resendOk: float = 0.5, baudrateDetectionPause: float = 1.0, positionLogWait: float = 10.0)
    -baudrateDetectionPause: float
    +baudrateDetectionPause: float
    -communication: float
    +communication: float

    Timeout during serial communication, in seconds

    -communicationBusy: float
    +communicationBusy: float

    Timeout during serial communication when busy protocol support is detected, in seconds

    -connection: float
    +connection: float

    Timeout for waiting to establish a connection with the selected port, in seconds

    -detectionConsecutive: float
    +detectionConsecutive: float
    -detectionFirst: float
    +detectionFirst: float
    -posAutoreport: float
    +posAutoreport: float
    -positionLogWait: float
    +positionLogWait: float
    -resendOk: float
    +resendOk: float
    -sdStatus: float
    +sdStatus: float

    Timeout after which to query the SD status while SD printing

    -sdStatusAutoreport: float
    +sdStatusAutoreport: float
    -temperature: float
    +temperature: float

    Timeout after which to query temperature when no target is set

    -temperatureAutoreport: float
    +temperatureAutoreport: float
    -temperatureTargetSet: float
    +temperatureTargetSet: float

    Timeout after which to query temperature when a target is set

    @@ -1970,28 +1970,28 @@
    -class octoprint.schema.config.server.CommandsConfig(*, systemShutdownCommand: Optional[str] = None, systemRestartCommand: Optional[str] = None, serverRestartCommand: Optional[str] = None, localPipCommand: Optional[str] = None)
    +class octoprint.schema.config.server.CommandsConfig(*, systemShutdownCommand: Optional[str] = None, systemRestartCommand: Optional[str] = None, serverRestartCommand: Optional[str] = None, localPipCommand: Optional[str] = None)
    -localPipCommand: Optional[str]
    +localPipCommand: Optional[str]

    pip command associated with OctoPrint, used for installing plugins and updates, if unset (default) the command will be autodetected based on the current python executable - unless you have a really special setup this is the right way to do it and there should be no need to ever touch this setting.

    -serverRestartCommand: Optional[str]
    +serverRestartCommand: Optional[str]

    Command to restart OctoPrint.

    -systemRestartCommand: Optional[str]
    +systemRestartCommand: Optional[str]

    Command to restart the system OctoPrint is running on.

    -systemShutdownCommand: Optional[str]
    +systemShutdownCommand: Optional[str]

    Command to shut down the system OctoPrint is running on.

    @@ -1999,7 +1999,7 @@
    -class octoprint.schema.config.server.CookiesConfig(*, secure: bool = False, samesite: Optional[octoprint.schema.config.server.SameSiteEnum] = SameSiteEnum.lax)
    +class octoprint.schema.config.server.CookiesConfig(*, secure: bool = False, samesite: Optional[octoprint.schema.config.server.SameSiteEnum] = SameSiteEnum.lax)
    samesite: Optional[octoprint.schema.config.server.SameSiteEnum]
    @@ -2016,7 +2016,7 @@
    -secure: bool
    +secure: bool

    Whether to set the Secure flag to true on cookies. Only set to true if you are running OctoPrint behind a reverse proxy taking care of SSL termination.

    @@ -2024,16 +2024,16 @@
    -class octoprint.schema.config.server.DiskspaceConfig(*, warning: int = 524288000, critical: int = 209715200)
    +class octoprint.schema.config.server.DiskspaceConfig(*, warning: int = 524288000, critical: int = 209715200)
    -critical: int
    +critical: int

    Threshold (bytes) after which to consider disk space becoming critical, defaults to 200MB.

    -warning: int
    +warning: int

    Threshold (bytes) after which to consider disk space becoming sparse, defaults to 500MB.

    @@ -2041,16 +2041,16 @@
    -class octoprint.schema.config.server.IpCheckConfig(*, enabled: bool = True, trustedSubnets: List[str] = [])
    +class octoprint.schema.config.server.IpCheckConfig(*, enabled: bool = True, trustedSubnets: List[str] = [])
    -enabled: bool
    +enabled: bool

    Whether to enable the check.

    -trustedSubnets: List[str]
    +trustedSubnets: List[str]

    Additional non-local subnets to consider trusted, in CIDR notation, e.g. 192.168.1.0/24.

    @@ -2058,34 +2058,34 @@
    -class octoprint.schema.config.server.OnlineCheckConfig(*, enabled: Optional[bool] = None, interval: int = 900, host: str = '1.1.1.1', port: int = 53, name: str = 'octoprint.org')
    +class octoprint.schema.config.server.OnlineCheckConfig(*, enabled: Optional[bool] = None, interval: int = 900, host: str = '1.1.1.1', port: int = 53, name: str = 'octoprint.org')
    -enabled: Optional[bool]
    +enabled: Optional[bool]

    Whether the online check is enabled. Ships unset, the user will be asked to make a decision as part of the setup wizard.

    -host: str
    +host: str

    DNS host against which to check, defaults to Cloudflare’s DNS.

    -interval: int
    +interval: int

    Interval in which to check for online connectivity (in seconds), defaults to 15 minutes.

    -name: str
    +name: str

    Host name for which to check name resolution, defaults to OctoPrint’s main domain.

    -port: int
    +port: int

    DNS port against which to check, defaults to the standard DNS port.

    @@ -2093,16 +2093,16 @@
    -class octoprint.schema.config.server.PluginBlacklistConfig(*, enabled: Optional[bool] = None, url: str = 'https://plugins.octoprint.org/blacklist.json', ttl: int = 900, timeout: float = 3.05)
    +class octoprint.schema.config.server.PluginBlacklistConfig(*, enabled: Optional[bool] = None, url: str = 'https://plugins.octoprint.org/blacklist.json', ttl: int = 900, timeout: float = 3.05)
    -enabled: Optional[bool]
    +enabled: Optional[bool]

    Whether use of the blacklist is enabled. If unset, the user will be asked to make a decision as part of the setup wizard.

    -timeout: float
    +timeout: float

    3.05 seconds).

    Type
    @@ -2113,7 +2113,7 @@
    -ttl: int
    +ttl: int

    15 minutes).

    Type
    @@ -2124,7 +2124,7 @@
    -url: str
    +url: str

    The URL from which to fetch the blacklist.

    @@ -2132,16 +2132,16 @@
    -class octoprint.schema.config.server.PreemptiveCacheConfig(*, exceptions: List[str] = [], until: int = 7)
    +class octoprint.schema.config.server.PreemptiveCacheConfig(*, exceptions: List[str] = [], until: int = 7)
    -exceptions: List[str]
    +exceptions: List[str]

    Which server paths to exclude from the preemptive cache, e.g. /some/path.

    -until: int
    +until: int

    How many days to leave unused entries in the preemptive cache config.

    @@ -2149,66 +2149,66 @@
    -class octoprint.schema.config.server.ReverseProxyConfig(*, prefixHeader: Optional[str] = None, schemeHeader: Optional[str] = None, hostHeader: Optional[str] = None, serverHeader: Optional[str] = None, portHeader: Optional[str] = None, prefixFallback: Optional[str] = None, schemeFallback: Optional[str] = None, hostFallback: Optional[str] = None, serverFallback: Optional[str] = None, portFallback: Optional[str] = None, trustedDownstream: List[str] = [])
    +class octoprint.schema.config.server.ReverseProxyConfig(*, prefixHeader: Optional[str] = None, schemeHeader: Optional[str] = None, hostHeader: Optional[str] = None, serverHeader: Optional[str] = None, portHeader: Optional[str] = None, prefixFallback: Optional[str] = None, schemeFallback: Optional[str] = None, hostFallback: Optional[str] = None, serverFallback: Optional[str] = None, portFallback: Optional[str] = None, trustedDownstream: List[str] = [])
    -hostFallback: Optional[str]
    +hostFallback: Optional[str]

    Use this option to define an optional forced host under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy with a different hostname than OctoPrint itself but can’t configure said reverse proxy to send a host HTTP header (X-Forwarded-Host by default, see above) with forwarded requests.

    -hostHeader: Optional[str]
    +hostHeader: Optional[str]

    The request header from which to determine the host under which OctoPrint is served by the reverse proxy.

    -portFallback: Optional[str]
    +portFallback: Optional[str]
    -portHeader: Optional[str]
    +portHeader: Optional[str]
    -prefixFallback: Optional[str]
    +prefixFallback: Optional[str]

    Use this option to define an optional URL prefix (with a leading /, so absolute to your server’s root) under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy under a different root endpoint than / and can’t configure said reverse proxy to send a prefix HTTP header (X-Script-Name by default, see above) with forwarded requests.

    -prefixHeader: Optional[str]
    +prefixHeader: Optional[str]

    The request header from which to determine the URL prefix under which OctoPrint is served by the reverse proxy.

    -schemeFallback: Optional[str]
    +schemeFallback: Optional[str]

    Use this option to define an optional forced scheme (http or https) under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy that also does HTTPS determination but can’t configure said reverse proxy to send a scheme HTTP header (X-Scheme by default, see above) with forwarded requests.

    -schemeHeader: Optional[str]
    +schemeHeader: Optional[str]

    The request header from which to determine the scheme (http or https) under which a specific request to OctoPrint was made to the reverse proxy.

    -serverFallback: Optional[str]
    +serverFallback: Optional[str]
    -serverHeader: Optional[str]
    +serverHeader: Optional[str]
    -trustedDownstream: List[str]
    +trustedDownstream: List[str]

    List of trusted downstream servers for which to ignore the IP address when trying to determine the connecting client’s IP address. If you have OctoPrint behind more than one reverse proxy you should add their IPs here so that they won’t be interpreted as the client’s IP. One reverse proxy will be handled correctly by default.

    @@ -2240,13 +2240,13 @@ class octoprint.schema.config.server.ServerConfig(*, host: typing.Optional[str] = None, port: int = 5000, firstRun: bool = True, startOnceInSafeMode: bool = False, ignoreIncompleteStartup: bool = False, seenWizards: typing.Dict[str, str] = {}, secretKey: typing.Optional[str] = None, heartbeat: int = 900, reverseProxy: octoprint.schema.config.server.ReverseProxyConfig = ReverseProxyConfig(prefixHeader=None, schemeHeader=None, hostHeader=None, serverHeader=None, portHeader=None, prefixFallback=None, schemeFallback=None, hostFallback=None, serverFallback=None, portFallback=None, trustedDownstream=[]), uploads: octoprint.schema.config.server.UploadsConfig = UploadsConfig(maxSize=1073741824, nameSuffix='name', pathSuffix='path'), maxSize: int = 102400, commands: octoprint.schema.config.server.CommandsConfig = CommandsConfig(systemShutdownCommand=None, systemRestartCommand=None, serverRestartCommand=None, localPipCommand=None), onlineCheck: octoprint.schema.config.server.OnlineCheckConfig = OnlineCheckConfig(enabled=None, interval=900, host='1.1.1.1', port=53, name='octoprint.org'), pluginBlacklist: octoprint.schema.config.server.PluginBlacklistConfig = PluginBlacklistConfig(enabled=None, url='https://plugins.octoprint.org/blacklist.json', ttl=900, timeout=3.05), diskspace: octoprint.schema.config.server.DiskspaceConfig = DiskspaceConfig(warning=524288000, critical=209715200), preemptiveCache: octoprint.schema.config.server.PreemptiveCacheConfig = PreemptiveCacheConfig(exceptions=[], until=7), ipCheck: octoprint.schema.config.server.IpCheckConfig = IpCheckConfig(enabled=True, trustedSubnets=[]), allowFraming: bool = False, cookies: octoprint.schema.config.server.CookiesConfig = CookiesConfig(secure=False, samesite=<SameSiteEnum.lax: 'Lax'>), allowedLoginRedirectPaths: typing.List[str] = [])
    -allowFraming: bool
    +allowFraming: bool

    Whether to allow OctoPrint to be embedded in a frame or not. Note that depending on your setup you might have to set SameSite to None, Secure to true and serve OctoPrint through a reverse proxy that enables https for cookies and thus logging in to work.

    -allowedLoginRedirectPaths: List[str]
    +allowedLoginRedirectPaths: List[str]

    List of paths that are allowed to be used as redirect targets for the login page, in addition to the default ones (/, /recovery/ and /plugin/appkeys/auth/)

    @@ -2270,24 +2270,24 @@
    -firstRun: bool
    +firstRun: bool

    If this option is true, OctoPrint will show the First Run wizard and set the setting to false after that completes.

    -heartbeat: int
    +heartbeat: int
    -host: Optional[str]
    +host: Optional[str]

    Use this option to define the host to which to bind the server. If unset, OctoPrint will attempt to bind on all available interfaces, IPv4 and v6 unless either is disabled.

    -ignoreIncompleteStartup: bool
    +ignoreIncompleteStartup: bool

    Set this to true to make OctoPrint ignore incomplete startups. Helpful for development.

    @@ -2299,7 +2299,7 @@
    -maxSize: int
    +maxSize: int

    Maximum size of requests other than file uploads in bytes, defaults to 100KB.

    @@ -2317,7 +2317,7 @@
    -port: int
    +port: int

    Use this option to define the port to which to bind the server.

    @@ -2340,18 +2340,18 @@
    -secretKey: Optional[str]
    +secretKey: Optional[str]

    Secret key for encrypting cookies and such, randomly generated on first run.

    -seenWizards: Dict[str, str]
    +seenWizards: Dict[str, str]
    -startOnceInSafeMode: bool
    +startOnceInSafeMode: bool

    If this option is true, OctoPrint will enable safe mode on the next server start and reset the setting to false

    @@ -2365,22 +2365,22 @@
    -class octoprint.schema.config.server.UploadsConfig(*, maxSize: int = 1073741824, nameSuffix: str = 'name', pathSuffix: str = 'path')
    +class octoprint.schema.config.server.UploadsConfig(*, maxSize: int = 1073741824, nameSuffix: str = 'name', pathSuffix: str = 'path')
    -maxSize: int
    +maxSize: int

    Maximum size of uploaded files in bytes, defaults to 1GB.

    -nameSuffix: str
    +nameSuffix: str

    Suffix used for storing the filename in the file upload headers when streaming uploads.

    -pathSuffix: str
    +pathSuffix: str

    Suffix used for storing the path to the temporary file in the file upload headers when streaming uploads.

    @@ -2388,22 +2388,22 @@
    -class octoprint.schema.config.slicing.SlicingConfig(*, enabled: bool = True, defaultSlicer: Optional[str] = None, defaultProfiles: Dict[str, str] = {})
    +class octoprint.schema.config.slicing.SlicingConfig(*, enabled: bool = True, defaultSlicer: Optional[str] = None, defaultProfiles: Dict[str, str] = {})
    -defaultProfiles: Dict[str, str]
    +defaultProfiles: Dict[str, str]

    Default slicing profiles per slicer, maps slicer identifier to profile identifier.

    -defaultSlicer: Optional[str]
    +defaultSlicer: Optional[str]

    Default slicer to use.

    -enabled: bool
    +enabled: bool

    Whether to enable slicing support or not.

    @@ -2411,34 +2411,34 @@
    -class octoprint.schema.config.system.ActionConfig(*, action: str, name: Optional[str] = None, command: Optional[str] = None, confirm: Optional[str] = None, **extra_data: Any)
    +class octoprint.schema.config.system.ActionConfig(*, action: str, name: Optional[str] = None, command: Optional[str] = None, confirm: Optional[str] = None, **extra_data: Any)
    -action: str
    +action: str

    The identifier used internally to identify the action. Set to divider to generate a divider in the menu.

    -async_: bool
    +async_: bool

    Whether to run the command asynchronously.

    -command: Optional[str]
    +command: Optional[str]

    The command to execute when the action is selected. Must be set if the action is not a divider.

    -confirm: Optional[str]
    +confirm: Optional[str]

    An optional confirmation message to show before executing the command.

    -name: Optional[str]
    +name: Optional[str]

    The name of the action that will be shown on the menu. Must be set if the action is not a divider.

    @@ -2446,7 +2446,7 @@
    -class octoprint.schema.config.system.SystemConfig(*, actions: List[octoprint.schema.config.system.ActionConfig] = [])
    +class octoprint.schema.config.system.SystemConfig(*, actions: List[octoprint.schema.config.system.ActionConfig] = [])
    actions: List[octoprint.schema.config.system.ActionConfig]
    @@ -2457,10 +2457,10 @@
    -class octoprint.schema.config.temperature.TemperatureConfig(*, profiles: List[octoprint.schema.config.temperature.TemperatureProfile] = [TemperatureProfile(name='ABS', extruder=210, bed=100), TemperatureProfile(name='PLA', extruder=180, bed=60)], cutoff: int = 30, sendAutomatically: bool = False, sendAutomaticallyAfter: int = 1)
    +class octoprint.schema.config.temperature.TemperatureConfig(*, profiles: List[octoprint.schema.config.temperature.TemperatureProfile] = [TemperatureProfile(name='ABS', extruder=210, bed=100), TemperatureProfile(name='PLA', extruder=180, bed=60)], cutoff: int = 30, sendAutomatically: bool = False, sendAutomaticallyAfter: int = 1)
    -cutoff: int
    +cutoff: int

    Cut off time for the temperature data, in minutes.

    @@ -2472,13 +2472,13 @@
    -sendAutomatically: bool
    +sendAutomatically: bool

    Whether to send new temperature settings made in the UI automatically.

    -sendAutomaticallyAfter: int
    +sendAutomaticallyAfter: int

    After what time to send the new temperature settings automatically, in seconds.

    @@ -2486,22 +2486,22 @@
    -class octoprint.schema.config.temperature.TemperatureProfile(*, name: str, extruder: int, bed: int)
    +class octoprint.schema.config.temperature.TemperatureProfile(*, name: str, extruder: int, bed: int)
    -bed: int
    +bed: int

    Bed temperature to set with the profile.

    -extruder: int
    +extruder: int

    Hotend temperature to set with the profile.

    -name: str
    +name: str

    Name of the profile.

    @@ -2509,16 +2509,16 @@
    -class octoprint.schema.config.terminalfilters.TerminalFilterEntry(*, name: str, regex: str)
    +class octoprint.schema.config.terminalfilters.TerminalFilterEntry(*, name: str, regex: str)
    -name: str
    +name: str

    The name of the filter.

    -regex: str
    +regex: str

    //developer.mozilla.org/en/docs/Web/JavaScript/Guide/Regular_Expressions).

    Type
    @@ -2531,10 +2531,10 @@
    -class octoprint.schema.config.webcam.TimelapseConfig(*, type: octoprint.schema.config.webcam.TimelapseTypeEnum = TimelapseTypeEnum.off, fps: int = 25, postRoll: int = 0, options: octoprint.schema.config.webcam.TimelapseOptions = TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None))
    +class octoprint.schema.config.webcam.TimelapseConfig(*, type: octoprint.schema.config.webcam.TimelapseTypeEnum = TimelapseTypeEnum.off, fps: int = 25, postRoll: int = 0, options: octoprint.schema.config.webcam.TimelapseOptions = TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None))
    -fps: int
    +fps: int

    The framerate at which to render the movie.

    @@ -2546,7 +2546,7 @@
    -postRoll: int
    +postRoll: int

    The number of seconds in the rendered video to add after a finished print. The exact way how the additional images will be recorded depends on timelapse type. zchange timelapses will take one final picture and add it fps * postRoll times. timed timelapses continue to record just like at the beginning, so the recording will continue another fps * postRoll * interval seconds. This behaviour can be overridden by setting the capturePostRoll option to false, in which case the post roll will be created identically to zchange mode.

    @@ -2560,10 +2560,10 @@
    -class octoprint.schema.config.webcam.TimelapseOptions(*, interval: Optional[int] = None, capturePostRoll: Optional[bool] = None, retractionZHop: Optional[float] = None)
    +class octoprint.schema.config.webcam.TimelapseOptions(*, interval: Optional[int] = None, capturePostRoll: Optional[bool] = None, retractionZHop: Optional[float] = None)
    -capturePostRoll: Optional[bool]
    +capturePostRoll: Optional[bool]

    Whether to capture the snapshots for the post roll (true) or just copy the last captured snapshot from the print over and over again (false).

    Type
    @@ -2574,7 +2574,7 @@
    -interval: Optional[int]
    +interval: Optional[int]

    The interval which to leave between images in seconds.

    Type
    @@ -2585,7 +2585,7 @@
    -retractionZHop: Optional[float]
    +retractionZHop: Optional[float]

    z-hop height during retractions to ignore for capturing snapshots.

    Type
    @@ -2622,53 +2622,53 @@ class octoprint.schema.config.webcam.WebcamConfig(*, webcamEnabled: bool = True, timelapseEnabled: bool = True, ffmpeg: typing.Optional[str] = None, ffmpegThreads: int = 1, ffmpegVideoCodec: str = 'libx264', bitrate: str = '10000k', watermark: bool = True, ffmpegCommandline: str = '{ffmpeg} -framerate {fps} -i "{input}" -vcodec {videocodec} -threads {threads} -b:v {bitrate} -f {containerformat} -y {filters} "{output}"', ffmpegThumbnailCommandline: str = '{ffmpeg} -sseof -1 -i "{input}" -update 1 -q:v 0.7 "{output}"', timelapse: octoprint.schema.config.webcam.TimelapseConfig = TimelapseConfig(type=<TimelapseTypeEnum.off: 'off'>, fps=25, postRoll=0, options=TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None)), cleanTmpAfterDays: int = 7, defaultWebcam: str = 'classic', snapshotWebcam: str = 'classic')
    -bitrate: str
    +bitrate: str

    The bitrate to use for rendering the timelapse video. This gets directly passed to ffmpeg.

    -cleanTmpAfterDays: int
    +cleanTmpAfterDays: int

    After how many days unrendered timelapses will be deleted.

    -defaultWebcam: str
    +defaultWebcam: str

    The name of the default webcam

    -ffmpeg: Optional[str]
    +ffmpeg: Optional[str]

    Path to ffmpeg binary to use for creating timelapse recordings. Timelapse support will be disabled if not set.

    -ffmpegCommandline: str
    +ffmpegCommandline: str
    -ffmpegThreads: int
    +ffmpegThreads: int

    Number of how many threads to instruct ffmpeg to use for encoding.

    -ffmpegThumbnailCommandline: str
    +ffmpegThumbnailCommandline: str
    -ffmpegVideoCodec: str
    +ffmpegVideoCodec: str

    Videocodec to be used for encoding.

    -snapshotWebcam: str
    +snapshotWebcam: str

    The name of the default webcam to use for snapshots

    @@ -2680,19 +2680,19 @@
    -timelapseEnabled: bool
    +timelapseEnabled: bool

    Use this option to enable timelapse support via snapshot, e.g. via MJPG-Streamer. Timelapse support will be disabled if not set.

    -watermark: bool
    +watermark: bool

    Whether to include a “created with OctoPrint” watermark in the generated timelapse recordings.

    -webcamEnabled: bool
    +webcamEnabled: bool

    Use this option to enable display of a webcam stream in the UI, e.g. via MJPG-Streamer. Webcam support will be disabled if not set.

    @@ -2719,10 +2719,10 @@
    -class octoprint.schema.webcam.Webcam(*, name: str, displayName: str, canSnapshot: bool = False, snapshotDisplay: str = None, flipH: bool = False, flipV: bool = False, rotate90: bool = False, extras: dict = {}, compat: Optional[octoprint.schema.webcam.WebcamCompatibility] = None)
    +class octoprint.schema.webcam.Webcam(*, name: str, displayName: str, canSnapshot: bool = False, snapshotDisplay: str = None, flipH: bool = False, flipV: bool = False, rotate90: bool = False, extras: dict = {}, compat: Optional[octoprint.schema.webcam.WebcamCompatibility] = None)
    -canSnapshot: bool
    +canSnapshot: bool

    Whether this webcam can take a snapshot.

    @@ -2734,43 +2734,43 @@
    -displayName: str
    +displayName: str

    Displayable name for this webcam

    -extras: dict
    +extras: dict

    Unstructured data describing this webcam

    -flipH: bool
    +flipH: bool

    Whether to flip the webcam horizontally.

    -flipV: bool
    +flipV: bool

    Whether to flip the webcam vertically.

    -name: str
    +name: str

    Identifier of this webcam

    -rotate90: bool
    +rotate90: bool

    Whether to rotate the webcam 90° counter clockwise.

    -snapshotDisplay: str
    +snapshotDisplay: str

    Human readable information about how a snapshot is captured or a HTTP URL from which the snapshot is loaded (optional, only for user reference)

    @@ -2778,34 +2778,34 @@
    -class octoprint.schema.webcam.WebcamCompatibility(*, streamTimeout: int = 5, streamRatio: octoprint.schema.webcam.RatioEnum = RatioEnum.sixteen_nine, streamWebrtcIceServers: List[str] = ['stun:stun.l.google.com:19302'], cacheBuster: bool = False, stream: str, snapshot: str = None, snapshotTimeout: int = 5, snapshotSslValidation: bool = True)
    +class octoprint.schema.webcam.WebcamCompatibility(*, streamTimeout: int = 5, streamRatio: octoprint.schema.webcam.RatioEnum = RatioEnum.sixteen_nine, streamWebrtcIceServers: List[str] = ['stun:stun.l.google.com:19302'], cacheBuster: bool = False, stream: str, snapshot: str = None, snapshotTimeout: int = 5, snapshotSslValidation: bool = True)
    -cacheBuster: bool
    +cacheBuster: bool

    Whether the URL should be randomized to bust caches

    -snapshot: str
    +snapshot: str

    The URL to get the snapshot from

    -snapshotSslValidation: bool
    +snapshotSslValidation: bool

    Whether to validate SSL certificates when retrieving a snapshot

    -snapshotTimeout: int
    +snapshotTimeout: int

    The timeout when retrieving snapshots

    -stream: str
    +stream: str

    The URL to get an MJPEG stream from

    @@ -2817,13 +2817,13 @@
    -streamTimeout: int
    +streamTimeout: int

    The timeout of the stream in seconds

    -streamWebrtcIceServers: List[str]
    +streamWebrtcIceServers: List[str]

    The WebRTC STUN and TURN servers

    @@ -2865,7 +2865,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/modules/server.html b/devel/modules/server.html index baa04d4f8..113a1614e 100644 --- a/devel/modules/server.html +++ b/devel/modules/server.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -298,8 +298,8 @@
    Parameters
      -

    • url (str) – URL to validate

      • -

    • allowed_paths (List[str]) – List of allowed paths, only paths contained +

    • url (str) – URL to validate

      • +

    • allowed_paths (List[str]) – List of allowed paths, only paths contained or prefixed (if allowed path ends with “*”) will be considered valid.

    @@ -307,7 +307,7 @@

    Whether the url passed validation or not.

    Return type
    -

    bool

    +

    bool

    @@ -410,7 +410,7 @@
    property cookies
    -

    A dict with the contents of all cookies transmitted with +

    A dict with the contents of all cookies transmitted with the request.

    @@ -430,7 +430,7 @@
    -class octoprint.server.util.flask.OctoPrintFlaskResponse(response: Optional[Union[Iterable[bytes], bytes, Iterable[str], str]] = None, status: Optional[Union[int, str, http.HTTPStatus]] = None, headers: Optional[Union[Mapping[str, Union[str, int, Iterable[Union[str, int]]]], Iterable[Tuple[str, Union[str, int]]]]] = None, mimetype: Optional[str] = None, content_type: Optional[str] = None, direct_passthrough: bool = False)
    +class octoprint.server.util.flask.OctoPrintFlaskResponse(response: Optional[Union[Iterable[bytes], bytes, Iterable[str], str]] = None, status: Optional[Union[int, str, http.HTTPStatus]] = None, headers: Optional[Union[Mapping[str, Union[str, int, Iterable[Union[str, int]]]], Iterable[Tuple[str, Union[str, int]]]]] = None, mimetype: Optional[str] = None, content_type: Optional[str] = None, direct_passthrough: bool = False)
    @@ -492,16 +492,16 @@ class octoprint.server.util.flask.OctoPrintJsonProvider(app: Flask)
    -dumps(obj: Any, **kwargs: Any) → str
    +dumps(obj: Any, **kwargs: Any) → str

    Serialize data as JSON to a string.

    -

    Keyword arguments are passed to json.dumps(). Sets some +

    Keyword arguments are passed to json.dumps(). Sets some parameter defaults from the default, ensure_ascii, and sort_keys attributes.

    Parameters
    @@ -596,7 +596,7 @@
    -octoprint.server.util.flask.check_lastmodified(lastmodified: Union[int, float, datetime.datetime]) → bool
    +octoprint.server.util.flask.check_lastmodified(lastmodified: Union[int, float, datetime.datetime]) → bool

    Compares the provided lastmodified value with the value of the If-Modified-Since header.

    If lastmodified is an int or float, it’s assumed to be a Unix timestamp and converted to a timezone aware datetime instance in UTC.

    @@ -604,16 +604,16 @@ result will always be False.

    Parameters
    -

    lastmodified (Union[int, float, datetime]) – The last modified value to compare against

    +

    lastmodified (Union[int, float, datetime]) – The last modified value to compare against

    Raises
    -

    ValueError – If anything but an int, float or datetime instance is passed

    +

    ValueError – If anything but an int, float or datetime instance is passed

    Returns

    true if the values indicate that the document is still up to date

    Return type
    -

    bool

    +

    bool

    @@ -769,7 +769,7 @@

    octoprint.server.util.tornado

    -class octoprint.server.util.tornado.CorsSupportMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.CorsSupportMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    tornado.web.RequestHandler mixin that makes sure to set CORS headers similarly to the Flask backed API endpoints.

    @@ -801,7 +801,7 @@
    -class octoprint.server.util.tornado.CustomHTTP1ServerConnection(stream: tornado.iostream.IOStream, params: Optional[tornado.http1connection.HTTP1ConnectionParameters] = None, context: Optional[object] = None)
    +class octoprint.server.util.tornado.CustomHTTP1ServerConnection(stream: tornado.iostream.IOStream, params: Optional[tornado.http1connection.HTTP1ConnectionParameters] = None, context: Optional[object] = None)

    A custom implementation of tornado.http1connection.HTTP1ServerConnection which utilizes a CustomHTTP1Connection instead of a tornado.http1connection.HTTP1Connection in _server_request_loop. The implementation logic is otherwise the same as tornado.http1connection.HTTP1ServerConnection.

    @@ -809,7 +809,7 @@
    -class octoprint.server.util.tornado.CustomHTTPServer(*args: Any, **kwargs: Any)
    +class octoprint.server.util.tornado.CustomHTTPServer(*args: Any, **kwargs: Any)

    Custom implementation of tornado.httpserver.HTTPServer that allows defining max body sizes depending on path and method.

    The implementation is mostly taken from tornado.httpserver.HTTPServer, the only difference is the creation @@ -840,32 +840,32 @@

    -class octoprint.server.util.tornado.DeprecatedEndpointHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.DeprecatedEndpointHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    tornado.web.RequestHandler that redirects to another url and logs a deprecation warning.

    Parameters
    -

    url (str) – URL to which to redirect

    +

    url (str) – URL to which to redirect

    -class octoprint.server.util.tornado.DynamicZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.DynamicZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    -class octoprint.server.util.tornado.GeneratingDataHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.GeneratingDataHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    A RequestHandler that generates data from a generator function and returns it to the client.

    Parameters

    • generator (function) – A generator function that returns the data to be written to the client. The function will be called without any parameters.

      • -

    • content_type (str) – The content type with which to respond. Defaults to text/plain

      • -

    • as_attachment (bool | str) – Whether to serve files with Content-Disposition: attachment header (True) +

    • content_type (str) – The content type with which to respond. Defaults to text/plain

      • +

    • as_attachment (bool | str) – Whether to serve files with Content-Disposition: attachment header (True) or not. Defaults to False. If a string is given it will be used as the filename of the attachment.

    • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise @@ -883,21 +883,21 @@

      -class octoprint.server.util.tornado.LargeResponseHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.LargeResponseHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

      Customized tornado.web.StaticFileHandler that allows delivery of the requested resource as attachment and access and request path validation through optional callbacks. Note that access validation takes place before path validation.

      Parameters
        -

      • path (str) – The system path from which to serve files (this will be forwarded to the initialize method of +

      • path (str) – The system path from which to serve files (this will be forwarded to the initialize method of :class:~tornado.web.StaticFileHandler)

        • -

      • default_filename (str) – The default filename to serve if none is explicitly specified and the request references +

      • default_filename (str) – The default filename to serve if none is explicitly specified and the request references a subdirectory of the served path (this will be forwarded to the initialize method of :class:~tornado.web.StaticFileHandler as the default_filename keyword parameter). Defaults to None.

        • -

      • as_attachment (bool) – Whether to serve requested files with Content-Disposition: attachment header (True) +

      • as_attachment (bool) – Whether to serve requested files with Content-Disposition: attachment header (True) or not. Defaults to False.

        • -

      • allow_client_caching (bool) – Whether to allow the client to cache (by not setting any Cache-Control or +

      • allow_client_caching (bool) – Whether to allow the client to cache (by not setting any Cache-Control or Expires headers on the response) or not.

      • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise @@ -915,7 +915,7 @@ called with the requested path as parameter.

      • mime_type_guesser (function) – Callback to guess the mime type to use for the content type encoding of the response. Will be called with the requested path on disk as parameter.

        • -

      • is_pre_compressed (bool) – if the file is expected to be pre-compressed, i.e, if there is a file in the same +

      • is_pre_compressed (bool) – if the file is expected to be pre-compressed, i.e, if there is a file in the same directory with the same name, but with ‘.gz’ appended and gzip-encoded

      @@ -972,7 +972,7 @@
      -class octoprint.server.util.tornado.RequestlessExceptionLoggingMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.RequestlessExceptionLoggingMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      log_exception(typ, value, tb, *args, **kwargs)
      @@ -990,14 +990,14 @@
      -class octoprint.server.util.tornado.StaticDataHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.StaticDataHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

      tornado.web.RequestHandler that returns static data of a configured content_type.

      Parameters
        -

      • data (str) – The data with which to respond

        • -

      • content_type (str) – The content type with which to respond. Defaults to text/plain

        • +

      • data (str) – The data with which to respond

        • +

      • content_type (str) – The content type with which to respond. Defaults to text/plain

      @@ -1005,17 +1005,17 @@
      -class octoprint.server.util.tornado.StaticZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.StaticZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      -class octoprint.server.util.tornado.SystemInfoBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.SystemInfoBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      -class octoprint.server.util.tornado.UploadStorageFallbackHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.UploadStorageFallbackHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

      A RequestHandler similar to tornado.web.FallbackHandler which fetches any files contained in the request bodies of content type multipart, stores them in temporary files and supplies the fallback with the file’s name, content_type, path and size instead via a rewritten body.

      @@ -1157,7 +1157,7 @@
      -class octoprint.server.util.tornado.UrlProxyHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.UrlProxyHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

      tornado.web.RequestHandler that proxies requests to a preconfigured url and returns the response. Allows delivery of the requested content as attachment and access validation through an optional callback.

      @@ -1176,10 +1176,10 @@
      Parameters
        -

      • url (str) – URL to forward any requests to. A 404 response will be returned if this is not set. Defaults to None.

        • -

      • as_attachment (bool) – Whether to serve files with Content-Disposition: attachment header (True) +

      • url (str) – URL to forward any requests to. A 404 response will be returned if this is not set. Defaults to None.

        • +

      • as_attachment (bool) – Whether to serve files with Content-Disposition: attachment header (True) or not. Defaults to False.

        • -

      • basename (str) – base name of file names to return as part of the attachment header, see above. Defaults to None.

        • +

      • basename (str) – base name of file names to return as part of the attachment header, see above. Defaults to None.

      • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise a tornado.web.HTTPError if access is not allowed in which case the request will not be further processed. @@ -1191,12 +1191,12 @@

        -class octoprint.server.util.tornado.WebcamSnapshotHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
        +class octoprint.server.util.tornado.WebcamSnapshotHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

        GeneratingDataHandler that returns a snapshot from the configured webcam.

        Parameters
          -

        • as_attachment (bool | str) – Whether to serve files with Content-Disposition: attachment header (True) +

        • as_attachment (bool | str) – Whether to serve files with Content-Disposition: attachment header (True) or not. Defaults to False. If a string is given it will be used as the filename of the attachment.

        • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise @@ -1326,7 +1326,7 @@

          Tags
          -
          1.9.2
          +
          1.9.3
          1.8.7
          diff --git a/devel/modules/settings.html b/devel/modules/settings.html index 7c4dc51c0..fafd8440b 100644 --- a/devel/modules/settings.html +++ b/devel/modules/settings.html @@ -122,7 +122,7 @@

          Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

          @@ -178,15 +178,15 @@
          Parameters

          • init (boolean) – A flag indicating whether this is the initial call to construct the singleton (True) or not -(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError +(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError will be raised. The same will happen if the plugin manager has not yet been initialized and this is set to False.

            • -

          • basedir (str) – Path of the base directory for all of OctoPrint’s settings, log files, uploads etc. If not set +

          • basedir (str) – Path of the base directory for all of OctoPrint’s settings, log files, uploads etc. If not set the default will be used: ~/.octoprint on Linux, %APPDATA%/OctoPrint on Windows and ~/Library/Application Support/OctoPrint on MacOS.

            • -

          • configfile (str) – Path of the configuration file (config.yaml) to work on. If not set the default will +

          • configfile (str) – Path of the configuration file (config.yaml) to work on. If not set the default will be used: <basedir>/config.yaml for basedir as defined above.

            • -

          • overlays (list) – List of paths to config overlays to put between default settings and config.yaml

            • +

          • overlays (list) – List of paths to config overlays to put between default settings and config.yaml

          Returns
          @@ -196,7 +196,7 @@

          Settings

          Raises
          -

          ValueError – init is True but settings are already initialized or vice versa.

          +

          ValueError – init is True but settings are already initialized or vice versa.

        @@ -489,7 +489,7 @@
        Tags
        -
        1.9.2
        +
        1.9.3
        1.8.7
        diff --git a/devel/modules/slicing.html b/devel/modules/slicing.html index 3aa4bfca8..3e28cac0f 100644 --- a/devel/modules/slicing.html +++ b/devel/modules/slicing.html @@ -122,7 +122,7 @@

        Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

        @@ -161,12 +161,12 @@
        Parameters
          -

        • slicer (str) – Identifier of the slicer this profile belongs to.

          • -

        • name (str) – Identifier of this slicing profile.

          • -

        • data (object) – Profile data, actual structure depends on individual slicer implementation.

          • -

        • display_name (str) – Displayable name for this slicing profile.

          • -

        • description (str) – Description of this slicing profile.

          • -

        • default (bool) – Whether this is the default slicing profile for the slicer.

          • +

        • slicer (str) – Identifier of the slicer this profile belongs to.

          • +

        • name (str) – Identifier of this slicing profile.

          • +

        • data (object) – Profile data, actual structure depends on individual slicer implementation.

          • +

        • display_name (str) – Displayable name for this slicing profile.

          • +

        • description (str) – Description of this slicing profile.

          • +

        • default (bool) – Whether this is the default slicing profile for the slicer.

        @@ -191,7 +191,7 @@ supplied overrides. This will be called according to the method signature of save_slicer_profile().

      • profile (SlicingProfile) – The profile from which to derive the temporary profile.

        • -

      • overrides (dict) – Optional overrides to apply to the profile for creation of the temporary profile.

        • +

      • overrides (dict) – Optional overrides to apply to the profile for creation of the temporary profile.

      @@ -204,7 +204,7 @@
      Parameters
        -

      • profile_path (str) – Absolute path to the base folder where all slicing profiles are stored.

        • +

      • profile_path (str) – Absolute path to the base folder where all slicing profiles are stored.

      • printer_profile_manager (PrinterProfileManager) – PrinterProfileManager instance to use for accessing available printer profiles, most importantly the currently selected one.

      @@ -219,7 +219,7 @@
      Parameters
        -

      • slicer (str) – Identifier of the slicer for which to retrieve all slicer profiles

        • +

      • slicer (str) – Identifier of the slicer for which to retrieve all slicer profiles

      • require_configured (boolean) – Whether to require the slicer slicer to be already configured (True) or not (False, default). If False and the slicer is not yet configured, a SlicerNotConfigured exception will be raised.

        • @@ -247,9 +247,9 @@
        Parameters
          -

        • slicer_name (str) – Identifier of the slicer on which to cancel the job.

          • -

        • source_path (str) – The absolute path to the source file being sliced.

          • -

        • dest_path (str) – The absolute path to the destination file being sliced to.

          • +

        • slicer_name (str) – Identifier of the slicer on which to cancel the job.

          • +

        • source_path (str) – The absolute path to the source file being sliced.

          • +

        • dest_path (str) – The absolute path to the destination file being sliced to.

        Raises
        @@ -288,8 +288,8 @@
        Parameters
          -

        • slicer (str) – Identifier of the slicer for which to delete the profile.

          • -

        • name (str) – Identifier of the profile to delete.

          • +

        • slicer (str) – Identifier of the slicer for which to delete the profile.

          • +

        • name (str) – Identifier of the profile to delete.

        Raises
        @@ -310,8 +310,8 @@
        Parameters
          -

        • slicer (str) – Identifier of the slicer to which the profile belongs to.

          • -

        • name (str) – Identifier of the profile for which to retrieve the path.

          • +

        • slicer (str) – Identifier of the slicer to which the profile belongs to.

          • +

        • name (str) – Identifier of the profile for which to retrieve the path.

        • must_exist (boolean) – Whether the path must exist (True) or not (False, default).

        @@ -319,7 +319,7 @@

        The absolute path to the profile identified by name for slicer slicer.

        Return type
        -

        str

        +

        str

        Raises
          @@ -338,7 +338,7 @@
          Parameters
            -

          • slicer (str) – Identifier of the slicer to return

            • +

          • slicer (str) – Identifier of the slicer to return

          • require_configured (boolean) – Whether to raise an exception if the slicer has not been configured yet (True, the default), or also return an unconfigured slicer (False).

          @@ -358,13 +358,13 @@

          Retrieves the path where the profiles for slicer slicer are stored.

          Parameters
          -

          slicer (str) – Identifier of the slicer for which to retrieve the path.

          +

          slicer (str) – Identifier of the slicer for which to retrieve the path.

          Returns

          The absolute path to the folder where the slicer’s profiles are stored.

          Return type
          -

          str

          +

          str

          Raises

          UnknownSlicer – The slicer slicer is unknown.

          @@ -383,7 +383,7 @@
          load_profile(slicer, name, require_configured=True)

          Loads the slicing profile for slicer with the given profile name and returns it. If it can’t be loaded -due to an IOError None will be returned instead.

          +due to an IOError None will be returned instead.

          If require_configured is True (the default) a SlicerNotConfigured exception will be raised if the indicated slicer has not yet been configured.

          @@ -410,7 +410,7 @@

          Retrieves the last modification date of slicer’s profiles.

          Parameters
          -

          slicer (str) – the slicer for which to retrieve the last modification date

          +

          slicer (str) – the slicer for which to retrieve the last modification date

          Returns

          (float) the time stamp of the last modification of the slicer’s profiles

          @@ -436,11 +436,11 @@
          save_profile(slicer, name, profile, overrides=None, allow_overwrite=True, display_name=None, description=None)

          Saves the slicer profile profile for slicer slicer under name name.

          -

          profile may be either a SlicingProfile or a dict.

          +

          profile may be either a SlicingProfile or a dict.

          If it’s a SlicingProfile, its slicer`, name and - if provided - display_name and description attributes will be overwritten with the supplied values.

          -

          If it’s a dict, a new SlicingProfile instance will be created with the supplied meta data and +

          If it’s a dict, a new SlicingProfile instance will be created with the supplied meta data and the profile data as the data attribute.

          Note

          @@ -449,15 +449,15 @@
          Parameters
            -

          • slicer (str) – Identifier of the slicer for which to save the profile.

            • -

          • name (str) – Identifier under which to save the profile.

            • -

          • profile (SlicingProfile or dict) – The SlicingProfile or a dict containing the profile +

          • slicer (str) – Identifier of the slicer for which to save the profile.

            • +

          • name (str) – Identifier under which to save the profile.

            • +

          • profile (SlicingProfile or dict) – The SlicingProfile or a dict containing the profile data of the profile the save.

            • -

          • overrides (dict) – Overrides to apply to the profile before saving it.

            • +

          • overrides (dict) – Overrides to apply to the profile before saving it.

          • allow_overwrite (boolean) – If True (default) if a profile for the same slicer of the same name already exists, it will be overwritten. Otherwise an exception will be thrown.

            • -

          • display_name (str) – The name to display to the user for the profile.

            • -

          • description (str) – A description of the profile.

            • +

          • display_name (str) – The name to display to the user for the profile.

            • +

          • description (str) – A description of the profile.

          Returns
          @@ -468,7 +468,7 @@
          Raises
            -

          • ValueError – The supplied profile is neither a SlicingProfile nor a dict.

            • +

          • ValueError – The supplied profile is neither a SlicingProfile nor a dict.

          • UnknownSlicer – The slicer slicer is unknown.

          • ProfileAlreadyExists – A profile with name name already exists for slicer and allow_overwrite is False.

            • @@ -484,14 +484,14 @@
            Parameters
              -

            • slicer (str) – Identifier of the slicer for which to set the default +

            • slicer (str) – Identifier of the slicer for which to set the default profile.

              • -

            • name (str) – Identifier of the profile to set as default.

              • -

            • require_configured (bool) – Whether the slicer needs to be configured +

            • name (str) – Identifier of the profile to set as default.

              • +

            • require_configured (bool) – Whether the slicer needs to be configured for the action to succeed. Defaults to false. Will raise a SlicerNotConfigured error if true and the slicer has not been configured yet.

              • -

            • require_exists (bool) – Whether the profile is required to exist in +

            • require_exists (bool) – Whether the profile is required to exist in order to be set as default. Defaults to true. Will raise a UnknownProfile error if true and the profile is unknown.

            @@ -542,24 +542,24 @@
            Parameters
              -

            • slicer_name (str) – The identifier of the slicer to use for slicing.

              • -

            • source_path (str) – The absolute path to the source file to slice.

              • -

            • dest_path (str) – The absolute path to the destination file to slice to.

              • -

            • profile_name (str) – The name of the slicing profile to use.

              • +

            • slicer_name (str) – The identifier of the slicer to use for slicing.

              • +

            • source_path (str) – The absolute path to the source file to slice.

              • +

            • dest_path (str) – The absolute path to the destination file to slice to.

              • +

            • profile_name (str) – The name of the slicing profile to use.

            • callback (callable) – A callback to call after slicing has finished.

              • -

            • callback_args (list or tuple) – Arguments of the callback to call after slicing has finished. Defaults to +

            • callback_args (list or tuple) – Arguments of the callback to call after slicing has finished. Defaults to an empty list.

              • -

            • callback_kwargs (dict) – Keyword arguments for the callback to call after slicing has finished, will be +

            • callback_kwargs (dict) – Keyword arguments for the callback to call after slicing has finished, will be extended by _analysis, _error or _cancelled as described above! Defaults to an empty dictionary.

              • -

            • overrides (dict) – Overrides for the printer profile to apply.

              • +

            • overrides (dict) – Overrides for the printer profile to apply.

            • on_progress (callable) – Callback to call upon slicing progress.

              • -

            • on_progress_args (list or tuple) – Arguments of the progress callback. Defaults to an empty list.

              • -

            • on_progress_kwargs (dict) – Keyword arguments of the progress callback, will be extended by _progress +

            • on_progress_args (list or tuple) – Arguments of the progress callback. Defaults to an empty list.

              • +

            • on_progress_kwargs (dict) – Keyword arguments of the progress callback, will be extended by _progress as described above! Defaults to an empty dictionary.

              • -

            • printer_profile_id (str) – Identifier of the printer profile for which to slice, if another than the +

            • printer_profile_id (str) – Identifier of the printer profile for which to slice, if another than the one currently selected is to be used.

              • -

            • position (dict) – Dictionary containing the x and y coordinate in the print bed’s coordinate system +

            • position (dict) – Dictionary containing the x and y coordinate in the print bed’s coordinate system of the sliced model’s center. If not provided the model will be positioned at the print bed’s center. Example: dict(x=10,y=20).

            @@ -694,7 +694,7 @@
            Tags
            -
            1.9.2
            +
            1.9.3
            1.8.7
            diff --git a/devel/modules/util.html b/devel/modules/util.html index be7963567..64923cd5e 100644 --- a/devel/modules/util.html +++ b/devel/modules/util.html @@ -122,7 +122,7 @@

            Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

            @@ -181,7 +181,7 @@
            class octoprint.util.RepeatedTimer(interval, function, args=None, kwargs=None, run_first=False, condition=None, on_condition_false=None, on_cancelled=None, on_finish=None, daemon=True)

            This class represents an action that should be run repeatedly in an interval. It is similar to python’s -own threading.Timer class, but instead of only running once the function will be run again and again, +own threading.Timer class, but instead of only running once the function will be run again and again, sleeping the stated interval in between.

            RepeatedTimers are started, as with threads, by calling their start() method. The timer can be stopped (in between runs) by calling the cancel() method. The interval the time waited before execution of a loop may @@ -223,11 +223,11 @@

            Parameters
              -

            • interval (float or callable) – The interval between each function call, in seconds. Can also be a callable +

            • interval (float or callable) – The interval between each function call, in seconds. Can also be a callable returning the interval to use, in case the interval is not static.

            • function (callable) – The function to call.

              • -

            • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

              • -

            • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

              • +

            • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

              • +

            • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

            • run_first (boolean) – If set to True, the function will be run for the first time before the first wait period. If set to False (the default), the function will be run for the first time after the first wait period.

            • condition (callable) – Condition that needs to be True for loop to continue. Defaults to lambda: True.

              • @@ -237,7 +237,7 @@ before the on_finish callback.

            • on_finish (callable) – Callback to call when the timer finishes, either due to being cancelled or since the condition became false.

              • -

            • daemon (bool) – daemon flag to set on underlying thread.

              • +

            • daemon (bool) – daemon flag to set on underlying thread.

            @@ -257,7 +257,7 @@
            class octoprint.util.ResettableTimer(interval, function, args=None, kwargs=None, on_reset=None, on_cancelled=None, daemon=True)

            This class represents an action that should be run after a specified amount of time. It is similar to python’s -own threading.Timer class, with the addition of being able to reset the counter to zero.

            +own threading.Timer class, with the addition of being able to reset the counter to zero.

            ResettableTimers are started, as with threads, by calling their start() method. The timer can be stopped (in between runs) by calling the cancel() method. Resetting the counter can be done with the reset() method.

            For example:

            @@ -275,14 +275,14 @@
            Parameters
              -

            • interval (float or callable) – The interval before calling function, in seconds. Can also be a callable +

            • interval (float or callable) – The interval before calling function, in seconds. Can also be a callable returning the interval to use, in case the interval is not static.

            • function (callable) – The function to call.

              • -

            • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

              • -

            • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

              • +

            • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

              • +

            • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

            • on_cancelled (callable) – Callback to call when the timer finishes due to being cancelled.

            • on_reset (callable) – Callback to call when the timer is reset.

              • -

            • daemon (bool) – daemon flag to set on underlying thread.

              • +

            • daemon (bool) – daemon flag to set on underlying thread.

            @@ -359,7 +359,7 @@
            Parameters

            • message (string) – The message to include in the deprecation warning.

              • -

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

              • @@ -387,8 +387,8 @@
              Parameters
                -

              • filename (str) – The file to deserialize from

                • -

              • encoding (str) – The encoding to use for the file, defaults to utf-8

                • +

              • filename (str) – The file to deserialize from

                • +

              • encoding (str) – The encoding to use for the file, defaults to utf-8

              Returns
              @@ -415,8 +415,8 @@
              Parameters
                -

              • a (dict) – The dictionary to clean against b.

                • -

              • b (dict) – The dictionary containing the key structure to clean from a.

                • +

              • a (dict) – The dictionary to clean against b.

                • +

              • b (dict) – The dictionary containing the key structure to clean from a.

              @@ -443,8 +443,8 @@
              Parameters
                -

              • a (dict) – The dictionary to check for the keys from b.

                • -

              • b (dict) – The dictionary whose keys to check a for.

                • +

              • a (dict) – The dictionary to check for the keys from b.

                • +

              • b (dict) – The dictionary whose keys to check a for.

              Returns
              @@ -485,7 +485,7 @@
              Parameters
                -

              • dictionary (dict) – The dictionary to filter

                • +

              • dictionary (dict) – The dictionary to filter

              • filter_function (callable) – The filter function to apply, called with key and value of an entry in the dictionary, must return True for values to keep and False for values to strip

                • @@ -499,7 +499,7 @@

              Return type
              -

              dict

              +

              dict

            @@ -571,8 +571,8 @@
            Parameters
              -

            • a (dict) – The dictionary to merge b into

              • -

            • b (dict) – The dictionary to merge into a

              • +

            • a (dict) – The dictionary to merge b into

              • +

            • b (dict) – The dictionary to merge into a

            • leaf_merger (callable) – An optional callable to use to merge leaves (non-dict values)

            • in_place (boolean) – If set to True, a will be merged with b in place, meaning a will be modified

            @@ -581,7 +581,7 @@

            b deep-merged into a

            Return type
            -

            dict

            +

            dict

            @@ -604,8 +604,8 @@
            Parameters
              -

            • source (dict) – Source dictionary

              • -

            • target (dict) – Dictionary to compare to source dictionary and derive diff for

              • +

            • source (dict) – Source dictionary

              • +

            • target (dict) – Dictionary to compare to source dictionary and derive diff for

            Returns
            @@ -616,7 +616,7 @@

            Return type
            -

            dict

            +

            dict

          @@ -639,8 +639,8 @@
          Parameters
            -

          • a (dict) – The dictionary to clean against b.

            • -

          • b (dict) – The dictionary containing the key structure to clean from a.

            • +

          • a (dict) – The dictionary to clean against b.

            • +

          • b (dict) – The dictionary containing the key structure to clean from a.

          @@ -715,10 +715,10 @@

          The class if it could be found.

          Return type
          -

          type

          +

          type

          Raises
          -

          ImportError –

          +

          ImportError –

          @@ -744,7 +744,7 @@

          Formats a datetime instance as “YYYY-mm-dd HH:MM” and returns the resulting string.

          Parameters
          -

          d (datetime.datetime) – The datetime instance to format

          +

          d (datetime.datetime) – The datetime instance to format

          Returns

          The datetime formatted as “YYYY-mm-dd HH:MM”

          @@ -763,7 +763,7 @@

          Based on http://stackoverflow.com/a/1094933/2028598

          Parameters
          -

          num (int) – The byte count to format

          +

          num (int) – The byte count to format

          Returns

          The formatted byte count.

          @@ -780,7 +780,7 @@

          Formats a timedelta instance as “HH:MM:ss” and returns the resulting string.

          Parameters
          -

          d (datetime.timedelta) – The timedelta instance to format

          +

          d (datetime.timedelta) – The timedelta instance to format

          Returns

          The timedelta formatted as “HH:MM:ss”

          @@ -814,7 +814,7 @@
          Parameters

          • filename (string) – The file name to check against the extensions.

            • -

          • extensions (list) – The extensions to check against, a list of strings

            • +

          • extensions (list) – The extensions to check against, a list of strings

          Returns
          @@ -838,7 +838,7 @@
          Parameters

          • message (string) – The message to include in the deprecation warning.

            • -

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

            • @@ -894,10 +894,10 @@
            Parameters
              -

            • filename (str) – The file to write to

              • -

            • data (object) – The data to serialize

              • -

            • encoding (str) – The encoding to use for the file

              • -

            • compressed (bool) – Whether to compress the data before writing it to the file

              • +

            • filename (str) – The file to write to

              • +

            • data (object) – The data to serialize

              • +

            • encoding (str) – The encoding to use for the file

              • +

            • compressed (bool) – Whether to compress the data before writing it to the file

            @@ -905,28 +905,28 @@
            -octoprint.util.to_bytes(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes
            +octoprint.util.to_bytes(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes

            Make sure s_or_u is a byte string.

            Parameters
            Returns

            converted bytes.

            Return type
            -

            bytes

            +

            bytes

            -octoprint.util.to_native_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str
            +octoprint.util.to_native_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str

            Deprecated since version 1.8.0: to_native_str is no longer needed, use to_unicode instead

            @@ -934,7 +934,7 @@
            -octoprint.util.to_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes
            +octoprint.util.to_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes

            Deprecated since version 1.3.11: to_str has been renamed to to_bytes and in a future version will become the new to_unicode

            @@ -942,21 +942,21 @@
            -octoprint.util.to_unicode(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str
            +octoprint.util.to_unicode(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str

            Make sure s_or_u is a string (str).

            Parameters
            Returns

            converted string.

            Return type
            -

            str

            +

            str

            @@ -971,7 +971,7 @@
            Parameters

            • message (string) – The message to include in the deprecation warning.

              • -

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

              • @@ -997,7 +997,7 @@
              Parameters

              • message (string) – The message to include in the deprecation warning.

                • -

              • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

              • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

                • @@ -1058,13 +1058,13 @@
    -call(command: Union[str, List[str], Tuple[str]], delimiter: bytes = b'\n', buffer_size: int = - 1, logged: bool = True, **kwargs) → Tuple[Optional[int], List[str], List[str]]
    +call(command: Union[str, List[str], Tuple[str]], delimiter: bytes = b'\n', buffer_size: int = - 1, logged: bool = True, **kwargs) → Tuple[Optional[int], List[str], List[str]]

    Calls a command

    Parameters
      -

    • command (list, tuple or str) – command to call

      • -

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, +

    • command (list, tuple or str) – command to call

      • +

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, stdout and stderr will be overwritten)

    @@ -1076,13 +1076,13 @@
    -checked_call(command: Union[str, List[str], Tuple[str]], **kwargs) → Tuple[int, List[str], List[str]]
    +checked_call(command: Union[str, List[str], Tuple[str]], **kwargs) → Tuple[int, List[str], List[str]]

    Calls a command and raises an error if it doesn’t return with return code 0

    Parameters
      -

    • command (list, tuple or str) – command to call

      • -

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, +

    • command (list, tuple or str) – command to call

      • +

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, stdout and stderr will be overwritten)

    @@ -1122,9 +1122,9 @@
    Parameters
      -

    • returncode (int) – the return code of the command

      • -

    • stdout (str) – the stdout output produced by the command

      • -

    • stderr (str) – the stderr output produced by the command

      • +

    • returncode (int) – the return code of the command

      • +

    • stdout (str) – the stdout output produced by the command

      • +

    • stderr (str) – the stderr output produced by the command

    @@ -1137,7 +1137,7 @@
    -octoprint.util.commandline.clean_ansi(line: Union[str, bytes]) → Union[str, bytes]
    +octoprint.util.commandline.clean_ansi(line: Union[str, bytes]) → Union[str, bytes]

    Removes ANSI control codes from line.

    Note: This function also still supports an input of bytes, leading to an output of bytes. This if for reasons of backwards compatibility only, @@ -1145,7 +1145,7 @@ a future version of OctoPrint. A warning will be logged.

    Parameters
    -

    line (str or bytes) – the line to process

    +

    line (str or bytes) – the line to process

    Returns

    (str or bytes) The line without any ANSI control codes

    @@ -1235,7 +1235,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/concepts.html b/devel/plugins/concepts.html index f875608d4..52b6a9b30 100644 --- a/devel/plugins/concepts.html +++ b/devel/plugins/concepts.html @@ -106,7 +106,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -137,7 +137,7 @@

    General Concepts

    -

    OctoPrint’s plugins are Python Packages which in their +

    OctoPrint’s plugins are Python Packages which in their top-level module define a bunch of control properties defining metadata (like name, version etc of the plugin) as well as information on how to initialize the plugin and into what parts of the system the plugin will actually plug in to perform its job.

    @@ -214,7 +214,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/controlproperties.html b/devel/plugins/controlproperties.html index 240d5e480..b2c081eab 100644 --- a/devel/plugins/controlproperties.html +++ b/devel/plugins/controlproperties.html @@ -103,7 +103,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -304,7 +304,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/distributing.html b/devel/plugins/distributing.html index 95e26a765..aba74e166 100644 --- a/devel/plugins/distributing.html +++ b/devel/plugins/distributing.html @@ -109,7 +109,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -246,7 +246,7 @@

    Version management after the official plu
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/gettingstarted.html b/devel/plugins/gettingstarted.html index d8f558947..bb4cf4256 100644 --- a/devel/plugins/gettingstarted.html +++ b/devel/plugins/gettingstarted.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -253,7 +253,7 @@ up and ready to serve requests.

    You’ll also note that we are using self._logger for logging. Where did that one come from? OctoPrint’s plugin system injects a some useful objects into our plugin implementation classes, -one of those being a fully instantiated python logger ready to be +one of those being a fully instantiated python logger ready to be used by your plugin. As you can see in the log output above, that logger uses the namespace octoprint.plugins.helloworld for our little plugin here, or more generally octoprint.plugins.<plugin identifier>.

    @@ -1119,7 +1119,7 @@

    Where do we go from here?
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/helpers.html b/devel/plugins/helpers.html index 495ad09ee..67a8639c2 100644 --- a/devel/plugins/helpers.html +++ b/devel/plugins/helpers.html @@ -103,7 +103,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -234,7 +234,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/hooks.html b/devel/plugins/hooks.html index d2b5bfa2b..146609862 100644 --- a/devel/plugins/hooks.html +++ b/devel/plugins/hooks.html @@ -157,7 +157,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -580,7 +580,7 @@
    Parameters
      -

    • components (dict) – System components to use for user manager instance initialization

      • +

    • components (dict) – System components to use for user manager instance initialization

    • settings (SettingsManager) – The global settings manager instance to fetch configuration values from if necessary

    @@ -631,7 +631,7 @@
    Parameters
    -

    apikey (str) – The API key to validate

    +

    apikey (str) – The API key to validate

    Returns

    The user in whose name the request will be processed further

    @@ -793,7 +793,7 @@ OctoPrint’s CLI.

    Return type
    -

    list

    +

    list

    @@ -827,9 +827,9 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • firmware_name (str) – The parsed name of the firmware

      • -

    • firmware_data (dict) – All data contained in the M115 report

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • firmware_name (str) – The parsed name of the firmware

      • +

    • firmware_data (dict) – All data contained in the M115 report

    @@ -858,10 +858,10 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • capability (str) – The name of the parsed capability

      • -

    • enabled (bool) – Whether the capability is reported as enabled or disabled

      • -

    • already_defined (dict) – Already defined capabilities (capability name mapped to enabled flag)

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • capability (str) – The name of the parsed capability

      • +

    • enabled (bool) – Whether the capability is reported as enabled or disabled

      • +

    • already_defined (dict) – Already defined capabilities (capability name mapped to enabled flag)

    @@ -888,8 +888,8 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • firmware_capabilities (dict) – Reported capabilities (capability name mapped to enabled flag)

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • firmware_capabilities (dict) – Reported capabilities (capability name mapped to enabled flag)

    @@ -947,13 +947,13 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • line (str) – The complete line as received from the printer, format // action:<command>

      • -

    • action (str) – The parsed out action command incl. parameters, so for a line like // action:some_command key value this will be +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • line (str) – The complete line as received from the printer, format // action:<command>

      • +

    • action (str) – The parsed out action command incl. parameters, so for a line like // action:some_command key value this will be some_command key value

      • -

    • name (str) – The action command name, for a line like // action:some_command key value this will be +

    • name (str) – The action command name, for a line like // action:some_command key value this will be some_command

      • -

    • params (str) – The action command’s parameter, for a line like // action:some_command key value this will +

    • params (str) – The action command’s parameter, for a line like // action:some_command key value this will be key value

    @@ -1020,11 +1020,11 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • phase (str) – The current phase in the command progression, either queuing or sending. Will always +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • phase (str) – The current phase in the command progression, either queuing or sending. Will always match the <phase> of the hook.

      • -

    • cmd (str) – The @ command without the leading @

      • -

    • parameters (str) – Any parameters provided to the @ command. If none were provided this will be an empty string.

      • +

    • cmd (str) – The @ command without the leading @

      • +

    • parameters (str) – Any parameters provided to the @ command. If none were provided this will be an empty string.

    @@ -1203,15 +1203,15 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • phase (str) – The current phase in the command progression, either queuing, queued, sending or +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • phase (str) – The current phase in the command progression, either queuing, queued, sending or sent. Will always match the <phase> of the hook.

      • -

    • cmd (str) – The GCODE command for which the hook was triggered. This is the full command as taken either +

    • cmd (str) – The GCODE command for which the hook was triggered. This is the full command as taken either from the currently streamed GCODE file or via other means (e.g. user input our status polling).

      • -

    • cmd_type (str) – Type of command, e.g. temperature_poll for temperature polling or sd_status_poll for SD +

    • cmd_type (str) – Type of command, e.g. temperature_poll for temperature polling or sd_status_poll for SD printing status polling.

      • -

    • gcode (str) – Parsed GCODE command, e.g. G0 or M110, may also be None if no known command could be parsed

      • -

    • subcode (str) – Parsed subcode of the GCODE command, e.g. 1 for M80.1. Will be None if no subcode was provided +

    • gcode (str) – Parsed GCODE command, e.g. G0 or M110, may also be None if no known command could be parsed

      • +

    • subcode (str) – Parsed subcode of the GCODE command, e.g. 1 for M80.1. Will be None if no subcode was provided or no command could be parsed.

    • tags – Tags attached to the command

    @@ -1274,14 +1274,14 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • line (str) – The line received from the printer.

      • +

    • line (str) – The line received from the printer.

    Returns

    The received line or in any case, a modified version of it.

    Return type
    -

    str

    +

    str

    @@ -1334,14 +1334,14 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • error_message (str) – The error message received from the printer.

      • +

    • error_message (str) – The error message received from the printer.

    Returns

    True if the error was handled in the plugin and should not be processed further, False (or None) otherwise.

    Return type
    -

    bool

    +

    bool

    @@ -1413,15 +1413,15 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • script_type (str) – The type of the script for which the hook was called, currently only “gcode” is supported here.

      • -

    • script_name (str) – The name of the script for which the hook was called.

      • +

    • script_type (str) – The type of the script for which the hook was called, currently only “gcode” is supported here.

      • +

    • script_name (str) – The name of the script for which the hook was called.

    Returns

    A 2-tuple in the form (prefix, postfix), 3-tuple in the form (prefix, postfix, variables), or None

    Return type
    -

    tuple or None

    +

    tuple or None

    @@ -1487,13 +1487,13 @@

    For an example of use see the bundled virtual_printer plugin.

    Parameters
    -

    candidates (list) – The port names already found on the system available for connection.

    +

    candidates (list) – The port names already found on the system available for connection.

    Returns

    Additional port names to offer up for connection.

    Return type
    -

    list

    +

    list

    @@ -1564,11 +1564,11 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • port (str) – The port for which to construct a serial instance. May be None or AUTO in which case port +

    • port (str) – The port for which to construct a serial instance. May be None or AUTO in which case port auto detection is to be performed.

      • -

    • baudrate (int) – The baudrate for which to construct a serial instance. May be 0 in which case baudrate auto +

    • baudrate (int) – The baudrate for which to construct a serial instance. May be 0 in which case baudrate auto detection is to be performed.

      • -

    • read_timeout (int) – The read timeout to set on the serial port.

      • +

    • read_timeout (int) – The read timeout to set on the serial port.

    Returns
    @@ -1607,7 +1607,7 @@

    A list of custom events to register

    Return type
    -

    list

    +

    list

    @@ -1646,7 +1646,7 @@

    A dictionary of analysis queue factories, mapped by their targeted file type.

    Return type
    -

    dict

    +

    dict

    @@ -1685,7 +1685,7 @@

    The partial extension tree to merge with the full extension tree.

    Return type
    -

    dict

    +

    dict

    @@ -1748,11 +1748,11 @@
    Parameters
      -

    • path (str) – The path on storage the file_object is to be stored

      • +

    • path (str) – The path on storage the file_object is to be stored

    • file_object (AbstractFileWrapper) – The AbstractFileWrapper instance representing the file object to store.

      • -

    • links (dict) – The links that are going to be stored with the file.

      • -

    • printer_profile (dict) – The printer profile associated with the file.

      • +

    • links (dict) – The links that are going to be stored with the file.

      • +

    • printer_profile (dict) – The printer profile associated with the file.

    • allow_overwrite (boolean) – Whether to allow overwriting an existing file named the same or not.

    @@ -1843,7 +1843,7 @@

    Additional data to include

    Return type
    -

    dict

    +

    dict

    @@ -1878,7 +1878,7 @@ class will be instantiated.

    Parameters
    -

    components (dict) – System components to use for printer instance initialization

    +

    components (dict) – System components to use for printer instance initialization

    Returns

    The printer instance to use globally.

    @@ -2035,9 +2035,9 @@
    Parameters
      -

    • printer (object) – the PrinterInterface instance the hook was called from

      • -

    • filename (str) – filename on the local storage

      • -

    • path (str) – path of the file in the local file system

      • +

    • printer (object) – the PrinterInterface instance the hook was called from

      • +

    • filename (str) – filename on the local storage

      • +

    • path (str) – path of the file in the local file system

    • sd_upload_started (function) – callback for when the upload started

    • sd_upload_success (function) – callback for successful finish of upload

    • sd_upload_failure (function) – callback for failure of upload

      • @@ -2183,13 +2183,13 @@
      Parameters
      -

      current_max_body_sizes (list) – read-only list of the currently configured maximum body sizes

      +

      current_max_body_sizes (list) – read-only list of the currently configured maximum body sizes

      Returns

      A list of 3-tuples with additional request specific maximum body sizes as defined above

      Return type
      -

      list

      +

      list

    @@ -2286,13 +2286,13 @@
    Parameters
    -

    server_routes (list) – read-only list of the currently configured server routes

    +

    server_routes (list) – read-only list of the currently configured server routes

    Returns

    a list of 3-tuples with additional routes as defined above

    Return type
    -

    list

    +

    list

    @@ -2310,8 +2310,8 @@
    Parameters
      -

    • socket (object) – the socket object which is about to be registered

      • -

    • user (object) – the user that got authenticated on the socket, or None if the user got deauthenticated

      • +

    • socket (object) – the socket object which is about to be registered

      • +

    • user (object) – the user that got authenticated on the socket, or None if the user got deauthenticated

    @@ -2332,8 +2332,8 @@
    Parameters
      -

    • socket (object) – the socket object which is about to be registered

      • -

    • user (object) – the user currently authenticated on the socket - might be None

      • +

    • socket (object) – the socket object which is about to be registered

      • +

    • user (object) – the user currently authenticated on the socket - might be None

    Returns
    @@ -2359,10 +2359,10 @@
    Parameters
      -

    • socket (object) – the socket object on which a message is about to be emitted

      • -

    • user (object) – the user currently authenticated on the socket - might be None

      • +

    • socket (object) – the socket object on which a message is about to be emitted

      • +

    • user (object) – the user currently authenticated on the socket - might be None

    • message (string) – the message type about to be emitted

      • -

    • payload (dict) – the payload of the message about to be emitted (may be None)

      • +

    • payload (dict) – the payload of the message about to be emitted (may be None)

    Returns
    @@ -2463,7 +2463,7 @@

    a list of command specifications

    Return type
    -

    list

    +

    list

    @@ -2497,7 +2497,7 @@

    a dictionary mapping bundle file names to bundle file content

    Return type
    -

    dict

    +

    dict

    @@ -2528,7 +2528,7 @@

    a list of additional file extensions

    Return type
    -

    list

    +

    list

    @@ -2704,15 +2704,15 @@
    Parameters
      -

    • template_rules (dict) – read-only dictionary of currently configured template rules

      • -

    • template_sorting (dict) – read-only dictionary of currently configured template sorting specifications

      • +

    • template_rules (dict) – read-only dictionary of currently configured template rules

      • +

    • template_sorting (dict) – read-only dictionary of currently configured template sorting specifications

    Returns

    a list of 3-tuples (template type, rule, sorting spec)

    Return type
    -

    list

    +

    list

    @@ -2770,7 +2770,7 @@

    filename will be the future path of the frame to be saved.

    Parameters
    -

    filename (str) – The future path of the frame to be saved.

    +

    filename (str) – The future path of the frame to be saved.

    Returns

    None

    @@ -2796,7 +2796,7 @@
    Parameters
      -

    • filename (str) – The path of the frame that should have been saved.

      • +

    • filename (str) – The path of the frame that should have been saved.

    • success (boolean) – Indicates whether the capture was successful or not.

    @@ -2847,7 +2847,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/index.html b/devel/plugins/index.html index f2bb22a9e..df723ef89 100644 --- a/devel/plugins/index.html +++ b/devel/plugins/index.html @@ -103,7 +103,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -301,7 +301,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/injectedproperties.html b/devel/plugins/injectedproperties.html index 195417661..0064a44a9 100644 --- a/devel/plugins/injectedproperties.html +++ b/devel/plugins/injectedproperties.html @@ -103,7 +103,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -152,7 +152,7 @@ data files etc). Plugins should not access this property directly but instead utilize get_plugin_data_folder() which will make sure the path actually does exist and if not create it before returning it.

    -
    self._logger

    A logging.Logger instance logging to the log target +

    self._logger

    A logging.Logger instance logging to the log target octoprint.plugin.<plugin identifier>.

    self._settings

    The plugin’s personalized settings manager, injected only into plugins that include the SettingsPlugin mixin. @@ -222,7 +222,7 @@

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/mixins.html b/devel/plugins/mixins.html index 92be99fea..bc1615b72 100644 --- a/devel/plugins/mixins.html +++ b/devel/plugins/mixins.html @@ -126,7 +126,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -628,9 +628,9 @@
    Parameters
      -

    • event (str) – The type of event that got fired, see the list of events +

    • event (str) – The type of event that got fired, see the list of events for possible values

      • -

    • payload (dict) – The payload as provided with the event

      • +

    • payload (dict) – The payload as provided with the event

    @@ -656,7 +656,7 @@

    • storage (string) – Location of the file

    • path (string) – Path of the file

      • -

    • progress (int) – Current progress as a value between 0 and 100

      • +

    • progress (int) – Current progress as a value between 0 and 100

    @@ -674,7 +674,7 @@

  • source_path (string) – Path of the source file

  • destination_location (string) – Location the destination file

  • destination_path (string) – Path of the destination file

    • -

  • progress (int) – Current progress as a value between 0 and 100

    • +

  • progress (int) – Current progress as a value between 0 and 100

    • @@ -808,7 +808,7 @@ getters, the second the preprocessors for setters

    Return type
    -

    (dict, dict)

    +

    (dict, dict)

    @@ -900,7 +900,7 @@ plugin’s configuration.

    Return type
    -

    int or None

    +

    int or None

    @@ -966,9 +966,9 @@
    Parameters
      -

    • target (int) – The settings format version the plugin requires, this should always be the same value as +

    • target (int) – The settings format version the plugin requires, this should always be the same value as returned by get_settings_version().

      • -

    • current (int or None) – The settings format version as currently stored in config.yaml. May be None if +

    • current (int or None) – The settings format version as currently stored in config.yaml. May be None if no version information can be found.

    @@ -992,13 +992,13 @@
    Parameters
    -

    data (dict) – The settings dictionary to be saved for the plugin

    +

    data (dict) – The settings dictionary to be saved for the plugin

    Returns

    The settings that differed from the defaults and were actually saved.

    Return type
    -

    dict

    +

    dict

    @@ -1138,7 +1138,7 @@
    Parameters

    • command (string) – the command with which the resource was called

      • -

    • data (dict) – the full request body of the POST request parsed from JSON into a Python dictionary

      • +

    • data (dict) – the full request body of the POST request parsed from JSON into a Python dictionary

    Returns
    @@ -1184,7 +1184,7 @@

    Cancels the slicing to the indicated file.

    Parameters
    -

    machinecode_path (str) – The absolute path to the machine code file to which to stop slicing to.

    +

    machinecode_path (str) – The absolute path to the machine code file to which to stop slicing to.

    @@ -1217,7 +1217,7 @@ should make sure to track the started jobs via the machinecode_path, if provided.

    The method should return a 2-tuple consisting of a boolean flag indicating whether the slicing job was finished successfully (True) or not (False) and a result depending on the success of the slicing job.

    -

    For jobs that finished successfully, result should be a dict containing additional information +

    For jobs that finished successfully, result should be a dict containing additional information about the slicing job under the following keys:

    analysis

    Analysis result of the generated machine code as returned by the slicer itself. This should match the @@ -1225,7 +1225,7 @@ GcodeAnalysisQueue for GCODE files.

    -

    For jobs that did not finish successfully (but not due to being cancelled!), result should be a str +

    For jobs that did not finish successfully (but not due to being cancelled!), result should be a str containing a human readable reason for the error.

    If the job gets cancelled, a SlicingCancelled exception should be raised.

    @@ -1233,7 +1233,7 @@

    A 2-tuple (boolean, object) as outlined above.

    Return type
    -

    tuple

    +

    tuple

    Raises

    SlicingCancelled – The slicing job was cancelled (via cancel_slicing()).

    @@ -1280,7 +1280,7 @@ indicated path.

    Parameters
    -

    path (str) – The absolute path from which to read the slicing profile.

    +

    path (str) – The absolute path from which to read the slicing profile.

    Returns

    The specified slicing profile.

    @@ -1300,7 +1300,7 @@ of the plugin implementation.

    Parameters
    -

    profile_path (str) – The base folder where OctoPrint stores this slicer plugin’s profiles

    +

    profile_path (str) – The base folder where OctoPrint stores this slicer plugin’s profiles

    @@ -1347,7 +1347,7 @@

    A dict describing the slicer as outlined above.

    Return type
    -

    dict

    +

    dict

    @@ -1366,16 +1366,16 @@ save_slicer_profile(path, profile, allow_overwrite=True, overrides=None)

    Should save the provided SlicingProfile to the indicated path, after applying any supplied overrides. If a profile is already saved under the indicated path and allow_overwrite is -set to False (defaults to True), an IOError should be raised.

    +set to False (defaults to True), an IOError should be raised.

    Parameters
      -

    • path (str) – The absolute path to which to save the profile.

      • +

    • path (str) – The absolute path to which to save the profile.

    • profile (SlicingProfile) – The profile to save.

    • allow_overwrite (boolean) – Whether to allow to overwrite an existing profile at the indicated path (True, default) or not (False). If a profile already exists on the path and this is False an -IOError should be raised.

      • -

    • overrides (dict) – Profile overrides to apply to the profile before saving it

      • +IOError should be raised.

      +

    • overrides (dict) – Profile overrides to apply to the profile before saving it

    @@ -1423,7 +1423,7 @@
    Parameters

    • host (string) – the host the server will listen on, may be 0.0.0.0

      • -

    • port (int) – the port the server will listen on

      • +

    • port (int) – the port the server will listen on

    @@ -1922,13 +1922,13 @@ via the parameter default_additional).

    Parameters
    -

    default_additional (list) – The list of default fields added to the ETag of the default UI

    +

    default_additional (list) – The list of default fields added to the ETag of the default UI

    Returns

    A list of additional fields for the ETag generation, or None

    Return type
    -

    (list)

    +

    (list)

    @@ -1950,7 +1950,7 @@

    Return type
    -

    list, tuple

    +

    list, tuple

    @@ -1975,7 +1975,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -1998,7 +1998,7 @@

    Return type
    -

    list

    +

    list

    @@ -2016,7 +2016,7 @@

    An alternatively calculated ETag value. Ignored if None is returned (default).

    Return type
    -

    str

    +

    str

    @@ -2034,7 +2034,7 @@

    An alternatively calculated LastModified value. Ignored if None is returned (default).

    Return type
    -

    int

    +

    int

    @@ -2079,7 +2079,7 @@

    Return type
    -

    list

    +

    list

    @@ -2097,7 +2097,7 @@

    Additional data to persist in the preemptive cache configuration.

    Return type
    -

    dict

    +

    dict

    @@ -2135,7 +2135,7 @@

    Whether to suppress a record (True) or not (False, default)

    Return type
    -

    bool

    +

    bool

    @@ -2154,7 +2154,7 @@

    Whether to enable preemptive caching (True, default) or not (False)

    Return type
    -

    bool

    +

    bool

    @@ -2255,12 +2255,12 @@
    Parameters
      -

    • now (datetime.datetime) – The datetime instance representing “now” +

    • now (datetime.datetime) – The datetime instance representing “now” for this request, in case your plugin implementation needs this information.

    • request (flask.Request) –

      A Flask Request object.

      • -

    • render_kwargs (dict) – The (cached) render keyword arguments that +

    • render_kwargs (dict) – The (cached) render keyword arguments that would usually be provided to the core UI render function.

    @@ -2303,7 +2303,7 @@

    Return type
    -

    bool

    +

    bool

    @@ -2433,7 +2433,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -2459,7 +2459,7 @@

    Return type
    -

    int or None

    +

    int or None

    @@ -2491,11 +2491,11 @@
    Parameters
      -

    • seen_wizards (dict) – A dictionary with information about already seen +

    • seen_wizards (dict) – A dictionary with information about already seen wizards and their versions. Mappings from the identifiers of the plugin providing the wizard to the reported wizard version (int or None) that was already seen by the user.

      • -

    • implementation (object) – The plugin implementation to check.

      • +

    • implementation (object) – The plugin implementation to check.

    Returns
    @@ -2506,7 +2506,7 @@

    Return type
    -

    bool

    +

    bool

    @@ -2535,7 +2535,7 @@

    Use this to do any clean up tasks necessary after wizard completion.

    Parameters
    -

    handled (bool) – True if the plugin’s wizard was previously reported as +

    handled (bool) – True if the plugin’s wizard was previously reported as required, not ignored and thus presented to the user, False otherwise

    @@ -2582,7 +2582,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/python3_migration.html b/devel/plugins/python3_migration.html index 5e363ed6c..cbd8f6ccd 100644 --- a/devel/plugins/python3_migration.html +++ b/devel/plugins/python3_migration.html @@ -117,7 +117,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -490,7 +490,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/plugins/viewmodels.html b/devel/plugins/viewmodels.html index ec0746a5b..e01034d57 100644 --- a/devel/plugins/viewmodels.html +++ b/devel/plugins/viewmodels.html @@ -113,7 +113,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -594,7 +594,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/py-modindex.html b/devel/py-modindex.html index cc4652464..a421d5c99 100644 --- a/devel/py-modindex.html +++ b/devel/py-modindex.html @@ -91,7 +91,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -414,7 +414,7 @@

    Python Module Index

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/devel/search.html b/devel/search.html index 7105ed217..c18d71649 100644 --- a/devel/search.html +++ b/devel/search.html @@ -91,7 +91,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -159,7 +159,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/access.html b/maintenance/api/access.html index cd1602fdf..63db950a2 100644 --- a/maintenance/api/access.html +++ b/maintenance/api/access.html @@ -145,7 +145,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -945,7 +945,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/connection.html b/maintenance/api/connection.html index cb08a4f4f..2b4cae549 100644 --- a/maintenance/api/connection.html +++ b/maintenance/api/connection.html @@ -116,7 +116,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -346,7 +346,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/datamodel.html b/maintenance/api/datamodel.html index 9e44d841e..79fac6e05 100644 --- a/maintenance/api/datamodel.html +++ b/maintenance/api/datamodel.html @@ -143,7 +143,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1259,7 +1259,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/files.html b/maintenance/api/files.html index 3c79beac1..1cc18d14b 100644 --- a/maintenance/api/files.html +++ b/maintenance/api/files.html @@ -125,7 +125,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1129,7 +1129,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/general.html b/maintenance/api/general.html index a3045afec..19b3d1b99 100644 --- a/maintenance/api/general.html +++ b/maintenance/api/general.html @@ -127,7 +127,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -501,7 +501,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/index.html b/maintenance/api/index.html index 36d5bacc5..0b14bb978 100644 --- a/maintenance/api/index.html +++ b/maintenance/api/index.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -313,7 +313,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/job.html b/maintenance/api/job.html index d8315ac59..dc6a8188d 100644 --- a/maintenance/api/job.html +++ b/maintenance/api/job.html @@ -120,7 +120,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -448,7 +448,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/languages.html b/maintenance/api/languages.html index 567c92bc8..dad5b1d16 100644 --- a/maintenance/api/languages.html +++ b/maintenance/api/languages.html @@ -123,7 +123,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -464,7 +464,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/logs.html b/maintenance/api/logs.html index 04f804e61..ac7567c81 100644 --- a/maintenance/api/logs.html +++ b/maintenance/api/logs.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -184,7 +184,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/printer.html b/maintenance/api/printer.html index 9acc70eed..ea11e5307 100644 --- a/maintenance/api/printer.html +++ b/maintenance/api/printer.html @@ -134,7 +134,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1491,7 +1491,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/printerprofiles.html b/maintenance/api/printerprofiles.html index 59d9ffe8a..7de79492a 100644 --- a/maintenance/api/printerprofiles.html +++ b/maintenance/api/printerprofiles.html @@ -125,7 +125,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -873,7 +873,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/push.html b/maintenance/api/push.html index 62a583b90..4ed18e84e 100644 --- a/maintenance/api/push.html +++ b/maintenance/api/push.html @@ -121,7 +121,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -559,7 +559,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/server.html b/maintenance/api/server.html index 1a05d1803..46c6075fc 100644 --- a/maintenance/api/server.html +++ b/maintenance/api/server.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -214,7 +214,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/settings.html b/maintenance/api/settings.html index f3892db23..6ff6874f0 100644 --- a/maintenance/api/settings.html +++ b/maintenance/api/settings.html @@ -119,7 +119,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -632,7 +632,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/slicing.html b/maintenance/api/slicing.html index d3ed96149..17ea8ec35 100644 --- a/maintenance/api/slicing.html +++ b/maintenance/api/slicing.html @@ -128,7 +128,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -686,7 +686,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/system.html b/maintenance/api/system.html index 4ddb656f2..58954224a 100644 --- a/maintenance/api/system.html +++ b/maintenance/api/system.html @@ -123,7 +123,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -492,7 +492,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/timelapse.html b/maintenance/api/timelapse.html index d98faa62e..56dbbdde4 100644 --- a/maintenance/api/timelapse.html +++ b/maintenance/api/timelapse.html @@ -126,7 +126,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -567,7 +567,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/util.html b/maintenance/api/util.html index c7f9d30e5..df6cd439f 100644 --- a/maintenance/api/util.html +++ b/maintenance/api/util.html @@ -123,7 +123,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -766,7 +766,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/version.html b/maintenance/api/version.html index a54f87516..08e82369d 100644 --- a/maintenance/api/version.html +++ b/maintenance/api/version.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -211,7 +211,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/api/wizard.html b/maintenance/api/wizard.html index 371236428..32062ba53 100644 --- a/maintenance/api/wizard.html +++ b/maintenance/api/wizard.html @@ -120,7 +120,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -281,7 +281,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/action_command_notification.html b/maintenance/bundledplugins/action_command_notification.html index dfa16c8c8..881659151 100644 --- a/maintenance/bundledplugins/action_command_notification.html +++ b/maintenance/bundledplugins/action_command_notification.html @@ -114,7 +114,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -225,7 +225,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/action_command_prompt.html b/maintenance/bundledplugins/action_command_prompt.html index d5fc8d684..09adb276e 100644 --- a/maintenance/bundledplugins/action_command_prompt.html +++ b/maintenance/bundledplugins/action_command_prompt.html @@ -114,7 +114,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -261,7 +261,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/announcements.html b/maintenance/bundledplugins/announcements.html index 94e6a3581..a5a907631 100644 --- a/maintenance/bundledplugins/announcements.html +++ b/maintenance/bundledplugins/announcements.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -236,7 +236,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/appkeys.html b/maintenance/bundledplugins/appkeys.html index de88b3d75..73e8e9d46 100644 --- a/maintenance/bundledplugins/appkeys.html +++ b/maintenance/bundledplugins/appkeys.html @@ -133,7 +133,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -998,7 +998,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/backup.html b/maintenance/bundledplugins/backup.html index 48542ab2b..1d49d0dfb 100644 --- a/maintenance/bundledplugins/backup.html +++ b/maintenance/bundledplugins/backup.html @@ -127,7 +127,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -312,7 +312,7 @@

    A list of paths to exclude, relative to your plugin’s data folder

    Return type
    -

    list

    +

    list

    @@ -408,8 +408,8 @@
    Parameters
      -

    • exclude (list) – Names of data folders to exclude, defaults to None

      • -

    • filename (str) – Name of backup to be created, if None (default) the backup +

    • exclude (list) – Names of data folders to exclude, defaults to None

      • +

    • filename (str) – Name of backup to be created, if None (default) the backup name will be auto-generated. This should use a .zip extension.

    @@ -447,7 +447,7 @@
    Parameters
    -

    filename (str) – The name of the backup to delete

    +

    filename (str) – The name of the backup to delete

    @@ -510,7 +510,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/discovery.html b/maintenance/bundledplugins/discovery.html index a202fa54e..76a34726b 100644 --- a/maintenance/bundledplugins/discovery.html +++ b/maintenance/bundledplugins/discovery.html @@ -121,7 +121,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -324,7 +324,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/errortracking.html b/maintenance/bundledplugins/errortracking.html index b50033086..280369160 100644 --- a/maintenance/bundledplugins/errortracking.html +++ b/maintenance/bundledplugins/errortracking.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -210,7 +210,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/file_check.html b/maintenance/bundledplugins/file_check.html index 048f50209..2b23530a9 100644 --- a/maintenance/bundledplugins/file_check.html +++ b/maintenance/bundledplugins/file_check.html @@ -108,7 +108,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -180,7 +180,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/firmware_check.html b/maintenance/bundledplugins/firmware_check.html index 59361295a..9f33cb400 100644 --- a/maintenance/bundledplugins/firmware_check.html +++ b/maintenance/bundledplugins/firmware_check.html @@ -108,7 +108,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -181,7 +181,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/gcodeviewer.html b/maintenance/bundledplugins/gcodeviewer.html index 079f8d6ee..96093a42e 100644 --- a/maintenance/bundledplugins/gcodeviewer.html +++ b/maintenance/bundledplugins/gcodeviewer.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -208,7 +208,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/index.html b/maintenance/bundledplugins/index.html index 36ce02a28..b8e9d4265 100644 --- a/maintenance/bundledplugins/index.html +++ b/maintenance/bundledplugins/index.html @@ -108,7 +108,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -266,7 +266,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/logging.html b/maintenance/bundledplugins/logging.html index 5e215251c..b2ca40f12 100644 --- a/maintenance/bundledplugins/logging.html +++ b/maintenance/bundledplugins/logging.html @@ -119,7 +119,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -467,7 +467,7 @@

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/pluginmanager.html b/maintenance/bundledplugins/pluginmanager.html index 4cbcb8ac0..e10441aa9 100644 --- a/maintenance/bundledplugins/pluginmanager.html +++ b/maintenance/bundledplugins/pluginmanager.html @@ -117,7 +117,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -347,7 +347,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/softwareupdate.html b/maintenance/bundledplugins/softwareupdate.html index 2bcc2b383..63b12baf4 100644 --- a/maintenance/bundledplugins/softwareupdate.html +++ b/maintenance/bundledplugins/softwareupdate.html @@ -132,7 +132,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -799,7 +799,7 @@

    A dictionary of check configurations as described above

    Return type
    -

    dict

    +

    dict

    @@ -868,7 +868,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/tracking.html b/maintenance/bundledplugins/tracking.html index baa0b8a57..05eee0dca 100644 --- a/maintenance/bundledplugins/tracking.html +++ b/maintenance/bundledplugins/tracking.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -218,7 +218,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/bundledplugins/virtual_printer.html b/maintenance/bundledplugins/virtual_printer.html index 60c71ee63..cf40881ff 100644 --- a/maintenance/bundledplugins/virtual_printer.html +++ b/maintenance/bundledplugins/virtual_printer.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -196,7 +196,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/configuration/cli.html b/maintenance/configuration/cli.html index d20e70ba6..171925537 100644 --- a/maintenance/configuration/cli.html +++ b/maintenance/configuration/cli.html @@ -97,7 +97,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -262,7 +262,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/configuration/config_yaml.html b/maintenance/configuration/config_yaml.html index f6dab99e4..33934a27f 100644 --- a/maintenance/configuration/config_yaml.html +++ b/maintenance/configuration/config_yaml.html @@ -120,7 +120,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1349,7 +1349,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/configuration/index.html b/maintenance/configuration/index.html index 430dd2bea..4b4c8ea60 100644 --- a/maintenance/configuration/index.html +++ b/maintenance/configuration/index.html @@ -97,7 +97,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -203,7 +203,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/configuration/logging_yaml.html b/maintenance/configuration/logging_yaml.html index c02ad73a3..85f59950d 100644 --- a/maintenance/configuration/logging_yaml.html +++ b/maintenance/configuration/logging_yaml.html @@ -102,7 +102,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -205,7 +205,7 @@

    Changing logging handlerslogging.handlers.

    +logging.handlers.

    Changing logging formatters

    @@ -217,7 +217,7 @@

    Changing logging formattersPython documentation on LogRecord attributes.

    +Python documentation on LogRecord attributes.

    @@ -255,7 +255,7 @@

    Changing logging formatters
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/configuration/yaml.html b/maintenance/configuration/yaml.html index 9c57f7b67..795a2db5e 100644 --- a/maintenance/configuration/yaml.html +++ b/maintenance/configuration/yaml.html @@ -107,7 +107,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -349,7 +349,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/development/branches.html b/maintenance/development/branches.html index facee2953..96b5d1dd0 100644 --- a/maintenance/development/branches.html +++ b/maintenance/development/branches.html @@ -98,7 +98,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -234,7 +234,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/development/environment.html b/maintenance/development/environment.html index 132e245cc..3aa51e424 100644 --- a/maintenance/development/environment.html +++ b/maintenance/development/environment.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -597,7 +597,7 @@

    Visual Studio Code (vscode)
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/development/index.html b/maintenance/development/index.html index 8d7abbcf2..af34441c2 100644 --- a/maintenance/development/index.html +++ b/maintenance/development/index.html @@ -98,7 +98,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -196,7 +196,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/development/request-profiling.html b/maintenance/development/request-profiling.html index 19df6184b..98dece3eb 100644 --- a/maintenance/development/request-profiling.html +++ b/maintenance/development/request-profiling.html @@ -101,7 +101,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -181,7 +181,7 @@

    Errors
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/development/versioning.html b/maintenance/development/versioning.html index ba4826f59..dc2b6398f 100644 --- a/maintenance/development/versioning.html +++ b/maintenance/development/versioning.html @@ -98,7 +98,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -189,7 +189,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/development/virtual_printer.html b/maintenance/development/virtual_printer.html index c9cc251f8..9519ee4a3 100644 --- a/maintenance/development/virtual_printer.html +++ b/maintenance/development/virtual_printer.html @@ -104,7 +104,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -479,7 +479,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/events/index.html b/maintenance/events/index.html index 0e8529738..359f2b6f2 100644 --- a/maintenance/events/index.html +++ b/maintenance/events/index.html @@ -110,7 +110,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -1221,7 +1221,7 @@

    Example
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/features/accesscontrol.html b/maintenance/features/accesscontrol.html index f2107941c..6a2677734 100644 --- a/maintenance/features/accesscontrol.html +++ b/maintenance/features/accesscontrol.html @@ -114,7 +114,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -394,7 +394,7 @@

    If you are using a VPN and your setup ABSOLUTELY REQUIRES disabling internal
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/features/action_commands.html b/maintenance/features/action_commands.html index f5e6ee955..4311fdec7 100644 --- a/maintenance/features/action_commands.html +++ b/maintenance/features/action_commands.html @@ -100,7 +100,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -243,7 +243,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/features/atcommands.html b/maintenance/features/atcommands.html index 940c6c4b3..5e0128050 100644 --- a/maintenance/features/atcommands.html +++ b/maintenance/features/atcommands.html @@ -100,7 +100,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -190,7 +190,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/features/custom_controls.html b/maintenance/features/custom_controls.html index 589625a31..73ca93c21 100644 --- a/maintenance/features/custom_controls.html +++ b/maintenance/features/custom_controls.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -377,7 +377,7 @@

    -

    (Optional) Step size per slider “tick”, defaults to 1.

    regex

    (Optional) A regular expression to +

    (Optional) A regular expression to match against lines received from the printer to retrieve information from it (e.g. specific output). Together with template this allows rendition of received data from the printer within the UI.

    Please also read the note below.

    @@ -385,7 +385,7 @@

    template

    (Optional) A template to use for rendering the match of regex. May contain placeholders in -Python Format String Syntax for either named +Python Format String Syntax for either named groups within the regex (e.g. Temperature: {temperature} for a regex T:\s*(?P<temperature>\d+(\.\d*)) or positional groups within the regex (e.g. Position: X={0}, Y={1}, Z={2}, E={3} for a regex X:([0-9.]+) Y:([0-9.]+) Z:([0-9.]+) E:([0-9.]+)).

    @@ -512,7 +512,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/features/gcode_scripts.html b/maintenance/features/gcode_scripts.html index 8e6380626..4897ea0c6 100644 --- a/maintenance/features/gcode_scripts.html +++ b/maintenance/features/gcode_scripts.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -459,7 +459,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/features/index.html b/maintenance/features/index.html index a0c97d00a..87b56e83b 100644 --- a/maintenance/features/index.html +++ b/maintenance/features/index.html @@ -100,7 +100,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -205,7 +205,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/features/plugins.html b/maintenance/features/plugins.html index 0acfe9937..8e445a074 100644 --- a/maintenance/features/plugins.html +++ b/maintenance/features/plugins.html @@ -108,7 +108,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -237,7 +237,7 @@

    Manual Installation
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/features/safemode.html b/maintenance/features/safemode.html index c803acb0f..4261e038d 100644 --- a/maintenance/features/safemode.html +++ b/maintenance/features/safemode.html @@ -104,7 +104,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -262,7 +262,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/genindex.html b/maintenance/genindex.html index 1e2d6bba2..acebf029e 100644 --- a/maintenance/genindex.html +++ b/maintenance/genindex.html @@ -88,7 +88,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -3862,7 +3862,7 @@

    Z

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/http-routingtable.html b/maintenance/http-routingtable.html index 617615d6c..898e3f660 100644 --- a/maintenance/http-routingtable.html +++ b/maintenance/http-routingtable.html @@ -95,7 +95,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -570,7 +570,7 @@

    HTTP Routing Table

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/index.html b/maintenance/index.html index b075881c8..33892cc45 100644 --- a/maintenance/index.html +++ b/maintenance/index.html @@ -90,7 +90,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -312,7 +312,7 @@

    Contents
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/base.html b/maintenance/jsclientlib/base.html index c2456fadf..f58c606a9 100644 --- a/maintenance/jsclientlib/base.html +++ b/maintenance/jsclientlib/base.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -780,7 +780,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/browser.html b/maintenance/jsclientlib/browser.html index a399b1534..6d3659294 100644 --- a/maintenance/jsclientlib/browser.html +++ b/maintenance/jsclientlib/browser.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -256,7 +256,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/connection.html b/maintenance/jsclientlib/connection.html index a3a07f9dc..1a02f24ce 100644 --- a/maintenance/jsclientlib/connection.html +++ b/maintenance/jsclientlib/connection.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -257,7 +257,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/control.html b/maintenance/jsclientlib/control.html index 4c9785b00..2ecbeaf22 100644 --- a/maintenance/jsclientlib/control.html +++ b/maintenance/jsclientlib/control.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -273,7 +273,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/files.html b/maintenance/jsclientlib/files.html index e4f5347a6..5fbeab826 100644 --- a/maintenance/jsclientlib/files.html +++ b/maintenance/jsclientlib/files.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -531,7 +531,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/index.html b/maintenance/jsclientlib/index.html index 6d8e0a2cf..1bd742c5f 100644 --- a/maintenance/jsclientlib/index.html +++ b/maintenance/jsclientlib/index.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -278,7 +278,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/job.html b/maintenance/jsclientlib/job.html index 555520940..a9d93f349 100644 --- a/maintenance/jsclientlib/job.html +++ b/maintenance/jsclientlib/job.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -309,7 +309,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/languages.html b/maintenance/jsclientlib/languages.html index 6a7dc76e6..0de3efdba 100644 --- a/maintenance/jsclientlib/languages.html +++ b/maintenance/jsclientlib/languages.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -240,7 +240,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/logs.html b/maintenance/jsclientlib/logs.html index a619bc687..43f96f6d2 100644 --- a/maintenance/jsclientlib/logs.html +++ b/maintenance/jsclientlib/logs.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -183,7 +183,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/printer.html b/maintenance/jsclientlib/printer.html index 8f56600ad..1bf4214d4 100644 --- a/maintenance/jsclientlib/printer.html +++ b/maintenance/jsclientlib/printer.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -670,7 +670,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/printerprofiles.html b/maintenance/jsclientlib/printerprofiles.html index abb55ca1d..442258262 100644 --- a/maintenance/jsclientlib/printerprofiles.html +++ b/maintenance/jsclientlib/printerprofiles.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -270,7 +270,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/settings.html b/maintenance/jsclientlib/settings.html index 7c4e71a6c..6ab8f93ba 100644 --- a/maintenance/jsclientlib/settings.html +++ b/maintenance/jsclientlib/settings.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -269,7 +269,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/slicing.html b/maintenance/jsclientlib/slicing.html index 74b4bfb72..1b03ea205 100644 --- a/maintenance/jsclientlib/slicing.html +++ b/maintenance/jsclientlib/slicing.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -290,7 +290,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/socket.html b/maintenance/jsclientlib/socket.html index 8555dbad1..9367a6444 100644 --- a/maintenance/jsclientlib/socket.html +++ b/maintenance/jsclientlib/socket.html @@ -115,7 +115,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -388,7 +388,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/system.html b/maintenance/jsclientlib/system.html index 62dc6d9f8..49736434c 100644 --- a/maintenance/jsclientlib/system.html +++ b/maintenance/jsclientlib/system.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -241,7 +241,7 @@

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/timelapse.html b/maintenance/jsclientlib/timelapse.html index e23bcf343..9de01a090 100644 --- a/maintenance/jsclientlib/timelapse.html +++ b/maintenance/jsclientlib/timelapse.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -355,7 +355,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/users.html b/maintenance/jsclientlib/users.html index 4a597fdaf..228aab0c8 100644 --- a/maintenance/jsclientlib/users.html +++ b/maintenance/jsclientlib/users.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -368,7 +368,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/util.html b/maintenance/jsclientlib/util.html index 3ae677bae..980570fba 100644 --- a/maintenance/jsclientlib/util.html +++ b/maintenance/jsclientlib/util.html @@ -111,7 +111,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -432,7 +432,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/jsclientlib/wizard.html b/maintenance/jsclientlib/wizard.html index d977eed3a..b03e6a5cd 100644 --- a/maintenance/jsclientlib/wizard.html +++ b/maintenance/jsclientlib/wizard.html @@ -110,7 +110,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -221,7 +221,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/modules/access.html b/maintenance/modules/access.html index ac2ccbb72..29c8525fd 100644 --- a/maintenance/modules/access.html +++ b/maintenance/modules/access.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -237,7 +237,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/modules/cli.html b/maintenance/modules/cli.html index e92322134..5e96e1ed6 100644 --- a/maintenance/modules/cli.html +++ b/maintenance/modules/cli.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -155,7 +155,7 @@

    octoprint.cli

    -class octoprint.cli.HiddenOption(param_decls: Optional[Sequence[str]] = None, show_default: Optional[Union[bool, str]] = None, prompt: Union[bool, str] = False, confirmation_prompt: Union[bool, str] = False, prompt_required: bool = True, hide_input: bool = False, is_flag: Optional[bool] = None, flag_value: Optional[Any] = None, multiple: bool = False, count: bool = False, allow_from_autoenv: bool = True, type: Optional[Union[click.types.ParamType, Any]] = None, help: Optional[str] = None, hidden: bool = False, show_choices: bool = True, show_envvar: bool = False, **attrs: Any)
    +class octoprint.cli.HiddenOption(param_decls: Optional[Sequence[str]] = None, show_default: Optional[Union[bool, str]] = None, prompt: Union[bool, str] = False, confirmation_prompt: Union[bool, str] = False, prompt_required: bool = True, hide_input: bool = False, is_flag: Optional[bool] = None, flag_value: Optional[Any] = None, multiple: bool = False, count: bool = False, allow_from_autoenv: bool = True, type: Optional[Union[click.types.ParamType, Any]] = None, help: Optional[str] = None, hidden: bool = False, show_choices: bool = True, show_envvar: bool = False, **attrs: Any)

    Custom option sub class with empty help.

    @@ -351,7 +351,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/modules/filemanager.html b/maintenance/modules/filemanager.html index e28c8e6a0..010321f96 100644 --- a/maintenance/modules/filemanager.html +++ b/maintenance/modules/filemanager.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -215,7 +215,7 @@ overridden by sub classes.

    Parameters
    -

    high_priority (bool) – Whether the current entry has high priority or not.

    +

    high_priority (bool) – Whether the current entry has high priority or not.

    Returns

    @@ -225,7 +225,7 @@

    Return type
    -

    object

    +

    object

    @@ -289,7 +289,7 @@
    class octoprint.filemanager.analysis.GcodeAnalysisQueue(finished_callback)
    -

    A queue to analyze GCODE files. Analysis results are dict instances structured as follows:

    +

    A queue to analyze GCODE files. Analysis results are dict instances structured as follows:

    @@ -390,14 +390,14 @@
    Parameters
      -

    • name (str) – Name of the file to analyze.

      • -

    • path (str) – Storage location specific path to the file to analyze.

      • -

    • type (str) – Type of file to analyze, necessary to map to the correct AbstractAnalysisQueue sub class. +

    • name (str) – Name of the file to analyze.

      • +

    • path (str) – Storage location specific path to the file to analyze.

      • +

    • type (str) – Type of file to analyze, necessary to map to the correct AbstractAnalysisQueue sub class. At the moment, only gcode is supported here.

      • -

    • location (str) – Location the file is located on.

      • -

    • absolute_path (str) – Absolute path on disk through which to access the file.

      • +

    • location (str) – Location the file is located on.

      • +

    • absolute_path (str) – Absolute path on disk through which to access the file.

    • printer_profile (PrinterProfile) – PrinterProfile which to use for analysis.

      • -

    • analysis (dict) – GcodeAnalysisQueue results from prior analysis, or None if there is none.

      • +

    • analysis (dict) – GcodeAnalysisQueue results from prior analysis, or None if there is none.

    @@ -424,13 +424,13 @@
    Parameters

    • path (string) – the file’s new path, will be sanitized

      • -

    • file_object (object) – a file object that provides a save method which will be called with the destination path +

    • file_object (object) – a file object that provides a save method which will be called with the destination path where the object should then store its contents

      • -

    • printer_profile (object) – the printer profile associated with this file (if any)

      • -

    • links (list) – any links to add with the file

      • -

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file +

    • printer_profile (object) – the printer profile associated with this file (if any)

      • +

    • links (list) – any links to add with the file

      • +

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file and its metadata will just be silently overwritten

      • -

    • display (str) – display name of the file

      • +

    • display (str) – display name of the file

    Returns
    @@ -448,8 +448,8 @@
    Parameters

    • path (string) – the path of the new folder

      • -

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • -

    • display (str) – display name of the folder

      • +

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • +

    • display (str) – display name of the folder

    Returns
    @@ -634,9 +634,9 @@
    Parameters
      -

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or +

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or set to None, defatuls to storage root.

      • -

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or +

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or the whole path’s subtree (True).

    @@ -706,7 +706,7 @@ from root of base folder

  • filter (function) – a filter that matches the files that are to be returned, may be left out in which case no filtering will take place

    • -

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only +

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only do one step down into sub folders to be able to populate the children.

    • @@ -770,7 +770,7 @@ path_on_disk(path)

    Retrieves the path on disk for path.

    Note: if the storage is not on disk and there exists no path on disk to refer to it, this method should -raise an io.UnsupportedOperation

    +raise an io.UnsupportedOperation

    Opposite of path_in_storage().

    Parameters
    @@ -817,7 +817,7 @@
    Parameters

    • path (string) – the path of the folder to remove

      • -

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will +

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will be raised if the folder is not empty (apart from any metadata files) when it’s to be removed

    @@ -861,7 +861,7 @@
    sanitize_name(name)
    -

    Raises a ValueError for a name containing / or \. Otherwise +

    Raises a ValueError for a name containing / or \. Otherwise sanitizes the given name using octoprint.files.sanitize_filename. Also strips any leading ..

    @@ -917,13 +917,13 @@
    Parameters

    • path (string) – the file’s new path, will be sanitized

      • -

    • file_object (object) – a file object that provides a save method which will be called with the destination path +

    • file_object (object) – a file object that provides a save method which will be called with the destination path where the object should then store its contents

      • -

    • printer_profile (object) – the printer profile associated with this file (if any)

      • -

    • links (list) – any links to add with the file

      • -

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file +

    • printer_profile (object) – the printer profile associated with this file (if any)

      • +

    • links (list) – any links to add with the file

      • +

    • allow_overwrite (bool) – if set to True no error will be raised if the file already exists and the existing file and its metadata will just be silently overwritten

      • -

    • display (str) – display name of the file

      • +

    • display (str) – display name of the file

    Returns
    @@ -941,8 +941,8 @@
    Parameters

    • path (string) – the path of the new folder

      • -

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • -

    • display (str) – display name of the folder

      • +

    • ignore_existing (bool) – if set to True, no error will be raised if the folder to be added already exists

      • +

    • display (str) – display name of the folder

    Returns
    @@ -1127,9 +1127,9 @@
    Parameters
      -

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or +

    • path (str or None) – Path for which to determine the subtree’s last modification date. If left out or set to None, defatuls to storage root.

      • -

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or +

    • recursive (bool) – Whether to determine only the date of the specified path (False, default) or the whole path’s subtree (True).

    @@ -1199,7 +1199,7 @@ from root of base folder

  • filter (function) – a filter that matches the files that are to be returned, may be left out in which case no filtering will take place

    • -

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only +

  • recursive (bool) – will also step into sub folders for building the complete list if set to True, otherwise will only do one step down into sub folders to be able to populate the children.

    • @@ -1263,7 +1263,7 @@ path_on_disk(path)

    Retrieves the path on disk for path.

    Note: if the storage is not on disk and there exists no path on disk to refer to it, this method should -raise an io.UnsupportedOperation

    +raise an io.UnsupportedOperation

    Opposite of path_in_storage().

    Parameters
    @@ -1310,7 +1310,7 @@
    Parameters

    • path (string) – the path of the folder to remove

      • -

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will +

    • recursive (bool) – if set to True, contained folders and files will also be removed, otherwise an error will be raised if the folder is not empty (apart from any metadata files) when it’s to be removed

    @@ -1403,7 +1403,7 @@

    Wrapper for file representations to save to storages.

    Parameters
    -

    filename (str) – The file’s name

    +

    filename (str) – The file’s name

    @@ -1413,8 +1413,8 @@
    Parameters
      -

    • path (str) – The absolute path to where to save the file

      • -

    • permissions (int) – The permissions to set on the file

      • +

    • path (str) – The absolute path to where to save the file

      • +

    • permissions (int) – The permissions to set on the file

    @@ -1429,7 +1429,7 @@

    The file’s contents as a stream.

    Return type
    -

    io.IOBase

    +

    io.IOBase

    @@ -1445,8 +1445,8 @@
    Parameters
      -

    • filename (str) – The file’s name

      • -

    • path (str) – The file’s absolute path

      • +

    • filename (str) – The file’s name

      • +

    • path (str) – The file’s absolute path

    • move (boolean) – Whether to move the file upon saving (True, default) or copying.

    @@ -1458,8 +1458,8 @@
    Parameters
      -

    • path (str) – The absolute path to where to save the file

      • -

    • permissions (int) – The permissions to set on the file

      • +

    • path (str) – The absolute path to where to save the file

      • +

    • permissions (int) – The permissions to set on the file

    @@ -1474,7 +1474,7 @@

    The file’s contents as a stream.

    Return type
    -

    io.IOBase

    +

    io.IOBase

    @@ -1491,7 +1491,7 @@ to do the decoding yourself.

    Parameters
    -

    input_stream (io.RawIOBase) – The stream to process on the fly.

    +

    input_stream (io.RawIOBase) – The stream to process on the fly.

    @@ -1509,7 +1509,7 @@ wrapper input_stream.

    Parameters
    -

    line (bytes) – The line as read from self.input_stream in byte representation

    +

    line (bytes) – The line as read from self.input_stream in byte representation

    Returns

    @@ -1519,7 +1519,7 @@

    Return type
    -

    bytes or None

    +

    bytes or None

    @@ -1555,7 +1555,7 @@ their contents in the order they are provided to the constructor.

    Parameters
    -

    *streams – One or more io.IOBase streams to concatenate.

    +

    *streams – One or more io.IOBase streams to concatenate.

    @@ -1595,7 +1595,7 @@

    A wrapper allowing processing of one or more consecutive streams.

    Parameters
    -

    *streams – One or more io.IOBase streams to process one after another to save to storage.

    +

    *streams – One or more io.IOBase streams to process one after another to save to storage.

    @@ -1650,7 +1650,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/modules/index.html b/maintenance/modules/index.html index 05ef1d539..83f0123e3 100644 --- a/maintenance/modules/index.html +++ b/maintenance/modules/index.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -220,7 +220,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/modules/plugin.html b/maintenance/modules/plugin.html index 921a728fe..b7ea4bff0 100644 --- a/maintenance/modules/plugin.html +++ b/maintenance/modules/plugin.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -164,31 +164,31 @@
    Parameters

    • init (boolean) – A flag indicating whether this is the initial call to construct the singleton (True) or not -(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError +(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError will be raised. The same will happen if the plugin manager has not yet been initialized and this is set to False.

      • -

    • plugin_folders (list) – A list of folders (as strings containing the absolute path to them) in which to look for +

    • plugin_folders (list) – A list of folders (as strings containing the absolute path to them) in which to look for potential plugin modules. If not provided this defaults to the configured plugins base folder and src/plugins within OctoPrint’s code base.

      • -

    • plugin_bases (list) – A list of recognized plugin base classes for which to look for provided implementations. If not +

    • plugin_bases (list) – A list of recognized plugin base classes for which to look for provided implementations. If not provided this defaults to OctoPrintPlugin.

      • -

    • plugin_entry_points (list) – A list of entry points pointing to modules which to load as plugins. If not provided +

    • plugin_entry_points (list) – A list of entry points pointing to modules which to load as plugins. If not provided this defaults to the entry point octoprint.plugin.

      • -

    • plugin_disabled_list (list) – A list of plugin identifiers that are currently disabled. If not provided this +

    • plugin_disabled_list (list) – A list of plugin identifiers that are currently disabled. If not provided this defaults to all plugins for which enabled is set to False in the settings.

      • -

    • plugin_sorting_order (dict) – A dict containing a custom sorting orders for plugins. The keys are plugin identifiers, +

    • plugin_sorting_order (dict) – A dict containing a custom sorting orders for plugins. The keys are plugin identifiers, mapped to dictionaries containing the sorting contexts as key and the custom sorting value as value.

      • -

    • plugin_blacklist (list) – A list of plugin identifiers/identifier-requirement tuples +

    • plugin_blacklist (list) – A list of plugin identifiers/identifier-requirement tuples that are currently blacklisted.

      • -

    • plugin_restart_needing_hooks (list) – A list of hook namespaces which cause a plugin to need a restart in order +

    • plugin_restart_needing_hooks (list) – A list of hook namespaces which cause a plugin to need a restart in order be enabled/disabled. Does not have to contain full hook identifiers, will be matched with startswith similar to logging handlers

      • -

    • plugin_obsolete_hooks (list) – A list of hooks that have been declared obsolete. Plugins implementing them will +

    • plugin_obsolete_hooks (list) – A list of hooks that have been declared obsolete. Plugins implementing them will not be enabled since they might depend on functionality that is no longer available.

      • -

    • plugin_considered_bundled (list) – A list of plugin identifiers that are considered bundled plugins even if +

    • plugin_considered_bundled (list) – A list of plugin identifiers that are considered bundled plugins even if installed separately.

      • -

    • plugin_validators (list) – A list of additional plugin validators through which to process each plugin.

      • -

    • compatibility_ignored_list (list) – A list of plugin keys for which it will be ignored if they are flagged as +

    • plugin_validators (list) – A list of additional plugin validators through which to process each plugin.

      • +

    • compatibility_ignored_list (list) – A list of plugin keys for which it will be ignored if they are flagged as incompatible. This is for development purposes only and should not be used in production.

    @@ -203,7 +203,7 @@

    PluginManager

    Raises
    -

    ValueError – init was True although the plugin manager was already initialized, or it was False although +

    ValueError – init was True although the plugin manager was already initialized, or it was False although the plugin manager was not yet initialized.

    @@ -217,9 +217,9 @@
    Parameters

    • plugin_key (string) – The plugin identifier for which to create the settings instance.

      • -

    • defaults (dict) – The default settings for the plugin, if different from get_settings_defaults.

      • -

    • get_preprocessors (dict) – The getter preprocessors for the plugin.

      • -

    • set_preprocessors (dict) – The setter preprocessors for the plugin.

      • +

    • defaults (dict) – The default settings for the plugin, if different from get_settings_defaults.

      • +

    • get_preprocessors (dict) – The getter preprocessors for the plugin.

      • +

    • set_preprocessors (dict) – The setter preprocessors for the plugin.

    • settings (octoprint.settings.Settings) – The settings instance to use.

    @@ -261,10 +261,10 @@
    Parameters
      -

    • types (list) – A list of plugin implementation types to match against.

      • +

    • types (list) – A list of plugin implementation types to match against.

    • method (string) – Name of the method to call on all matching implementations.

      • -

    • args (tuple) – A tuple containing the arguments to supply to the called method. Optional.

      • -

    • kwargs (dict) – A dictionary containing the keyword arguments to supply to the called method. Optional.

      • +

    • args (tuple) – A tuple containing the arguments to supply to the called method. Optional.

      • +

    • kwargs (dict) – A dictionary containing the keyword arguments to supply to the called method. Optional.

    • callback (function) – A callback to invoke after an implementation has been called successfully. Will be called with the three arguments name, plugin and result. name will be the plugin identifier, plugin the plugin implementation instance itself and result the result returned from the @@ -291,8 +291,8 @@

      Parameters

      • settings (Settings) – The Settings instance on which to operate.

        • -

      • plugin_key (str) – The plugin identifier of the plugin for which to create this instance.

        • -

      • defaults (dict) – The plugin’s defaults settings, will be used to determine valid paths within the plugin’s +

      • plugin_key (str) – The plugin identifier of the plugin for which to create this instance.

        • +

      • defaults (dict) – The plugin’s defaults settings, will be used to determine valid paths within the plugin’s settings structure

      @@ -305,7 +305,7 @@
      Parameters
        -

      • path (list, tuple) – The path for which to retrieve the value.

        • +

      • path (list, tuple) – The path for which to retrieve the value.

      • merged (boolean) – Whether to merge the returned result with the default settings (True) or not (False, default).

      @@ -314,7 +314,7 @@

      The retrieved settings value.

      Return type
      -

      object

      +

      object

    @@ -348,8 +348,8 @@
    Parameters
      -

    • path (list, tuple) – The path for which to retrieve the value.

      • -

    • value (object) – The value to set.

      • +

    • path (list, tuple) – The path for which to retrieve the value.

      • +

    • value (object) – The value to set.

    • force (boolean) – If set to True, the modified configuration will even be written back to disk if the value didn’t change.

    @@ -404,13 +404,13 @@
    Parameters
      -

    • overlay (dict) – Overlay dict to add

      • +

    • overlay (dict) – Overlay dict to add

    • at_end (boolean) – Whether to add overlay at end or start (default) of config hierarchy

      • -

    • key (str) – Key to use to identify overlay. If not set one will be built based on the overlay’s hash

      • +

    • key (str) – Key to use to identify overlay. If not set one will be built based on the overlay’s hash

    Return type
    -

    str

    +

    str

    @@ -422,7 +422,7 @@ removed, False otherwise.

    Parameters
    -

    key (str) – The key of the overlay to remove

    +

    key (str) – The key of the overlay to remove

    Return type

    boolean

    @@ -448,7 +448,7 @@ want to create a log file for logging the output of the slicing engine itself if some debug flag is set.

    Parameters
    -

    postfix (str) – Postfix of the logfile for which to create the path. If set, the file name of the log file +

    postfix (str) – Postfix of the logfile for which to create the path. If set, the file name of the log file will be plugin_<plugin identifier>_<postfix>.log, if not it will be plugin_<plugin identifier>.log.

    @@ -456,7 +456,7 @@

    Absolute path to the log file, directly usable by the plugin.

    Return type
    -

    str

    +

    str

    @@ -559,7 +559,7 @@

    A list of all found and matching implementations.

    Return type
    -

    list

    +

    list

    @@ -568,12 +568,12 @@
    get_helpers(name, *helpers)

    Retrieves the named helpers for the plugin with identifier name.

    -

    If the plugin is not available, returns None. Otherwise returns a dict with the requested plugin +

    If the plugin is not available, returns None. Otherwise returns a dict with the requested plugin helper names mapped to the method - if a helper could not be resolved, it will be missing from the dict.

    Parameters
      -

    • name (str) – Identifier of the plugin for which to look up the helpers.

      • +

    • name (str) – Identifier of the plugin for which to look up the helpers.

    • helpers (one or more str) – Identifiers of the helpers of plugin name to return.

    @@ -585,7 +585,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -596,13 +596,13 @@

    Retrieves all registered handlers for the specified hook.

    Parameters
    -

    hook (str) – The hook for which to retrieve the handlers.

    +

    hook (str) – The hook for which to retrieve the handlers.

    Returns

    A dict containing all registered handlers mapped by their plugin’s identifier.

    Return type
    -

    dict

    +

    dict

    @@ -619,7 +619,7 @@

    A list of all found implementations

    Return type
    -

    list

    +

    list

    @@ -632,7 +632,7 @@
    Parameters
      -

    • identifier (str) – The identifier of the plugin to retrieve.

      • +

    • identifier (str) – The identifier of the plugin to retrieve.

    • require_enabled (boolean) – Whether to only return the plugin if is enabled (True, default) or also if it’s disabled.

    @@ -654,7 +654,7 @@
    Parameters
      -

    • identifier (str) – The identifier of the plugin to retrieve.

      • +

    • identifier (str) – The identifier of the plugin to retrieve.

    • require_enabled (boolean) – Whether to only return the plugin if is enabled (True, default) or also if it’s disabled.

    @@ -688,7 +688,7 @@

    Return type
    -

    (bool)

    +

    (bool)

    @@ -713,7 +713,7 @@

    Return type
    -

    (bool)

    +

    (bool)

    @@ -743,7 +743,7 @@

    hook is expected to be an exact hook name.

    hooks is expected to be a list containing one or more hook names or patterns. That can be either an exact hook name or an -fnmatch.fnmatch() pattern.

    +fnmatch.fnmatch() pattern.

    Parameters
      @@ -755,7 +755,7 @@

      True if the hook matches any of the hooks, False otherwise.

      Return type
      -

      (bool)

      +

      (bool)

    @@ -773,8 +773,8 @@
    Parameters
      -

    • name (str) – the plugin’s identifier

      • -

    • flag (str) – the flag to check

      • +

    • name (str) – the plugin’s identifier

      • +

    • flag (str) – the flag to check

    Returns
    @@ -805,8 +805,8 @@
    Parameters
      -

    • name (str) – plugin identifier

      • -

    • **flags (dict) – dictionary of flag names and values

      • +

    • name (str) – plugin identifier

      • +

    • **flags (dict) – dictionary of flag names and values

    @@ -843,7 +843,7 @@

    • startup (boolean) – whether this is called during startup of the platform

    • initialize_implementations (boolean) – whether plugin implementations should be initialized

      • -

    • force_reload (list) – list of plugin identifiers which should be force reloaded

      • +

    • force_reload (list) – list of plugin identifiers which should be force reloaded

    @@ -857,9 +857,9 @@
    Parameters
      -

    • plugin (str) – The sending plugin’s identifier.

      • -

    • data (object) – The message.

      • -

    • permissions (list) – A list of permissions to test against in the client.

      • +

    • plugin (str) – The sending plugin’s identifier.

      • +

    • data (object) – The message.

      • +

    • permissions (list) – A list of permissions to test against in the client.

    @@ -884,15 +884,15 @@
    Parameters
      -

    • key (str) – Identifier of the plugin

      • -

    • location (str) – Installation folder of the plugin

      • +

    • key (str) – Identifier of the plugin

      • +

    • location (str) – Installation folder of the plugin

    • instance (module) – Plugin module instance - this may be None if the plugin has been blacklisted!

      • -

    • name (str) – Human readable name of the plugin

      • -

    • version (str) – Version of the plugin

      • -

    • description (str) – Description of the plugin

      • -

    • author (str) – Author of the plugin

      • -

    • url (str) – URL of the website of the plugin

      • -

    • license (str) – License of the plugin

      • +

    • name (str) – Human readable name of the plugin

      • +

    • version (str) – Version of the plugin

      • +

    • description (str) – Description of the plugin

      • +

    • author (str) – Author of the plugin

      • +

    • url (str) – URL of the website of the plugin

      • +

    • license (str) – License of the plugin

    @@ -906,7 +906,7 @@

    Author of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -953,7 +953,7 @@

    Description of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -984,7 +984,7 @@

    Reason why disabling this plugin is discouraged (only for bundled plugins)

    Return type
    -

    str or None

    +

    str or None

    @@ -1021,7 +1021,7 @@ get_hook(hook)
    Parameters
    -

    hook (str) – Hook to return.

    +

    hook (str) – Hook to return.

    Returns

    Handler for the requested hook or None if no handler is registered.

    @@ -1037,13 +1037,13 @@ get_implementation(*types)
    Parameters
    -

    types (list) – List of Plugin sub classes the implementation needs to implement.

    +

    types (list) – List of Plugin sub classes the implementation needs to implement.

    Returns

    The plugin’s implementation if it matches all of the requested types, None otherwise.

    Return type
    -

    object

    +

    object

    @@ -1058,7 +1058,7 @@

    Helpers provided by the plugin.

    Return type
    -

    dict

    +

    dict

    @@ -1072,7 +1072,7 @@

    Whether the plugin should be flagged as hidden or not

    Return type
    -

    bool

    +

    bool

    @@ -1087,7 +1087,7 @@

    Hooks provided by the plugin.

    Return type
    -

    dict

    +

    dict

    @@ -1102,7 +1102,7 @@

    Implementation provided by the plugin.

    Return type
    -

    object

    +

    object

    @@ -1129,7 +1129,7 @@

    License of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1177,18 +1177,18 @@
    Parameters

    • show_enabled (boolean) – whether to show the enabled part

      • -

    • enabled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the enabled state

      • +

    • enabled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the enabled state

    • show_bundled (boolean) – whether to show the bundled part

      • -

    • bundled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the bundled state

      • +

    • bundled_strs (tuple) – the 2-tuple containing the two possible strings to use for displaying the bundled state

    • show_location (boolean) – whether to show the location part

      • -

    • location_str (str) – the format string to use for displaying the plugin’s installation location

      • +

    • location_str (str) – the format string to use for displaying the plugin’s installation location

    Returns

    The long string representation of the plugin as described above

    Return type
    -

    str

    +

    str

    @@ -1215,7 +1215,7 @@

    Name of the plugin, fallback is the plugin’s identifier.

    Return type
    -

    str

    +

    str

    @@ -1249,7 +1249,7 @@

    Privacy Policy URL of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1264,7 +1264,7 @@

    Python compatibility string of the plugin

    Return type
    -

    str

    +

    str

    @@ -1294,7 +1294,7 @@

    Website URL for the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1317,7 +1317,7 @@

    Version of the plugin.

    Return type
    -

    str or None

    +

    str or None

    @@ -1400,7 +1400,7 @@ not None sorted by that.

    Parameters
    -

    context (str) – The sorting context for which to provide the +

    context (str) – The sorting context for which to provide the sorting key value.

    Returns
    @@ -1412,7 +1412,7 @@

    Return type
    -

    int or None

    +

    int or None

    @@ -1577,7 +1577,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/modules/printer.html b/maintenance/modules/printer.html index 947c0659a..d9964796e 100644 --- a/maintenance/modules/printer.html +++ b/maintenance/modules/printer.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -192,8 +192,8 @@
    Parameters
      -

    • path (str) – path in storage of the file to check

      • -

    • sd (bool) – True if to check against SD storage, False otherwise

      • +

    • path (str) – path in storage of the file to check

      • +

    • sd (bool) – True if to check against SD storage, False otherwise

    Returns
    @@ -220,7 +220,7 @@
    Parameters
      -

    • tool (str) – The tool to switch to, matching the regex “tool[0-9]+” (e.g. “tool0”, “tool1”, …)

      • +

    • tool (str) – The tool to switch to, matching the regex “tool[0-9]+” (e.g. “tool0”, “tool1”, …)

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -234,10 +234,10 @@
    Parameters
      -

    • commands (str, list) – The commands to send. Might be a single command provided just as a string or a list +

    • commands (str, list) – The commands to send. Might be a single command provided just as a string or a list of multiple commands to send in order.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      • -

    • force (bool) – Whether to force sending of the command right away or allow queuing while printing

      • +

    • force (bool) – Whether to force sending of the command right away or allow queuing while printing

    @@ -252,9 +252,9 @@
    Parameters
      -

    • port (str) – Name of the serial port to connect to. If not provided, an auto detection will be attempted.

      • -

    • baudrate (int) – Baudrate to connect with. If not provided, an auto detection will be attempted.

      • -

    • profile (str) – Name of the printer profile to use for this connection. If not provided, the default +

    • port (str) – Name of the serial port to connect to. If not provided, an auto detection will be attempted.

      • +

    • baudrate (int) – Baudrate to connect with. If not provided, an auto detection will be attempted.

      • +

    • profile (str) – Name of the printer profile to use for this connection. If not provided, the default will be retrieved from the PrinterProfileManager.

    @@ -274,8 +274,8 @@
    Parameters
      -

    • amount (int, float) – The amount of material to extrude in mm

      • -

    • speed (int, None) – Speed at which to extrude (F parameter). If set to None (or left out)

      • +

    • amount (int, float) – The amount of material to extrude in mm

      • +

    • speed (int, None) – Speed at which to extrude (F parameter). If set to None (or left out)

    • used. (the maximum speed of E axis from the printer profile will be) –

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -298,7 +298,7 @@
    Parameters
      -

    • factor (int, float) – The factor for the feed rate to send to the firmware. Percentage expressed as either an +

    • factor (int, float) – The factor for the feed rate to send to the firmware. Percentage expressed as either an int between 0 and 100 or a float between 0 and 1.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -313,7 +313,7 @@
    Parameters
      -

    • factor (int, float) – The factor for the flow rate to send to the firmware. Percentage expressed as either an +

    • factor (int, float) – The factor for the flow rate to send to the firmware. Percentage expressed as either an int between 0 and 100 or a float between 0 and 1.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -338,7 +338,7 @@

    A dictionary holding the connection options in the structure specified above

    Return type
    -

    (dict)

    +

    (dict)

    @@ -448,7 +448,7 @@

    The communication layer’s transport object

    Return type
    -

    object

    +

    object

    @@ -460,7 +460,7 @@
    Parameters
      -

    • axes (str, list) – The axis or axes to home, each of which must converted to lower case must match one of +

    • axes (str, list) – The axis or axes to home, each of which must converted to lower case must match one of “x”, “y”, “z” and “e”

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

    @@ -508,8 +508,8 @@
    Parameters
      -

    • path (str) – path in storage of the file to check

      • -

    • sd (bool) – True if to check against SD storage, False otherwise

      • +

    • path (str) – path in storage of the file to check

      • +

    • sd (bool) – True if to check against SD storage, False otherwise

    Returns
    @@ -598,7 +598,7 @@ if the lock can’t be acquired.

    Parameters
    -

    blocking (bool) – Whether to block while attempting to acquire the lock (default) or not

    +

    blocking (bool) – Whether to block while attempting to acquire the lock (default) or not

    @@ -610,10 +610,10 @@
    Parameters
      -

    • axes (dict) – Axes and distances to jog, keys are axes (“x”, “y”, “z”), values are distances in mm

      • -

    • relative (bool) – Whether to interpret the distance values as relative (true, default) or absolute (false) +

    • axes (dict) – Axes and distances to jog, keys are axes (“x”, “y”, “z”), values are distances in mm

      • +

    • relative (bool) – Whether to interpret the distance values as relative (true, default) or absolute (false) coordinates

      • -

    • speed (int, bool or None) – Speed at which to jog (F parameter). If set to False no speed will be set +

    • speed (int, bool or None) – Speed at which to jog (F parameter). If set to False no speed will be set specifically. If set to None (or left out) the minimum of all involved axes speeds from the printer profile will be used.

    • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      • @@ -672,8 +672,8 @@
      Parameters
        -

      • name (str) – The name of the GCODE script to render.

        • -

      • context (dict) – An optional context of additional template variables to provide to the renderer.

        • +

      • name (str) – The name of the GCODE script to render.

        • +

      • context (dict) – An optional context of additional template variables to provide to the renderer.

      • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

      @@ -691,7 +691,7 @@
      Parameters
        -

      • path (str) – The path to select for printing. Either an absolute path or relative path to a local file in +

      • path (str) – The path to select for printing. Either an absolute path or relative path to a local file in the uploads folder or a filename on the printer’s SD card.

      • sd (boolean) – Indicates whether the file is on the printer’s SD card or not.

      • printAfterSelect (boolean) – Indicates whether a print should be started @@ -743,8 +743,8 @@

        Parameters
          -

        • value (bool) – The value to set

          • -

        • blocking (bool) – Whether to block while attempting to set the value (default) or not

          • +

        • value (bool) – The value to set

          • +

        • blocking (bool) – Whether to block while attempting to set the value (default) or not

        Returns
        @@ -760,12 +760,12 @@
        Parameters
          -

        • heater (str) – The heater for which to set the target temperature. Either “bed” for setting the bed +

        • heater (str) – The heater for which to set the target temperature. Either “bed” for setting the bed temperature, “chamber” for setting the temperature of the heated enclosure or something matching the regular expression “tool[0-9]+” (e.g. “tool0”, “tool1”, …) for the hotends of the printer. However, addressing components that are disabled or unconfigured in the printer profile will result in a “Suppressed command” error popup message.

          • -

        • value (int, float) – The temperature in celsius to set the target temperature to.

          • +

        • value (int, float) – The temperature in celsius to set the target temperature to.

        • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle.

        @@ -779,7 +779,7 @@
        Parameters
          -

        • offsets (dict) – A dictionary specifying the offsets to apply. Keys must match the format for the heater +

        • offsets (dict) – A dictionary specifying the offsets to apply. Keys must match the format for the heater parameter to set_temperature(), so “bed” for the offset for the bed target temperature and “tool[0-9]+” for the offsets to the hotend target temperatures.

        • tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

          • @@ -856,7 +856,7 @@

          Called when the PrinterInterface receives a new communication log entry from the communication layer.

          Parameters
          -

          data (str) – The received log line.

          +

          data (str) – The received log line.

        @@ -867,7 +867,7 @@

        Called when the PrinterInterface receives a new message from the communication layer.

        Parameters
        -

        data (str) – The received message.

        +

        data (str) – The received message.

        @@ -891,7 +891,7 @@
    Parameters
    -

    data (dict) – A dict of all current temperatures in the format as specified above

    +

    data (dict) – A dict of all current temperatures in the format as specified above

    @@ -903,8 +903,8 @@
    Parameters
      -

    • name (str) – Name of the registered message (e.g. the feedback command)

      • -

    • output (str) – Output for the registered message

      • +

    • name (str) – Name of the registered message (e.g. the feedback command)

      • +

    • output (str) – Output for the registered message

    @@ -949,7 +949,7 @@
    Parameters
    -

    data (dict) – The current data in the format as specified above.

    +

    data (dict) – The current data in the format as specified above.

    @@ -976,7 +976,7 @@
    Parameters
    -

    data (dict) – The initial data in the format as specified above.

    +

    data (dict) – The initial data in the format as specified above.

    @@ -1253,7 +1253,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/modules/schema.html b/maintenance/modules/schema.html index 67e7471ef..1f34a591e 100644 --- a/maintenance/modules/schema.html +++ b/maintenance/modules/schema.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -283,34 +283,34 @@
    -class octoprint.schema.config.access_control.AccessControlConfig(*, salt: Optional[str] = None, userManager: str = 'octoprint.access.users.FilebasedUserManager', groupManager: str = 'octoprint.access.groups.FilebasedGroupManager', permissionManager: str = 'octoprint.access.permissions.PermissionManager', userfile: Optional[str] = None, groupfile: Optional[str] = None, autologinLocal: bool = False, localNetworks: List[str] = ['127.0.0.0/8', '::1/128'], autologinAs: Optional[str] = None, trustBasicAuthentication: bool = False, checkBasicAuthenticationPassword: bool = True, trustRemoteUser: bool = False, remoteUserHeader: str = 'REMOTE_USER', addRemoteUsers: bool = False)
    +class octoprint.schema.config.access_control.AccessControlConfig(*, salt: Optional[str] = None, userManager: str = 'octoprint.access.users.FilebasedUserManager', groupManager: str = 'octoprint.access.groups.FilebasedGroupManager', permissionManager: str = 'octoprint.access.permissions.PermissionManager', userfile: Optional[str] = None, groupfile: Optional[str] = None, autologinLocal: bool = False, localNetworks: List[str] = ['127.0.0.0/8', '::1/128'], autologinAs: Optional[str] = None, trustBasicAuthentication: bool = False, checkBasicAuthenticationPassword: bool = True, trustRemoteUser: bool = False, remoteUserHeader: str = 'REMOTE_USER', addRemoteUsers: bool = False)
    -addRemoteUsers: bool
    +addRemoteUsers: bool

    If a remote user is not found, add them. Use this only if all users from the remote system can use OctoPrint.

    -autologinAs: Optional[str]
    +autologinAs: Optional[str]

    The name of the user to automatically log on clients originating from localNetworks as. Must be the name of one of your configured users.

    -autologinLocal: bool
    +autologinLocal: bool

    If set to true, will automatically log on clients originating from any of the networks defined in localNetworks as the user defined in autologinAs.

    -checkBasicAuthenticationPassword: bool
    +checkBasicAuthenticationPassword: bool

    Whether to also check the password provided through Basic Authentication, if the Basic Authentication header is to be trusted. Disabling this will only match the user name in the Basic Authentication header and login the user without further checks, thus disable with caution.

    -groupManager: str
    +groupManager: str

    groups.yaml in the default configuration folder).

    Type
    @@ -321,49 +321,49 @@
    -groupfile: Optional[str]
    +groupfile: Optional[str]

    The YAML group file to use. If left out defaults to groups.yaml in the default configuration folder.

    -localNetworks: List[str]
    +localNetworks: List[str]

    A list of networks or IPs for which an automatic logon as the user defined in autologinAs will take place. If available OctoPrint will evaluate the X-Forwarded-For HTTP header for determining the client’s IP address. Defaults to anything originating from localhost.

    -permissionManager: str
    +permissionManager: str

    The permission manager implementation to use.

    -remoteUserHeader: str
    +remoteUserHeader: str

    Header used by the reverse proxy to convey the authenticated user.

    -salt: Optional[str]
    +salt: Optional[str]

    Secret salt used for password hashing. DO NOT TOUCH! If changed you will no longer be able to log in with your existing accounts. Default unset, generated on first run.

    -trustBasicAuthentication: bool
    +trustBasicAuthentication: bool

    Whether to trust Basic Authentication headers. If you have setup Basic Authentication in front of OctoPrint and the user names you use there match OctoPrint accounts, by setting this to true users will be logged into OctoPrint as the user during Basic Authentication. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through Basic Authentication!

    -trustRemoteUser: bool
    +trustRemoteUser: bool

    Whether to trust remote user headers. If you have setup authentication in front of OctoPrint and the user names you use there match OctoPrint accounts, by setting this to true users will be logged into OctoPrint as the user provided in the header. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through an authenticating reverse proxy!

    -userManager: str
    +userManager: str

    users.yaml in the default configuration folder).

    Type
    @@ -374,7 +374,7 @@
    -userfile: Optional[str]
    +userfile: Optional[str]

    The YAML user file to use. If left out defaults to users.yaml in the default configuration folder.

    @@ -382,21 +382,21 @@
    -class octoprint.schema.config.api.ApiConfig(*, key: Optional[str] = None, apps: Dict[str, str] = {}, allowCrossOrigin: bool = False)
    +class octoprint.schema.config.api.ApiConfig(*, key: Optional[str] = None, apps: Dict[str, str] = {}, allowCrossOrigin: bool = False)
    -allowCrossOrigin: bool
    +allowCrossOrigin: bool

    Whether to allow cross origin access to the API or not.

    -apps: Dict[str, str]
    +apps: Dict[str, str]
    -key: Optional[str]
    +key: Optional[str]

    Global API key, deprecated, use User API keys instead. Unset by default, will be generated on first run.

    @@ -404,10 +404,10 @@
    -class octoprint.schema.config.appearance.AppearanceConfig(*, name: str = '', color: octoprint.schema.config.appearance.ColorEnum = ColorEnum.default, colorTransparent: bool = False, colorIcon: bool = True, defaultLanguage: str = '_default', showFahrenheitAlso: bool = False, fuzzyTimes: bool = True, closeModalsWithClick: bool = True, showInternalFilename: bool = True, components: octoprint.schema.config.appearance.ComponentConfig = ComponentConfig(order=ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic=[]), disabled=ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[])))
    +class octoprint.schema.config.appearance.AppearanceConfig(*, name: str = '', color: octoprint.schema.config.appearance.ColorEnum = ColorEnum.default, colorTransparent: bool = False, colorIcon: bool = True, defaultLanguage: str = '_default', showFahrenheitAlso: bool = False, fuzzyTimes: bool = True, closeModalsWithClick: bool = True, showInternalFilename: bool = True, components: octoprint.schema.config.appearance.ComponentConfig = ComponentConfig(order=ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic=[]), disabled=ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[])))
    -closeModalsWithClick: bool
    +closeModalsWithClick: bool
    @@ -418,12 +418,12 @@
    -colorIcon: bool
    +colorIcon: bool
    -colorTransparent: bool
    +colorTransparent: bool

    Makes the color of the navigation bar “transparent”. In case your printer uses acrylic for its frame 😉.

    @@ -435,18 +435,18 @@
    -defaultLanguage: str
    +defaultLanguage: str

    Default language of OctoPrint. If left unset OctoPrint will try to match up available languages with the user’s browser settings.

    -fuzzyTimes: bool
    +fuzzyTimes: bool
    -name: str
    +name: str

    <>”)

    Type
    @@ -457,12 +457,12 @@
    -showFahrenheitAlso: bool
    +showFahrenheitAlso: bool
    -showInternalFilename: bool
    +showInternalFilename: bool

    Show the internal filename in the files sidebar, if necessary.

    @@ -528,52 +528,52 @@
    -class octoprint.schema.config.appearance.ComponentDisabledConfig(*, navbar: List[str] = [], sidebar: List[str] = [], tab: List[str] = [], settings: List[str] = [], usersettings: List[str] = [], wizard: List[str] = [], about: List[str] = [], generic: List[str] = [])
    +class octoprint.schema.config.appearance.ComponentDisabledConfig(*, navbar: List[str] = [], sidebar: List[str] = [], tab: List[str] = [], settings: List[str] = [], usersettings: List[str] = [], wizard: List[str] = [], about: List[str] = [], generic: List[str] = [])
    -about: List[str]
    +about: List[str]

    Disabled about dialog items.

    -generic: List[str]
    +generic: List[str]

    Disabled generic items.

    -navbar: List[str]
    +navbar: List[str]

    Disabled navbar items.

    -settings: List[str]
    +settings: List[str]

    Disabled settings.

    -sidebar: List[str]
    +sidebar: List[str]

    Disabled sidebar items.

    -tab: List[str]
    +tab: List[str]

    Disabled tabs.

    -usersettings: List[str]
    +usersettings: List[str]

    Disabled user settings.

    -wizard: List[str]
    +wizard: List[str]

    Disabled wizards.

    @@ -581,52 +581,52 @@
    -class octoprint.schema.config.appearance.ComponentOrderConfig(*, navbar: List[str] = ['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar: List[str] = ['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab: List[str] = ['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings: List[str] = ['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings: List[str] = ['access', 'interface'], wizard: List[str] = ['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about: List[str] = ['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic: List[str] = [])
    +class octoprint.schema.config.appearance.ComponentOrderConfig(*, navbar: List[str] = ['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar: List[str] = ['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab: List[str] = ['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings: List[str] = ['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings: List[str] = ['access', 'interface'], wizard: List[str] = ['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about: List[str] = ['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager'], generic: List[str] = [])
    -about: List[str]
    +about: List[str]

    Order of about dialog items.

    -generic: List[str]
    +generic: List[str]

    Order of generic items.

    -navbar: List[str]
    +navbar: List[str]

    Order of navbar items.

    -settings: List[str]
    +settings: List[str]

    Order of settings.

    -sidebar: List[str]
    +sidebar: List[str]

    Order of sidebar items.

    -tab: List[str]
    +tab: List[str]

    Order of tabs.

    -usersettings: List[str]
    +usersettings: List[str]

    Order of user settings.

    -wizard: List[str]
    +wizard: List[str]

    Order of wizards.

    @@ -634,7 +634,7 @@
    -class octoprint.schema.config.controls.ContainerConfig(*, children: List[Union[ContainerConfig, ControlConfig]] = [], name: Optional[str] = None, layout: octoprint.schema.config.controls.LayoutEnum = LayoutEnum.vertical)
    +class octoprint.schema.config.controls.ContainerConfig(*, children: List[Union[ContainerConfig, ControlConfig]] = [], name: Optional[str] = None, layout: octoprint.schema.config.controls.LayoutEnum = LayoutEnum.vertical)
    children: List[Union[octoprint.schema.config.controls.ContainerConfig, octoprint.schema.config.controls.ControlConfig]]
    @@ -649,7 +649,7 @@
    -name: Optional[str]
    +name: Optional[str]

    A name to display above the container, basically a section header.

    @@ -657,34 +657,34 @@
    -class octoprint.schema.config.controls.ControlConfig(*, name: str, command: Optional[str] = None, commands: Optional[List[str]] = None, script: Optional[str] = None, javascript: Optional[str] = None, additionalClasses: Optional[str] = None, enabled: Optional[str] = None, input: Optional[List[octoprint.schema.config.controls.ControlInputConfig]] = [], regex: Optional[str] = None, template: Optional[str] = None, confirm: Optional[str] = None)
    +class octoprint.schema.config.controls.ControlConfig(*, name: str, command: Optional[str] = None, commands: Optional[List[str]] = None, script: Optional[str] = None, javascript: Optional[str] = None, additionalClasses: Optional[str] = None, enabled: Optional[str] = None, input: Optional[List[octoprint.schema.config.controls.ControlInputConfig]] = [], regex: Optional[str] = None, template: Optional[str] = None, confirm: Optional[str] = None)
    -additionalClasses: Optional[str]
    +additionalClasses: Optional[str]

    Additional classes to apply to the button of a command, commands, script or javascript control, other than the default btn. Can be used to visually style the button, e.g. set to btn-danger to turn the button red.

    -command: Optional[str]
    +command: Optional[str]

    A single GCODE command to send to the printer. Will be rendered as a button which sends the command to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with commands and script. The rendered button be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met.

    -commands: Optional[List[str]]
    +commands: Optional[List[str]]

    A list of GCODE commands to send to the printer. Will be rendered as a button which sends the commands to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with command and script. The rendered button will be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met.

    -confirm: Optional[str]
    +confirm: Optional[str]

    A text to display to the user to confirm his button press. Can be used with sensitive custom controls like changing EEPROM values in order to prevent accidental clicks. The text will be displayed in a confirmation dialog.

    -enabled: Optional[str]
    +enabled: Optional[str]

    A JavaScript snippet returning either true or false determining whether the control should be enabled or not. This allows to override the default logic for the enable state of the control (disabled if printer is offline). The JavaScript snippet is eval’d and processed in a context where the control it is part of is provided as local variable data and the ControlViewModel is available as self.

    @@ -696,19 +696,19 @@
    -javascript: Optional[str]
    +javascript: Optional[str]

    A JavaScript snippet to be executed when the button rendered for command or commands is clicked. This allows to override the direct sending of the command or commands to the printer with more sophisticated behaviour. The JavaScript snippet is eval’d and processed in a context where the control it is part of is provided as local variable data and the ControlViewModel is available as self.

    -name: str
    +name: str

    The name of the control, will be displayed either on the button if it’s a control sending a command or as a label for controls which only display output.

    -regex: Optional[str]
    +regex: Optional[str]

    //docs.python.org/3/library/re.html#regular-expression-syntax) to match against lines received from the printer to retrieve information from it (e.g. specific output). Together with template this allows rendition of received data from the printer within the UI.

    Type
    @@ -719,13 +719,13 @@
    -script: Optional[str]
    +script: Optional[str]

    The name of a full blown [GCODE script]() to send to the printer. Will be rendered as a button which sends the script to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with command and commands. The rendered button will be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met. Values of input parameters will be available in the template context under the parameter variable (e.g. an input parameter speed will be available in the script template as parameter.speed). On top of that all other variables defined in the [GCODE template context]() will be available.

    -template: Optional[str]
    +template: Optional[str]

    {temperature}` for a regex T:s*(?P<temperature>d+(.d*)) or positional groups within the regex (e.g. Position: X={0}, Y={1}, Z={2}, E={3} for a regex X:([0-9.]+) Y:([0-9.]+) Z:([0-9.]+) E:([0-9.]+)).

    Type
    @@ -741,22 +741,22 @@
    -class octoprint.schema.config.controls.ControlInputConfig(*, name: str, parameter: str, default: Union[str, int, float, bool], slider: Optional[octoprint.schema.config.controls.ControlSliderInputConfig] = None)
    +class octoprint.schema.config.controls.ControlInputConfig(*, name: str, parameter: str, default: Union[str, int, float, bool], slider: Optional[octoprint.schema.config.controls.ControlSliderInputConfig] = None)
    -default: Union[str, int, float, bool]
    +default: Union[str, int, float, bool]

    Default value for the input field.

    -name: str
    +name: str

    Name to display for the input field.

    -parameter: str
    +parameter: str

    Internal parameter name for the input field, used as a placeholder in command/commands.

    @@ -770,22 +770,22 @@
    -class octoprint.schema.config.controls.ControlSliderInputConfig(*, min: int = 0, max: int = 255, step: int = 1)
    +class octoprint.schema.config.controls.ControlSliderInputConfig(*, min: int = 0, max: int = 255, step: int = 1)
    -max: int
    +max: int

    Maximum value of the slider.

    -min: int
    +min: int

    Minimum value of the slider.

    -step: int
    +step: int

    Step size per slider tick.

    @@ -809,16 +809,16 @@
    -class octoprint.schema.config.devel.DevelCacheConfig(*, enabled: bool = True, preemptive: bool = True)
    +class octoprint.schema.config.devel.DevelCacheConfig(*, enabled: bool = True, preemptive: bool = True)
    -enabled: bool
    +enabled: bool

    Whether to enable caching. Defaults to true. Setting it to false will cause the UI to always be fully rerendered on request to / on the server.

    -preemptive: bool
    +preemptive: bool

    Whether to enable the preemptive cache.

    @@ -826,7 +826,7 @@
    -class octoprint.schema.config.devel.DevelConfig(*, stylesheet: octoprint.schema.config.devel.StylesheetEnum = StylesheetEnum.css, cache: octoprint.schema.config.devel.DevelCacheConfig = DevelCacheConfig(enabled=True, preemptive=True), webassets: octoprint.schema.config.devel.DevelWebassetsConfig = DevelWebassetsConfig(bundle=True, clean_on_startup=True, minify=True, minify_plugins=False), useFrozenDictForPrinterState: bool = True, showLoadingAnimation: bool = True, sockJsConnectTimeout: float = 30, pluginTimings: bool = False, enableRateLimiter: bool = True, enableCsrfProtection: bool = True)
    +class octoprint.schema.config.devel.DevelConfig(*, stylesheet: octoprint.schema.config.devel.StylesheetEnum = StylesheetEnum.css, cache: octoprint.schema.config.devel.DevelCacheConfig = DevelCacheConfig(enabled=True, preemptive=True), webassets: octoprint.schema.config.devel.DevelWebassetsConfig = DevelWebassetsConfig(bundle=True, clean_on_startup=True, minify=True, minify_plugins=False), useFrozenDictForPrinterState: bool = True, showLoadingAnimation: bool = True, sockJsConnectTimeout: float = 30, pluginTimings: bool = False, enableRateLimiter: bool = True, enableCsrfProtection: bool = True)
    cache: octoprint.schema.config.devel.DevelCacheConfig
    @@ -835,30 +835,30 @@
    -enableCsrfProtection: bool
    +enableCsrfProtection: bool

    Enable or disable the CSRF protection. Careful, disabling this reduces security.

    -enableRateLimiter: bool
    +enableRateLimiter: bool

    Enable or disable the rate limiter. Careful, disabling this reduces security.

    -pluginTimings: bool
    +pluginTimings: bool
    -showLoadingAnimation: bool
    +showLoadingAnimation: bool

    Enable or disable the loading animation.

    -sockJsConnectTimeout: float
    +sockJsConnectTimeout: float
    @@ -869,7 +869,7 @@
    -useFrozenDictForPrinterState: bool
    +useFrozenDictForPrinterState: bool
    @@ -882,10 +882,10 @@
    -class octoprint.schema.config.devel.DevelWebassetsConfig(*, bundle: bool = True, clean_on_startup: bool = True, minify: bool = True, minify_plugins: bool = False)
    +class octoprint.schema.config.devel.DevelWebassetsConfig(*, bundle: bool = True, clean_on_startup: bool = True, minify: bool = True, minify_plugins: bool = False)
    -bundle: bool
    +bundle: bool

    if this is set to false, no minification will take place regardless of the minify setting.

    Type
    @@ -896,13 +896,13 @@
    -clean_on_startup: bool
    +clean_on_startup: bool

    Whether to delete generated web assets on server startup (forcing a regeneration).

    -minify: bool
    +minify: bool

    if bundle is set to false, no minification will take place either.

    Type
    @@ -913,7 +913,7 @@
    -minify_plugins: bool
    +minify_plugins: bool

    if bundle or minify are set to false, no minification of the plugin assets will take place either.

    Type
    @@ -953,34 +953,34 @@
    -class octoprint.schema.config.estimation.PrintTimeEstimationConfig(*, statsWeighingUntil: float = 0.5, validityRange: float = 0.15, forceDumbFromPercent: float = 0.3, forceDumbAfterMin: float = 30.0, stableThreshold: int = 60)
    +class octoprint.schema.config.estimation.PrintTimeEstimationConfig(*, statsWeighingUntil: float = 0.5, validityRange: float = 0.15, forceDumbFromPercent: float = 0.3, forceDumbAfterMin: float = 30.0, stableThreshold: int = 60)
    -forceDumbAfterMin: float
    +forceDumbAfterMin: float

    If no estimate could be calculated until this many minutes into the print and no statistical data is available, use dumb linear estimate.

    -forceDumbFromPercent: float
    +forceDumbFromPercent: float

    If no estimate could be calculated until this percentage and no statistical data is available, use dumb linear estimate. Value between 0 and 1.0.

    -stableThreshold: int
    +stableThreshold: int

    Average fluctuation between individual calculated estimates to consider in stable range. Seconds of difference.

    -statsWeighingUntil: float
    +statsWeighingUntil: float

    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.

    -validityRange: float
    +validityRange: float

    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.

    @@ -988,34 +988,34 @@
    -class octoprint.schema.config.events.EventSubscription(*, event: str, name: Optional[str] = None, command: str, type: octoprint.schema.config.events.SubscriptionTypeEnum, enabled: bool = True, debug: bool = False)
    +class octoprint.schema.config.events.EventSubscription(*, event: str, name: Optional[str] = None, command: str, type: octoprint.schema.config.events.SubscriptionTypeEnum, enabled: bool = True, debug: bool = False)
    -command: str
    +command: str

    The command to execute when the event is triggered, either a GCODE or a system command.

    -debug: bool
    +debug: bool

    If set to true, OctoPrint will log the command after performing all placeholder replacements.

    -enabled: bool
    +enabled: bool

    Whether the event subscription should be enabled.

    -event: str
    +event: str

    The event to subscribe to.

    -name: Optional[str]
    +name: Optional[str]

    The event name to show on the UI

    @@ -1029,10 +1029,10 @@
    -class octoprint.schema.config.events.EventsConfig(*, enabled: bool = True, subscriptions: List[octoprint.schema.config.events.EventSubscription] = [])
    +class octoprint.schema.config.events.EventsConfig(*, enabled: bool = True, subscriptions: List[octoprint.schema.config.events.EventSubscription] = [])
    -enabled: bool
    +enabled: bool

    Whether event subscriptions should be enabled or not.

    @@ -1062,164 +1062,164 @@
    -class octoprint.schema.config.feature.FeatureConfig(*, temperatureGraph: bool = True, sdSupport: bool = True, keyboardControl: bool = True, pollWatched: bool = False, modelSizeDetection: bool = True, rememberFileFolder: bool = False, printStartConfirmation: bool = False, printCancelConfirmation: bool = True, uploadOverwriteConfirmation: bool = True, autoUppercaseBlacklist: List[str] = ['M117', 'M118'], g90InfluencesExtruder: bool = False, enforceReallyUniversalFilenames: bool = False, enableDragDropUpload: bool = True)
    +class octoprint.schema.config.feature.FeatureConfig(*, temperatureGraph: bool = True, sdSupport: bool = True, keyboardControl: bool = True, pollWatched: bool = False, modelSizeDetection: bool = True, rememberFileFolder: bool = False, printStartConfirmation: bool = False, printCancelConfirmation: bool = True, uploadOverwriteConfirmation: bool = True, autoUppercaseBlacklist: List[str] = ['M117', 'M118'], g90InfluencesExtruder: bool = False, enforceReallyUniversalFilenames: bool = False, enableDragDropUpload: bool = True)
    -autoUppercaseBlacklist: List[str]
    +autoUppercaseBlacklist: List[str]

    Commands that should never be auto-uppercased when sent to the printer through the Terminal tab.

    -enableDragDropUpload: bool
    +enableDragDropUpload: bool

    Enable drag and drop upload overlay

    -enforceReallyUniversalFilenames: bool
    +enforceReallyUniversalFilenames: bool

    Replace all special characters and spaces with text equivalent to make them universally compatible. Most OS filesystems work fine with unicode characters, but just in case you can revert to the older behaviour by setting this to true.

    -g90InfluencesExtruder: bool
    +g90InfluencesExtruder: bool

    Whether G90/G91 also influence absolute/relative mode of extruders.

    -keyboardControl: bool
    +keyboardControl: bool

    Whether to enable the keyboard control feature in the control tab.

    -modelSizeDetection: bool
    +modelSizeDetection: bool

    Whether to enable model size detection and warning (true) or not (false).

    -pollWatched: bool
    +pollWatched: bool

    Whether to actively poll the watched folder (true) or to rely on the OS’s file system notifications instead (false).

    -printCancelConfirmation: bool
    +printCancelConfirmation: bool

    Whether to show a confirmation on print cancelling (true) or not (false)

    -printStartConfirmation: bool
    +printStartConfirmation: bool

    Whether to show a confirmation on print start (true) or not (false)

    -rememberFileFolder: bool
    +rememberFileFolder: bool

    Whether to remember the selected folder on the file manager.

    -sdSupport: bool
    +sdSupport: bool

    Specifies whether support for SD printing and file management should be enabled.

    -temperatureGraph: bool
    +temperatureGraph: bool

    Whether to enable the temperature graph in the UI or not.

    -uploadOverwriteConfirmation: bool
    +uploadOverwriteConfirmation: bool
    -class octoprint.schema.config.folder.FolderConfig(*, uploads: Optional[str] = None, timelapse: Optional[str] = None, timelapse_tmp: Optional[str] = None, logs: Optional[str] = None, virtualSd: Optional[str] = None, watched: Optional[str] = None, plugins: Optional[str] = None, slicingProfiles: Optional[str] = None, printerProfiles: Optional[str] = None, scripts: Optional[str] = None, translations: Optional[str] = None, generated: Optional[str] = None, data: Optional[str] = None)
    +class octoprint.schema.config.folder.FolderConfig(*, uploads: Optional[str] = None, timelapse: Optional[str] = None, timelapse_tmp: Optional[str] = None, logs: Optional[str] = None, virtualSd: Optional[str] = None, watched: Optional[str] = None, plugins: Optional[str] = None, slicingProfiles: Optional[str] = None, printerProfiles: Optional[str] = None, scripts: Optional[str] = None, translations: Optional[str] = None, generated: Optional[str] = None, data: Optional[str] = None)
    -data: Optional[str]
    +data: Optional[str]

    Absolute path where to store additional data. Defaults to the data folder in OctoPrint’s base folder.

    -generated: Optional[str]
    +generated: Optional[str]

    Absolute path where to store generated files. Defaults to the generated folder in OctoPrint’s base folder.

    -logs: Optional[str]
    +logs: Optional[str]

    Absolute path where to store logs. Defaults to the logs folder in OctoPrint’s base folder.

    -plugins: Optional[str]
    +plugins: Optional[str]

    Absolute path where to locate and install single file plugins. Defaults to the plugins folder in OctoPrint’s base folder.

    -printerProfiles: Optional[str]
    +printerProfiles: Optional[str]

    Absolute path where to store printer profiles. Defaults to the printerProfiles folder in OctoPrint’s base folder.

    -scripts: Optional[str]
    +scripts: Optional[str]

    Absolute path where to store (GCODE) scripts. Defaults to the scripts folder in OctoPrint’s base folder.

    -slicingProfiles: Optional[str]
    +slicingProfiles: Optional[str]

    Absolute path where to store slicing profiles. Defaults to the slicingProfiles folder in OctoPrint’s base folder.

    -timelapse: Optional[str]
    +timelapse: Optional[str]

    Absolute path where to store finished timelase recordings. Defaults to the timelapse folder in OctoPrint’s base folder.

    -timelapse_tmp: Optional[str]
    +timelapse_tmp: Optional[str]

    Absolute path where to store temporary timelapse snapshots. Defaults to the timelapse/tmp folder in OctoPrint’s base folder.

    -translations: Optional[str]
    +translations: Optional[str]

    Absolute path where to store additional translations. Defaults to the translations folder in OctoPrint’s base folder.

    -uploads: Optional[str]
    +uploads: Optional[str]

    Absolute path where to store gcode uploads. Defaults to the uploads folder in OctoPrint’s base folder.

    -virtualSd: Optional[str]
    +virtualSd: Optional[str]

    Absolute path where to store the virtual printer’s SD card files. Defaults to the virtualSd folder in OctoPrint’s base folder.

    -watched: Optional[str]
    +watched: Optional[str]

    Absolute path to the watched folder. Defaults to the watched folder in OctoPrint’s base folder.

    @@ -1227,16 +1227,16 @@
    -class octoprint.schema.config.gcode_analysis.GcodeAnalysisConfig(*, maxExtruders: int = 10, throttle_normalprio: float = 0.01, throttle_highprio: float = 0.0, throttle_lines: int = 100, runAt: octoprint.schema.config.gcode_analysis.RunAtEnum = RunAtEnum.idle, bedZ: float = 0.0)
    +class octoprint.schema.config.gcode_analysis.GcodeAnalysisConfig(*, maxExtruders: int = 10, throttle_normalprio: float = 0.01, throttle_highprio: float = 0.0, throttle_lines: int = 100, runAt: octoprint.schema.config.gcode_analysis.RunAtEnum = RunAtEnum.idle, bedZ: float = 0.0)
    -bedZ: float
    +bedZ: float

    Z position considered the location of the bed.

    -maxExtruders: int
    +maxExtruders: int

    Maximum number of extruders to support/to sanity check for.

    @@ -1248,19 +1248,19 @@
    -throttle_highprio: float
    +throttle_highprio: float

    Pause between each processed GCODE line batch in high priority mode (e.g. on fresh uploads), seconds.

    -throttle_lines: int
    +throttle_lines: int

    GCODE line batch size.

    -throttle_normalprio: float
    +throttle_normalprio: float

    Pause between each processed GCODE line batch in normal priority mode, seconds.

    @@ -1289,22 +1289,22 @@
    -class octoprint.schema.config.plugins.PluginsConfig(*, _disabled: List[str] = [], _forcedCompatible: List[str] = [], _sortingOrder: Dict[str, Dict[str, int]] = {})
    +class octoprint.schema.config.plugins.PluginsConfig(*, _disabled: List[str] = [], _forcedCompatible: List[str] = [], _sortingOrder: Dict[str, Dict[str, int]] = {})
    -disabled: List[str]
    +disabled: List[str]

    Identifiers of installed but disabled plugins.

    -forced_compatible: List[str]
    +forced_compatible: List[str]

    Identifiers of plugins for which python compatibility information will be ignored and the plugin considered compatible in any case. Only for development, do NOT use in production.

    -sorting_order: Dict[str, Dict[str, int]]
    +sorting_order: Dict[str, Dict[str, int]]

    Custom sorting of hooks and implementations provided by plugins. Two-tiered dictionary structure, plugin identifier mapping to a dictionary of order overrides mapped by sorting context/hook name.

    @@ -1312,20 +1312,20 @@
    -class octoprint.schema.config.printer_parameters.PrinterParametersConfig(*, pauseTriggers: List[str] = [])
    +class octoprint.schema.config.printer_parameters.PrinterParametersConfig(*, pauseTriggers: List[str] = [])
    -pauseTriggers: List[str]
    +pauseTriggers: List[str]
    -class octoprint.schema.config.printer_profiles.PrinterProfilesConfig(*, default: Optional[str] = None)
    +class octoprint.schema.config.printer_profiles.PrinterProfilesConfig(*, default: Optional[str] = None)
    -default: Optional[str]
    +default: Optional[str]

    Name of the printer profile to default to.

    @@ -1333,55 +1333,55 @@
    -class octoprint.schema.config.scripts.GcodeScriptsConfig(*, afterPrinterConnected: Optional[str] = None, beforePrinterDisconnected: Optional[str] = None, beforePrintStarted: Optional[str] = None, afterPrintCancelled: Optional[str] = "; disable motors\nM84\n\n;disable all heaters\n{% snippet 'disable_hotends' %}\n{% snippet 'disable_bed' %}\n;disable fan\nM106 S0", afterPrintDone: Optional[str] = None, beforePrintPaused: Optional[str] = None, afterPrintResumed: Optional[str] = None, beforeToolChange: Optional[str] = None, afterToolChange: Optional[str] = None, snippets: Dict[str, str] = {'disable_bed': '{% if printer_profile.heatedBed %}M140 S0\n{% endif %}', 'disable_hotends': '{% if printer_profile.extruder.sharedNozzle %}M104 T0 S0\n{% else %}{% for tool in range(printer_profile.extruder.count) %}M104 T{{ tool }} S0\n{% endfor %}{% endif %}'})
    +class octoprint.schema.config.scripts.GcodeScriptsConfig(*, afterPrinterConnected: Optional[str] = None, beforePrinterDisconnected: Optional[str] = None, beforePrintStarted: Optional[str] = None, afterPrintCancelled: Optional[str] = "; disable motors\nM84\n\n;disable all heaters\n{% snippet 'disable_hotends' %}\n{% snippet 'disable_bed' %}\n;disable fan\nM106 S0", afterPrintDone: Optional[str] = None, beforePrintPaused: Optional[str] = None, afterPrintResumed: Optional[str] = None, beforeToolChange: Optional[str] = None, afterToolChange: Optional[str] = None, snippets: Dict[str, str] = {'disable_bed': '{% if printer_profile.heatedBed %}M140 S0\n{% endif %}', 'disable_hotends': '{% if printer_profile.extruder.sharedNozzle %}M104 T0 S0\n{% else %}{% for tool in range(printer_profile.extruder.count) %}M104 T{{ tool }} S0\n{% endfor %}{% endif %}'})
    -afterPrintCancelled: Optional[str]
    +afterPrintCancelled: Optional[str]
    -afterPrintDone: Optional[str]
    +afterPrintDone: Optional[str]
    -afterPrintResumed: Optional[str]
    +afterPrintResumed: Optional[str]
    -afterPrinterConnected: Optional[str]
    +afterPrinterConnected: Optional[str]
    -afterToolChange: Optional[str]
    +afterToolChange: Optional[str]
    -beforePrintPaused: Optional[str]
    +beforePrintPaused: Optional[str]
    -beforePrintStarted: Optional[str]
    +beforePrintStarted: Optional[str]
    -beforePrinterDisconnected: Optional[str]
    +beforePrinterDisconnected: Optional[str]
    -beforeToolChange: Optional[str]
    +beforeToolChange: Optional[str]
    -snippets: Dict[str, str]
    +snippets: Dict[str, str]
    @@ -1440,46 +1440,46 @@
    -class octoprint.schema.config.serial.SerialCapabilities(*, autoreport_temp: bool = True, autoreport_sdstatus: bool = True, autoreport_pos: bool = True, busy_protocol: bool = True, emergency_parser: bool = True, extended_m20: bool = True, lfn_write: bool = True)
    +class octoprint.schema.config.serial.SerialCapabilities(*, autoreport_temp: bool = True, autoreport_sdstatus: bool = True, autoreport_pos: bool = True, busy_protocol: bool = True, emergency_parser: bool = True, extended_m20: bool = True, lfn_write: bool = True)
    -autoreport_pos: bool
    +autoreport_pos: bool

    Whether to enable position autoreport in the firmware if its support is detected

    -autoreport_sdstatus: bool
    +autoreport_sdstatus: bool

    Whether to enable SD printing autoreport in the firmware if its support is detected

    -autoreport_temp: bool
    +autoreport_temp: bool

    Whether to enable temperature autoreport in the firmware if its support is detected

    -busy_protocol: bool
    +busy_protocol: bool

    Whether to shorten the communication timeout if the firmware seems to support the busy protocol

    -emergency_parser: bool
    +emergency_parser: bool

    Whether to send emergency commands out of band if the firmware seems to support the emergency parser

    -extended_m20: bool
    +extended_m20: bool

    Whether to request extended M20 (file list) output from the firmware if its support is detected

    -lfn_write: bool
    +lfn_write: bool

    Whether to enable long filename support for SD card writes if the firmware reports support for it

    @@ -1487,26 +1487,26 @@
    -class octoprint.schema.config.serial.SerialConfig(*, port: Optional[str] = None, baudrate: Optional[int] = None, exclusive: bool = True, lowLatency: bool = False, autoconnect: bool = False, autorefresh: bool = True, autorefreshInterval: int = 1, log: bool = False, timeout: octoprint.schema.config.serial.SerialTimeoutConfig = SerialTimeoutConfig(detectionFirst=10.0, detectionConsecutive=2.0, connection=10.0, communication=30.0, communicationBusy=3.0, temperature=5.0, temperatureTargetSet=2.0, temperatureAutoreport=2.0, sdStatus=1.0, sdStatusAutoreport=1.0, posAutoreport=5.0, resendOk=0.5, baudrateDetectionPause=1.0, positionLogWait=10.0), maxCommunicationTimeouts: octoprint.schema.config.serial.SerialMaxTimeouts = SerialMaxTimeouts(idle=2, printing=5, long=5), maxWritePasses: int = 5, additionalPorts: List[str] = [], additionalBaudrates: List[int] = [], blacklistedPorts: List[str] = [], blacklistedBaudrates: List[int] = [], longRunningCommands: List[str] = ['G4', 'G28', 'G29', 'G30', 'G32', 'M400', 'M226', 'M600'], blockedCommands: List[str] = ['M0', 'M1'], ignoredCommands: List[str] = [], pausingCommands: List[str] = ['M0', 'M1', 'M25'], emergencyCommands: List[str] = ['M112', 'M108', 'M410'], checksumRequiringCommands: List[str] = ['M110'], helloCommand: str = 'M110 N0', disconnectOnErrors: bool = True, ignoreErrorsFromFirmware: bool = False, terminalLogSize: int = 20, lastLineBufferSize: int = 50, logResends: bool = True, supportResendsWithoutOk: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', logPositionOnPause: bool = True, logPositionOnCancel: bool = False, abortHeatupOnCancel: bool = True, waitForStartOnConnect: bool = False, waitToLoadSdFileList: bool = True, alwaysSendChecksum: bool = False, neverSendChecksum: bool = False, sendChecksumWithUnknownCommands: bool = False, unknownCommandsNeedAck: bool = False, sdRelativePath: bool = False, sdAlwaysAvailable: bool = False, sdLowerCase: bool = False, sdCancelCommand: str = 'M25', maxNotSdPrinting: int = 2, swallowOkAfterResend: bool = True, repetierTargetTemp: bool = False, externalHeatupDetection: bool = True, supportWait: bool = True, ignoreIdenticalResends: bool = False, identicalResendsCountdown: int = 7, supportFAsCommand: bool = False, firmwareDetection: bool = True, blockWhileDwelling: bool = False, useParityWorkaround: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', maxConsecutiveResends: int = 10, sendM112OnError: bool = True, disableSdPrintingDetection: bool = False, ackMax: int = 1, sanityCheckTools: bool = True, notifySuppressedCommands: octoprint.schema.config.serial.InfoWarnNeverEnum = 'warn', capabilities: octoprint.schema.config.serial.SerialCapabilities = SerialCapabilities(autoreport_temp=True, autoreport_sdstatus=True, autoreport_pos=True, busy_protocol=True, emergency_parser=True, extended_m20=True, lfn_write=True), resendRatioThreshold: int = 10, resendRatioStart: int = 100, ignoreEmptyPorts: bool = False, encoding: str = 'ascii', enableShutdownActionCommand: bool = False, triggerOkForM29: bool = True)
    +class octoprint.schema.config.serial.SerialConfig(*, port: Optional[str] = None, baudrate: Optional[int] = None, exclusive: bool = True, lowLatency: bool = False, autoconnect: bool = False, autorefresh: bool = True, autorefreshInterval: int = 1, log: bool = False, timeout: octoprint.schema.config.serial.SerialTimeoutConfig = SerialTimeoutConfig(detectionFirst=10.0, detectionConsecutive=2.0, connection=10.0, communication=30.0, communicationBusy=3.0, temperature=5.0, temperatureTargetSet=2.0, temperatureAutoreport=2.0, sdStatus=1.0, sdStatusAutoreport=1.0, posAutoreport=5.0, resendOk=0.5, baudrateDetectionPause=1.0, positionLogWait=10.0), maxCommunicationTimeouts: octoprint.schema.config.serial.SerialMaxTimeouts = SerialMaxTimeouts(idle=2, printing=5, long=5), maxWritePasses: int = 5, additionalPorts: List[str] = [], additionalBaudrates: List[int] = [], blacklistedPorts: List[str] = [], blacklistedBaudrates: List[int] = [], longRunningCommands: List[str] = ['G4', 'G28', 'G29', 'G30', 'G32', 'M400', 'M226', 'M600'], blockedCommands: List[str] = ['M0', 'M1'], ignoredCommands: List[str] = [], pausingCommands: List[str] = ['M0', 'M1', 'M25'], emergencyCommands: List[str] = ['M112', 'M108', 'M410'], checksumRequiringCommands: List[str] = ['M110'], helloCommand: str = 'M110 N0', disconnectOnErrors: bool = True, ignoreErrorsFromFirmware: bool = False, terminalLogSize: int = 20, lastLineBufferSize: int = 50, logResends: bool = True, supportResendsWithoutOk: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', logPositionOnPause: bool = True, logPositionOnCancel: bool = False, abortHeatupOnCancel: bool = True, waitForStartOnConnect: bool = False, waitToLoadSdFileList: bool = True, alwaysSendChecksum: bool = False, neverSendChecksum: bool = False, sendChecksumWithUnknownCommands: bool = False, unknownCommandsNeedAck: bool = False, sdRelativePath: bool = False, sdAlwaysAvailable: bool = False, sdLowerCase: bool = False, sdCancelCommand: str = 'M25', maxNotSdPrinting: int = 2, swallowOkAfterResend: bool = True, repetierTargetTemp: bool = False, externalHeatupDetection: bool = True, supportWait: bool = True, ignoreIdenticalResends: bool = False, identicalResendsCountdown: int = 7, supportFAsCommand: bool = False, firmwareDetection: bool = True, blockWhileDwelling: bool = False, useParityWorkaround: octoprint.schema.config.serial.AlwaysDetectNeverEnum = 'detect', maxConsecutiveResends: int = 10, sendM112OnError: bool = True, disableSdPrintingDetection: bool = False, ackMax: int = 1, sanityCheckTools: bool = True, notifySuppressedCommands: octoprint.schema.config.serial.InfoWarnNeverEnum = 'warn', capabilities: octoprint.schema.config.serial.SerialCapabilities = SerialCapabilities(autoreport_temp=True, autoreport_sdstatus=True, autoreport_pos=True, busy_protocol=True, emergency_parser=True, extended_m20=True, lfn_write=True), resendRatioThreshold: int = 10, resendRatioStart: int = 100, ignoreEmptyPorts: bool = False, encoding: str = 'ascii', enableShutdownActionCommand: bool = False, triggerOkForM29: bool = True)
    -abortHeatupOnCancel: bool
    +abortHeatupOnCancel: bool
    -ackMax: int
    +ackMax: int
    -additionalBaudrates: List[int]
    +additionalBaudrates: List[int]

    Use this to define additional baud rates to offer for connecting to serial ports. Must be a valid integer

    -additionalPorts: List[str]
    +additionalPorts: List[str]

    //docs.python.org/3/library/glob.html)

    Type
    @@ -1517,53 +1517,53 @@
    -alwaysSendChecksum: bool
    +alwaysSendChecksum: bool

    Specifies whether OctoPrint should send linenumber + checksum with every printer command. Needed for successful communication with Repetier firmware.

    -autoconnect: bool
    +autoconnect: bool

    Whether to try to automatically connect to the printer on startup or not

    -autorefresh: bool
    +autorefresh: bool

    Whether to automatically refresh the port list while no connection is established

    -autorefreshInterval: int
    +autorefreshInterval: int

    Interval in seconds at which to refresh the port list while no connection is established

    -baudrate: Optional[int]
    +baudrate: Optional[int]

    The default baudrate to use to connect to the printer. If unset or set to 0, the baudrate will be auto-detected.

    -blacklistedBaudrates: List[int]
    +blacklistedBaudrates: List[int]
    -blacklistedPorts: List[str]
    +blacklistedPorts: List[str]
    -blockWhileDwelling: bool
    +blockWhileDwelling: bool

    Whether to block all sending to the printer while a G4 (dwell) command is active (true, repetier) or not (false).

    -blockedCommands: List[str]
    +blockedCommands: List[str]

    Commands which should not be sent to the printer, e.g. because they are known to block serial communication until physical interaction with the printer as is the case on most firmwares with the default M0 and M1.

    @@ -1574,35 +1574,35 @@
    -checksumRequiringCommands: List[str]
    +checksumRequiringCommands: List[str]

    Commands which need to always be send with a checksum.

    -disableSdPrintingDetection: bool
    +disableSdPrintingDetection: bool
    -disconnectOnErrors: bool
    +disconnectOnErrors: bool

    Whether to disconnect from the printer on errors or not.

    -emergencyCommands: List[str]
    +emergencyCommands: List[str]
    -enableShutdownActionCommand: bool
    +enableShutdownActionCommand: bool

    Whether to enable support for the shutdown action command, allowing the printer to shut down OctoPrint and the system it’s running on.

    -encoding: str
    +encoding: str

    //docs.python.org/3/library/codecs.html#standard-encodings).

    Type
    @@ -1613,65 +1613,65 @@
    -exclusive: bool
    +exclusive: bool

    Whether to request the serial port exclusively or not

    -externalHeatupDetection: bool
    +externalHeatupDetection: bool

    Whether to enable external heatup detection (to detect heatup triggered e.g. through the printer’s LCD panel or while printing from SD) or not. Causes issues with Repetier’s “first ok then response” approach to communication, so disable for printers running Repetier firmware.

    -firmwareDetection: bool
    +firmwareDetection: bool

    Whether to attempt to auto detect the firmware of the printer and adjust settings accordingly (true) or not and rely on manual configuration (false).

    -helloCommand: str
    +helloCommand: str

    Command to send in order to initiate a handshake with the printer.

    -identicalResendsCountdown: int
    +identicalResendsCountdown: int

    If ignoreIdenticalResends is true, how many consecutive identical resends to ignore.

    -ignoreEmptyPorts: bool
    +ignoreEmptyPorts: bool
    -ignoreErrorsFromFirmware: bool
    +ignoreErrorsFromFirmware: bool

    Whether to completely ignore errors from the firmware or not.

    -ignoreIdenticalResends: bool
    +ignoreIdenticalResends: bool

    Whether to ignore identical resends from the printer (true, repetier) or not (false).

    -ignoredCommands: List[str]
    +ignoredCommands: List[str]

    Commands which should not be sent to the printer and just silently ignored. An example of when you may wish to use this could be useful if you wish to manually change a filament on M600, by using that as a Pausing command.

    -lastLineBufferSize: int
    +lastLineBufferSize: int
    -log: bool
    +log: bool

    might decrease performance)

    Type
    @@ -1682,29 +1682,29 @@
    -logPositionOnCancel: bool
    +logPositionOnCancel: bool
    -logPositionOnPause: bool
    +logPositionOnPause: bool
    -logResends: bool
    +logResends: bool

    Whether to log resends to octoprint.log or not. Invaluable debug tool without performance impact, leave on if possible please.

    -longRunningCommands: List[str]
    +longRunningCommands: List[str]

    Commands which are known to take a long time to be acknowledged by the firmware, e.g. homing, dwelling, auto leveling etc.

    -lowLatency: bool
    +lowLatency: bool

    Whether to request low latency mode on the serial port or not

    @@ -1715,23 +1715,23 @@
    -maxConsecutiveResends: int
    +maxConsecutiveResends: int
    -maxNotSdPrinting: int
    +maxNotSdPrinting: int
    -maxWritePasses: int
    +maxWritePasses: int

    Maximum number of write attempts to serial during which nothing can be written before the communication with the printer is considered dead and OctoPrint will disconnect with an error

    -neverSendChecksum: bool
    +neverSendChecksum: bool
    @@ -1741,19 +1741,19 @@
    -pausingCommands: List[str]
    +pausingCommands: List[str]

    Commands which should cause OctoPrint to pause any ongoing prints.

    -port: Optional[str]
    +port: Optional[str]

    The default port to use to connect to the printer. If unset or set to AUTO, the port will be auto-detected.

    -repetierTargetTemp: bool
    +repetierTargetTemp: bool

    <temperature>` instead of attaching that information to the regular M105 responses.

    Type
    @@ -1764,56 +1764,56 @@
    -resendRatioStart: int
    +resendRatioStart: int
    -resendRatioThreshold: int
    +resendRatioThreshold: int

    Percentage of resend requests among all sent lines that should be considered critical.

    -sanityCheckTools: bool
    +sanityCheckTools: bool
    -sdAlwaysAvailable: bool
    +sdAlwaysAvailable: bool

    Whether to always assume that an SD card is present in the printer. Needed by some firmwares which don’t report the SD card status properly.

    -sdCancelCommand: str
    +sdCancelCommand: str
    -sdLowerCase: bool
    +sdLowerCase: bool
    -sdRelativePath: bool
    +sdRelativePath: bool

    Specifies whether firmware expects relative paths for selecting SD files.

    -sendChecksumWithUnknownCommands: bool
    +sendChecksumWithUnknownCommands: bool

    Specifies whether OctoPrint should also send linenumber + checksum with commands that are not detected as valid GCODE (as in, they do not match the regular expression ^s*([GM]d+|T)).

    -sendM112OnError: bool
    +sendM112OnError: bool
    -supportFAsCommand: bool
    +supportFAsCommand: bool

    Whether to support F on its own as a valid GCODE command (true) or not (false).

    @@ -1825,17 +1825,17 @@
    -supportWait: bool
    +supportWait: bool
    -swallowOkAfterResend: bool
    +swallowOkAfterResend: bool
    -terminalLogSize: int
    +terminalLogSize: int
    @@ -1846,13 +1846,13 @@
    -triggerOkForM29: bool
    +triggerOkForM29: bool

    Whether to automatically trigger an ok for M29 (a lot of versions of this command are buggy and the response skips on the ok).

    -unknownCommandsNeedAck: bool
    +unknownCommandsNeedAck: bool

    Specifies whether OctoPrint should also use up acknowledgments (ok) for commands that are not detected as valid GCODE (as in, they do not match the regular expression ^s*([GM]d+|T)).

    @@ -1863,13 +1863,13 @@
    -waitForStartOnConnect: bool
    +waitForStartOnConnect: bool

    Whether OctoPrint should wait for the start response from the printer before trying to send commands during connect.

    -waitToLoadSdFileList: bool
    +waitToLoadSdFileList: bool

    Specifies whether OctoPrint should wait to load the SD card file list until the first firmware capability report is processed.

    @@ -1877,22 +1877,22 @@
    -class octoprint.schema.config.serial.SerialMaxTimeouts(*, idle: int = 2, printing: int = 5, long: int = 5)
    +class octoprint.schema.config.serial.SerialMaxTimeouts(*, idle: int = 2, printing: int = 5, long: int = 5)
    -idle: int
    +idle: int

    Max. timeouts when the printer is idle

    -long: int
    +long: int

    Max. timeouts when a long running command is active

    -printing: int
    +printing: int

    Max. timeouts when the printer is printing

    @@ -1900,80 +1900,80 @@
    -class octoprint.schema.config.serial.SerialTimeoutConfig(*, detectionFirst: float = 10.0, detectionConsecutive: float = 2.0, connection: float = 10.0, communication: float = 30.0, communicationBusy: float = 3.0, temperature: float = 5.0, temperatureTargetSet: float = 2.0, temperatureAutoreport: float = 2.0, sdStatus: float = 1.0, sdStatusAutoreport: float = 1.0, posAutoreport: float = 5.0, resendOk: float = 0.5, baudrateDetectionPause: float = 1.0, positionLogWait: float = 10.0)
    +class octoprint.schema.config.serial.SerialTimeoutConfig(*, detectionFirst: float = 10.0, detectionConsecutive: float = 2.0, connection: float = 10.0, communication: float = 30.0, communicationBusy: float = 3.0, temperature: float = 5.0, temperatureTargetSet: float = 2.0, temperatureAutoreport: float = 2.0, sdStatus: float = 1.0, sdStatusAutoreport: float = 1.0, posAutoreport: float = 5.0, resendOk: float = 0.5, baudrateDetectionPause: float = 1.0, positionLogWait: float = 10.0)
    -baudrateDetectionPause: float
    +baudrateDetectionPause: float
    -communication: float
    +communication: float

    Timeout during serial communication, in seconds

    -communicationBusy: float
    +communicationBusy: float

    Timeout during serial communication when busy protocol support is detected, in seconds

    -connection: float
    +connection: float

    Timeout for waiting to establish a connection with the selected port, in seconds

    -detectionConsecutive: float
    +detectionConsecutive: float
    -detectionFirst: float
    +detectionFirst: float
    -posAutoreport: float
    +posAutoreport: float
    -positionLogWait: float
    +positionLogWait: float
    -resendOk: float
    +resendOk: float
    -sdStatus: float
    +sdStatus: float

    Timeout after which to query the SD status while SD printing

    -sdStatusAutoreport: float
    +sdStatusAutoreport: float
    -temperature: float
    +temperature: float

    Timeout after which to query temperature when no target is set

    -temperatureAutoreport: float
    +temperatureAutoreport: float
    -temperatureTargetSet: float
    +temperatureTargetSet: float

    Timeout after which to query temperature when a target is set

    @@ -1981,28 +1981,28 @@
    -class octoprint.schema.config.server.CommandsConfig(*, systemShutdownCommand: Optional[str] = None, systemRestartCommand: Optional[str] = None, serverRestartCommand: Optional[str] = None, localPipCommand: Optional[str] = None)
    +class octoprint.schema.config.server.CommandsConfig(*, systemShutdownCommand: Optional[str] = None, systemRestartCommand: Optional[str] = None, serverRestartCommand: Optional[str] = None, localPipCommand: Optional[str] = None)
    -localPipCommand: Optional[str]
    +localPipCommand: Optional[str]

    pip command associated with OctoPrint, used for installing plugins and updates, if unset (default) the command will be autodetected based on the current python executable - unless you have a really special setup this is the right way to do it and there should be no need to ever touch this setting.

    -serverRestartCommand: Optional[str]
    +serverRestartCommand: Optional[str]

    Command to restart OctoPrint.

    -systemRestartCommand: Optional[str]
    +systemRestartCommand: Optional[str]

    Command to restart the system OctoPrint is running on.

    -systemShutdownCommand: Optional[str]
    +systemShutdownCommand: Optional[str]

    Command to shut down the system OctoPrint is running on.

    @@ -2010,7 +2010,7 @@
    -class octoprint.schema.config.server.CookiesConfig(*, secure: bool = False, samesite: Optional[octoprint.schema.config.server.SameSiteEnum] = SameSiteEnum.lax)
    +class octoprint.schema.config.server.CookiesConfig(*, secure: bool = False, samesite: Optional[octoprint.schema.config.server.SameSiteEnum] = SameSiteEnum.lax)
    samesite: Optional[octoprint.schema.config.server.SameSiteEnum]
    @@ -2027,7 +2027,7 @@
    -secure: bool
    +secure: bool

    Whether to set the Secure flag to true on cookies. Only set to true if you are running OctoPrint behind a reverse proxy taking care of SSL termination.

    @@ -2035,16 +2035,16 @@
    -class octoprint.schema.config.server.DiskspaceConfig(*, warning: int = 524288000, critical: int = 209715200)
    +class octoprint.schema.config.server.DiskspaceConfig(*, warning: int = 524288000, critical: int = 209715200)
    -critical: int
    +critical: int

    Threshold (bytes) after which to consider disk space becoming critical, defaults to 200MB.

    -warning: int
    +warning: int

    Threshold (bytes) after which to consider disk space becoming sparse, defaults to 500MB.

    @@ -2052,16 +2052,16 @@
    -class octoprint.schema.config.server.IpCheckConfig(*, enabled: bool = True, trustedSubnets: List[str] = [])
    +class octoprint.schema.config.server.IpCheckConfig(*, enabled: bool = True, trustedSubnets: List[str] = [])
    -enabled: bool
    +enabled: bool

    Whether to enable the check.

    -trustedSubnets: List[str]
    +trustedSubnets: List[str]

    Additional non-local subnets to consider trusted, in CIDR notation, e.g. 192.168.1.0/24.

    @@ -2069,34 +2069,34 @@
    -class octoprint.schema.config.server.OnlineCheckConfig(*, enabled: Optional[bool] = None, interval: int = 900, host: str = '1.1.1.1', port: int = 53, name: str = 'octoprint.org')
    +class octoprint.schema.config.server.OnlineCheckConfig(*, enabled: Optional[bool] = None, interval: int = 900, host: str = '1.1.1.1', port: int = 53, name: str = 'octoprint.org')
    -enabled: Optional[bool]
    +enabled: Optional[bool]

    Whether the online check is enabled. Ships unset, the user will be asked to make a decision as part of the setup wizard.

    -host: str
    +host: str

    DNS host against which to check, defaults to Cloudflare’s DNS.

    -interval: int
    +interval: int

    Interval in which to check for online connectivity (in seconds), defaults to 15 minutes.

    -name: str
    +name: str

    Host name for which to check name resolution, defaults to OctoPrint’s main domain.

    -port: int
    +port: int

    DNS port against which to check, defaults to the standard DNS port.

    @@ -2104,16 +2104,16 @@
    -class octoprint.schema.config.server.PluginBlacklistConfig(*, enabled: Optional[bool] = None, url: str = 'https://plugins.octoprint.org/blacklist.json', ttl: int = 900, timeout: float = 3.05)
    +class octoprint.schema.config.server.PluginBlacklistConfig(*, enabled: Optional[bool] = None, url: str = 'https://plugins.octoprint.org/blacklist.json', ttl: int = 900, timeout: float = 3.05)
    -enabled: Optional[bool]
    +enabled: Optional[bool]

    Whether use of the blacklist is enabled. If unset, the user will be asked to make a decision as part of the setup wizard.

    -timeout: float
    +timeout: float

    3.05 seconds).

    Type
    @@ -2124,7 +2124,7 @@
    -ttl: int
    +ttl: int

    15 minutes).

    Type
    @@ -2135,7 +2135,7 @@
    -url: str
    +url: str

    The URL from which to fetch the blacklist.

    @@ -2143,16 +2143,16 @@
    -class octoprint.schema.config.server.PreemptiveCacheConfig(*, exceptions: List[str] = [], until: int = 7)
    +class octoprint.schema.config.server.PreemptiveCacheConfig(*, exceptions: List[str] = [], until: int = 7)
    -exceptions: List[str]
    +exceptions: List[str]

    Which server paths to exclude from the preemptive cache, e.g. /some/path.

    -until: int
    +until: int

    How many days to leave unused entries in the preemptive cache config.

    @@ -2160,66 +2160,66 @@
    -class octoprint.schema.config.server.ReverseProxyConfig(*, prefixHeader: Optional[str] = None, schemeHeader: Optional[str] = None, hostHeader: Optional[str] = None, serverHeader: Optional[str] = None, portHeader: Optional[str] = None, prefixFallback: Optional[str] = None, schemeFallback: Optional[str] = None, hostFallback: Optional[str] = None, serverFallback: Optional[str] = None, portFallback: Optional[str] = None, trustedDownstream: List[str] = [])
    +class octoprint.schema.config.server.ReverseProxyConfig(*, prefixHeader: Optional[str] = None, schemeHeader: Optional[str] = None, hostHeader: Optional[str] = None, serverHeader: Optional[str] = None, portHeader: Optional[str] = None, prefixFallback: Optional[str] = None, schemeFallback: Optional[str] = None, hostFallback: Optional[str] = None, serverFallback: Optional[str] = None, portFallback: Optional[str] = None, trustedDownstream: List[str] = [])
    -hostFallback: Optional[str]
    +hostFallback: Optional[str]

    Use this option to define an optional forced host under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy with a different hostname than OctoPrint itself but can’t configure said reverse proxy to send a host HTTP header (X-Forwarded-Host by default, see above) with forwarded requests.

    -hostHeader: Optional[str]
    +hostHeader: Optional[str]

    The request header from which to determine the host under which OctoPrint is served by the reverse proxy.

    -portFallback: Optional[str]
    +portFallback: Optional[str]
    -portHeader: Optional[str]
    +portHeader: Optional[str]
    -prefixFallback: Optional[str]
    +prefixFallback: Optional[str]

    Use this option to define an optional URL prefix (with a leading /, so absolute to your server’s root) under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy under a different root endpoint than / and can’t configure said reverse proxy to send a prefix HTTP header (X-Script-Name by default, see above) with forwarded requests.

    -prefixHeader: Optional[str]
    +prefixHeader: Optional[str]

    The request header from which to determine the URL prefix under which OctoPrint is served by the reverse proxy.

    -schemeFallback: Optional[str]
    +schemeFallback: Optional[str]

    Use this option to define an optional forced scheme (http or https) under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy that also does HTTPS determination but can’t configure said reverse proxy to send a scheme HTTP header (X-Scheme by default, see above) with forwarded requests.

    -schemeHeader: Optional[str]
    +schemeHeader: Optional[str]

    The request header from which to determine the scheme (http or https) under which a specific request to OctoPrint was made to the reverse proxy.

    -serverFallback: Optional[str]
    +serverFallback: Optional[str]
    -serverHeader: Optional[str]
    +serverHeader: Optional[str]
    -trustedDownstream: List[str]
    +trustedDownstream: List[str]

    List of trusted downstream servers for which to ignore the IP address when trying to determine the connecting client’s IP address. If you have OctoPrint behind more than one reverse proxy you should add their IPs here so that they won’t be interpreted as the client’s IP. One reverse proxy will be handled correctly by default.

    @@ -2251,13 +2251,13 @@ class octoprint.schema.config.server.ServerConfig(*, host: typing.Optional[str] = None, port: int = 5000, firstRun: bool = True, startOnceInSafeMode: bool = False, ignoreIncompleteStartup: bool = False, seenWizards: typing.Dict[str, str] = {}, secretKey: typing.Optional[str] = None, heartbeat: int = 900, reverseProxy: octoprint.schema.config.server.ReverseProxyConfig = ReverseProxyConfig(prefixHeader=None, schemeHeader=None, hostHeader=None, serverHeader=None, portHeader=None, prefixFallback=None, schemeFallback=None, hostFallback=None, serverFallback=None, portFallback=None, trustedDownstream=[]), uploads: octoprint.schema.config.server.UploadsConfig = UploadsConfig(maxSize=1073741824, nameSuffix='name', pathSuffix='path'), maxSize: int = 102400, commands: octoprint.schema.config.server.CommandsConfig = CommandsConfig(systemShutdownCommand=None, systemRestartCommand=None, serverRestartCommand=None, localPipCommand=None), onlineCheck: octoprint.schema.config.server.OnlineCheckConfig = OnlineCheckConfig(enabled=None, interval=900, host='1.1.1.1', port=53, name='octoprint.org'), pluginBlacklist: octoprint.schema.config.server.PluginBlacklistConfig = PluginBlacklistConfig(enabled=None, url='https://plugins.octoprint.org/blacklist.json', ttl=900, timeout=3.05), diskspace: octoprint.schema.config.server.DiskspaceConfig = DiskspaceConfig(warning=524288000, critical=209715200), preemptiveCache: octoprint.schema.config.server.PreemptiveCacheConfig = PreemptiveCacheConfig(exceptions=[], until=7), ipCheck: octoprint.schema.config.server.IpCheckConfig = IpCheckConfig(enabled=True, trustedSubnets=[]), allowFraming: bool = False, cookies: octoprint.schema.config.server.CookiesConfig = CookiesConfig(secure=False, samesite=<SameSiteEnum.lax: 'Lax'>), allowedLoginRedirectPaths: typing.List[str] = [])
    -allowFraming: bool
    +allowFraming: bool

    Whether to allow OctoPrint to be embedded in a frame or not. Note that depending on your setup you might have to set SameSite to None, Secure to true and serve OctoPrint through a reverse proxy that enables https for cookies and thus logging in to work.

    -allowedLoginRedirectPaths: List[str]
    +allowedLoginRedirectPaths: List[str]

    List of paths that are allowed to be used as redirect targets for the login page, in addition to the default ones (/, /recovery/ and /plugin/appkeys/auth/)

    @@ -2281,24 +2281,24 @@
    -firstRun: bool
    +firstRun: bool

    If this option is true, OctoPrint will show the First Run wizard and set the setting to false after that completes.

    -heartbeat: int
    +heartbeat: int
    -host: Optional[str]
    +host: Optional[str]

    Use this option to define the host to which to bind the server. If unset, OctoPrint will attempt to bind on all available interfaces, IPv4 and v6 unless either is disabled.

    -ignoreIncompleteStartup: bool
    +ignoreIncompleteStartup: bool

    Set this to true to make OctoPrint ignore incomplete startups. Helpful for development.

    @@ -2310,7 +2310,7 @@
    -maxSize: int
    +maxSize: int

    Maximum size of requests other than file uploads in bytes, defaults to 100KB.

    @@ -2328,7 +2328,7 @@
    -port: int
    +port: int

    Use this option to define the port to which to bind the server.

    @@ -2351,18 +2351,18 @@
    -secretKey: Optional[str]
    +secretKey: Optional[str]

    Secret key for encrypting cookies and such, randomly generated on first run.

    -seenWizards: Dict[str, str]
    +seenWizards: Dict[str, str]
    -startOnceInSafeMode: bool
    +startOnceInSafeMode: bool

    If this option is true, OctoPrint will enable safe mode on the next server start and reset the setting to false

    @@ -2376,22 +2376,22 @@
    -class octoprint.schema.config.server.UploadsConfig(*, maxSize: int = 1073741824, nameSuffix: str = 'name', pathSuffix: str = 'path')
    +class octoprint.schema.config.server.UploadsConfig(*, maxSize: int = 1073741824, nameSuffix: str = 'name', pathSuffix: str = 'path')
    -maxSize: int
    +maxSize: int

    Maximum size of uploaded files in bytes, defaults to 1GB.

    -nameSuffix: str
    +nameSuffix: str

    Suffix used for storing the filename in the file upload headers when streaming uploads.

    -pathSuffix: str
    +pathSuffix: str

    Suffix used for storing the path to the temporary file in the file upload headers when streaming uploads.

    @@ -2399,22 +2399,22 @@
    -class octoprint.schema.config.slicing.SlicingConfig(*, enabled: bool = True, defaultSlicer: Optional[str] = None, defaultProfiles: Dict[str, str] = {})
    +class octoprint.schema.config.slicing.SlicingConfig(*, enabled: bool = True, defaultSlicer: Optional[str] = None, defaultProfiles: Dict[str, str] = {})
    -defaultProfiles: Dict[str, str]
    +defaultProfiles: Dict[str, str]

    Default slicing profiles per slicer, maps slicer identifier to profile identifier.

    -defaultSlicer: Optional[str]
    +defaultSlicer: Optional[str]

    Default slicer to use.

    -enabled: bool
    +enabled: bool

    Whether to enable slicing support or not.

    @@ -2422,34 +2422,34 @@
    -class octoprint.schema.config.system.ActionConfig(*, action: str, name: Optional[str] = None, command: Optional[str] = None, confirm: Optional[str] = None, **extra_data: Any)
    +class octoprint.schema.config.system.ActionConfig(*, action: str, name: Optional[str] = None, command: Optional[str] = None, confirm: Optional[str] = None, **extra_data: Any)
    -action: str
    +action: str

    The identifier used internally to identify the action. Set to divider to generate a divider in the menu.

    -async_: bool
    +async_: bool

    Whether to run the command asynchronously.

    -command: Optional[str]
    +command: Optional[str]

    The command to execute when the action is selected. Must be set if the action is not a divider.

    -confirm: Optional[str]
    +confirm: Optional[str]

    An optional confirmation message to show before executing the command.

    -name: Optional[str]
    +name: Optional[str]

    The name of the action that will be shown on the menu. Must be set if the action is not a divider.

    @@ -2457,7 +2457,7 @@
    -class octoprint.schema.config.system.SystemConfig(*, actions: List[octoprint.schema.config.system.ActionConfig] = [])
    +class octoprint.schema.config.system.SystemConfig(*, actions: List[octoprint.schema.config.system.ActionConfig] = [])
    actions: List[octoprint.schema.config.system.ActionConfig]
    @@ -2468,10 +2468,10 @@
    -class octoprint.schema.config.temperature.TemperatureConfig(*, profiles: List[octoprint.schema.config.temperature.TemperatureProfile] = [TemperatureProfile(name='ABS', extruder=210, bed=100), TemperatureProfile(name='PLA', extruder=180, bed=60)], cutoff: int = 30, sendAutomatically: bool = False, sendAutomaticallyAfter: int = 1)
    +class octoprint.schema.config.temperature.TemperatureConfig(*, profiles: List[octoprint.schema.config.temperature.TemperatureProfile] = [TemperatureProfile(name='ABS', extruder=210, bed=100), TemperatureProfile(name='PLA', extruder=180, bed=60)], cutoff: int = 30, sendAutomatically: bool = False, sendAutomaticallyAfter: int = 1)
    -cutoff: int
    +cutoff: int

    Cut off time for the temperature data, in minutes.

    @@ -2483,13 +2483,13 @@
    -sendAutomatically: bool
    +sendAutomatically: bool

    Whether to send new temperature settings made in the UI automatically.

    -sendAutomaticallyAfter: int
    +sendAutomaticallyAfter: int

    After what time to send the new temperature settings automatically, in seconds.

    @@ -2497,22 +2497,22 @@
    -class octoprint.schema.config.temperature.TemperatureProfile(*, name: str, extruder: int, bed: int)
    +class octoprint.schema.config.temperature.TemperatureProfile(*, name: str, extruder: int, bed: int)
    -bed: int
    +bed: int

    Bed temperature to set with the profile.

    -extruder: int
    +extruder: int

    Hotend temperature to set with the profile.

    -name: str
    +name: str

    Name of the profile.

    @@ -2520,16 +2520,16 @@
    -class octoprint.schema.config.terminalfilters.TerminalFilterEntry(*, name: str, regex: str)
    +class octoprint.schema.config.terminalfilters.TerminalFilterEntry(*, name: str, regex: str)
    -name: str
    +name: str

    The name of the filter.

    -regex: str
    +regex: str

    //developer.mozilla.org/en/docs/Web/JavaScript/Guide/Regular_Expressions).

    Type
    @@ -2542,10 +2542,10 @@
    -class octoprint.schema.config.webcam.TimelapseConfig(*, type: octoprint.schema.config.webcam.TimelapseTypeEnum = TimelapseTypeEnum.off, fps: int = 25, postRoll: int = 0, options: octoprint.schema.config.webcam.TimelapseOptions = TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None))
    +class octoprint.schema.config.webcam.TimelapseConfig(*, type: octoprint.schema.config.webcam.TimelapseTypeEnum = TimelapseTypeEnum.off, fps: int = 25, postRoll: int = 0, options: octoprint.schema.config.webcam.TimelapseOptions = TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None))
    -fps: int
    +fps: int

    The framerate at which to render the movie.

    @@ -2557,7 +2557,7 @@
    -postRoll: int
    +postRoll: int

    The number of seconds in the rendered video to add after a finished print. The exact way how the additional images will be recorded depends on timelapse type. zchange timelapses will take one final picture and add it fps * postRoll times. timed timelapses continue to record just like at the beginning, so the recording will continue another fps * postRoll * interval seconds. This behaviour can be overridden by setting the capturePostRoll option to false, in which case the post roll will be created identically to zchange mode.

    @@ -2571,10 +2571,10 @@
    -class octoprint.schema.config.webcam.TimelapseOptions(*, interval: Optional[int] = None, capturePostRoll: Optional[bool] = None, retractionZHop: Optional[float] = None)
    +class octoprint.schema.config.webcam.TimelapseOptions(*, interval: Optional[int] = None, capturePostRoll: Optional[bool] = None, retractionZHop: Optional[float] = None)
    -capturePostRoll: Optional[bool]
    +capturePostRoll: Optional[bool]

    Whether to capture the snapshots for the post roll (true) or just copy the last captured snapshot from the print over and over again (false).

    Type
    @@ -2585,7 +2585,7 @@
    -interval: Optional[int]
    +interval: Optional[int]

    The interval which to leave between images in seconds.

    Type
    @@ -2596,7 +2596,7 @@
    -retractionZHop: Optional[float]
    +retractionZHop: Optional[float]

    z-hop height during retractions to ignore for capturing snapshots.

    Type
    @@ -2633,53 +2633,53 @@ class octoprint.schema.config.webcam.WebcamConfig(*, webcamEnabled: bool = True, timelapseEnabled: bool = True, ffmpeg: typing.Optional[str] = None, ffmpegThreads: int = 1, ffmpegVideoCodec: str = 'libx264', bitrate: str = '10000k', watermark: bool = True, ffmpegCommandline: str = '{ffmpeg} -framerate {fps} -i "{input}" -vcodec {videocodec} -threads {threads} -b:v {bitrate} -f {containerformat} -y {filters} "{output}"', ffmpegThumbnailCommandline: str = '{ffmpeg} -sseof -1 -i "{input}" -update 1 -q:v 0.7 "{output}"', timelapse: octoprint.schema.config.webcam.TimelapseConfig = TimelapseConfig(type=<TimelapseTypeEnum.off: 'off'>, fps=25, postRoll=0, options=TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None)), cleanTmpAfterDays: int = 7, defaultWebcam: str = 'classic', snapshotWebcam: str = 'classic')
    -bitrate: str
    +bitrate: str

    The bitrate to use for rendering the timelapse video. This gets directly passed to ffmpeg.

    -cleanTmpAfterDays: int
    +cleanTmpAfterDays: int

    After how many days unrendered timelapses will be deleted.

    -defaultWebcam: str
    +defaultWebcam: str

    The name of the default webcam

    -ffmpeg: Optional[str]
    +ffmpeg: Optional[str]

    Path to ffmpeg binary to use for creating timelapse recordings. Timelapse support will be disabled if not set.

    -ffmpegCommandline: str
    +ffmpegCommandline: str
    -ffmpegThreads: int
    +ffmpegThreads: int

    Number of how many threads to instruct ffmpeg to use for encoding.

    -ffmpegThumbnailCommandline: str
    +ffmpegThumbnailCommandline: str
    -ffmpegVideoCodec: str
    +ffmpegVideoCodec: str

    Videocodec to be used for encoding.

    -snapshotWebcam: str
    +snapshotWebcam: str

    The name of the default webcam to use for snapshots

    @@ -2691,19 +2691,19 @@
    -timelapseEnabled: bool
    +timelapseEnabled: bool

    Use this option to enable timelapse support via snapshot, e.g. via MJPG-Streamer. Timelapse support will be disabled if not set.

    -watermark: bool
    +watermark: bool

    Whether to include a “created with OctoPrint” watermark in the generated timelapse recordings.

    -webcamEnabled: bool
    +webcamEnabled: bool

    Use this option to enable display of a webcam stream in the UI, e.g. via MJPG-Streamer. Webcam support will be disabled if not set.

    @@ -2730,10 +2730,10 @@
    -class octoprint.schema.webcam.Webcam(*, name: str, displayName: str, canSnapshot: bool = False, snapshotDisplay: str = None, flipH: bool = False, flipV: bool = False, rotate90: bool = False, extras: dict = {}, compat: Optional[octoprint.schema.webcam.WebcamCompatibility] = None)
    +class octoprint.schema.webcam.Webcam(*, name: str, displayName: str, canSnapshot: bool = False, snapshotDisplay: str = None, flipH: bool = False, flipV: bool = False, rotate90: bool = False, extras: dict = {}, compat: Optional[octoprint.schema.webcam.WebcamCompatibility] = None)
    -canSnapshot: bool
    +canSnapshot: bool

    Whether this webcam can take a snapshot.

    @@ -2745,43 +2745,43 @@
    -displayName: str
    +displayName: str

    Displayable name for this webcam

    -extras: dict
    +extras: dict

    Unstructured data describing this webcam

    -flipH: bool
    +flipH: bool

    Whether to flip the webcam horizontally.

    -flipV: bool
    +flipV: bool

    Whether to flip the webcam vertically.

    -name: str
    +name: str

    Identifier of this webcam

    -rotate90: bool
    +rotate90: bool

    Whether to rotate the webcam 90° counter clockwise.

    -snapshotDisplay: str
    +snapshotDisplay: str

    Human readable information about how a snapshot is captured or a HTTP URL from which the snapshot is loaded (optional, only for user reference)

    @@ -2789,34 +2789,34 @@
    -class octoprint.schema.webcam.WebcamCompatibility(*, streamTimeout: int = 5, streamRatio: octoprint.schema.webcam.RatioEnum = RatioEnum.sixteen_nine, streamWebrtcIceServers: List[str] = ['stun:stun.l.google.com:19302'], cacheBuster: bool = False, stream: str, snapshot: str = None, snapshotTimeout: int = 5, snapshotSslValidation: bool = True)
    +class octoprint.schema.webcam.WebcamCompatibility(*, streamTimeout: int = 5, streamRatio: octoprint.schema.webcam.RatioEnum = RatioEnum.sixteen_nine, streamWebrtcIceServers: List[str] = ['stun:stun.l.google.com:19302'], cacheBuster: bool = False, stream: str, snapshot: str = None, snapshotTimeout: int = 5, snapshotSslValidation: bool = True)
    -cacheBuster: bool
    +cacheBuster: bool

    Whether the URL should be randomized to bust caches

    -snapshot: str
    +snapshot: str

    The URL to get the snapshot from

    -snapshotSslValidation: bool
    +snapshotSslValidation: bool

    Whether to validate SSL certificates when retrieving a snapshot

    -snapshotTimeout: int
    +snapshotTimeout: int

    The timeout when retrieving snapshots

    -stream: str
    +stream: str

    The URL to get an MJPEG stream from

    @@ -2828,13 +2828,13 @@
    -streamTimeout: int
    +streamTimeout: int

    The timeout of the stream in seconds

    -streamWebrtcIceServers: List[str]
    +streamWebrtcIceServers: List[str]

    The WebRTC STUN and TURN servers

    @@ -2876,7 +2876,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/modules/server.html b/maintenance/modules/server.html index 1aeb8207d..39d83a57d 100644 --- a/maintenance/modules/server.html +++ b/maintenance/modules/server.html @@ -122,7 +122,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -298,8 +298,8 @@
    Parameters
      -

    • url (str) – URL to validate

      • -

    • allowed_paths (List[str]) – List of allowed paths, only paths contained +

    • url (str) – URL to validate

      • +

    • allowed_paths (List[str]) – List of allowed paths, only paths contained or prefixed (if allowed path ends with “*”) will be considered valid.

    @@ -307,7 +307,7 @@

    Whether the url passed validation or not.

    Return type
    -

    bool

    +

    bool

    @@ -410,7 +410,7 @@
    property cookies
    -

    A dict with the contents of all cookies transmitted with +

    A dict with the contents of all cookies transmitted with the request.

    @@ -430,7 +430,7 @@
    -class octoprint.server.util.flask.OctoPrintFlaskResponse(response: Optional[Union[Iterable[bytes], bytes, Iterable[str], str]] = None, status: Optional[Union[int, str, http.HTTPStatus]] = None, headers: Optional[Union[Mapping[str, Union[str, int, Iterable[Union[str, int]]]], Iterable[Tuple[str, Union[str, int]]]]] = None, mimetype: Optional[str] = None, content_type: Optional[str] = None, direct_passthrough: bool = False)
    +class octoprint.server.util.flask.OctoPrintFlaskResponse(response: Optional[Union[Iterable[bytes], bytes, Iterable[str], str]] = None, status: Optional[Union[int, str, http.HTTPStatus]] = None, headers: Optional[Union[Mapping[str, Union[str, int, Iterable[Union[str, int]]]], Iterable[Tuple[str, Union[str, int]]]]] = None, mimetype: Optional[str] = None, content_type: Optional[str] = None, direct_passthrough: bool = False)
    @@ -492,16 +492,16 @@ class octoprint.server.util.flask.OctoPrintJsonProvider(app: Flask)
    -dumps(obj: Any, **kwargs: Any) → str
    +dumps(obj: Any, **kwargs: Any) → str

    Serialize data as JSON to a string.

    -

    Keyword arguments are passed to json.dumps(). Sets some +

    Keyword arguments are passed to json.dumps(). Sets some parameter defaults from the default, ensure_ascii, and sort_keys attributes.

    Parameters
    @@ -596,7 +596,7 @@
    -octoprint.server.util.flask.check_lastmodified(lastmodified: Union[int, float, datetime.datetime]) → bool
    +octoprint.server.util.flask.check_lastmodified(lastmodified: Union[int, float, datetime.datetime]) → bool

    Compares the provided lastmodified value with the value of the If-Modified-Since header.

    If lastmodified is an int or float, it’s assumed to be a Unix timestamp and converted to a timezone aware datetime instance in UTC.

    @@ -604,16 +604,16 @@ result will always be False.

    Parameters
    -

    lastmodified (Union[int, float, datetime]) – The last modified value to compare against

    +

    lastmodified (Union[int, float, datetime]) – The last modified value to compare against

    Raises
    -

    ValueError – If anything but an int, float or datetime instance is passed

    +

    ValueError – If anything but an int, float or datetime instance is passed

    Returns

    true if the values indicate that the document is still up to date

    Return type
    -

    bool

    +

    bool

    @@ -769,7 +769,7 @@

    octoprint.server.util.tornado

    -class octoprint.server.util.tornado.CorsSupportMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.CorsSupportMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    tornado.web.RequestHandler mixin that makes sure to set CORS headers similarly to the Flask backed API endpoints.

    @@ -801,7 +801,7 @@
    -class octoprint.server.util.tornado.CustomHTTP1ServerConnection(stream: tornado.iostream.IOStream, params: Optional[tornado.http1connection.HTTP1ConnectionParameters] = None, context: Optional[object] = None)
    +class octoprint.server.util.tornado.CustomHTTP1ServerConnection(stream: tornado.iostream.IOStream, params: Optional[tornado.http1connection.HTTP1ConnectionParameters] = None, context: Optional[object] = None)

    A custom implementation of tornado.http1connection.HTTP1ServerConnection which utilizes a CustomHTTP1Connection instead of a tornado.http1connection.HTTP1Connection in _server_request_loop. The implementation logic is otherwise the same as tornado.http1connection.HTTP1ServerConnection.

    @@ -809,7 +809,7 @@
    -class octoprint.server.util.tornado.CustomHTTPServer(*args: Any, **kwargs: Any)
    +class octoprint.server.util.tornado.CustomHTTPServer(*args: Any, **kwargs: Any)

    Custom implementation of tornado.httpserver.HTTPServer that allows defining max body sizes depending on path and method.

    The implementation is mostly taken from tornado.httpserver.HTTPServer, the only difference is the creation @@ -840,32 +840,32 @@

    -class octoprint.server.util.tornado.DeprecatedEndpointHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.DeprecatedEndpointHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    tornado.web.RequestHandler that redirects to another url and logs a deprecation warning.

    Parameters
    -

    url (str) – URL to which to redirect

    +

    url (str) – URL to which to redirect

    -class octoprint.server.util.tornado.DynamicZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.DynamicZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    -class octoprint.server.util.tornado.GeneratingDataHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
    +class octoprint.server.util.tornado.GeneratingDataHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

    A RequestHandler that generates data from a generator function and returns it to the client.

    Parameters

    • generator (function) – A generator function that returns the data to be written to the client. The function will be called without any parameters.

      • -

    • content_type (str) – The content type with which to respond. Defaults to text/plain

      • -

    • as_attachment (bool | str) – Whether to serve files with Content-Disposition: attachment header (True) +

    • content_type (str) – The content type with which to respond. Defaults to text/plain

      • +

    • as_attachment (bool | str) – Whether to serve files with Content-Disposition: attachment header (True) or not. Defaults to False. If a string is given it will be used as the filename of the attachment.

    • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise @@ -883,21 +883,21 @@

      -class octoprint.server.util.tornado.LargeResponseHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.LargeResponseHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

      Customized tornado.web.StaticFileHandler that allows delivery of the requested resource as attachment and access and request path validation through optional callbacks. Note that access validation takes place before path validation.

      Parameters
        -

      • path (str) – The system path from which to serve files (this will be forwarded to the initialize method of +

      • path (str) – The system path from which to serve files (this will be forwarded to the initialize method of :class:~tornado.web.StaticFileHandler)

        • -

      • default_filename (str) – The default filename to serve if none is explicitly specified and the request references +

      • default_filename (str) – The default filename to serve if none is explicitly specified and the request references a subdirectory of the served path (this will be forwarded to the initialize method of :class:~tornado.web.StaticFileHandler as the default_filename keyword parameter). Defaults to None.

        • -

      • as_attachment (bool) – Whether to serve requested files with Content-Disposition: attachment header (True) +

      • as_attachment (bool) – Whether to serve requested files with Content-Disposition: attachment header (True) or not. Defaults to False.

        • -

      • allow_client_caching (bool) – Whether to allow the client to cache (by not setting any Cache-Control or +

      • allow_client_caching (bool) – Whether to allow the client to cache (by not setting any Cache-Control or Expires headers on the response) or not.

      • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise @@ -915,7 +915,7 @@ called with the requested path as parameter.

      • mime_type_guesser (function) – Callback to guess the mime type to use for the content type encoding of the response. Will be called with the requested path on disk as parameter.

        • -

      • is_pre_compressed (bool) – if the file is expected to be pre-compressed, i.e, if there is a file in the same +

      • is_pre_compressed (bool) – if the file is expected to be pre-compressed, i.e, if there is a file in the same directory with the same name, but with ‘.gz’ appended and gzip-encoded

      @@ -972,7 +972,7 @@
      -class octoprint.server.util.tornado.RequestlessExceptionLoggingMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.RequestlessExceptionLoggingMixin(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      log_exception(typ, value, tb, *args, **kwargs)
      @@ -990,14 +990,14 @@
      -class octoprint.server.util.tornado.StaticDataHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.StaticDataHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

      tornado.web.RequestHandler that returns static data of a configured content_type.

      Parameters
        -

      • data (str) – The data with which to respond

        • -

      • content_type (str) – The content type with which to respond. Defaults to text/plain

        • +

      • data (str) – The data with which to respond

        • +

      • content_type (str) – The content type with which to respond. Defaults to text/plain

      @@ -1005,17 +1005,17 @@
      -class octoprint.server.util.tornado.StaticZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.StaticZipBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      -class octoprint.server.util.tornado.SystemInfoBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.SystemInfoBundleHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      -class octoprint.server.util.tornado.UploadStorageFallbackHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.UploadStorageFallbackHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

      A RequestHandler similar to tornado.web.FallbackHandler which fetches any files contained in the request bodies of content type multipart, stores them in temporary files and supplies the fallback with the file’s name, content_type, path and size instead via a rewritten body.

      @@ -1157,7 +1157,7 @@
      -class octoprint.server.util.tornado.UrlProxyHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
      +class octoprint.server.util.tornado.UrlProxyHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

      tornado.web.RequestHandler that proxies requests to a preconfigured url and returns the response. Allows delivery of the requested content as attachment and access validation through an optional callback.

      @@ -1176,10 +1176,10 @@
      Parameters
        -

      • url (str) – URL to forward any requests to. A 404 response will be returned if this is not set. Defaults to None.

        • -

      • as_attachment (bool) – Whether to serve files with Content-Disposition: attachment header (True) +

      • url (str) – URL to forward any requests to. A 404 response will be returned if this is not set. Defaults to None.

        • +

      • as_attachment (bool) – Whether to serve files with Content-Disposition: attachment header (True) or not. Defaults to False.

        • -

      • basename (str) – base name of file names to return as part of the attachment header, see above. Defaults to None.

        • +

      • basename (str) – base name of file names to return as part of the attachment header, see above. Defaults to None.

      • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise a tornado.web.HTTPError if access is not allowed in which case the request will not be further processed. @@ -1191,12 +1191,12 @@

        -class octoprint.server.util.tornado.WebcamSnapshotHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)
        +class octoprint.server.util.tornado.WebcamSnapshotHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

        GeneratingDataHandler that returns a snapshot from the configured webcam.

        Parameters
          -

        • as_attachment (bool | str) – Whether to serve files with Content-Disposition: attachment header (True) +

        • as_attachment (bool | str) – Whether to serve files with Content-Disposition: attachment header (True) or not. Defaults to False. If a string is given it will be used as the filename of the attachment.

        • access_validation (function) – Callback to call in the get method to validate access to the resource. Will be called with self.request as parameter which contains the full tornado request object. Should raise @@ -1326,7 +1326,7 @@

          Tags
          -
          1.9.2
          +
          1.9.3
          1.8.7
          diff --git a/maintenance/modules/settings.html b/maintenance/modules/settings.html index 76f45290d..cef21a10c 100644 --- a/maintenance/modules/settings.html +++ b/maintenance/modules/settings.html @@ -122,7 +122,7 @@

          Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

          @@ -178,15 +178,15 @@
          Parameters

          • init (boolean) – A flag indicating whether this is the initial call to construct the singleton (True) or not -(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError +(False, default). If this is set to True and the plugin manager has already been initialized, a ValueError will be raised. The same will happen if the plugin manager has not yet been initialized and this is set to False.

            • -

          • basedir (str) – Path of the base directory for all of OctoPrint’s settings, log files, uploads etc. If not set +

          • basedir (str) – Path of the base directory for all of OctoPrint’s settings, log files, uploads etc. If not set the default will be used: ~/.octoprint on Linux, %APPDATA%/OctoPrint on Windows and ~/Library/Application Support/OctoPrint on MacOS.

            • -

          • configfile (str) – Path of the configuration file (config.yaml) to work on. If not set the default will +

          • configfile (str) – Path of the configuration file (config.yaml) to work on. If not set the default will be used: <basedir>/config.yaml for basedir as defined above.

            • -

          • overlays (list) – List of paths to config overlays to put between default settings and config.yaml

            • +

          • overlays (list) – List of paths to config overlays to put between default settings and config.yaml

          Returns
          @@ -196,7 +196,7 @@

          Settings

          Raises
          -

          ValueError – init is True but settings are already initialized or vice versa.

          +

          ValueError – init is True but settings are already initialized or vice versa.

        @@ -499,7 +499,7 @@
        Tags
        -
        1.9.2
        +
        1.9.3
        1.8.7
        diff --git a/maintenance/modules/slicing.html b/maintenance/modules/slicing.html index 89307d6b2..6d0930270 100644 --- a/maintenance/modules/slicing.html +++ b/maintenance/modules/slicing.html @@ -122,7 +122,7 @@

        Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

        @@ -161,12 +161,12 @@
        Parameters
          -

        • slicer (str) – Identifier of the slicer this profile belongs to.

          • -

        • name (str) – Identifier of this slicing profile.

          • -

        • data (object) – Profile data, actual structure depends on individual slicer implementation.

          • -

        • display_name (str) – Displayable name for this slicing profile.

          • -

        • description (str) – Description of this slicing profile.

          • -

        • default (bool) – Whether this is the default slicing profile for the slicer.

          • +

        • slicer (str) – Identifier of the slicer this profile belongs to.

          • +

        • name (str) – Identifier of this slicing profile.

          • +

        • data (object) – Profile data, actual structure depends on individual slicer implementation.

          • +

        • display_name (str) – Displayable name for this slicing profile.

          • +

        • description (str) – Description of this slicing profile.

          • +

        • default (bool) – Whether this is the default slicing profile for the slicer.

        @@ -191,7 +191,7 @@ supplied overrides. This will be called according to the method signature of save_slicer_profile().

      • profile (SlicingProfile) – The profile from which to derive the temporary profile.

        • -

      • overrides (dict) – Optional overrides to apply to the profile for creation of the temporary profile.

        • +

      • overrides (dict) – Optional overrides to apply to the profile for creation of the temporary profile.

      @@ -204,7 +204,7 @@
      Parameters
        -

      • profile_path (str) – Absolute path to the base folder where all slicing profiles are stored.

        • +

      • profile_path (str) – Absolute path to the base folder where all slicing profiles are stored.

      • printer_profile_manager (PrinterProfileManager) – PrinterProfileManager instance to use for accessing available printer profiles, most importantly the currently selected one.

      @@ -219,7 +219,7 @@
      Parameters
        -

      • slicer (str) – Identifier of the slicer for which to retrieve all slicer profiles

        • +

      • slicer (str) – Identifier of the slicer for which to retrieve all slicer profiles

      • require_configured (boolean) – Whether to require the slicer slicer to be already configured (True) or not (False, default). If False and the slicer is not yet configured, a SlicerNotConfigured exception will be raised.

        • @@ -247,9 +247,9 @@
        Parameters
          -

        • slicer_name (str) – Identifier of the slicer on which to cancel the job.

          • -

        • source_path (str) – The absolute path to the source file being sliced.

          • -

        • dest_path (str) – The absolute path to the destination file being sliced to.

          • +

        • slicer_name (str) – Identifier of the slicer on which to cancel the job.

          • +

        • source_path (str) – The absolute path to the source file being sliced.

          • +

        • dest_path (str) – The absolute path to the destination file being sliced to.

        Raises
        @@ -288,8 +288,8 @@
        Parameters
          -

        • slicer (str) – Identifier of the slicer for which to delete the profile.

          • -

        • name (str) – Identifier of the profile to delete.

          • +

        • slicer (str) – Identifier of the slicer for which to delete the profile.

          • +

        • name (str) – Identifier of the profile to delete.

        Raises
        @@ -310,8 +310,8 @@
        Parameters
          -

        • slicer (str) – Identifier of the slicer to which the profile belongs to.

          • -

        • name (str) – Identifier of the profile for which to retrieve the path.

          • +

        • slicer (str) – Identifier of the slicer to which the profile belongs to.

          • +

        • name (str) – Identifier of the profile for which to retrieve the path.

        • must_exist (boolean) – Whether the path must exist (True) or not (False, default).

        @@ -319,7 +319,7 @@

        The absolute path to the profile identified by name for slicer slicer.

        Return type
        -

        str

        +

        str

        Raises
          @@ -338,7 +338,7 @@
          Parameters
            -

          • slicer (str) – Identifier of the slicer to return

            • +

          • slicer (str) – Identifier of the slicer to return

          • require_configured (boolean) – Whether to raise an exception if the slicer has not been configured yet (True, the default), or also return an unconfigured slicer (False).

          @@ -358,13 +358,13 @@

          Retrieves the path where the profiles for slicer slicer are stored.

          Parameters
          -

          slicer (str) – Identifier of the slicer for which to retrieve the path.

          +

          slicer (str) – Identifier of the slicer for which to retrieve the path.

          Returns

          The absolute path to the folder where the slicer’s profiles are stored.

          Return type
          -

          str

          +

          str

          Raises

          UnknownSlicer – The slicer slicer is unknown.

          @@ -383,7 +383,7 @@
          load_profile(slicer, name, require_configured=True)

          Loads the slicing profile for slicer with the given profile name and returns it. If it can’t be loaded -due to an IOError None will be returned instead.

          +due to an IOError None will be returned instead.

          If require_configured is True (the default) a SlicerNotConfigured exception will be raised if the indicated slicer has not yet been configured.

          @@ -410,7 +410,7 @@

          Retrieves the last modification date of slicer’s profiles.

          Parameters
          -

          slicer (str) – the slicer for which to retrieve the last modification date

          +

          slicer (str) – the slicer for which to retrieve the last modification date

          Returns

          (float) the time stamp of the last modification of the slicer’s profiles

          @@ -436,11 +436,11 @@
          save_profile(slicer, name, profile, overrides=None, allow_overwrite=True, display_name=None, description=None)

          Saves the slicer profile profile for slicer slicer under name name.

          -

          profile may be either a SlicingProfile or a dict.

          +

          profile may be either a SlicingProfile or a dict.

          If it’s a SlicingProfile, its slicer`, name and - if provided - display_name and description attributes will be overwritten with the supplied values.

          -

          If it’s a dict, a new SlicingProfile instance will be created with the supplied meta data and +

          If it’s a dict, a new SlicingProfile instance will be created with the supplied meta data and the profile data as the data attribute.

          Note

          @@ -449,15 +449,15 @@
          Parameters
            -

          • slicer (str) – Identifier of the slicer for which to save the profile.

            • -

          • name (str) – Identifier under which to save the profile.

            • -

          • profile (SlicingProfile or dict) – The SlicingProfile or a dict containing the profile +

          • slicer (str) – Identifier of the slicer for which to save the profile.

            • +

          • name (str) – Identifier under which to save the profile.

            • +

          • profile (SlicingProfile or dict) – The SlicingProfile or a dict containing the profile data of the profile the save.

            • -

          • overrides (dict) – Overrides to apply to the profile before saving it.

            • +

          • overrides (dict) – Overrides to apply to the profile before saving it.

          • allow_overwrite (boolean) – If True (default) if a profile for the same slicer of the same name already exists, it will be overwritten. Otherwise an exception will be thrown.

            • -

          • display_name (str) – The name to display to the user for the profile.

            • -

          • description (str) – A description of the profile.

            • +

          • display_name (str) – The name to display to the user for the profile.

            • +

          • description (str) – A description of the profile.

          Returns
          @@ -468,7 +468,7 @@
          Raises
            -

          • ValueError – The supplied profile is neither a SlicingProfile nor a dict.

            • +

          • ValueError – The supplied profile is neither a SlicingProfile nor a dict.

          • UnknownSlicer – The slicer slicer is unknown.

          • ProfileAlreadyExists – A profile with name name already exists for slicer and allow_overwrite is False.

            • @@ -484,14 +484,14 @@
            Parameters
              -

            • slicer (str) – Identifier of the slicer for which to set the default +

            • slicer (str) – Identifier of the slicer for which to set the default profile.

              • -

            • name (str) – Identifier of the profile to set as default.

              • -

            • require_configured (bool) – Whether the slicer needs to be configured +

            • name (str) – Identifier of the profile to set as default.

              • +

            • require_configured (bool) – Whether the slicer needs to be configured for the action to succeed. Defaults to false. Will raise a SlicerNotConfigured error if true and the slicer has not been configured yet.

              • -

            • require_exists (bool) – Whether the profile is required to exist in +

            • require_exists (bool) – Whether the profile is required to exist in order to be set as default. Defaults to true. Will raise a UnknownProfile error if true and the profile is unknown.

            @@ -542,24 +542,24 @@
            Parameters
              -

            • slicer_name (str) – The identifier of the slicer to use for slicing.

              • -

            • source_path (str) – The absolute path to the source file to slice.

              • -

            • dest_path (str) – The absolute path to the destination file to slice to.

              • -

            • profile_name (str) – The name of the slicing profile to use.

              • +

            • slicer_name (str) – The identifier of the slicer to use for slicing.

              • +

            • source_path (str) – The absolute path to the source file to slice.

              • +

            • dest_path (str) – The absolute path to the destination file to slice to.

              • +

            • profile_name (str) – The name of the slicing profile to use.

            • callback (callable) – A callback to call after slicing has finished.

              • -

            • callback_args (list or tuple) – Arguments of the callback to call after slicing has finished. Defaults to +

            • callback_args (list or tuple) – Arguments of the callback to call after slicing has finished. Defaults to an empty list.

              • -

            • callback_kwargs (dict) – Keyword arguments for the callback to call after slicing has finished, will be +

            • callback_kwargs (dict) – Keyword arguments for the callback to call after slicing has finished, will be extended by _analysis, _error or _cancelled as described above! Defaults to an empty dictionary.

              • -

            • overrides (dict) – Overrides for the printer profile to apply.

              • +

            • overrides (dict) – Overrides for the printer profile to apply.

            • on_progress (callable) – Callback to call upon slicing progress.

              • -

            • on_progress_args (list or tuple) – Arguments of the progress callback. Defaults to an empty list.

              • -

            • on_progress_kwargs (dict) – Keyword arguments of the progress callback, will be extended by _progress +

            • on_progress_args (list or tuple) – Arguments of the progress callback. Defaults to an empty list.

              • +

            • on_progress_kwargs (dict) – Keyword arguments of the progress callback, will be extended by _progress as described above! Defaults to an empty dictionary.

              • -

            • printer_profile_id (str) – Identifier of the printer profile for which to slice, if another than the +

            • printer_profile_id (str) – Identifier of the printer profile for which to slice, if another than the one currently selected is to be used.

              • -

            • position (dict) – Dictionary containing the x and y coordinate in the print bed’s coordinate system +

            • position (dict) – Dictionary containing the x and y coordinate in the print bed’s coordinate system of the sliced model’s center. If not provided the model will be positioned at the print bed’s center. Example: dict(x=10,y=20).

            @@ -694,7 +694,7 @@
            Tags
            -
            1.9.2
            +
            1.9.3
            1.8.7
            diff --git a/maintenance/modules/util.html b/maintenance/modules/util.html index d394af679..91902848e 100644 --- a/maintenance/modules/util.html +++ b/maintenance/modules/util.html @@ -122,7 +122,7 @@

            Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

            @@ -181,7 +181,7 @@
            class octoprint.util.RepeatedTimer(interval, function, args=None, kwargs=None, run_first=False, condition=None, on_condition_false=None, on_cancelled=None, on_finish=None, daemon=True)

            This class represents an action that should be run repeatedly in an interval. It is similar to python’s -own threading.Timer class, but instead of only running once the function will be run again and again, +own threading.Timer class, but instead of only running once the function will be run again and again, sleeping the stated interval in between.

            RepeatedTimers are started, as with threads, by calling their start() method. The timer can be stopped (in between runs) by calling the cancel() method. The interval the time waited before execution of a loop may @@ -223,11 +223,11 @@

            Parameters
              -

            • interval (float or callable) – The interval between each function call, in seconds. Can also be a callable +

            • interval (float or callable) – The interval between each function call, in seconds. Can also be a callable returning the interval to use, in case the interval is not static.

            • function (callable) – The function to call.

              • -

            • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

              • -

            • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

              • +

            • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

              • +

            • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

            • run_first (boolean) – If set to True, the function will be run for the first time before the first wait period. If set to False (the default), the function will be run for the first time after the first wait period.

            • condition (callable) – Condition that needs to be True for loop to continue. Defaults to lambda: True.

              • @@ -237,7 +237,7 @@ before the on_finish callback.

            • on_finish (callable) – Callback to call when the timer finishes, either due to being cancelled or since the condition became false.

              • -

            • daemon (bool) – daemon flag to set on underlying thread.

              • +

            • daemon (bool) – daemon flag to set on underlying thread.

            @@ -257,7 +257,7 @@
            class octoprint.util.ResettableTimer(interval, function, args=None, kwargs=None, on_reset=None, on_cancelled=None, daemon=True)

            This class represents an action that should be run after a specified amount of time. It is similar to python’s -own threading.Timer class, with the addition of being able to reset the counter to zero.

            +own threading.Timer class, with the addition of being able to reset the counter to zero.

            ResettableTimers are started, as with threads, by calling their start() method. The timer can be stopped (in between runs) by calling the cancel() method. Resetting the counter can be done with the reset() method.

            For example:

            @@ -275,14 +275,14 @@
            Parameters
              -

            • interval (float or callable) – The interval before calling function, in seconds. Can also be a callable +

            • interval (float or callable) – The interval before calling function, in seconds. Can also be a callable returning the interval to use, in case the interval is not static.

            • function (callable) – The function to call.

              • -

            • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

              • -

            • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

              • +

            • args (list or tuple) – The arguments for the function call. Defaults to an empty list.

              • +

            • kwargs (dict) – The keyword arguments for the function call. Defaults to an empty dict.

            • on_cancelled (callable) – Callback to call when the timer finishes due to being cancelled.

            • on_reset (callable) – Callback to call when the timer is reset.

              • -

            • daemon (bool) – daemon flag to set on underlying thread.

              • +

            • daemon (bool) – daemon flag to set on underlying thread.

            @@ -359,7 +359,7 @@
            Parameters

            • message (string) – The message to include in the deprecation warning.

              • -

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

              • @@ -387,8 +387,8 @@
              Parameters
                -

              • filename (str) – The file to deserialize from

                • -

              • encoding (str) – The encoding to use for the file, defaults to utf-8

                • +

              • filename (str) – The file to deserialize from

                • +

              • encoding (str) – The encoding to use for the file, defaults to utf-8

              Returns
              @@ -415,8 +415,8 @@
              Parameters
                -

              • a (dict) – The dictionary to clean against b.

                • -

              • b (dict) – The dictionary containing the key structure to clean from a.

                • +

              • a (dict) – The dictionary to clean against b.

                • +

              • b (dict) – The dictionary containing the key structure to clean from a.

              @@ -443,8 +443,8 @@
              Parameters
                -

              • a (dict) – The dictionary to check for the keys from b.

                • -

              • b (dict) – The dictionary whose keys to check a for.

                • +

              • a (dict) – The dictionary to check for the keys from b.

                • +

              • b (dict) – The dictionary whose keys to check a for.

              Returns
              @@ -485,7 +485,7 @@
              Parameters
                -

              • dictionary (dict) – The dictionary to filter

                • +

              • dictionary (dict) – The dictionary to filter

              • filter_function (callable) – The filter function to apply, called with key and value of an entry in the dictionary, must return True for values to keep and False for values to strip

                • @@ -499,7 +499,7 @@

              Return type
              -

              dict

              +

              dict

            @@ -571,8 +571,8 @@
            Parameters
              -

            • a (dict) – The dictionary to merge b into

              • -

            • b (dict) – The dictionary to merge into a

              • +

            • a (dict) – The dictionary to merge b into

              • +

            • b (dict) – The dictionary to merge into a

            • leaf_merger (callable) – An optional callable to use to merge leaves (non-dict values)

            • in_place (boolean) – If set to True, a will be merged with b in place, meaning a will be modified

            @@ -581,7 +581,7 @@

            b deep-merged into a

            Return type
            -

            dict

            +

            dict

            @@ -604,8 +604,8 @@
            Parameters
              -

            • source (dict) – Source dictionary

              • -

            • target (dict) – Dictionary to compare to source dictionary and derive diff for

              • +

            • source (dict) – Source dictionary

              • +

            • target (dict) – Dictionary to compare to source dictionary and derive diff for

            Returns
            @@ -616,7 +616,7 @@

            Return type
            -

            dict

            +

            dict

          @@ -639,8 +639,8 @@
          Parameters
            -

          • a (dict) – The dictionary to clean against b.

            • -

          • b (dict) – The dictionary containing the key structure to clean from a.

            • +

          • a (dict) – The dictionary to clean against b.

            • +

          • b (dict) – The dictionary containing the key structure to clean from a.

          @@ -715,10 +715,10 @@

          The class if it could be found.

          Return type
          -

          type

          +

          type

          Raises
          -

          ImportError –

          +

          ImportError –

          @@ -744,7 +744,7 @@

          Formats a datetime instance as “YYYY-mm-dd HH:MM” and returns the resulting string.

          Parameters
          -

          d (datetime.datetime) – The datetime instance to format

          +

          d (datetime.datetime) – The datetime instance to format

          Returns

          The datetime formatted as “YYYY-mm-dd HH:MM”

          @@ -763,7 +763,7 @@

          Based on http://stackoverflow.com/a/1094933/2028598

          Parameters
          -

          num (int) – The byte count to format

          +

          num (int) – The byte count to format

          Returns

          The formatted byte count.

          @@ -780,7 +780,7 @@

          Formats a timedelta instance as “HH:MM:ss” and returns the resulting string.

          Parameters
          -

          d (datetime.timedelta) – The timedelta instance to format

          +

          d (datetime.timedelta) – The timedelta instance to format

          Returns

          The timedelta formatted as “HH:MM:ss”

          @@ -814,7 +814,7 @@
          Parameters

          • filename (string) – The file name to check against the extensions.

            • -

          • extensions (list) – The extensions to check against, a list of strings

            • +

          • extensions (list) – The extensions to check against, a list of strings

          Returns
          @@ -838,7 +838,7 @@
          Parameters

          • message (string) – The message to include in the deprecation warning.

            • -

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

          • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

            • @@ -894,10 +894,10 @@
            Parameters
              -

            • filename (str) – The file to write to

              • -

            • data (object) – The data to serialize

              • -

            • encoding (str) – The encoding to use for the file

              • -

            • compressed (bool) – Whether to compress the data before writing it to the file

              • +

            • filename (str) – The file to write to

              • +

            • data (object) – The data to serialize

              • +

            • encoding (str) – The encoding to use for the file

              • +

            • compressed (bool) – Whether to compress the data before writing it to the file

            @@ -905,28 +905,28 @@
            -octoprint.util.to_bytes(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes
            +octoprint.util.to_bytes(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes

            Make sure s_or_u is a byte string.

            Parameters
            Returns

            converted bytes.

            Return type
            -

            bytes

            +

            bytes

            -octoprint.util.to_native_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str
            +octoprint.util.to_native_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str

            Deprecated since version 1.8.0: to_native_str is no longer needed, use to_unicode instead

            @@ -934,7 +934,7 @@
            -octoprint.util.to_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes
            +octoprint.util.to_str(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → bytes

            Deprecated since version 1.3.11: to_str has been renamed to to_bytes and in a future version will become the new to_unicode

            @@ -942,21 +942,21 @@
            -octoprint.util.to_unicode(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str
            +octoprint.util.to_unicode(s_or_u: Union[str, bytes], encoding: str = 'utf-8', errors: str = 'strict') → str

            Make sure s_or_u is a string (str).

            Parameters
            Returns

            converted string.

            Return type
            -

            str

            +

            str

            @@ -971,7 +971,7 @@
            Parameters

            • message (string) – The message to include in the deprecation warning.

              • -

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

            • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

              • @@ -997,7 +997,7 @@
              Parameters

              • message (string) – The message to include in the deprecation warning.

                • -

              • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, +

              • stacklevel (int) – Stack level for including the caller of the offending method in the logged warning. Defaults to 1, meaning the direct caller of the method. It might make sense to increase this in case of the function call happening dynamically from a fixed position to not shadow the real caller (e.g. in case of overridden getattr methods).

                • @@ -1058,13 +1058,13 @@
    -call(command: Union[str, List[str], Tuple[str]], delimiter: bytes = b'\n', buffer_size: int = - 1, logged: bool = True, **kwargs) → Tuple[Optional[int], List[str], List[str]]
    +call(command: Union[str, List[str], Tuple[str]], delimiter: bytes = b'\n', buffer_size: int = - 1, logged: bool = True, **kwargs) → Tuple[Optional[int], List[str], List[str]]

    Calls a command

    Parameters
      -

    • command (list, tuple or str) – command to call

      • -

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, +

    • command (list, tuple or str) – command to call

      • +

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, stdout and stderr will be overwritten)

    @@ -1076,13 +1076,13 @@
    -checked_call(command: Union[str, List[str], Tuple[str]], **kwargs) → Tuple[int, List[str], List[str]]
    +checked_call(command: Union[str, List[str], Tuple[str]], **kwargs) → Tuple[int, List[str], List[str]]

    Calls a command and raises an error if it doesn’t return with return code 0

    Parameters
      -

    • command (list, tuple or str) – command to call

      • -

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, +

    • command (list, tuple or str) – command to call

      • +

    • kwargs (dict) – additional keyword arguments to pass to the sarge run call (note that _async, stdout and stderr will be overwritten)

    @@ -1122,9 +1122,9 @@
    Parameters
      -

    • returncode (int) – the return code of the command

      • -

    • stdout (str) – the stdout output produced by the command

      • -

    • stderr (str) – the stderr output produced by the command

      • +

    • returncode (int) – the return code of the command

      • +

    • stdout (str) – the stdout output produced by the command

      • +

    • stderr (str) – the stderr output produced by the command

    @@ -1137,7 +1137,7 @@
    -octoprint.util.commandline.clean_ansi(line: Union[str, bytes]) → Union[str, bytes]
    +octoprint.util.commandline.clean_ansi(line: Union[str, bytes]) → Union[str, bytes]

    Removes ANSI control codes from line.

    Note: This function also still supports an input of bytes, leading to an output of bytes. This if for reasons of backwards compatibility only, @@ -1145,7 +1145,7 @@ a future version of OctoPrint. A warning will be logged.

    Parameters
    -

    line (str or bytes) – the line to process

    +

    line (str or bytes) – the line to process

    Returns

    (str or bytes) The line without any ANSI control codes

    @@ -1235,7 +1235,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/concepts.html b/maintenance/plugins/concepts.html index c45e3cd11..172e90095 100644 --- a/maintenance/plugins/concepts.html +++ b/maintenance/plugins/concepts.html @@ -106,7 +106,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -137,7 +137,7 @@

    General Concepts

    -

    OctoPrint’s plugins are Python Packages which in their +

    OctoPrint’s plugins are Python Packages which in their top-level module define a bunch of control properties defining metadata (like name, version etc of the plugin) as well as information on how to initialize the plugin and into what parts of the system the plugin will actually plug in to perform its job.

    @@ -214,7 +214,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/controlproperties.html b/maintenance/plugins/controlproperties.html index 7c399a5bb..c13183187 100644 --- a/maintenance/plugins/controlproperties.html +++ b/maintenance/plugins/controlproperties.html @@ -103,7 +103,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -304,7 +304,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/distributing.html b/maintenance/plugins/distributing.html index f0bb3288e..23dc73342 100644 --- a/maintenance/plugins/distributing.html +++ b/maintenance/plugins/distributing.html @@ -109,7 +109,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -246,7 +246,7 @@

    Version management after the official plu
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/gettingstarted.html b/maintenance/plugins/gettingstarted.html index ca51034b9..59801131a 100644 --- a/maintenance/plugins/gettingstarted.html +++ b/maintenance/plugins/gettingstarted.html @@ -112,7 +112,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -253,7 +253,7 @@ up and ready to serve requests.

    You’ll also note that we are using self._logger for logging. Where did that one come from? OctoPrint’s plugin system injects a some useful objects into our plugin implementation classes, -one of those being a fully instantiated python logger ready to be +one of those being a fully instantiated python logger ready to be used by your plugin. As you can see in the log output above, that logger uses the namespace octoprint.plugins.helloworld for our little plugin here, or more generally octoprint.plugins.<plugin identifier>.

    @@ -1119,7 +1119,7 @@

    Where do we go from here?
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/helpers.html b/maintenance/plugins/helpers.html index 1c609dbce..aa3e18e11 100644 --- a/maintenance/plugins/helpers.html +++ b/maintenance/plugins/helpers.html @@ -103,7 +103,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -234,7 +234,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/hooks.html b/maintenance/plugins/hooks.html index 70ca5e5a9..475d18976 100644 --- a/maintenance/plugins/hooks.html +++ b/maintenance/plugins/hooks.html @@ -157,7 +157,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -580,7 +580,7 @@
    Parameters
      -

    • components (dict) – System components to use for user manager instance initialization

      • +

    • components (dict) – System components to use for user manager instance initialization

    • settings (SettingsManager) – The global settings manager instance to fetch configuration values from if necessary

    @@ -631,7 +631,7 @@
    Parameters
    -

    apikey (str) – The API key to validate

    +

    apikey (str) – The API key to validate

    Returns

    The user in whose name the request will be processed further

    @@ -793,7 +793,7 @@ OctoPrint’s CLI.

    Return type
    -

    list

    +

    list

    @@ -827,9 +827,9 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • firmware_name (str) – The parsed name of the firmware

      • -

    • firmware_data (dict) – All data contained in the M115 report

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • firmware_name (str) – The parsed name of the firmware

      • +

    • firmware_data (dict) – All data contained in the M115 report

    @@ -858,10 +858,10 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • capability (str) – The name of the parsed capability

      • -

    • enabled (bool) – Whether the capability is reported as enabled or disabled

      • -

    • already_defined (dict) – Already defined capabilities (capability name mapped to enabled flag)

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • capability (str) – The name of the parsed capability

      • +

    • enabled (bool) – Whether the capability is reported as enabled or disabled

      • +

    • already_defined (dict) – Already defined capabilities (capability name mapped to enabled flag)

    @@ -888,8 +888,8 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • firmware_capabilities (dict) – Reported capabilities (capability name mapped to enabled flag)

      • +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • firmware_capabilities (dict) – Reported capabilities (capability name mapped to enabled flag)

    @@ -947,13 +947,13 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • line (str) – The complete line as received from the printer, format // action:<command>

      • -

    • action (str) – The parsed out action command incl. parameters, so for a line like // action:some_command key value this will be +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • line (str) – The complete line as received from the printer, format // action:<command>

      • +

    • action (str) – The parsed out action command incl. parameters, so for a line like // action:some_command key value this will be some_command key value

      • -

    • name (str) – The action command name, for a line like // action:some_command key value this will be +

    • name (str) – The action command name, for a line like // action:some_command key value this will be some_command

      • -

    • params (str) – The action command’s parameter, for a line like // action:some_command key value this will +

    • params (str) – The action command’s parameter, for a line like // action:some_command key value this will be key value

    @@ -1020,11 +1020,11 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • phase (str) – The current phase in the command progression, either queuing or sending. Will always +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • phase (str) – The current phase in the command progression, either queuing or sending. Will always match the <phase> of the hook.

      • -

    • cmd (str) – The @ command without the leading @

      • -

    • parameters (str) – Any parameters provided to the @ command. If none were provided this will be an empty string.

      • +

    • cmd (str) – The @ command without the leading @

      • +

    • parameters (str) – Any parameters provided to the @ command. If none were provided this will be an empty string.

    @@ -1203,15 +1203,15 @@
    Parameters
      -

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • -

    • phase (str) – The current phase in the command progression, either queuing, queued, sending or +

    • comm_instance (object) – The MachineCom instance which triggered the hook.

      • +

    • phase (str) – The current phase in the command progression, either queuing, queued, sending or sent. Will always match the <phase> of the hook.

      • -

    • cmd (str) – The GCODE command for which the hook was triggered. This is the full command as taken either +

    • cmd (str) – The GCODE command for which the hook was triggered. This is the full command as taken either from the currently streamed GCODE file or via other means (e.g. user input our status polling).

      • -

    • cmd_type (str) – Type of command, e.g. temperature_poll for temperature polling or sd_status_poll for SD +

    • cmd_type (str) – Type of command, e.g. temperature_poll for temperature polling or sd_status_poll for SD printing status polling.

      • -

    • gcode (str) – Parsed GCODE command, e.g. G0 or M110, may also be None if no known command could be parsed

      • -

    • subcode (str) – Parsed subcode of the GCODE command, e.g. 1 for M80.1. Will be None if no subcode was provided +

    • gcode (str) – Parsed GCODE command, e.g. G0 or M110, may also be None if no known command could be parsed

      • +

    • subcode (str) – Parsed subcode of the GCODE command, e.g. 1 for M80.1. Will be None if no subcode was provided or no command could be parsed.

    • tags – Tags attached to the command

    @@ -1274,14 +1274,14 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • line (str) – The line received from the printer.

      • +

    • line (str) – The line received from the printer.

    Returns

    The received line or in any case, a modified version of it.

    Return type
    -

    str

    +

    str

    @@ -1334,14 +1334,14 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • error_message (str) – The error message received from the printer.

      • +

    • error_message (str) – The error message received from the printer.

    Returns

    True if the error was handled in the plugin and should not be processed further, False (or None) otherwise.

    Return type
    -

    bool

    +

    bool

    @@ -1413,15 +1413,15 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • script_type (str) – The type of the script for which the hook was called, currently only “gcode” is supported here.

      • -

    • script_name (str) – The name of the script for which the hook was called.

      • +

    • script_type (str) – The type of the script for which the hook was called, currently only “gcode” is supported here.

      • +

    • script_name (str) – The name of the script for which the hook was called.

    Returns

    A 2-tuple in the form (prefix, postfix), 3-tuple in the form (prefix, postfix, variables), or None

    Return type
    -

    tuple or None

    +

    tuple or None

    @@ -1487,13 +1487,13 @@

    For an example of use see the bundled virtual_printer plugin.

    Parameters
    -

    candidates (list) – The port names already found on the system available for connection.

    +

    candidates (list) – The port names already found on the system available for connection.

    Returns

    Additional port names to offer up for connection.

    Return type
    -

    list

    +

    list

    @@ -1564,11 +1564,11 @@
    Parameters

    • comm_instance (MachineCom) – The MachineCom instance which triggered the hook.

      • -

    • port (str) – The port for which to construct a serial instance. May be None or AUTO in which case port +

    • port (str) – The port for which to construct a serial instance. May be None or AUTO in which case port auto detection is to be performed.

      • -

    • baudrate (int) – The baudrate for which to construct a serial instance. May be 0 in which case baudrate auto +

    • baudrate (int) – The baudrate for which to construct a serial instance. May be 0 in which case baudrate auto detection is to be performed.

      • -

    • read_timeout (int) – The read timeout to set on the serial port.

      • +

    • read_timeout (int) – The read timeout to set on the serial port.

    Returns
    @@ -1607,7 +1607,7 @@

    A list of custom events to register

    Return type
    -

    list

    +

    list

    @@ -1646,7 +1646,7 @@

    A dictionary of analysis queue factories, mapped by their targeted file type.

    Return type
    -

    dict

    +

    dict

    @@ -1685,7 +1685,7 @@

    The partial extension tree to merge with the full extension tree.

    Return type
    -

    dict

    +

    dict

    @@ -1748,11 +1748,11 @@
    Parameters
      -

    • path (str) – The path on storage the file_object is to be stored

      • +

    • path (str) – The path on storage the file_object is to be stored

    • file_object (AbstractFileWrapper) – The AbstractFileWrapper instance representing the file object to store.

      • -

    • links (dict) – The links that are going to be stored with the file.

      • -

    • printer_profile (dict) – The printer profile associated with the file.

      • +

    • links (dict) – The links that are going to be stored with the file.

      • +

    • printer_profile (dict) – The printer profile associated with the file.

    • allow_overwrite (boolean) – Whether to allow overwriting an existing file named the same or not.

    @@ -1843,7 +1843,7 @@

    Additional data to include

    Return type
    -

    dict

    +

    dict

    @@ -1878,7 +1878,7 @@ class will be instantiated.

    Parameters
    -

    components (dict) – System components to use for printer instance initialization

    +

    components (dict) – System components to use for printer instance initialization

    Returns

    The printer instance to use globally.

    @@ -2035,9 +2035,9 @@
    Parameters
      -

    • printer (object) – the PrinterInterface instance the hook was called from

      • -

    • filename (str) – filename on the local storage

      • -

    • path (str) – path of the file in the local file system

      • +

    • printer (object) – the PrinterInterface instance the hook was called from

      • +

    • filename (str) – filename on the local storage

      • +

    • path (str) – path of the file in the local file system

    • sd_upload_started (function) – callback for when the upload started

    • sd_upload_success (function) – callback for successful finish of upload

    • sd_upload_failure (function) – callback for failure of upload

      • @@ -2183,13 +2183,13 @@
      Parameters
      -

      current_max_body_sizes (list) – read-only list of the currently configured maximum body sizes

      +

      current_max_body_sizes (list) – read-only list of the currently configured maximum body sizes

      Returns

      A list of 3-tuples with additional request specific maximum body sizes as defined above

      Return type
      -

      list

      +

      list

    @@ -2286,13 +2286,13 @@
    Parameters
    -

    server_routes (list) – read-only list of the currently configured server routes

    +

    server_routes (list) – read-only list of the currently configured server routes

    Returns

    a list of 3-tuples with additional routes as defined above

    Return type
    -

    list

    +

    list

    @@ -2310,8 +2310,8 @@
    Parameters
      -

    • socket (object) – the socket object which is about to be registered

      • -

    • user (object) – the user that got authenticated on the socket, or None if the user got deauthenticated

      • +

    • socket (object) – the socket object which is about to be registered

      • +

    • user (object) – the user that got authenticated on the socket, or None if the user got deauthenticated

    @@ -2332,8 +2332,8 @@
    Parameters
      -

    • socket (object) – the socket object which is about to be registered

      • -

    • user (object) – the user currently authenticated on the socket - might be None

      • +

    • socket (object) – the socket object which is about to be registered

      • +

    • user (object) – the user currently authenticated on the socket - might be None

    Returns
    @@ -2359,10 +2359,10 @@
    Parameters
      -

    • socket (object) – the socket object on which a message is about to be emitted

      • -

    • user (object) – the user currently authenticated on the socket - might be None

      • +

    • socket (object) – the socket object on which a message is about to be emitted

      • +

    • user (object) – the user currently authenticated on the socket - might be None

    • message (string) – the message type about to be emitted

      • -

    • payload (dict) – the payload of the message about to be emitted (may be None)

      • +

    • payload (dict) – the payload of the message about to be emitted (may be None)

    Returns
    @@ -2463,7 +2463,7 @@

    a list of command specifications

    Return type
    -

    list

    +

    list

    @@ -2497,7 +2497,7 @@

    a dictionary mapping bundle file names to bundle file content

    Return type
    -

    dict

    +

    dict

    @@ -2528,7 +2528,7 @@

    a list of additional file extensions

    Return type
    -

    list

    +

    list

    @@ -2704,15 +2704,15 @@
    Parameters
      -

    • template_rules (dict) – read-only dictionary of currently configured template rules

      • -

    • template_sorting (dict) – read-only dictionary of currently configured template sorting specifications

      • +

    • template_rules (dict) – read-only dictionary of currently configured template rules

      • +

    • template_sorting (dict) – read-only dictionary of currently configured template sorting specifications

    Returns

    a list of 3-tuples (template type, rule, sorting spec)

    Return type
    -

    list

    +

    list

    @@ -2770,7 +2770,7 @@

    filename will be the future path of the frame to be saved.

    Parameters
    -

    filename (str) – The future path of the frame to be saved.

    +

    filename (str) – The future path of the frame to be saved.

    Returns

    None

    @@ -2796,7 +2796,7 @@
    Parameters
      -

    • filename (str) – The path of the frame that should have been saved.

      • +

    • filename (str) – The path of the frame that should have been saved.

    • success (boolean) – Indicates whether the capture was successful or not.

    @@ -2847,7 +2847,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/index.html b/maintenance/plugins/index.html index cdc0e1f60..aa6055c43 100644 --- a/maintenance/plugins/index.html +++ b/maintenance/plugins/index.html @@ -103,7 +103,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -301,7 +301,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/injectedproperties.html b/maintenance/plugins/injectedproperties.html index 95bb52cb0..9db292007 100644 --- a/maintenance/plugins/injectedproperties.html +++ b/maintenance/plugins/injectedproperties.html @@ -103,7 +103,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -152,7 +152,7 @@ data files etc). Plugins should not access this property directly but instead utilize get_plugin_data_folder() which will make sure the path actually does exist and if not create it before returning it.

    -
    self._logger

    A logging.Logger instance logging to the log target +

    self._logger

    A logging.Logger instance logging to the log target octoprint.plugin.<plugin identifier>.

    self._settings

    The plugin’s personalized settings manager, injected only into plugins that include the SettingsPlugin mixin. @@ -222,7 +222,7 @@

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/mixins.html b/maintenance/plugins/mixins.html index 4bf41c71a..c0b9e5951 100644 --- a/maintenance/plugins/mixins.html +++ b/maintenance/plugins/mixins.html @@ -126,7 +126,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -628,9 +628,9 @@
    Parameters
      -

    • event (str) – The type of event that got fired, see the list of events +

    • event (str) – The type of event that got fired, see the list of events for possible values

      • -

    • payload (dict) – The payload as provided with the event

      • +

    • payload (dict) – The payload as provided with the event

    @@ -656,7 +656,7 @@

    • storage (string) – Location of the file

    • path (string) – Path of the file

      • -

    • progress (int) – Current progress as a value between 0 and 100

      • +

    • progress (int) – Current progress as a value between 0 and 100

    @@ -674,7 +674,7 @@

  • source_path (string) – Path of the source file

  • destination_location (string) – Location the destination file

  • destination_path (string) – Path of the destination file

    • -

  • progress (int) – Current progress as a value between 0 and 100

    • +

  • progress (int) – Current progress as a value between 0 and 100

    • @@ -808,7 +808,7 @@ getters, the second the preprocessors for setters

    Return type
    -

    (dict, dict)

    +

    (dict, dict)

    @@ -900,7 +900,7 @@ plugin’s configuration.

    Return type
    -

    int or None

    +

    int or None

    @@ -966,9 +966,9 @@
    Parameters
      -

    • target (int) – The settings format version the plugin requires, this should always be the same value as +

    • target (int) – The settings format version the plugin requires, this should always be the same value as returned by get_settings_version().

      • -

    • current (int or None) – The settings format version as currently stored in config.yaml. May be None if +

    • current (int or None) – The settings format version as currently stored in config.yaml. May be None if no version information can be found.

    @@ -992,13 +992,13 @@
    Parameters
    -

    data (dict) – The settings dictionary to be saved for the plugin

    +

    data (dict) – The settings dictionary to be saved for the plugin

    Returns

    The settings that differed from the defaults and were actually saved.

    Return type
    -

    dict

    +

    dict

    @@ -1138,7 +1138,7 @@
    Parameters

    • command (string) – the command with which the resource was called

      • -

    • data (dict) – the full request body of the POST request parsed from JSON into a Python dictionary

      • +

    • data (dict) – the full request body of the POST request parsed from JSON into a Python dictionary

    Returns
    @@ -1184,7 +1184,7 @@

    Cancels the slicing to the indicated file.

    Parameters
    -

    machinecode_path (str) – The absolute path to the machine code file to which to stop slicing to.

    +

    machinecode_path (str) – The absolute path to the machine code file to which to stop slicing to.

    @@ -1217,7 +1217,7 @@ should make sure to track the started jobs via the machinecode_path, if provided.

    The method should return a 2-tuple consisting of a boolean flag indicating whether the slicing job was finished successfully (True) or not (False) and a result depending on the success of the slicing job.

    -

    For jobs that finished successfully, result should be a dict containing additional information +

    For jobs that finished successfully, result should be a dict containing additional information about the slicing job under the following keys:

    analysis

    Analysis result of the generated machine code as returned by the slicer itself. This should match the @@ -1225,7 +1225,7 @@ GcodeAnalysisQueue for GCODE files.

    -

    For jobs that did not finish successfully (but not due to being cancelled!), result should be a str +

    For jobs that did not finish successfully (but not due to being cancelled!), result should be a str containing a human readable reason for the error.

    If the job gets cancelled, a SlicingCancelled exception should be raised.

    @@ -1233,7 +1233,7 @@

    A 2-tuple (boolean, object) as outlined above.

    Return type
    -

    tuple

    +

    tuple

    Raises

    SlicingCancelled – The slicing job was cancelled (via cancel_slicing()).

    @@ -1280,7 +1280,7 @@ indicated path.

    Parameters
    -

    path (str) – The absolute path from which to read the slicing profile.

    +

    path (str) – The absolute path from which to read the slicing profile.

    Returns

    The specified slicing profile.

    @@ -1300,7 +1300,7 @@ of the plugin implementation.

    Parameters
    -

    profile_path (str) – The base folder where OctoPrint stores this slicer plugin’s profiles

    +

    profile_path (str) – The base folder where OctoPrint stores this slicer plugin’s profiles

    @@ -1347,7 +1347,7 @@

    A dict describing the slicer as outlined above.

    Return type
    -

    dict

    +

    dict

    @@ -1366,16 +1366,16 @@ save_slicer_profile(path, profile, allow_overwrite=True, overrides=None)

    Should save the provided SlicingProfile to the indicated path, after applying any supplied overrides. If a profile is already saved under the indicated path and allow_overwrite is -set to False (defaults to True), an IOError should be raised.

    +set to False (defaults to True), an IOError should be raised.

    Parameters
      -

    • path (str) – The absolute path to which to save the profile.

      • +

    • path (str) – The absolute path to which to save the profile.

    • profile (SlicingProfile) – The profile to save.

    • allow_overwrite (boolean) – Whether to allow to overwrite an existing profile at the indicated path (True, default) or not (False). If a profile already exists on the path and this is False an -IOError should be raised.

      • -

    • overrides (dict) – Profile overrides to apply to the profile before saving it

      • +IOError should be raised.

      +

    • overrides (dict) – Profile overrides to apply to the profile before saving it

    @@ -1423,7 +1423,7 @@
    Parameters

    • host (string) – the host the server will listen on, may be 0.0.0.0

      • -

    • port (int) – the port the server will listen on

      • +

    • port (int) – the port the server will listen on

    @@ -1922,13 +1922,13 @@ via the parameter default_additional).

    Parameters
    -

    default_additional (list) – The list of default fields added to the ETag of the default UI

    +

    default_additional (list) – The list of default fields added to the ETag of the default UI

    Returns

    A list of additional fields for the ETag generation, or None

    Return type
    -

    (list)

    +

    (list)

    @@ -1950,7 +1950,7 @@

    Return type
    -

    list, tuple

    +

    list, tuple

    @@ -1975,7 +1975,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -1998,7 +1998,7 @@

    Return type
    -

    list

    +

    list

    @@ -2016,7 +2016,7 @@

    An alternatively calculated ETag value. Ignored if None is returned (default).

    Return type
    -

    str

    +

    str

    @@ -2034,7 +2034,7 @@

    An alternatively calculated LastModified value. Ignored if None is returned (default).

    Return type
    -

    int

    +

    int

    @@ -2079,7 +2079,7 @@

    Return type
    -

    list

    +

    list

    @@ -2097,7 +2097,7 @@

    Additional data to persist in the preemptive cache configuration.

    Return type
    -

    dict

    +

    dict

    @@ -2135,7 +2135,7 @@

    Whether to suppress a record (True) or not (False, default)

    Return type
    -

    bool

    +

    bool

    @@ -2154,7 +2154,7 @@

    Whether to enable preemptive caching (True, default) or not (False)

    Return type
    -

    bool

    +

    bool

    @@ -2255,12 +2255,12 @@
    Parameters
      -

    • now (datetime.datetime) – The datetime instance representing “now” +

    • now (datetime.datetime) – The datetime instance representing “now” for this request, in case your plugin implementation needs this information.

    • request (flask.Request) –

      A Flask Request object.

      • -

    • render_kwargs (dict) – The (cached) render keyword arguments that +

    • render_kwargs (dict) – The (cached) render keyword arguments that would usually be provided to the core UI render function.

    @@ -2303,7 +2303,7 @@

    Return type
    -

    bool

    +

    bool

    @@ -2433,7 +2433,7 @@

    Return type
    -

    dict

    +

    dict

    @@ -2459,7 +2459,7 @@

    Return type
    -

    int or None

    +

    int or None

    @@ -2491,11 +2491,11 @@
    Parameters
      -

    • seen_wizards (dict) – A dictionary with information about already seen +

    • seen_wizards (dict) – A dictionary with information about already seen wizards and their versions. Mappings from the identifiers of the plugin providing the wizard to the reported wizard version (int or None) that was already seen by the user.

      • -

    • implementation (object) – The plugin implementation to check.

      • +

    • implementation (object) – The plugin implementation to check.

    Returns
    @@ -2506,7 +2506,7 @@

    Return type
    -

    bool

    +

    bool

    @@ -2535,7 +2535,7 @@

    Use this to do any clean up tasks necessary after wizard completion.

    Parameters
    -

    handled (bool) – True if the plugin’s wizard was previously reported as +

    handled (bool) – True if the plugin’s wizard was previously reported as required, not ignored and thus presented to the user, False otherwise

    @@ -2582,7 +2582,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/python3_migration.html b/maintenance/plugins/python3_migration.html index 50bb240fc..51f0c2b35 100644 --- a/maintenance/plugins/python3_migration.html +++ b/maintenance/plugins/python3_migration.html @@ -117,7 +117,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -490,7 +490,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/plugins/viewmodels.html b/maintenance/plugins/viewmodels.html index cd80f53ad..000072047 100644 --- a/maintenance/plugins/viewmodels.html +++ b/maintenance/plugins/viewmodels.html @@ -113,7 +113,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -594,7 +594,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/py-modindex.html b/maintenance/py-modindex.html index 263d5ffb0..9cf56cdbb 100644 --- a/maintenance/py-modindex.html +++ b/maintenance/py-modindex.html @@ -91,7 +91,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -414,7 +414,7 @@

    Python Module Index

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/maintenance/search.html b/maintenance/search.html index 4f73fcf12..755d6ce64 100644 --- a/maintenance/search.html +++ b/maintenance/search.html @@ -91,7 +91,7 @@

    Note: - These are not the docs of the latest released version. Those can be found here. + These are not the docs of the latest released version. Those can be found here.

    @@ -159,7 +159,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/access.html b/master/api/access.html index c75e625e5..900b6ceb3 100644 --- a/master/api/access.html +++ b/master/api/access.html @@ -940,7 +940,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/connection.html b/master/api/connection.html index bf68fc23b..183189e59 100644 --- a/master/api/connection.html +++ b/master/api/connection.html @@ -341,7 +341,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/datamodel.html b/master/api/datamodel.html index 249aad3c2..5688022e0 100644 --- a/master/api/datamodel.html +++ b/master/api/datamodel.html @@ -1254,7 +1254,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/files.html b/master/api/files.html index 009e8c32d..fe04582e2 100644 --- a/master/api/files.html +++ b/master/api/files.html @@ -1124,7 +1124,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/general.html b/master/api/general.html index 1fd007244..11a13464b 100644 --- a/master/api/general.html +++ b/master/api/general.html @@ -496,7 +496,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/index.html b/master/api/index.html index 68a27a476..bfb77250b 100644 --- a/master/api/index.html +++ b/master/api/index.html @@ -308,7 +308,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/job.html b/master/api/job.html index 71c284a5c..375289a65 100644 --- a/master/api/job.html +++ b/master/api/job.html @@ -443,7 +443,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/languages.html b/master/api/languages.html index dfd429d0d..4a7d76621 100644 --- a/master/api/languages.html +++ b/master/api/languages.html @@ -459,7 +459,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/logs.html b/master/api/logs.html index bcef0161a..8a6536794 100644 --- a/master/api/logs.html +++ b/master/api/logs.html @@ -179,7 +179,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/printer.html b/master/api/printer.html index 16e7baaf0..aec643438 100644 --- a/master/api/printer.html +++ b/master/api/printer.html @@ -1486,7 +1486,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/printerprofiles.html b/master/api/printerprofiles.html index 8a5f243e8..3677d580a 100644 --- a/master/api/printerprofiles.html +++ b/master/api/printerprofiles.html @@ -868,7 +868,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/push.html b/master/api/push.html index 518857267..10156e2de 100644 --- a/master/api/push.html +++ b/master/api/push.html @@ -554,7 +554,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/server.html b/master/api/server.html index 9d4719624..896e0864d 100644 --- a/master/api/server.html +++ b/master/api/server.html @@ -209,7 +209,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/settings.html b/master/api/settings.html index 12dbe3965..d978c9542 100644 --- a/master/api/settings.html +++ b/master/api/settings.html @@ -627,7 +627,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/slicing.html b/master/api/slicing.html index d894d21d1..32a2ffaf8 100644 --- a/master/api/slicing.html +++ b/master/api/slicing.html @@ -681,7 +681,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/system.html b/master/api/system.html index 2ac69b1ab..8b70bb840 100644 --- a/master/api/system.html +++ b/master/api/system.html @@ -487,7 +487,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/timelapse.html b/master/api/timelapse.html index 96ea1eb03..ee56d70ad 100644 --- a/master/api/timelapse.html +++ b/master/api/timelapse.html @@ -562,7 +562,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/util.html b/master/api/util.html index e07f52dcf..9ab63302e 100644 --- a/master/api/util.html +++ b/master/api/util.html @@ -761,7 +761,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/version.html b/master/api/version.html index 3079446eb..225e65c24 100644 --- a/master/api/version.html +++ b/master/api/version.html @@ -206,7 +206,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/api/wizard.html b/master/api/wizard.html index 62eff9c5d..8a949b46f 100644 --- a/master/api/wizard.html +++ b/master/api/wizard.html @@ -276,7 +276,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/action_command_notification.html b/master/bundledplugins/action_command_notification.html index 08ae59d14..413c65351 100644 --- a/master/bundledplugins/action_command_notification.html +++ b/master/bundledplugins/action_command_notification.html @@ -220,7 +220,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/action_command_prompt.html b/master/bundledplugins/action_command_prompt.html index 8ed3837d4..a16c6698f 100644 --- a/master/bundledplugins/action_command_prompt.html +++ b/master/bundledplugins/action_command_prompt.html @@ -256,7 +256,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/announcements.html b/master/bundledplugins/announcements.html index 1d2d0cd82..a4786216f 100644 --- a/master/bundledplugins/announcements.html +++ b/master/bundledplugins/announcements.html @@ -231,7 +231,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/appkeys.html b/master/bundledplugins/appkeys.html index 7dfc90e4b..702da1e6f 100644 --- a/master/bundledplugins/appkeys.html +++ b/master/bundledplugins/appkeys.html @@ -993,7 +993,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/backup.html b/master/bundledplugins/backup.html index cd15bbd10..868f94305 100644 --- a/master/bundledplugins/backup.html +++ b/master/bundledplugins/backup.html @@ -505,7 +505,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/discovery.html b/master/bundledplugins/discovery.html index 6bf1c07bd..e3ab65c33 100644 --- a/master/bundledplugins/discovery.html +++ b/master/bundledplugins/discovery.html @@ -319,7 +319,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/errortracking.html b/master/bundledplugins/errortracking.html index 077f54578..d5b44d29f 100644 --- a/master/bundledplugins/errortracking.html +++ b/master/bundledplugins/errortracking.html @@ -205,7 +205,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/file_check.html b/master/bundledplugins/file_check.html index b63063256..7039d1f01 100644 --- a/master/bundledplugins/file_check.html +++ b/master/bundledplugins/file_check.html @@ -175,7 +175,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/firmware_check.html b/master/bundledplugins/firmware_check.html index 192494135..cbfc03328 100644 --- a/master/bundledplugins/firmware_check.html +++ b/master/bundledplugins/firmware_check.html @@ -176,7 +176,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/gcodeviewer.html b/master/bundledplugins/gcodeviewer.html index a69dd5fe2..c7220f28b 100644 --- a/master/bundledplugins/gcodeviewer.html +++ b/master/bundledplugins/gcodeviewer.html @@ -203,7 +203,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/index.html b/master/bundledplugins/index.html index 2daa7e5b7..c4d7b5084 100644 --- a/master/bundledplugins/index.html +++ b/master/bundledplugins/index.html @@ -261,7 +261,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/logging.html b/master/bundledplugins/logging.html index 9daaa028d..a390d55c6 100644 --- a/master/bundledplugins/logging.html +++ b/master/bundledplugins/logging.html @@ -462,7 +462,7 @@

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/pluginmanager.html b/master/bundledplugins/pluginmanager.html index 3a2c4a567..6ad2521f7 100644 --- a/master/bundledplugins/pluginmanager.html +++ b/master/bundledplugins/pluginmanager.html @@ -342,7 +342,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/softwareupdate.html b/master/bundledplugins/softwareupdate.html index c80a3ed03..03a1949b5 100644 --- a/master/bundledplugins/softwareupdate.html +++ b/master/bundledplugins/softwareupdate.html @@ -863,7 +863,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/tracking.html b/master/bundledplugins/tracking.html index 18d006e88..1cb3b5b4c 100644 --- a/master/bundledplugins/tracking.html +++ b/master/bundledplugins/tracking.html @@ -213,7 +213,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/bundledplugins/virtual_printer.html b/master/bundledplugins/virtual_printer.html index 10be505e2..13cd90da4 100644 --- a/master/bundledplugins/virtual_printer.html +++ b/master/bundledplugins/virtual_printer.html @@ -191,7 +191,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/configuration/cli.html b/master/configuration/cli.html index 3a5ac04ba..36b311a85 100644 --- a/master/configuration/cli.html +++ b/master/configuration/cli.html @@ -257,7 +257,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/configuration/config_yaml.html b/master/configuration/config_yaml.html index 038b4c65e..1270b6f0d 100644 --- a/master/configuration/config_yaml.html +++ b/master/configuration/config_yaml.html @@ -1348,7 +1348,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/configuration/index.html b/master/configuration/index.html index 15e95c90f..ba0c8bbe3 100644 --- a/master/configuration/index.html +++ b/master/configuration/index.html @@ -198,7 +198,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/configuration/logging_yaml.html b/master/configuration/logging_yaml.html index 6ee9209ca..c287e9b49 100644 --- a/master/configuration/logging_yaml.html +++ b/master/configuration/logging_yaml.html @@ -250,7 +250,7 @@

    Changing logging formatters
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/configuration/yaml.html b/master/configuration/yaml.html index 20458ad4f..671c246be 100644 --- a/master/configuration/yaml.html +++ b/master/configuration/yaml.html @@ -344,7 +344,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/development/branches.html b/master/development/branches.html index 4294431ea..1f8fd88cc 100644 --- a/master/development/branches.html +++ b/master/development/branches.html @@ -229,7 +229,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/development/environment.html b/master/development/environment.html index 42813af27..3f7a0cebe 100644 --- a/master/development/environment.html +++ b/master/development/environment.html @@ -592,7 +592,7 @@

    Visual Studio Code (vscode)
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/development/index.html b/master/development/index.html index b6afa482e..4a6fcbaa9 100644 --- a/master/development/index.html +++ b/master/development/index.html @@ -191,7 +191,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/development/request-profiling.html b/master/development/request-profiling.html index 42a67b40d..83443f658 100644 --- a/master/development/request-profiling.html +++ b/master/development/request-profiling.html @@ -176,7 +176,7 @@

    Errors
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/development/versioning.html b/master/development/versioning.html index c77917704..08dcf8b17 100644 --- a/master/development/versioning.html +++ b/master/development/versioning.html @@ -184,7 +184,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/development/virtual_printer.html b/master/development/virtual_printer.html index d00155e2f..0b0d3ef41 100644 --- a/master/development/virtual_printer.html +++ b/master/development/virtual_printer.html @@ -465,7 +465,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/events/index.html b/master/events/index.html index 9eebcf4ba..6a8f8c22a 100644 --- a/master/events/index.html +++ b/master/events/index.html @@ -1209,7 +1209,7 @@

    Example
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/features/accesscontrol.html b/master/features/accesscontrol.html index 3d1cf6d2e..2f2cf888d 100644 --- a/master/features/accesscontrol.html +++ b/master/features/accesscontrol.html @@ -389,7 +389,7 @@

    If you are using a VPN and your setup ABSOLUTELY REQUIRES disabling internal
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/features/action_commands.html b/master/features/action_commands.html index 8a962c733..58cfefa45 100644 --- a/master/features/action_commands.html +++ b/master/features/action_commands.html @@ -238,7 +238,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/features/atcommands.html b/master/features/atcommands.html index b4e7274f1..e91770956 100644 --- a/master/features/atcommands.html +++ b/master/features/atcommands.html @@ -185,7 +185,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/features/custom_controls.html b/master/features/custom_controls.html index 14015393d..972989106 100644 --- a/master/features/custom_controls.html +++ b/master/features/custom_controls.html @@ -507,7 +507,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/features/gcode_scripts.html b/master/features/gcode_scripts.html index d592a41cb..72d6af9d4 100644 --- a/master/features/gcode_scripts.html +++ b/master/features/gcode_scripts.html @@ -451,7 +451,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/features/index.html b/master/features/index.html index 8da9bd020..80d0e3cdf 100644 --- a/master/features/index.html +++ b/master/features/index.html @@ -200,7 +200,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/features/plugins.html b/master/features/plugins.html index 4ecf05cf0..d837dc18f 100644 --- a/master/features/plugins.html +++ b/master/features/plugins.html @@ -232,7 +232,7 @@

    Manual Installation
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/features/safemode.html b/master/features/safemode.html index ef156b1c6..c46f28c71 100644 --- a/master/features/safemode.html +++ b/master/features/safemode.html @@ -257,7 +257,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/genindex.html b/master/genindex.html index f00383e91..8de236d8a 100644 --- a/master/genindex.html +++ b/master/genindex.html @@ -3853,7 +3853,7 @@

    Z

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/http-routingtable.html b/master/http-routingtable.html index 8b736e100..e16a59ef3 100644 --- a/master/http-routingtable.html +++ b/master/http-routingtable.html @@ -565,7 +565,7 @@

    HTTP Routing Table

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/index.html b/master/index.html index bc40b82e4..92d0bd364 100644 --- a/master/index.html +++ b/master/index.html @@ -307,7 +307,7 @@

    Contents
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/base.html b/master/jsclientlib/base.html index 3a9d8a84c..94142f06d 100644 --- a/master/jsclientlib/base.html +++ b/master/jsclientlib/base.html @@ -775,7 +775,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/browser.html b/master/jsclientlib/browser.html index 555d1a4ee..e7e9dfef4 100644 --- a/master/jsclientlib/browser.html +++ b/master/jsclientlib/browser.html @@ -251,7 +251,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/connection.html b/master/jsclientlib/connection.html index 7b0c4a872..ee656dc6b 100644 --- a/master/jsclientlib/connection.html +++ b/master/jsclientlib/connection.html @@ -252,7 +252,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/control.html b/master/jsclientlib/control.html index 68d1e4b2e..16921e4f4 100644 --- a/master/jsclientlib/control.html +++ b/master/jsclientlib/control.html @@ -268,7 +268,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/files.html b/master/jsclientlib/files.html index f14a2a653..9e743045d 100644 --- a/master/jsclientlib/files.html +++ b/master/jsclientlib/files.html @@ -526,7 +526,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/index.html b/master/jsclientlib/index.html index ecc530f43..3e47b8a49 100644 --- a/master/jsclientlib/index.html +++ b/master/jsclientlib/index.html @@ -273,7 +273,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/job.html b/master/jsclientlib/job.html index 8a7c23385..176294b27 100644 --- a/master/jsclientlib/job.html +++ b/master/jsclientlib/job.html @@ -304,7 +304,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/languages.html b/master/jsclientlib/languages.html index 16b918d8a..b84ebebab 100644 --- a/master/jsclientlib/languages.html +++ b/master/jsclientlib/languages.html @@ -235,7 +235,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/logs.html b/master/jsclientlib/logs.html index b00e00a53..fb6fbc043 100644 --- a/master/jsclientlib/logs.html +++ b/master/jsclientlib/logs.html @@ -178,7 +178,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/printer.html b/master/jsclientlib/printer.html index ffd6262ac..9e4353ef7 100644 --- a/master/jsclientlib/printer.html +++ b/master/jsclientlib/printer.html @@ -665,7 +665,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/printerprofiles.html b/master/jsclientlib/printerprofiles.html index 0ff563c39..02ab28ebf 100644 --- a/master/jsclientlib/printerprofiles.html +++ b/master/jsclientlib/printerprofiles.html @@ -265,7 +265,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/settings.html b/master/jsclientlib/settings.html index a059f8901..1fb56075b 100644 --- a/master/jsclientlib/settings.html +++ b/master/jsclientlib/settings.html @@ -264,7 +264,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/slicing.html b/master/jsclientlib/slicing.html index 94a47ac1a..9403f0c15 100644 --- a/master/jsclientlib/slicing.html +++ b/master/jsclientlib/slicing.html @@ -285,7 +285,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/socket.html b/master/jsclientlib/socket.html index 810236d40..d02bfcdde 100644 --- a/master/jsclientlib/socket.html +++ b/master/jsclientlib/socket.html @@ -383,7 +383,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/system.html b/master/jsclientlib/system.html index 13a133a65..9c9240f28 100644 --- a/master/jsclientlib/system.html +++ b/master/jsclientlib/system.html @@ -236,7 +236,7 @@

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/timelapse.html b/master/jsclientlib/timelapse.html index 7a78f9c3e..6c8fe4e3b 100644 --- a/master/jsclientlib/timelapse.html +++ b/master/jsclientlib/timelapse.html @@ -350,7 +350,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/users.html b/master/jsclientlib/users.html index 65f2bb3fe..a80eb5ca0 100644 --- a/master/jsclientlib/users.html +++ b/master/jsclientlib/users.html @@ -363,7 +363,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/util.html b/master/jsclientlib/util.html index 1ed8e7b61..62e2cc8a4 100644 --- a/master/jsclientlib/util.html +++ b/master/jsclientlib/util.html @@ -427,7 +427,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/jsclientlib/wizard.html b/master/jsclientlib/wizard.html index 169b21a7b..ab9b01076 100644 --- a/master/jsclientlib/wizard.html +++ b/master/jsclientlib/wizard.html @@ -216,7 +216,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/access.html b/master/modules/access.html index d3e4d3f12..e36fd13e8 100644 --- a/master/modules/access.html +++ b/master/modules/access.html @@ -232,7 +232,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/cli.html b/master/modules/cli.html index 8fbfbb82c..2a9b36c60 100644 --- a/master/modules/cli.html +++ b/master/modules/cli.html @@ -346,7 +346,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/filemanager.html b/master/modules/filemanager.html index cefcb5050..8203e3188 100644 --- a/master/modules/filemanager.html +++ b/master/modules/filemanager.html @@ -1645,7 +1645,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/index.html b/master/modules/index.html index 7b64c4788..6ea6ed9aa 100644 --- a/master/modules/index.html +++ b/master/modules/index.html @@ -215,7 +215,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/plugin.html b/master/modules/plugin.html index 7bcb1880c..966cba08f 100644 --- a/master/modules/plugin.html +++ b/master/modules/plugin.html @@ -1572,7 +1572,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/printer.html b/master/modules/printer.html index 16e21e404..d122086bc 100644 --- a/master/modules/printer.html +++ b/master/modules/printer.html @@ -1246,7 +1246,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/schema.html b/master/modules/schema.html index 162099a3e..0be6c1332 100644 --- a/master/modules/schema.html +++ b/master/modules/schema.html @@ -2871,7 +2871,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/server.html b/master/modules/server.html index 90a134c5b..15fcc625f 100644 --- a/master/modules/server.html +++ b/master/modules/server.html @@ -1282,7 +1282,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/settings.html b/master/modules/settings.html index 78ee2156f..78cc23008 100644 --- a/master/modules/settings.html +++ b/master/modules/settings.html @@ -494,7 +494,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/slicing.html b/master/modules/slicing.html index 40697395d..1efbb605f 100644 --- a/master/modules/slicing.html +++ b/master/modules/slicing.html @@ -689,7 +689,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/modules/util.html b/master/modules/util.html index 6336d1565..7f28fef53 100644 --- a/master/modules/util.html +++ b/master/modules/util.html @@ -1230,7 +1230,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/concepts.html b/master/plugins/concepts.html index b6eff7979..638468d18 100644 --- a/master/plugins/concepts.html +++ b/master/plugins/concepts.html @@ -209,7 +209,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/controlproperties.html b/master/plugins/controlproperties.html index 58222e10f..7b8dea518 100644 --- a/master/plugins/controlproperties.html +++ b/master/plugins/controlproperties.html @@ -299,7 +299,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/distributing.html b/master/plugins/distributing.html index c6aef80e4..44051f0d7 100644 --- a/master/plugins/distributing.html +++ b/master/plugins/distributing.html @@ -241,7 +241,7 @@

    Version management after the official plu
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/gettingstarted.html b/master/plugins/gettingstarted.html index c641d1a22..2ce52dd94 100644 --- a/master/plugins/gettingstarted.html +++ b/master/plugins/gettingstarted.html @@ -1114,7 +1114,7 @@

    Where do we go from here?
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/helpers.html b/master/plugins/helpers.html index 4dd00c09f..937785d86 100644 --- a/master/plugins/helpers.html +++ b/master/plugins/helpers.html @@ -229,7 +229,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/hooks.html b/master/plugins/hooks.html index 4ef85521d..776451668 100644 --- a/master/plugins/hooks.html +++ b/master/plugins/hooks.html @@ -2842,7 +2842,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/index.html b/master/plugins/index.html index c0d72a951..82cf6eaab 100644 --- a/master/plugins/index.html +++ b/master/plugins/index.html @@ -296,7 +296,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/injectedproperties.html b/master/plugins/injectedproperties.html index 64f02ba08..826b3c6ad 100644 --- a/master/plugins/injectedproperties.html +++ b/master/plugins/injectedproperties.html @@ -217,7 +217,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/mixins.html b/master/plugins/mixins.html index 8d2b65ebf..d10820f1c 100644 --- a/master/plugins/mixins.html +++ b/master/plugins/mixins.html @@ -2577,7 +2577,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/python3_migration.html b/master/plugins/python3_migration.html index 2bb0e6c3a..f196c607d 100644 --- a/master/plugins/python3_migration.html +++ b/master/plugins/python3_migration.html @@ -485,7 +485,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/plugins/viewmodels.html b/master/plugins/viewmodels.html index 9c9d62af2..bc94c49f9 100644 --- a/master/plugins/viewmodels.html +++ b/master/plugins/viewmodels.html @@ -585,7 +585,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/py-modindex.html b/master/py-modindex.html index 4eb00cc7d..04dec8bb5 100644 --- a/master/py-modindex.html +++ b/master/py-modindex.html @@ -409,7 +409,7 @@

    Python Module Index

    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7
    diff --git a/master/search.html b/master/search.html index 7fca8d422..d39e88d38 100644 --- a/master/search.html +++ b/master/search.html @@ -154,7 +154,7 @@
    Tags
    -
    1.9.2
    +
    1.9.3
    1.8.7