DOC: RatOS V2.1 documentation

site/docs/configuration/adaptive-meshing.md

@@ -2,116 +2,63 @@
 sidebar_position: 2
 ---
 
-# Adaptive Meshing (BETA)
+# Bed Meshing
 
-RatOS comes with it's own adaptive meshing (functionality was previously handled by PAM by Helge Keck), similar to KAMP. When enabled and configured in your slicer, RatOS will only probe the print area and your configured probe location, potentially saving a lot of time on smaller prints on bigger printers. RatOS will keep the resolution of your mesh (probes per mm), so that you always get consistent mesh performance. Contrary to KAMP and PAM, RatOS doesn't move your prime location, instead it probes the prime location (constrained by min/max bed_mesh settings) a single time and uses the difference between the probe result and your z_offset to dynamically apply a gcode offset only for the prime macro. This ensures no collision with prime blob and the toolhead on small meshes.
+- [Bed Mesh Calibration](#bed-mesh-calibration)
+- [Adaptive Meshing](#adaptive-meshing)
+- [Adaptive Meshing configuration](#adaptive-meshing-configuration)
+- [Adaptive Prime Blob configuration](#adaptive-prime-blob-configuration)
+- [Prime Blob x-margin ](#prime-blob-x-margin)
+- [Slicer configuration](#slicer-configuration)
+- [Zero reference osition](#zero-reference-position)
 
-:::warning
-Adaptive priming is currently **NOT** supported for Beacon. It is expected to be supported in the near future, once beacon probe results can be read from macros. RatOS will automatically skip priming if Beacon is detected.
-:::
+## Bed Mesh Calibration
 
-## Macro configuration
+By default RatOS calibrates the bed mesh before each print, if you prefer calibrating your bed mesh manually, you can disable it. Disabling `variable_calibrate_bed_mesh` will stop RatOS from loading a bed mesh entirely. If you want it to load a mesh, you can set `variable_bed_mesh_profile` to the name of the profile you want it to load.
 
-To enable adaptive priming set `variable_adaptive_mesh` to `True` in your RatOS macro configuration section (if it isn't already there, add it):
+| Name                        | Possible Values    | Default   | Description                                               |
+| :-------------------------- | :----------------- | :-------- | :-------------------------------------------------------- |
+| variable_calibrate_bed_mesh | True / False       | True      | Whether or not to calibrate a bed mesh before each print. |
+| variable_bed_mesh_profile   | undefined / string | undefined | The name of the profile you want to load.                 |
 
-| Name                   | Possible Values | Default | Description                        |
-| ---------------------- | --------------- | ------- | ---------------------------------- |
-| variable_adaptive_mesh | True / False    | False   | Whether to enable adaptive meshing |
+If `variable_calibrate_bed_mesh` is `False` you must set `variable_bed_mesh_profile` variable to the profile name you wish to load, or no bed mesh will be loaded. If `variable_calibrate_bed_mesh` is `True` and this variable isn't set, RatOS will use `ratos` as the profile name.
 
-:::info
-If you are currently using PAM, you should delete the PAM includes from printer.cfg before proceeding. Afterwards you can delete the PAM directory and remove the PAM moonraker.conf entry.
-:::
+## Adaptive Meshing
 
-## Slicer configuration
+RatOS comes with it's own, deeply integrated and IDEX aware, adaptive meshing implementation. Do not try to set up the klipper variant of it, which works only in combination with the exclude_objects feature. RatOS will only probe the print area and your configured probe location, potentially saving a lot of time on smaller prints on bigger printers. RatOS will keep the resolution of your mesh (probes per mm), so that you always get consistent mesh performance. Contrary to other implementations, RatOS doesn't move your prime location, instead it probes the prime location (constrained by min/max bed_mesh settings) a single time and uses the difference between the probe result and your z_offset to dynamically apply a gcode offset only for the prime macro. This ensures no collision with the prime blob and the toolhead on small meshes.
 
-Adaptive meshing requires that you provide print area coordinates to the START_PRINT macro, you can copy and paste the START_PRINT macro for your slicer below.
+### Adaptive Meshing configuration
 
-### PrusaSlicer / SuperSlicer
+Adaptive bed meshing is enabled by default. To disable it set `variable_adaptive_mesh` to `False` in your printer.cfg file.
 
-```properties
-START_PRINT EXTRUDER_TEMP=[first_layer_temperature] BED_TEMP=[first_layer_bed_temperature] X0={first_layer_print_min[0]} Y0={first_layer_print_min[1]} X1={first_layer_print_max[0]} Y1={first_layer_print_max[1]}
-```
+| Name                   | Possible Values | Default | Description                        |
+| :--------------------- | :-------------- | :------ | :--------------------------------- |
+| variable_adaptive_mesh | True / False    | True    | Whether to enable adaptive meshing |
 
-### OrcaSlicer / SoftFever
+### Adaptive Prime Blob configuration
 
-```properties
-START_PRINT EXTRUDER_TEMP=[nozzle_temperature_initial_layer] BED_TEMP=[bed_temperature_initial_layer_single] X0={first_layer_print_min[0]} Y0={first_layer_print_min[1]} X1={first_layer_print_max[0]} Y1={first_layer_print_max[1]}
-```
+For single toolhead printer you can control the location and direction of the prime blob, IDEX printers do use a fully automated and intelligent prime control depending on the situation and print mode. 
 
-### Ideamaker
+| Name                             | Possible Values                 | Default     | Description                      |
+| :------------------------------- | :------------------------------ | :---------- | :------------------------------- |
+| variable_nozzle_priming          | "primeblob", False              | "primeblob" | Whether to enable the prime blob |
+| variable_nozzle_prime_start_x    | "min", "max", Number            | "max"       | non IDEX priming x-location      |
+| variable_nozzle_prime_start_y    | "min", "max", Number            | "min"       | non IDEX priming y-location      |
+| variable_nozzle_prime_direction  | "auto", "forwards", "backwards" | "auto"      | non IDEX priming y-direction     |
+| variable_nozzle_prime_bridge_fan | Number                          | 102         | priming bridging fan speed 0-255 |
 
-```properties
-START_PRINT EXTRUDER_TEMP={temperature_extruder1} BED_TEMP={temperature_heatbed} X0={print_pos_min_x} Y0={print_pos_min_y} X1={print_pos_max_x} Y1={print_pos_max_y}
-```
+### Prime Blob x-margin 
 
-### Simplify 3D V5
-
-```properties
-START_PRINT EXTRUDER_TEMP=[extruder0_temperature] BED_TEMP=[bed0_temperature] X0=[build_min_x] Y0=[build_min_y] X1=[build_max_x] Y1=[build_max_y]
+By default the primeblob has a x-margin of 5 mm from the edge. This value can be changed by overriding it in the printer.cfg.
 ```
-
-### Cura
-
-To make adaptive meshing work with Cura you need to install a post processing plugin
-
-1. in cura open menu `Help -> Show configuration folder`
-2. Copy the following and save it as `MeshPrintSize.py` in the `scripts` folder
-
-```python
-# --------------------------------------------------------------------------------
-# Original Version from https://gist.github.com/frankbags
-# https://gist.github.com/frankbags/c85d37d9faff7bce67b6d18ec4e716ff
-#
-# Modified version from https://github.com/kmarty
-# https://github.com/kmarty/klipper_config_km_addons/blob/master/bed_mesh_calibrate/MeshPrintSize.py
-#
-# thank you frankbags and kmarty!
-# --------------------------------------------------------------------------------
-
-import re #To perform the search and replace.
-
-from ..Script import Script
-
-class MeshPrintSize(Script):
-
-    def getSettingDataString(self):
-        return """{
-            "name": "Mesh Print Size",
-            "key": "MeshPrintSize",
-            "metadata": {},
-            "version": 2,
-            "settings":{}
-        }"""
-
-    def execute(self, data):
-        minMaxXY = {'MINX':0,'MINY':0,'MAXX':0,'MAXY':0}
-        re_pattern = re.compile(r'%(' + r'|'.join(minMaxXY.keys()) + r')%')
-        minmax_counter = len(minMaxXY)
-
-        for i in range(len(data)):
-            # in Cura "layer' != "line" :-(
-            for k,v in minMaxXY.items():
-                if minmax_counter:
-                    result = re.search(r';' + k + r':\s*(\d*\.\d+|\d+)', data[i])
-                    if result:
-                        minMaxXY[k] = result.group(1)
-                        minmax_counter -= 1
-                else:
-                    if re_pattern.search(data[i]):
-                        data[i] = re.sub(r'%' + k + r'%', v, data[i])
-
-        return data
+[gcode_macro PRIME_BLOB]
+variable_x_offset: 5   # the prime blob x-margin 
 ```
 
-3. restart cura
-4. in cura open menu `Extensions -> Post processing -> Modify G-Code` and select `Mesh Print Size`
+### Slicer configuration
 
-Modify start gcode to:
-
-```properties
-START_PRINT EXTRUDER_TEMP={material_print_temperature_layer_0} BED_TEMP={material_bed_temperature_layer_0} X0=%MINX% Y0=%MINY% X1=%MAXX% Y1=%MAXY%
-```
+Make sure to setup your slicer according to the [official RatOS slicer configuration](../slicers.md).
 
-## Relative reference index
+### Zero reference position
 
-RatOS Adaptive Meshing currently doesn't modify the relative reference index, it's generally not advised to use relative reference index with adaptive meshing.
+RatOS Adaptive Meshing currently doesn't modify the zero reference position, it's generally not advised to set the zero reference position with adaptive meshing.