From 69ad228356161c4660003682e11e8fd333d7bf3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Boisselier?= Date: Mon, 17 Jun 2024 19:53:13 +0200 Subject: [PATCH] small documentation update about default parameters --- docs/macros/axes_shaper_calibrations.md | 6 +++--- docs/macros/compare_belts_responses.md | 6 +++--- docs/macros/excitate_axis_at_freq.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/macros/axes_shaper_calibrations.md b/docs/macros/axes_shaper_calibrations.md index ca02b69..35f7c51 100644 --- a/docs/macros/axes_shaper_calibrations.md +++ b/docs/macros/axes_shaper_calibrations.md @@ -11,10 +11,10 @@ Then, call the `AXES_SHAPER_CALIBRATION` macro and look for the graphs in the re | parameters | default value | description | |-----------:|---------------|-------------| -|FREQ_START|5|starting excitation frequency| -|FREQ_END|133|maximum excitation frequency| +|FREQ_START|None (default to `[resonance_tester]` value)|starting excitation frequency| +|FREQ_END|None (default to `[resonance_tester]` value)|maximum excitation frequency| |HZ_PER_SEC|1|number of Hz per seconds for the test| -|ACCEL_PER_HZ|None|accel per Hz value used for the test. If unset, it will use the value from your `[resonance_tester]` config section (75 is the default)| +|ACCEL_PER_HZ|None (default to `[resonance_tester]` value)|accel per Hz value used for the test| |AXIS|"all"|axis you want to test in the list of "all", "X" or "Y"| |SCV|printer square corner velocity|square corner velocity you want to use to calculate shaper recommendations. Using higher SCV values usually results in more smoothing and lower maximum accelerations| |MAX_SMOOTHING|None|max smoothing allowed when calculating shaper recommendations| diff --git a/docs/macros/compare_belts_responses.md b/docs/macros/compare_belts_responses.md index e1707cc..651cb4c 100644 --- a/docs/macros/compare_belts_responses.md +++ b/docs/macros/compare_belts_responses.md @@ -15,10 +15,10 @@ Then, call the `COMPARE_BELTS_RESPONSES` macro and look for the graphs in the re | parameters | default value | description | |-----------:|---------------|-------------| -|FREQ_START|5|starting excitation frequency| -|FREQ_END|133|maximum excitation frequency| +|FREQ_START|None (default to `[resonance_tester]` value)|starting excitation frequency| +|FREQ_END|None (default to `[resonance_tester]` value)|maximum excitation frequency| |HZ_PER_SEC|1|number of Hz per seconds for the test| -|ACCEL_PER_HZ|None|accel per Hz value used for the test. If unset, it will use the value from your `[resonance_tester]` config section (75 is the default)| +|ACCEL_PER_HZ|None (default to `[resonance_tester]` value)|accel per Hz value used for the test| |TRAVEL_SPEED|120|speed in mm/s used for all the travel movements (to go to the start position prior to the test)| |Z_HEIGHT|None|Z height wanted for the test. This value can be used if needed to override the Z value of the probe_point set in your `[resonance_tester]` config section| diff --git a/docs/macros/excitate_axis_at_freq.md b/docs/macros/excitate_axis_at_freq.md index 0b9ec25..699f4d5 100644 --- a/docs/macros/excitate_axis_at_freq.md +++ b/docs/macros/excitate_axis_at_freq.md @@ -12,7 +12,7 @@ Here are the parameters available: |CREATE_GRAPH|0|whether or not to record the accelerometer data and create an associated graph during the excitation| |FREQUENCY|25|excitation frequency (in Hz) that you want to maintain. Usually, it's the frequency of a peak on one of the graphs| |DURATION|30|duration in second to maintain this excitation| -|ACCEL_PER_HZ|None|accel per Hz value used for the test. If unset, it will use the value from your `[resonance_tester]` config section (75 is the default)| +|ACCEL_PER_HZ|None (default to `[resonance_tester]` value)|accel per Hz value used for the test| |AXIS|x|axis you want to excitate. Can be set to either "x", "y", "a", "b"| |TRAVEL_SPEED|120|speed in mm/s used for all the travel movements (to go to the start position prior to the test)| |Z_HEIGHT|None|Z height wanted for the test. This value can be used if needed to override the Z value of the probe_point set in your `[resonance_tester]` config section|