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 docs about semantic_components #2031

Closed
christophfroehlich opened this issue Feb 3, 2025 · 3 comments · Fixed by #2032
Closed

Update docs about semantic_components #2031

christophfroehlich opened this issue Feb 3, 2025 · 3 comments · Fixed by #2032

Comments

@christophfroehlich
Copy link
Contributor

We have an (outdated) list of semantic components here:
https://control.ros.org/rolling/doc/ros2_control/hardware_interface/doc/hardware_interface_types_userdoc.html#sensors
Where should we put this in the docs (can be a follow-up PR)?

Originally posted by @christophfroehlich in #1945 (review)

@christophfroehlich
Copy link
Contributor Author

@tpoignonec what do you think?

@tpoignonec
Copy link
Contributor

tpoignonec commented Feb 3, 2025

What about adding a subsection in guidelines and best practices?

Example text:

#Hardware Components
##Guidelines and Best Practices
###Using semantic components

In order to streamline the configuration of commonly used hardware interface, so-called semantic components can be used to wrap mechanisms to claim / release the interfaces. The base components semantic_components::SemanticComponentInterface and semantic_components::SemanticComponentCommandInterface are used to define semantic components for read-only and write only devices, respectively.

List of existing SemanticComponentInterface and associated broadcaster, if any:

List of existing SemanticComponentCommandInterface and associated controller, if any:

  • LedRgbDevice

Location in docs:

Image

@christophfroehlich
Copy link
Contributor Author

Looks fine, I've created a PR #2032 with your proposal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants