diff options
author | Gareth Farrington <gareth@waves.ky> | 2024-09-15 19:12:25 -0700 |
---|---|---|
committer | Kevin O'Connor <kevin@koconnor.net> | 2025-05-29 19:11:05 -0400 |
commit | 388fe1b23f008c0f678ebb40fe39050d16e92d91 (patch) | |
tree | 3db3d7aee128396fbd910d521c56cafd22e6705b /docs/Config_Reference.md | |
parent | f6d878a8980867a291335f3115908d90a0cd8499 (diff) | |
download | kutter-388fe1b23f008c0f678ebb40fe39050d16e92d91.tar.gz kutter-388fe1b23f008c0f678ebb40fe39050d16e92d91.tar.xz kutter-388fe1b23f008c0f678ebb40fe39050d16e92d91.zip |
docs: Load Cell Probe Documentation
Add documentation updates for Homing & Probing with load cell probe
Signed-off-by: Gareth Farrington <gareth@waves.ky>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r-- | docs/Config_Reference.md | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index 2f4b714d..9dbcae06 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -5128,6 +5128,65 @@ data_ready_pin: # and 'analog_supply'. Default is 'internal'. ``` +### [load_cell_probe] +Load Cell Probe. This combines the functionality of a [probe] and a [load_cell]. + +``` +[load_cell_probe] +sensor_type: +# This must be one of the supported bulk ADC sensor types and support +# load cell endstops on the mcu. +#counts_per_gram: +#reference_tare_counts: +#sensor_orientation: +# These parameters must be configured before the probe will operate. +# See the [load_cell] section for further details. +#force_safety_limit: 2000 +# The safe limit for probing force relative to the reference_tare_counts on +# the load_cell. The default is +/-2Kg. +#trigger_force: 75.0 +# The force that the probe will trigger at. 75g is the default. +#drift_filter_cutoff_frequency: 0.8 +# Enable optional continuous taring while homing & probing to reject drift. +# The value is a frequency, in Hz, below which drift will be ignored. This +# option requires the SciPy library. Default: None +#drift_filter_delay: 2 +# The delay, or 'order', of the drift filter. This controls the number of +# samples required to make a trigger detection. Can be 1 or 2, the default +# is 2. +#buzz_filter_cutoff_frequency: 100.0 +# The value is a frequency, in Hz, above which high frequency noise in the +# load cell will be igfiltered outnored. This option requires the SciPy +# library. Default: None +#buzz_filter_delay: 2 +# The delay, or 'order', of the buzz filter. This controle the number of +# samples required to make a trigger detection. Can be 1 or 2, the default +# is 2. +#notch_filter_frequencies: 50, 60 +# 1 or 2 frequencies, in Hz, to filter out of the load cell data. This is +# intended to reject power line noise. This option requires the SciPy +# library. Default: None +#notch_filter_quality: 2.0 +# Controls how narrow the range of frequencies are that the notch filter +# removes. Larger numbers produce a narrower filter. Minimum value is 0.5 and +# maximum is 3.0. Default: 2.0 +#tare_time: +# The rime in seconds used for taring the load_cell before each probe. The +# default value is: 4 / 60 = 0.066. This collects samples from 4 cycles of +# 60Hz mains power to cancel power line noise. +#z_offset: +#speed: +#samples: +#sample_retract_dist: +#lift_speed: +#samples_result: +#samples_tolerance: +#samples_tolerance_retries: +#activate_gcode: +#deactivate_gcode: +# See the "[probe]" section for a description of the above parameters. +``` + ## Board specific hardware support ### [sx1509] |