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.

Sign up for GitHub

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

Docs/add zenoh doc and disclaimer to readme #587

Merged
merged 7 commits into from
Feb 28, 2025
Merged

Docs/add zenoh doc and disclaimer to readme #587

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
df199f3
docs: add zenoh to readme
mschweig Feb 19, 2025
df86765
chore: add newline
mschweig Feb 19, 2025
06dbd98
fix: typo
mschweig Feb 19, 2025
beb1284
Merge branch 'main' into docs/add-zenoh-doc
tcappellari-bdai Feb 25, 2025
f7acac1
docs: update zenoh disclaimer
mschweig Feb 25, 2025
d42f99c
Merge branch 'main' into docs/add-zenoh-doc
tcappellari-bdai Feb 25, 2025
6f6ecb3
Merge branch 'main' into docs/add-zenoh-doc
tcappellari-bdai Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ The following flags may be useful for extra functionality when running the image
| `--runtime nvidia` + `--gpus all` | Use the [NVIDIA Container Runtime](https://developer.nvidia.com/container-runtime) to run the container with GPU acceleration |
| `-e DISPLAY` | Bind your display to the container in order to run GUI apps. Note that you will need to allow the Docker container to connect to your X11 server, which can be done in a number of ways ranging from disabling X11 authentication entirely, or by allowing the Docker daemon specifically to access your display server. |
| `--network host` | Use the host network directly. May help resolve issues connecting to Spot Wifi |
| `--build-arg EXPERIMENTAL_ZENOH_RMW=TRUE` | Enable experimental rmw_zenoh middleware. May result in issues we cannot address. |

### 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).
Copy link
Collaborator

@khughes-bdai khughes-bdai Feb 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@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.



# Packages
Expand Down
Loading