Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Measuring_Resonances.md #6509

Merged
merged 6 commits into from
Apr 29, 2024
Merged

Update Measuring_Resonances.md #6509

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
16c7b82
Update Measuring_Resonances.md
charminULTRA Feb 25, 2024
da80a17
Editied version
charminULTRA Mar 18, 2024
77dd55e
Fix trailing spaces
charminULTRA Mar 18, 2024
b38414c
Merge branch 'Klipper3d:master' into patch-1
charminULTRA Mar 18, 2024
01f3ea8
Sign-off by Jonathan Williams [email protected]
charminULTRA Apr 26, 2024
eaf516c
Update
charminULTRA Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Measuring_Resonances.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ TEST_RESONANCES AXIS=Y
```
This will generate 2 CSV files (`/tmp/resonances_x_*.csv` and
`/tmp/resonances_y_*.csv`). These files can be processed with the stand-alone
script on a Raspberry Pi. To do that, run the following commands:
script on a Raspberry Pi. To do that, run the following commands (WARNING: Do not run these commands when there is more than one .csv file in your tmp folder. This will result in ALL files being used for the charted results):
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not change this line: grammatically brackets are NOT meant to include whole sentences. If it's more than few words, it's not for brackets.

Add a line before line 458, after the code, as suggested:

457bis Keep in mind that these commands (written with the "*") will merge all available CSV files
from the specified folder to generate a single calibration graph. It may be useful if you tested the
machine in various conditions and you want a single result which takes all of them into account.

Remember to split at column 80, as the file originally was, don't add long lines which make the code difficult to read. Lines are free of charge :)

Copy link
Contributor Author

@charminULTRA charminULTRA Mar 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not change this line: grammatically brackets are NOT meant to include whole sentences. If it's more than few words, it's not for brackets.

Add a line before line 458, after the code, as suggested:

457bis Keep in mind that these commands (written with the "*") will merge all available CSV files
from the specified folder to generate a single calibration graph. It may be useful if you tested the
machine in various conditions and you want a single result which takes all of them into account.

Remember to split at column 80, as the file originally was, don't add long lines which make the code difficult to read. Lines are free of charge :)

I don't fully agree with this edit. There's no part of the documentation that already tells or assumes the user should or could use multiple CSV files, so the inherent assumption here is that the user is creating a single CSV for each axis. Given that, I don't think we should say things like "keep in mind" down below, but more of an upfront warning like "do not run this with multiple CSVs in your folder, unless you intend to blend the results". You want to alert the user before they perform an action, not after.

I assume the original intent of using a wildcard was to save the user time from writing out the file name, but again it's not clear from the documentation.

Will submit a modified commit.

```
~/klipper/scripts/calibrate_shaper.py /tmp/resonances_x_*.csv -o /tmp/shaper_calibrate_x.png
~/klipper/scripts/calibrate_shaper.py /tmp/resonances_y_*.csv -o /tmp/shaper_calibrate_y.png
Expand Down
Loading