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

ROS2 bindings #254

Open
2 tasks done
renzo-sie opened this issue Jun 21, 2024 · 6 comments
Open
2 tasks done

ROS2 bindings #254

renzo-sie opened this issue Jun 21, 2024 · 6 comments
Labels
enhancement New feature or request

Comments

@renzo-sie
Copy link

Why do we need this improvement?

We need this improvement to seamlessly integrate ROS2, a widely-used framework in robotics, with AsyncAPI. This integration will enhance the capabilities of ROS2 by providing a standardized way to document and communicate its event-driven architecture. By including ROS2 bindings, we can ensure that ROS2 developers can leverage AsyncAPI's benefits for better interoperability, documentation, and tooling.

How will this change help?

This change will help by providing a standardized approach to describing ROS2 communication interfaces, enabling better tooling support, improved collaboration, and more efficient development processes. It will facilitate the generation of documentation, code, and other artifacts, thus reducing the manual effort required and minimizing the risk of errors.

Screenshots

No response

How could it be implemented/designed?

We will implement the ROS2 bindings similarly to other existing bindings in AsyncAPI. This involves:

  • Defining the ROS2-specific protocol and message type bindings.
  • Creating documentation and examples to guide users in applying these bindings.

🚧 Breaking changes

No

👀 Have you checked for similar open issues?

  • I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

@renzo-sie renzo-sie added the enhancement New feature or request label Jun 21, 2024
Copy link

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@renzo-sie
Copy link
Author

Hi, is there any news on this issue? :) If I understand correctly, I still need to wait for a branch to be created to submit my code

@renzo-sie
Copy link
Author

Hi @derberg or @fmvilas , could you help with this issue?

@derberg
Copy link
Member

derberg commented Nov 25, 2024

@renzo-sie hey, sorry for the delay. Can you provide some example AsyncAPI document with these new binding included, with comments what these binding properties are for, so it is easier to understand what you need. It will also clear out where these bindings be located, in what AsyncAPI objects, like channel or others.

Are you aware that in case of bindings, it is not enough to contribute binding, you also have to become a maintainer of it?

@renzo-sie
Copy link
Author

Hi @derberg , thanks for the response!
Yes, I will you attached the ROS 2 bindings README that explains what does each property do. Let me know if you have any questions.
README.md

You can set @gramss (https://github.com/gramss) as the main mantainer for this binding, and me as the second contact.

Would be nice to show this binding in the next ROS event in germany next week :) (https://roscon2024.de/)

@renzo-sie
Copy link
Author

Hi @derberg,

Here is the new version of the ROS 2 bindings:
README (1).md

Did you had a chance to review the document ? :)

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

No branches or pull requests

2 participants