Docs/add zenoh doc and disclaimer to readme #587
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Manuel Schweiger <schweigermanuel@icloud.com>
Signed-off-by: Manuel Schweiger <schweigermanuel@icloud.com>
mschweig
requested review from
METEORITENMAX,
jbarry-bdai,
amessing-bdai,
mpickett-bdai,
bhung-bdai,
tcappellari-bdai and
khughes-bdai
as code owners
tcappellari-bdai
approved these changes
Feb 25, 2025
README.md
Outdated
|
|
||
| ### Experimental - RMW ZENOH Middleware | ||
|
|
||
| **Disclaimer:** The RMW ZENOH middleware is now available for installation with the driver. Please note that this feature is currently under experimental testing and may result in issues that we cannot address. To start the zenoh router with the driver, set the `experimental_zenoh_rmw` parameter to `True`. For further configuration and settings, please refer to the [rmw_zenoh documentation](https://github.com/ros2/rmw_zenoh). |
There was a problem hiding this comment.
the driver doesn't have a experimental_zenoh_rmw flag, can this be modified to tell users to just start the zenoh router in another shell if they want to use this feature? otherwise lgtm
There was a problem hiding this comment.
@khughes-bdai oops my bad, I added to my fork to automatically start the zenoh router with the driver when setting experimental_zenoh_rmw but did not add this feature to this PR.
Thanks for the review, gonna change that.
Signed-off-by: Manuel Schweiger <schweigermanuel@icloud.com>
khughes-bdai
approved these changes
Feb 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Overview
As discussed in my last PR (#572) I am adding a zenoh disclaimer to the
readme.Update on zenoh testing: I have been running the driver on
zenohfor 2 weeks (in a WAN VPN) and its running smoothly. Collected some logs and information I am happy to share with you.Testing Done
N/A