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.

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 documentation in the linear battery plugin example. #1500

Merged
merged 3 commits into from
May 26, 2022

Conversation

adityapande-1995
Copy link
Contributor

@adityapande-1995 adityapande-1995 commented May 18, 2022

🦟 Bug fix

Fixes #1494

Summary

The blue vehicle does not stop moving when the battery runs out, its just that the forces applied at the joints become zero. The line "vehicle stops moving" in the sdf file is a bit misleading. The update explains the reason for the behavior.

Detailed discussion here : #1494

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸

Signed-off-by: Aditya <[email protected]>
@adityapande-1995 adityapande-1995 changed the base branch from ign-gazebo6 to main May 18, 2022 20:29
@@ -28,7 +28,7 @@
Stop recharging the battery using a topic (optional if <recharge_by_topic> is true):
ign topic -t /model/vehicle_blue/battery/linear_battery/recharge/stop -m ignition.msgs.Boolean -p 'data:true'

The blue vehicle should stop when it runs out of battery.
After the battery runs out, no force is applied to the joints in the blue vehicle. It would keep on moving as there is no friction to stop it.
Copy link
Contributor

Choose a reason for hiding this comment

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

Alternatively, we can joint friction to the vehicles which would bring them to a stop. I still think what you added here is helpful. We can say:

After the battery runs out, no force is applied to the joints in the blue vehicle. It eventually comes to a stop due to friction in its joints. Had there been no joint friction, the vehicle would have kept on moving as Gazebo currently does not support rolling friction.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added here : cce79a3

@chapulina chapulina added 🌱 garden Ignition Garden documentation Improvements or additions to documentation MBARI-LRAUV Sponsored by MBARI-LRAUV project: https://github.com/osrf/lrauv labels May 23, 2022
Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

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

LGTM!

@codecov
Copy link

codecov bot commented May 26, 2022

Codecov Report

❗ No coverage uploaded for pull request base (main@90a87fd). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1500   +/-   ##
=======================================
  Coverage        ?   35.01%           
=======================================
  Files           ?       44           
  Lines           ?     2356           
  Branches        ?        0           
=======================================
  Hits            ?      825           
  Misses          ?     1531           
  Partials        ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 90a87fd...cce79a3. Read the comment docs.

@adityapande-1995
Copy link
Contributor Author

adityapande-1995 commented May 26, 2022

The errors in CI are unrelated to this PR :

53 - UNIT_NetworkManager_TEST (SEGFAULT)
175 - INTEGRATION_scene_broadcaster_system (Failed)

Windows errors are gz-cmake build related.

@adityapande-1995 adityapande-1995 merged commit aad2019 into main May 26, 2022
@adityapande-1995 adityapande-1995 deleted the aditya/edit_documentation_battery_example branch May 26, 2022 19:50
@j-rivero j-rivero mentioned this pull request Sep 16, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 🌱 garden Ignition Garden MBARI-LRAUV Sponsored by MBARI-LRAUV project: https://github.com/osrf/lrauv
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Robot should stop when battery is discharged.
3 participants