Skip to content
New issue

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

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

Already on GitHub? # to your account

Move setup instructions to ur_client_library #248

Merged
merged 15 commits into from
Jan 27, 2025

Conversation

urfeex
Copy link
Member

@urfeex urfeex commented Jan 20, 2025

As suggested in #240 we want to move more common setup instructions to the client library. It's documentation is pulled into https://github.com/UniversalRobots/Universal_Robots_ROS_Documentation anyway, so it will be available in the ROS documentation, anyway.

This is currently a draft, as there will be accompanying PRs in the ROS 2 driver and documentation repos.

Closing #240

When using the assembled documentation this wasn't working properly
otherwise.
Copy link

codecov bot commented Jan 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.03%. Comparing base (2c12bee) to head (5d44048).
Report is 11 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #248      +/-   ##
==========================================
+ Coverage   71.71%   73.03%   +1.31%     
==========================================
  Files          71       75       +4     
  Lines        2786     2896     +110     
  Branches      353      360       +7     
==========================================
+ Hits         1998     2115     +117     
+ Misses        596      594       -2     
+ Partials      192      187       -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

As the robot setup instructions are independent whether ROS, ROS 2 or a
custom application is using the client library, documentation for that
should also go to the client library.
@urfeex urfeex requested a review from a team January 21, 2025 07:40
@urfeex urfeex marked this pull request as ready for review January 21, 2025 08:41
@urrsk
Copy link
Member

urrsk commented Jan 21, 2025

Suggest updating the PolyscopeX service screen picture to a screenshot like this one where only Primary, secondary and RTDE is enabled:
services_polyscopex

@urrsk
Copy link
Member

urrsk commented Jan 21, 2025

Suggest using tabs for the installation on CB3, E-series and PolyscopeX instead of different pages

@urfeex urfeex requested a review from urrsk January 21, 2025 11:06
Co-authored-by: Rune Søe-Knudsen <41109954+urrsk@users.noreply.github.com>
Co-authored-by: Rune Søe-Knudsen <41109954+urrsk@users.noreply.github.com>
Script startup
--------------

All of the above is put together in a script in the ``ur_client_library`` package.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
All of the above is put together in a script in the ``ur_client_library`` package.
All of the above is put together in a script in the ``ur_client_library`` ROS package.

Copy link
Member Author

Choose a reason for hiding this comment

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

Isn't that a bit misleading? It's part of the ur_client_library. Yes, it gets installed in the ROS packages, but they are merely distributions of this repo. I would consider the code in this repo a package also independent of ROS.

Copy link
Member

Choose a reason for hiding this comment

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

Ok, lets skip it

@urrsk
Copy link
Member

urrsk commented Jan 23, 2025

  • We should also add to the main readme that the CL is a standalone lib that is not dependent on any ROS dependencies though it is used as a foundation for the ROS 1 and ROS 2 driver.

Copy link
Member

@urrsk urrsk left a comment

Choose a reason for hiding this comment

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

See my comments and code suggestions

urfeex and others added 3 commits January 24, 2025 10:16
@urfeex
Copy link
Member Author

urfeex commented Jan 24, 2025

  • We should also add to the main readme that the CL is a standalone lib that is not dependent on any ROS dependencies though it is used as a foundation for the ROS 1 and ROS 2 driver.

How about 55cdf01?

@urfeex urfeex requested a review from urrsk January 24, 2025 09:26
Co-authored-by: Rune Søe-Knudsen <41109954+urrsk@users.noreply.github.com>
@urfeex urfeex requested a review from urrsk January 27, 2025 13:09
Co-authored-by: Rune Søe-Knudsen <41109954+urrsk@users.noreply.github.com>
@urfeex urfeex requested a review from urrsk January 27, 2025 13:39
@urfeex urfeex merged commit 0f6b513 into UniversalRobots:master Jan 27, 2025
22 of 23 checks passed
@urfeex urfeex deleted the doc_robot_setup branch January 27, 2025 14:46
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation of how to make it work with Polyscope 5.17 and PolyScopeX, due to the new security settings.
2 participants