Repository navigation
docs: drop reverse mount guidance and deprecate template api - #56
Merged
Merged
Conversation
The shipped grippers have one mounting, so diagnostics no longer branch on a normal/reverse label and no longer suggest loading a mount template. Direction is reported as the close_sign value, and a missing calibration points at the factory file instead. No behavior changes; only the text of diagnostics.
|
🎉 This PR is included in version 1.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Shipped grippers have one mounting, so the normal/reverse distinction is no longer a choice users are taught to make. This removes the reverse-mount guidance from both READMEs, marks the mount/template API as deprecated for backward compatibility, and adds an explicit section on loading a calibration measured on the user's own machine.
No signatures, symbols, or runtime logic change; only documentation and diagnostic text.
Changes
can1template advice fromREADME.mdandREADME.zh-CN.md.default_calibration_path(channel), explicitload_calibration(path),$LITEGRIP_CALIB, the factory fallback, and post-load verification.GripperConfig::mount(),list_calibration_templates(),calibration_template_path(), andLiteGrip::load_template()deprecated in Doxygen comments. No[[deprecated]]attribute, so-Werrorbuilds keep compiling.src/gripper.cpp.Testing
No hardware was available; end-to-end movement was not tested.
Issues
No issue.