Merge pull request #74 from fabawi/dev

Further updates renaming ROS2 to ROS 2
modular-ml · Nov 6, 2023 · 4baa6e0 · 4baa6e0
2 parents 7fb5bb0 + 97f5d41
commit 4baa6e0
Show file tree

Hide file tree

Showing 27 changed files with 30 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ Note that the iCub package is not needed for Wrapyfi to work and does not have t
 * For installing ROS, follow the [ROS installation guide](http://wiki.ros.org/noetic/Installation/Ubuntu). 
 We recommend installing ROS on Conda using the [RoboStack](https://github.com/RoboStack/ros-noetic) environment.
 
-* For installing ROS2, follow the [ROS 2 installation guide](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html). 
+* For installing ROS 2, follow the [ROS 2 installation guide](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html). 
 We recommend installing ROS 2 on Conda using the [RoboStack](https://github.com/RoboStack/ros-humble) environment.
 
 * ZeroMQ can be installed using pip: `pip install pyzmq`. 
@@ -279,7 +279,7 @@ For more examples of usage, refer to the [user guide](docs/usage.md). Run script
 ## Middleware
 * [x] **YARP**
 * [x] **ROS**
-* [x] **ROS2**
+* [x] **ROS 2**
 * [x] **ZeroMQ** (beta feature: `should_wait` trigger introduced with event monitoring)
 
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -91,7 +91,7 @@ def setup(app):
 all_imported_modules = all_imported_modules_pre
 mock_imports = [mod for mod in all_imported_modules]
 autodoc_mock_imports = mock_imports
-# run from within an environment that has all requirements installed besides ROS2
+# run from within an environment that has all requirements installed besides ROS 2
 # autodoc_mock_imports = ["rclpy", "rclpy.node", "Parameter", "Node"]
 
 # extract project info

diff --git a/docs/usage.md b/docs/usage.md
@@ -69,7 +69,7 @@ Methods with a single return should be followed by a comma e.g., return encapsul
 
 Each of the list's returns is encapsulated with its own publisher and listener, with the named arguments transmitted as 
 a single dictionary within the list. Notice that `encapsulated_a` returns a list of length 3, therefore, the first decorator contains 
-3 list configurations as well. This is useful especially when transmitting multiple images or audio chunks over YARP, ROS, and ROS2.
+3 list configurations as well. This is useful especially when transmitting multiple images or audio chunks over YARP, ROS, and ROS 2.
 Note that by using a single `NativeObject` as a `<Data structure type>`, the same 
 can be achieved. However, the implementation of the `NativeObject` for most middleware serializes the 
 objects as strings before transmission. The `NativeObject` may result in a greater overhead and should only be used when multiple nesting depths are 

diff --git a/docs/usage/User Guide.md b/docs/usage/User Guide.md
@@ -68,7 +68,7 @@ Methods with a single return should be followed by a comma e.g., return encapsul
 
 Each of the list's returns is encapsulated with its own publisher and listener, with the named arguments transmitted as 
 a single dictionary within the list. Notice that `encapsulated_a` returns a list of length 3, therefore, the first decorator contains 
-3 list configurations as well. This is useful especially when transmitting multiple images or audio chunks over YARP, ROS, and ROS2.
+3 list configurations as well. This is useful especially when transmitting multiple images or audio chunks over YARP, ROS, and ROS 2.
 Note that by using a single `NativeObject` as a `<Data structure type>`, the same 
 can be achieved. However, the implementation of the `NativeObject` for most middleware serializes the 
 objects as strings before transmission. The `NativeObject` may result in a greater overhead and should only be used when multiple nesting depths are 

diff --git a/docs/usage/User Guide/Communication Patterns.md b/docs/usage/User Guide/Communication Patterns.md
@@ -40,7 +40,7 @@ All messages are transmitted using the rospy python bindings as topic messages
                   [geometry_msgs](http://wiki.ros.org/geometry_msgs), and [sensor_msgs](http://wiki.ros.org/sensor_msgs) can be directly 
                   returned by the method do not need to be converted to native types
 
-*(ROS2)*: 
+*(ROS 2)*: 
 
 ```{warning}
 ROS 2 requires a custom message to handle audio. This message must be compiled first before using Wrapyfi with ROS 2 Audio. 
@@ -100,7 +100,7 @@ The requester formats its arguments as *(\[args\], {kwargs})*
 * **AudioChunk**: Transmits and receives a `numpy` audio chunk using `wrapyfi_ros_interfaces.msg.ROSAudioMessage`
 * **NativeObject**: Transmits and receives a `json` string supporting all native python objects, `numpy` arrays, and [other formats](<Plugins.md#data-structure-types>) using `std_msgs.msg.String`
 
-*(ROS2)*:
+*(ROS 2)*:
 
 ```{warning}
 ROS 2 requires custom services to handle arbitrary messages. These services must be compiled first before using Wrapyfi in this mode. 

diff --git a/examples/communication_patterns/request_reply_example.py b/examples/communication_patterns/request_reply_example.py
@@ -14,7 +14,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - OpenCV: Used for handling and creating images (installed with Wrapyfi)
     - sounddevice, soundfile: Used for handling audio
 

diff --git a/examples/communication_schemes/channeling_example.py b/examples/communication_schemes/channeling_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - NumPy: Used for creating arrays (installed with Wrapyfi)
 
     Install using pip:

diff --git a/examples/communication_schemes/forwarding_example.py b/examples/communication_schemes/forwarding_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
 
 Run:
     # On machine 1 (or process 1): Mode Chain A: Publisher [ZeroMQ], Chain B: Disabled (chain A & B can have different middleware

diff --git a/examples/communication_schemes/mirroring_example.py b/examples/communication_schemes/mirroring_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
 
 Run:
     # Alternative 1: PUB/SUB

diff --git a/examples/custom_msgs/ros2_message_example.py b/examples/custom_msgs/ros2_message_example.py
@@ -13,7 +13,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - ROS2, rclpy: Used for handling and creating ROS 2 messages (refer to the Wrapyfi documentation for installation instructions)
+    - ROS 2, rclpy: Used for handling and creating ROS 2 messages (refer to the Wrapyfi documentation for installation instructions)
 
     Ensure ROS 2 is installed and the required message types are available.
 
@@ -43,7 +43,7 @@ class Notifier(MiddlewareCommunicator):
         should_wait=True
     )
     def send_message(self):
-        """Exchange ROS 2 messages over ROS2."""
+        """Exchange ROS 2 messages over ROS 2."""
         msg = input("Type your message: ")
         quat = Quaternion()
         quat.x = 0.1

diff --git a/examples/encoders/astropy_example.py b/examples/encoders/astropy_example.py
@@ -15,7 +15,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - Astropy: Used for creating and handling astronomical tables
 
     Install using pip:

diff --git a/examples/encoders/dask_example.py b/examples/encoders/dask_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - Dask, pandas: Used for handling and creating arrays and dataframes
 
     Install using pip:

diff --git a/examples/encoders/jax_example.py b/examples/encoders/jax_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - JAX: Used for handling and creating arrays (refer to https://jax.readthedocs.io/en/latest/installation.html for installation instructions)
 
     Install using pip:

diff --git a/examples/encoders/mxnet_example.py b/examples/encoders/mxnet_example.py
@@ -14,7 +14,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - MXNet: Used for handling and creating tensors (refer to https://mxnet.apache.org/get_started for installation instructions)
 
     Install using pip:

diff --git a/examples/encoders/numpy_pandas_example.py b/examples/encoders/numpy_pandas_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - NumPy: Used for creating arrays (installed with Wrapyfi)
     - pandas: Used for creating and handling series and dataframes
 

diff --git a/examples/encoders/paddlepaddle_example.py b/examples/encoders/paddlepaddle_example.py
@@ -14,7 +14,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - PaddlePaddle: Used for handling and creating tensors (refer to https://www.paddlepaddle.org.cn/en/install/quick for installation instructions)
 
     Install using pip:

diff --git a/examples/encoders/pillow_example.py b/examples/encoders/pillow_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - NumPy: Used for creating image arrays (installed with Wrapyfi)
     - PIL (Pillow): Used for handling image objects
 

diff --git a/examples/encoders/pint_example.py b/examples/encoders/pint_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - Pint: Used for handling physical quantities with units
 
     Install using pip:

diff --git a/examples/encoders/pyarrow_example.py b/examples/encoders/pyarrow_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - PyArrow: Used for handling Apache Arrow arrays
 
     Install using pip:

diff --git a/examples/encoders/pytorch_example.py b/examples/encoders/pytorch_example.py
@@ -14,7 +14,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - PyTorch: Used for handling and creating tensors (refer to https://pytorch.org/get-started/locally/ for installation instructions)
 
     Install using pip:

diff --git a/examples/encoders/tensorflow_example.py b/examples/encoders/tensorflow_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - TensorFlow: Used for creating and handling tensors (refer to https://www.tensorflow.org/install for installation instructions)
 
     Install using pip:

diff --git a/examples/encoders/xarray_example.py b/examples/encoders/xarray_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - NumPy: Used for creating arrays (installed with Wrapyfi)
     - xarray, pandas: Used for creating and handling DataArrays
 

diff --git a/examples/encoders/zarr_example.py b/examples/encoders/zarr_example.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - NumPy: Used for creating arrays (installed with Wrapyfi)
     - zarr: Used for creating and handling Zarr arrays and groups
 

diff --git a/examples/hello_world.py b/examples/hello_world.py
@@ -6,7 +6,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
 
 Run:
     # Alternative 1: PUB/SUB mode

diff --git a/examples/robots/icub_head.py b/examples/robots/icub_head.py
@@ -12,7 +12,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - iCub Robot and Simulator: Ensure the robot and its simulator are installed and configured.
         When running in simulation mode, the `iCub_SIM` must be running in a standalone terminal
         (refer to the Wrapyfi documentation for installation instructions)

diff --git a/examples/sensors/cam_mic.py b/examples/sensors/cam_mic.py
@@ -16,7 +16,7 @@
 
 Requirements:
     - Wrapyfi: Middleware communication wrapper (refer to the Wrapyfi documentation for installation instructions)
-    - YARP, ROS, ROS2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
+    - YARP, ROS, ROS 2, ZeroMQ (refer to the Wrapyfi documentation for installation instructions)
     - OpenCV: Used for handling and creating images (installed with Wrapyfi)
     - sounddevice, soundfile: Used for handling audio
 

diff --git a/setup.py b/setup.py
@@ -34,7 +34,7 @@ def check_cv2(default_python="opencv-python"):
 
 setuptools.setup(
     name             = 'wrapyfi',
-    version          = '0.4.27',
+    version          = '0.4.28',
     description      = 'Wrapyfi is a wrapper for simplifying Middleware communication',
     url              = 'https://github.com/fabawi/wrapyfi/blob/master/',
     project_urls={