From df199f330a880581c60109190458136fe8ce2ee7 Mon Sep 17 00:00:00 2001 From: Manuel Schweiger Date: Wed, 19 Feb 2025 19:21:36 +0100 Subject: [PATCH 1/4] docs: add zenoh to readme Signed-off-by: Manuel Schweiger --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index b50384e49..bf7e2c19b 100644 --- a/README.md +++ b/README.md @@ -72,7 +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-args 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). # Packages From df8676526251e3422945670206e811149d8fd518 Mon Sep 17 00:00:00 2001 From: Manuel Schweiger Date: Wed, 19 Feb 2025 19:29:51 +0100 Subject: [PATCH 2/4] chore: add newline Signed-off-by: Manuel Schweiger --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index bf7e2c19b..f0a0635ae 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,7 @@ The following flags may be useful for extra functionality when running the image **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). + # Packages This repository consists of a series of ROS 2 packages for usage with Spot. From 06dbd98100bb484b271241c75dc3094245e44e50 Mon Sep 17 00:00:00 2001 From: Manuel Schweiger Date: Wed, 19 Feb 2025 19:31:41 +0100 Subject: [PATCH 3/4] fix: typo Signed-off-by: Manuel Schweiger --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f0a0635ae..d749baa00 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ 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-args EXPERIMENTAL_ZENOH_RMW=TRUE` | Enable experimental rmw_zenoh middleware. May result in issues we cannot address. | +| `--build-arg EXPERIMENTAL_ZENOH_RMW=TRUE` | Enable experimental rmw_zenoh middleware. May result in issues we cannot address. | ### Experimental - RMW ZENOH Middleware From f7acac1eb4f5cfbb88c7c4e05b836833198b97f3 Mon Sep 17 00:00:00 2001 From: Manuel Schweiger Date: Tue, 25 Feb 2025 17:01:26 +0100 Subject: [PATCH 4/4] docs: update zenoh disclaimer Signed-off-by: Manuel Schweiger --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d749baa00..5a675406f 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ The following flags may be useful for extra functionality when running the image ### 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). +**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 use the zenoh implementation, please refer to the [rmw_zenoh documentation](https://github.com/ros2/rmw_zenoh). # Packages