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

[JTC] Update trajectory documentation #714

Merged
merged 9 commits into from
Jul 31, 2023

Conversation

christophfroehlich
Copy link
Contributor

@christophfroehlich christophfroehlich commented Jul 21, 2023

Trajectory Representation

I added several plots to the docs, which should help to understand what is going on here with the different combinations of the given trajectory.

I moved this part as well as the parameters to a subpage, feel free to comment if you have a different suggestion for the doc structure.

For reference: I wrote a Python module using pybind to visualize the outputs of the Trajectory class with matplotlib, see here.

Trajectory Replacement

As of the outcome from #574 I re-added the trajectory replacement section discarded from #566

Bugfixes

Also fixes a broken link ros-controls/control.ros.org#131

Comment on lines +13 to +14
by the controller's setup of command interfaces and PID configuration. There is no sanity check and
missing fields in the sampled trajectory might cause segmentation faults.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should we add sanity checks here?

I got a segfault using velocity command interface, interpolation_method=none giving position trajectory only.

@christophfroehlich christophfroehlich changed the title [JTC] Add visualized examples for outputs of Trajectory class [JTC] Update trajectory documentation Jul 25, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jul 25, 2023

Codecov Report

Merging #714 (b864c19) into master (e7f9962) will increase coverage by 0.75%.
The diff coverage is 34.91%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##           master     #714      +/-   ##
==========================================
+ Coverage   35.78%   36.53%   +0.75%     
==========================================
  Files         189        7     -182     
  Lines       17570      676   -16894     
  Branches    11592      357   -11235     
==========================================
- Hits         6287      247    -6040     
+ Misses        994      134     -860     
+ Partials    10289      295    -9994     
Flag Coverage Δ
unittests 36.53% <34.91%> (+0.75%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
...ontroller/test/test_load_diff_drive_controller.cpp 11.11% <0.00%> (ø)
diff_drive_controller/src/odometry.cpp 42.16% <11.11%> (ø)
diff_drive_controller/src/speed_limiter.cpp 46.55% <11.11%> (ø)
...ive_controller/test/test_diff_drive_controller.cpp 17.62% <12.08%> (ø)
...iff_drive_controller/src/diff_drive_controller.cpp 47.09% <46.88%> (ø)
...de/diff_drive_controller/diff_drive_controller.hpp 100.00% <100.00%> (ø)
...troller/include/diff_drive_controller/odometry.hpp 100.00% <100.00%> (ø)

... and 189 files with indirect coverage changes

@@ -0,0 +1,132 @@
:github_url: https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/joint_trajectory_controller/doc/parameters.rst

.. _parameters:
Copy link
Member

Choose a reason for hiding this comment

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

don't we generate this nwoadays?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

unfortunately not for all controllers, because nested parameters and maps are not supported yet :/

@bmagyar bmagyar merged commit fa72170 into ros-controls:master Jul 31, 2023
12 of 13 checks passed
@christophfroehlich christophfroehlich deleted the jtc/trajectory_docs branch July 31, 2023 18:48
@christophfroehlich christophfroehlich added the backport-humble This label should be used by maintaines only! Label triggers PR backport to ROS2 humble. label Jul 31, 2023
mergify bot pushed a commit that referenced this pull request Jul 31, 2023
(cherry picked from commit fa72170)

# Conflicts:
#	joint_trajectory_controller/doc/userdoc.rst
christophfroehlich added a commit to christophfroehlich/ros2_controllers that referenced this pull request Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-humble This label should be used by maintaines only! Label triggers PR backport to ROS2 humble.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants