Skip to content

Commit fe88fd0

Browse files
committed
docs: simplify beacon_true_zero_correction
1 parent da8a7a2 commit fe88fd0

1 file changed

Lines changed: 5 additions & 29 deletions

File tree

site/docs/configuration/beacon_true_zero_correction.md

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -10,36 +10,12 @@ Based on analysis of thousands of test data points, we determined that by applyi
1010

1111
## Configuration
1212

13-
The `[beacon_true_zero_correction]` module is enabled by default in RatOS whenever a beacon probe is configured. It can be configured by adding overrides in `printer.cfg` as follows:
13+
The `[beacon_true_zero_correction]` module is enabled by default in RatOS whenever a beacon probe is configured in the setup wizard. You should not add anything to your `printer.cfg` unless you want to disable the true zero correction feature.
1414

15-
```properties
16-
[beacon_true_zero_correction]
17-
# If True, the true zero correction feature is disabled. Default: False
18-
disabled: False
19-
```
20-
21-
## Diagnostic Configuration
22-
23-
The following configuration options are available for diagnostic purposes only. Users should not modify or paste these these settings into `printer.cfg` in normal use.
15+
### Disabling True Zero Correction
16+
Add the following to `printer.cfg`:
2417

2518
```properties
2619
[beacon_true_zero_correction]
27-
# z values greater than z_rejection_threshold are rejected. These typically correspond to early triggering
28-
# of beacon contact before the nozzle has touched the bed. From test data, these are rare. Only 0.028% of samples
29-
# exceeded 75um (from over 32,000 samples across multiple machines and print surfaces).
30-
# Rejected samples are discarded and another sample is taken in its place at a different random location.
31-
# Default: 0.075, minimum: 0.03
32-
z_rejection_threshold: 0.075
33-
# Controls the sampling strategy, notably affecting the number of points probed.
34-
# - Level 1: 6 points probed, 1 zero sample, use mean of 3 minimal samples. This is the default and recommended level.
35-
# - Level 2: 10 points probed, 1 zero sample, use mean of 3 minimal samples. This is a more robust probing strategy.
36-
# - Level 3: 12 points probed, 1 zero sample, use mean of 3 minimal samples. This is the most robust probing strategy.
37-
# From extensive testing, level 1 is very effective and efficient, with levels 2 and 3 offering only very modest gains
38-
# and diminishing returns. Levels 2 and 3 are included for diagnostic purposes, but level 1 is recommended for most users.
39-
# The zero sample is the implied zero sample from the initial BEACON_AUTO_CALIBRATE invocation.
40-
sampling_strategy: 1
41-
# If True, each of the multiple probe locations will itself be probed several times using
42-
# the standard beacon error detection logic. From extensive testing, this mode offers no benefit
43-
# and should not be used. It is included only as an option for diagnostic purposes. Deafult: False
44-
use_error_corrected_probing: False
45-
```
20+
disabled: True
21+
```

0 commit comments

Comments
 (0)