From 4ea97259b2cc01793cb4fa211641bfe76c282eda Mon Sep 17 00:00:00 2001 From: "Addisu Z. Taddese" Date: Wed, 11 Oct 2023 15:36:28 -0500 Subject: [PATCH] Bumps in Ionic: gz-transport14 (#455) Signed-off-by: Addisu Z. Taddese --- CMakeLists.txt | 2 +- Changelog.md | 4 ++++ README.md | 6 +++--- docker/gz-transport/Dockerfile | 2 +- example/CMakeLists.txt | 4 ++-- python/examples/data_race_with_mutex.py | 2 +- python/examples/data_race_without_mutex.py | 2 +- python/examples/publisher.py | 4 ++-- python/examples/requester.py | 2 +- python/examples/subscriber.py | 4 ++-- .../src/transport/_gz_transport_pybind11.cc | 2 +- python/test/options_TEST.py | 2 +- python/test/pubSub_TEST.py | 2 +- python/test/requester_TEST.py | 2 +- tutorials/04_messages.md | 18 ++++++++--------- tutorials/05_services.md | 20 +++++++++---------- tutorials/07_relay.md | 10 +++++----- tutorials/10_logging.md | 6 +++--- tutorials/23_topic_statistics.md | 2 +- 19 files changed, 50 insertions(+), 46 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index a65446be4..a44349a06 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR) #============================================================================ # Initialize the project #============================================================================ -project(gz-transport13 VERSION 13.0.0) +project(gz-transport14 VERSION 14.0.0) #============================================================================ # Find gz-cmake diff --git a/Changelog.md b/Changelog.md index cd27702f4..a5df01f6c 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,3 +1,7 @@ +## Gazebo Transport 14.X + +### Gazebo Transport 14.0.0 (2023-XX-XX) + ## Gazebo Transport 13.X ### Gazebo Transport 13.0.0 (2023-09-29) diff --git a/README.md b/README.md index 61425f00e..6e6b43b2f 100644 --- a/README.md +++ b/README.md @@ -55,11 +55,11 @@ combination of custom code and ZeroMQ. # Install -See the [installation tutorial](https://gazebosim.org/api/transport/13/installation.html). +See the [installation tutorial](https://gazebosim.org/api/transport/14/installation.html). # Usage -See [tutorials](https://gazebosim.org/api/transport/13/tutorials.html) +See [tutorials](https://gazebosim.org/api/transport/14/tutorials.html) and the [example directory](https://github.com/gazebosim/gz-transport/blob/main/example/) in the source code. @@ -79,7 +79,7 @@ This issue is tracked [here](https://github.com/gazebosim/gz-tools/issues/61). # Documentation -Visit the [documentation page](https://gazebosim.org/api/transport/13/index.html). +Visit the [documentation page](https://gazebosim.org/api/transport/14/index.html). # Folder Structure diff --git a/docker/gz-transport/Dockerfile b/docker/gz-transport/Dockerfile index e5dbac4d4..6d719bed5 100644 --- a/docker/gz-transport/Dockerfile +++ b/docker/gz-transport/Dockerfile @@ -72,7 +72,7 @@ RUN sudo /bin/sh -c 'echo "deb [trusted=yes] http://packages.osrfoundation.org/g && sudo apt-get clean # Gazebo transport -RUN git clone https://github.com/gazebosim/gz-transport.git -b gz-transport13 \ +RUN git clone https://github.com/gazebosim/gz-transport.git -b gz-transport14 \ && cd gz-transport \ && mkdir build \ && cd build \ diff --git a/example/CMakeLists.txt b/example/CMakeLists.txt index d37903e8c..304c32688 100644 --- a/example/CMakeLists.txt +++ b/example/CMakeLists.txt @@ -3,8 +3,8 @@ cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR) project(gz-transport-examples) # Find the Gazebo Transport library -find_package(gz-transport13 QUIET REQUIRED OPTIONAL_COMPONENTS log) -set(GZ_TRANSPORT_VER ${gz-transport13_VERSION_MAJOR}) +find_package(gz-transport14 QUIET REQUIRED OPTIONAL_COMPONENTS log) +set(GZ_TRANSPORT_VER ${gz-transport14_VERSION_MAJOR}) if (EXISTS "${CMAKE_SOURCE_DIR}/msgs/") # Message generation. Only required when using custom Protobuf messages. diff --git a/python/examples/data_race_with_mutex.py b/python/examples/data_race_with_mutex.py index caebaa0fa..3a1cf5ed6 100644 --- a/python/examples/data_race_with_mutex.py +++ b/python/examples/data_race_with_mutex.py @@ -14,7 +14,7 @@ # from gz.msgs10.vector3d_pb2 import Vector3d -from gz.transport13 import Node +from gz.transport14 import Node from threading import Lock import time diff --git a/python/examples/data_race_without_mutex.py b/python/examples/data_race_without_mutex.py index d77e5ea92..98d0f29ce 100644 --- a/python/examples/data_race_without_mutex.py +++ b/python/examples/data_race_without_mutex.py @@ -14,7 +14,7 @@ # from gz.msgs10.vector3d_pb2 import Vector3d -from gz.transport13 import Node +from gz.transport14 import Node import time diff --git a/python/examples/publisher.py b/python/examples/publisher.py index 0fdfa89eb..6a585a90f 100644 --- a/python/examples/publisher.py +++ b/python/examples/publisher.py @@ -15,8 +15,8 @@ from gz.msgs10.stringmsg_pb2 import StringMsg from gz.msgs10.vector3d_pb2 import Vector3d -from gz.transport13 import AdvertiseMessageOptions -from gz.transport13 import Node +from gz.transport14 import AdvertiseMessageOptions +from gz.transport14 import Node import time diff --git a/python/examples/requester.py b/python/examples/requester.py index 9da72b394..16077454d 100644 --- a/python/examples/requester.py +++ b/python/examples/requester.py @@ -14,7 +14,7 @@ # from gz.msgs10.stringmsg_pb2 import StringMsg -from gz.transport13 import Node +from gz.transport14 import Node def main(): node = Node() diff --git a/python/examples/subscriber.py b/python/examples/subscriber.py index f5f26b142..ef9dcc3aa 100644 --- a/python/examples/subscriber.py +++ b/python/examples/subscriber.py @@ -15,8 +15,8 @@ from gz.msgs10.stringmsg_pb2 import StringMsg from gz.msgs10.vector3d_pb2 import Vector3d -from gz.transport13 import SubscribeOptions -from gz.transport13 import Node +from gz.transport14 import SubscribeOptions +from gz.transport14 import Node import time diff --git a/python/src/transport/_gz_transport_pybind11.cc b/python/src/transport/_gz_transport_pybind11.cc index 0f8ac9422..a7619ba08 100644 --- a/python/src/transport/_gz_transport_pybind11.cc +++ b/python/src/transport/_gz_transport_pybind11.cc @@ -323,7 +323,7 @@ PYBIND11_MODULE(BINDINGS_MODULE_NAME, m) { .def("has_connections", &gz::transport::Node::Publisher::HasConnections, "Return true if this publisher has subscribers"); -} // gz-transport13 module +} // gz-transport14 module } // python } // transport diff --git a/python/test/options_TEST.py b/python/test/options_TEST.py index 9b2530a90..eaa6df2c7 100644 --- a/python/test/options_TEST.py +++ b/python/test/options_TEST.py @@ -1,5 +1,5 @@ from gz.msgs10.stringmsg_pb2 import StringMsg -from gz.transport13 import Node, AdvertiseMessageOptions, SubscribeOptions, NodeOptions +from gz.transport14 import Node, AdvertiseMessageOptions, SubscribeOptions, NodeOptions import unittest diff --git a/python/test/pubSub_TEST.py b/python/test/pubSub_TEST.py index a44278327..f159d5133 100644 --- a/python/test/pubSub_TEST.py +++ b/python/test/pubSub_TEST.py @@ -15,7 +15,7 @@ from gz.msgs10.stringmsg_pb2 import StringMsg from gz.msgs10.vector3d_pb2 import Vector3d -from gz.transport13 import Node, AdvertiseMessageOptions, SubscribeOptions, TopicStatistics +from gz.transport14 import Node, AdvertiseMessageOptions, SubscribeOptions, TopicStatistics from threading import Lock diff --git a/python/test/requester_TEST.py b/python/test/requester_TEST.py index 5523dcfa1..bce0f7b01 100644 --- a/python/test/requester_TEST.py +++ b/python/test/requester_TEST.py @@ -15,7 +15,7 @@ from gz.msgs10.int32_pb2 import Int32 from gz.msgs10.stringmsg_pb2 import StringMsg -from gz.transport13 import Node +from gz.transport14 import Node import os import subprocess diff --git a/tutorials/04_messages.md b/tutorials/04_messages.md index 98528d5fe..85bc5ab00 100644 --- a/tutorials/04_messages.md +++ b/tutorials/04_messages.md @@ -17,7 +17,7 @@ cd ~/gz_transport_tutorial ## Publisher -Download the [publisher.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/publisher.cc) file within the `gz_transport_tutorial` +Download the [publisher.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/publisher.cc) file within the `gz_transport_tutorial` folder and open it with your favorite editor: \snippet example/publisher.cc complete @@ -76,7 +76,7 @@ The method *Publish()* sends a message to all the subscribers. ## Subscriber -Download the [subscriber.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/subscriber.cc) +Download the [subscriber.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/subscriber.cc) file into the `gz_transport_tutorial` folder and open it with your favorite editor: \snippet example/subscriber.cc complete @@ -126,7 +126,7 @@ until you hit *CTRL-C*. Note that this function captures the *SIGINT* and ## Building the code -Download the [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/CMakeLists.txt) file within the `gz_transport_tutorial` folder. +Download the [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/CMakeLists.txt) file within the `gz_transport_tutorial` folder. Once you have all your files, go ahead and create a `build/` directory within the `gz_transport_tutorial` directory. @@ -273,7 +273,7 @@ between Gazebo Transport and another protocol or if you want to just print the content of a generic protobuf message using `DebugString()`, among other use cases. -Download the [subscriber_generic.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/subscriber_generic.cc) file within the `gz_transport_tutorial` folder and open it with your favorite editor: +Download the [subscriber_generic.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/subscriber_generic.cc) file within the `gz_transport_tutorial` folder and open it with your favorite editor: ```{.cpp} #include @@ -402,12 +402,12 @@ often the integration of the message generation into the build system of your project. Next, you can find an example of a publisher and subscriber using a custom Protobuf message integrated with CMake. -Download the [publisher_custom_msg.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/publisher_custom_msg.cc) -and the [subscriber_custom_msg.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/subscriber_custom_msg.cc) +Download the [publisher_custom_msg.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/publisher_custom_msg.cc) +and the [subscriber_custom_msg.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/subscriber_custom_msg.cc) files within the `gz_transport_tutorial`. Then, create a `msgs` folder and -download the [stringmsg.proto](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/msgs/stringmsg.proto) -and the [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/msgs/CMakeLists.txt) -files within the `msgs` folder. Finally, we'll need the main [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/CMakeLists.txt) +download the [stringmsg.proto](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/msgs/stringmsg.proto) +and the [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/msgs/CMakeLists.txt) +files within the `msgs` folder. Finally, we'll need the main [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/CMakeLists.txt) file. You should have this file from the previous examples. Otherwise, download and place it within the `gz_transport_tutorial` folder. diff --git a/tutorials/05_services.md b/tutorials/05_services.md index a411195cd..7bef1e0b7 100644 --- a/tutorials/05_services.md +++ b/tutorials/05_services.md @@ -25,7 +25,7 @@ cd ~/gz_transport_tutorial ## Responser -Download the [responser.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/responser.cc) file within the ``gz_transport_tutorial`` +Download the [responser.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/responser.cc) file within the ``gz_transport_tutorial`` folder and open it with your favorite editor: ```{.cpp} @@ -133,7 +133,7 @@ until you hit *CTRL-C*. Note that this function captures the *SIGINT* and ## Synchronous requester -Download the [requester.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/requester.cc) file within the ``gz_transport_tutorial`` +Download the [requester.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/requester.cc) file within the ``gz_transport_tutorial`` folder and open it with your favorite editor: ```{.cpp} @@ -228,7 +228,7 @@ message. ## Asynchronous requester -Download the [requester_async.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/requester_async.cc) file within the +Download the [requester_async.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/requester_async.cc) file within the ``gz_transport_tutorial`` folder and open it with your favorite editor: ```{.cpp} @@ -314,7 +314,7 @@ oneway service to process service requests without sending back responses. Oneway services don't accept any output parameters nor the requests have to wait for the response. -Download the [responser_oneway.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/responser_oneway.cc) file within the +Download the [responser_oneway.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/responser_oneway.cc) file within the ``gz_transport_tutorial`` folder and open it with your favorite editor: ```{.cpp} @@ -389,7 +389,7 @@ This case is similar to the oneway service provider. This code can be used for requesting a service that does not need a response back. We don't need any output parameters in this case nor we have to wait for the response. -Download the [requester_oneway.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/requester_oneway.cc) file within the +Download the [requester_oneway.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/requester_oneway.cc) file within the ``gz_transport_tutorial`` folder and open it with your favorite editor: ```{.cpp} @@ -454,7 +454,7 @@ request was already published. Sometimes we want to receive some result but don't have any input parameter to send. -Download the [responser_no_input.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/responser_no_input.cc) +Download the [responser_no_input.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/responser_no_input.cc) file within the ``gz_transport_tutorial`` folder and open it with your favorite editor: @@ -534,7 +534,7 @@ service requests. This case is similar to the service without input parameter. We don't send any request. -Download the [requester_no_input.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/requester_no_input.cc) +Download the [requester_no_input.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/requester_no_input.cc) file within the ``gz_transport_tutorial`` folder and open it with your favorite editor: @@ -577,14 +577,14 @@ request timed out or reached the service provider and ``result`` shows if the service was successfully executed. We also have the async version for service request without input. You should -download [requester_async_no_input.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/requester_async_no_input.cc) +download [requester_async_no_input.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/requester_async_no_input.cc) file within the ``gz_transport_tutorial`` folder. ## Building the code -Download the [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/CMakeLists.txt) file +Download the [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/CMakeLists.txt) file within the ``gz_transport_tutorial`` folder. Then, create a `msgs` directory -and download [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/msgs/CMakeLists.txt) and [stringmsg.proto](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/msgs/stringmsg.proto) inside the +and download [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/msgs/CMakeLists.txt) and [stringmsg.proto](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/msgs/stringmsg.proto) inside the ``msgs`` directory. Once you have all your files, go ahead and create a ``build/`` folder within diff --git a/tutorials/07_relay.md b/tutorials/07_relay.md index de417f59b..24fe7e215 100644 --- a/tutorials/07_relay.md +++ b/tutorials/07_relay.md @@ -25,13 +25,13 @@ install Docker following any of the existing guides available ([here](https://docs.docker.com/get-docker/)'s one). We're going to build a Docker image and run it inside your host computer. -Download the [build.bash](https://github.com/gazebosim/gz-transport/raw/gz-transport13/docker/build.bash), [run.bash](https://github.com/gazebosim/gz-transport/raw/gz-transport13/docker/run.bash) and -[Dockerfile](https://github.com/gazebosim/gz-transport/raw/gz-transport13/docker/gz-transport/Dockerfile) files. +Download the [build.bash](https://github.com/gazebosim/gz-transport/raw/gz-transport14/docker/build.bash), [run.bash](https://github.com/gazebosim/gz-transport/raw/gz-transport14/docker/run.bash) and +[Dockerfile](https://github.com/gazebosim/gz-transport/raw/gz-transport14/docker/gz-transport/Dockerfile) files. ```{.sh} -wget https://github.com/gazebosim/gz-transport/raw/gz-transport13/docker/build.bash -wget https://github.com/gazebosim/gz-transport/raw/gz-transport13/docker/run.bash -mkdir gz-transport && wget https://github.com/gazebosim/gz-transport/raw/gz-transport13/docker/gz-transport/Dockerfile -O gz-transport/Dockerfile +wget https://github.com/gazebosim/gz-transport/raw/gz-transport14/docker/build.bash +wget https://github.com/gazebosim/gz-transport/raw/gz-transport14/docker/run.bash +mkdir gz-transport && wget https://github.com/gazebosim/gz-transport/raw/gz-transport14/docker/gz-transport/Dockerfile -O gz-transport/Dockerfile chmod +x build.bash run.bash ``` diff --git a/tutorials/10_logging.md b/tutorials/10_logging.md index 7cb22cd4c..3e4e96aa7 100644 --- a/tutorials/10_logging.md +++ b/tutorials/10_logging.md @@ -25,7 +25,7 @@ cd ~/gz_transport_tutorial ## Record -Download the [record.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/record.cc) +Download the [record.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/record.cc) file within the `gz_transport_tutorial` folder and open it with your favorite editor: ```{.cpp} @@ -126,7 +126,7 @@ stops the log recording as expected. ## Play back -Download the [playback.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/playback.cc) +Download the [playback.cc](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/playback.cc) file within the `gz_transport_tutorial` folder and open it with your favorite editor: @@ -215,7 +215,7 @@ thread until all messages have been published. ## Building the code -Download the [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport13/example/CMakeLists.txt) +Download the [CMakeLists.txt](https://github.com/gazebosim/gz-transport/raw/gz-transport14/example/CMakeLists.txt) file within the `gz_transport_tutorial` folder. Once you have all your files, go ahead and create a `build/` directory within diff --git a/tutorials/23_topic_statistics.md b/tutorials/23_topic_statistics.md index 8d55d17bf..1f24806f6 100644 --- a/tutorials/23_topic_statistics.md +++ b/tutorials/23_topic_statistics.md @@ -44,7 +44,7 @@ if (!node.EnableStats(topic, true)) } ``` -A complete example can be found in the [subscriber_stats example program](https://github.com/gazebosim/gz-transport/blob/gz-transport13/example/subscriber_stats.cc). +A complete example can be found in the [subscriber_stats example program](https://github.com/gazebosim/gz-transport/blob/gz-transport14/example/subscriber_stats.cc). With both `GZ_TRANSPORT_TOPIC_STATISTICS` set to `1` and a node enabling topic statistics, then you will be able to echo statistic