Skip to content

Commit ab7f4de

Browse files
committed
Squashed commit of the following:
commit 72effa7 Author: Luke Schmitt <[email protected]> Date: Tue Nov 1 17:26:25 2022 -0500 Fix list formatting on Contact page (ros2#3153) commit dcd066f Author: Dan Zimmerman <[email protected]> Date: Tue Nov 1 16:29:34 2022 -0400 Update throttle logging docs with units and data type hints (re: rclcpp/issues/1929) (ros2#3143) * Note milliseconds on API Concepts page * Add units and types to About Logging page Co-authored-by: dan <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> commit 375b6cf Author: definitelyuncertain <[email protected]> Date: Fri Oct 28 14:30:22 2022 -0500 Change to mention explicit requirement for folder names for .msg and .srv files (ros2#3144) * Change to mention explicit requirement for folder names for msg and srv files From ros2/tutorials#29 * fix typo Co-authored-by: Tomoya Fujita <[email protected]> * fix rst formatting Co-authored-by: Chris Lalancette <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> commit da871ef Author: Sergei Sergienko <[email protected]> Date: Thu Oct 27 17:20:06 2022 +0300 fix link to Gazebo-ROS2 bridge + CLI examples (ros2#3139) * fix link to Gazebo-ROS2 bridge + CLI examples Co-authored-by: Chris Lalancette <[email protected]> commit e19c9b5 Author: Chris Lalancette <[email protected]> Date: Wed Oct 26 16:31:21 2022 -0400 Update the language to match the source code. (ros2#3135) Fallout from ros2#2865 Signed-off-by: Chris Lalancette <[email protected]> commit a5910a1 Author: Chris Lalancette <[email protected]> Date: Wed Oct 26 08:38:36 2022 -0400 Shorten the Windows build-from-source path. (ros2#3130) * Shorten the Windows build-from-source path. This is to keep the total length down below the 260 character limit imposed by Windows by default. Signed-off-by: Chris Lalancette <[email protected]> commit 8225686 Author: Chris Lalancette <[email protected]> Date: Mon Oct 24 08:30:37 2022 -0400 Fix up the variable name in the traveling in time (C++) tutorial. (ros2#3115) This is just to match what is in the code in the upstream repository. Signed-off-by: Chris Lalancette <[email protected]> commit 87ab121 Author: Ian Colwell <[email protected]> Date: Fri Oct 21 11:07:30 2022 -0400 Update default WORKING_DIRECTORY for ament_add_gtest() (ros2#3117) commit 87bf20a Author: chianfern <[email protected]> Date: Tue Oct 18 21:36:57 2022 +0800 Add ParameterDescriptor to 'Using parameters in a class (C++)' (ros2#2865) * Rename node name in "Using parameters" C++ tutorial to be consistent with Python tutorial. Signed-off-by: Tan Chian Fern <[email protected]> Signed-off-by: Chris Lalancette <[email protected]> commit 77646ce Author: George Stavrinos <[email protected]> Date: Tue Oct 18 15:29:37 2022 +0300 Fixed Intel's robot SDK repo with the new devkit name + reference to MoveIt2 instead of 1. (ros2#3107) commit 1d24955 Author: Chris Lalancette <[email protected]> Date: Mon Oct 17 14:06:52 2022 -0400 Monitor parameter changes: Add note to save callback handle (ros2#3102) Signed-off-by: Chris Lalancette <[email protected]> commit 8910a80 Author: David V. Lu!! <[email protected]> Date: Fri Oct 14 09:56:14 2022 -0400 Some testing basics (ros2#3084) * Some testing basics Signed-off-by: David V. Lu <[email protected]> Signed-off-by: Chris Lalancette <[email protected]> commit 8771452 Author: Tomoya Fujita <[email protected]> Date: Fri Oct 14 05:34:20 2022 -0700 Sony's task for Iron Release. (ros2#3089) * Sony's task for Iron Release. Signed-off-by: Tomoya.Fujita <[email protected]> * Rearrange and add in links. Signed-off-by: Chris Lalancette <[email protected]> Signed-off-by: Tomoya.Fujita <[email protected]> Signed-off-by: Chris Lalancette <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> commit 2ea9e7d Author: Yannick Goumaz <[email protected]> Date: Fri Oct 14 14:23:13 2022 +0200 Update Setting-up a Robot Simulation (Webots) tutorial (ros2#3090) * Update intro to WSL * Update world with declarations * Add supervisor node and environment var * Update tutorial with explanations Co-authored-by: ad-daniel <[email protected]> commit 0390a50 Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Date: Thu Oct 13 13:42:30 2022 -0400 fix unresolved package requirement to install Humble on Ubuntu 20.04 (ros2#3086) (ros2#3088) * fix command to install humble on Ubuntu 20.04 Co-authored-by: paolo.dimasi <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 5626af9) Co-authored-by: Paolo Dimasi <[email protected]>
1 parent 8754e15 commit ab7f4de

20 files changed

+348
-125
lines changed

source/Concepts/About-Logging.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ These are the APIs that end users of the ROS 2 logging infrastructure should use
5353
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_EXPRESSION`` - output the given printf-style message only if the given expression is true
5454
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_FUNCTION`` - output the given printf-style message only if the given function returns true
5555
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_SKIPFIRST`` - output the given printf-style message all but the first time this line is hit
56-
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_THROTTLE`` - output the given printf-style message no more than the given rate
57-
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_SKIPFIRST_THROTTLE`` - output the given printf-style message no more than the given rate, but skip the first
56+
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_THROTTLE`` - output the given printf-style message no more than the given rate in integer milliseconds
57+
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_SKIPFIRST_THROTTLE`` - output the given printf-style message no more than the given rate in integer milliseconds, but skip the first
5858
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_STREAM`` - output the given C++ stream-style message every time this line is hit
5959
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_STREAM_ONCE`` - output the given C++ stream-style message only the first time this line is hit
6060
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_STREAM_EXPRESSION`` - output the given C++ stream-style message only if the given expression is true
6161
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_STREAM_FUNCTION`` - output the given C++ stream-style message only if the given function returns true
6262
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_STREAM_SKIPFIRST`` - output the given C++ stream-style message all but the first time this line is hit
63-
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_STREAM_THROTTLE`` - output the given C++ stream-style message no more than the given rate
64-
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_STREAM_SKIPFIRST_THROTTLE`` - output the given C++ stream-style message no more than the given rate, but skip the first
63+
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_STREAM_THROTTLE`` - output the given C++ stream-style message no more than the given rate in integer milliseconds
64+
* ``RCLCPP_{DEBUG,INFO,WARN,ERROR,FATAL}_STREAM_SKIPFIRST_THROTTLE`` - output the given C++ stream-style message no more than the given rate in integer milliseconds, but skip the first
6565

6666
Each of the above APIs takes an ``rclcpp::Logger`` object as the first argument.
6767
This can be pulled from the node API by calling ``node->get_logger()`` (recommended), or by constructing a stand-alone ``rclcpp::Logger`` object.
@@ -73,7 +73,7 @@ These are the APIs that end users of the ROS 2 logging infrastructure should use
7373

7474
* ``logger.{debug,info,warning,error,fatal}`` - output the given Python string to the logging infrastructure. The calls accept the following keyword args to control behavior:
7575

76-
* ``throttle_duration_sec`` - if not None, the duration of the throttle interval
76+
* ``throttle_duration_sec`` - if not None, the duration of the throttle interval in floating-point seconds
7777
* ``skip_first`` - if True, output the message all but the first time this line is hit
7878
* ``once`` - if True, only output the message the first time this line is hit
7979

source/Contact.rst

+1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ If following a tutorial or online instructions provide a link to the specific in
5959
* When discussing any compiling/linking/installation issues, also provide the compiler version
6060

6161
As appropriate, also include your:
62+
6263
* ROS environment variables (env | grep ROS)
6364
* Backtraces
6465
* Relevant config files

source/How-To-Guides/Ament-CMake-Documentation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ The macros have additional parameters:
326326

327327
- ``WORKING_DIRECTORY``: set the working directory for the test.
328328

329-
The default working directory otherwise is the ``CMAKE_SOURCE_DIR``, which will be evaluated to the directory of the top-level ``CMakeLists.txt``.
329+
The default working directory otherwise is the ``CMAKE_CURRENT_BINARY_DIR``, which is described in the `CMake documentation <https://cmake.org/cmake/help/latest/variable/CMAKE_CURRENT_BINARY_DIR.html>`_.
330330

331331
Similarly, there is a CMake macro to set up GTest including GMock:
332332

source/Installation/Alternatives/Ubuntu-Development-Setup.rst

+37-9
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Add the ROS 2 apt repository
4646
Install development tools and ROS tools
4747
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4848

49+
Install common packages
50+
4951
.. code-block:: bash
5052
5153
sudo apt update && sudo apt install -y \
@@ -54,24 +56,50 @@ Install development tools and ROS tools
5456
git \
5557
python3-colcon-common-extensions \
5658
python3-flake8 \
57-
python3-flake8-blind-except \
58-
python3-flake8-builtins \
59-
python3-flake8-class-newline \
60-
python3-flake8-comprehensions \
61-
python3-flake8-deprecated \
6259
python3-flake8-docstrings \
63-
python3-flake8-import-order \
64-
python3-flake8-quotes \
6560
python3-pip \
6661
python3-pytest \
6762
python3-pytest-cov \
68-
python3-pytest-repeat \
69-
python3-pytest-rerunfailures \
7063
python3-rosdep \
7164
python3-setuptools \
7265
python3-vcstool \
7366
wget
7467
68+
Install packages according to your Ubuntu version
69+
70+
.. tabs::
71+
72+
.. group-tab:: Ubuntu 22.04 LTS and later
73+
74+
.. code-block:: console
75+
76+
sudo apt install -y \
77+
python3-flake8-blind-except
78+
python3-flake8-builtins
79+
python3-flake8-class-newline
80+
python3-flake8-comprehensions
81+
python3-flake8-deprecated
82+
python3-flake8-import-order
83+
python3-flake8-quotes
84+
python3-pytest-repeat
85+
python3-pytest-rerunfailures
86+
87+
.. group-tab:: Ubuntu 20.04 LTS
88+
89+
.. code-block:: bash
90+
91+
python3 -m pip install -U \
92+
flake8-blind-except \
93+
flake8-builtins \
94+
flake8-class-newline \
95+
flake8-comprehensions \
96+
flake8-deprecated \
97+
flake8-import-order \
98+
flake8-quotes \
99+
pytest-repeat \
100+
pytest-rerunfailures
101+
102+
75103
.. _Rolling_linux-dev-get-ros2-code:
76104

77105
Get ROS 2 code

source/Installation/Alternatives/Windows-Development-Setup.rst

+12-7
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,17 @@ Get the ROS 2 code
6565

6666
Now that we have the development tools we can get the ROS 2 source code.
6767

68-
First setup a development folder, for example ``C:\dev\ros2_{DISTRO}``:
68+
First setup a development folder, for example ``C:\{DISTRO}``:
69+
70+
.. note::
71+
72+
It is very important that the chosen path is short, due to the short default Windows path limits (260 characters).
73+
To allow longer paths, see https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry.
6974

7075
.. code-block:: bash
7176
72-
md \dev\ros2_{DISTRO}\src
73-
cd \dev\ros2_{DISTRO}
77+
md \{DISTRO}\src
78+
cd \{DISTRO}
7479
7580
Get the ``ros2.repos`` file which defines the repositories to clone from:
7681

@@ -81,6 +86,8 @@ Get the ``ros2.repos`` file which defines the repositories to clone from:
8186
Install additional DDS implementations (optional)
8287
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8388

89+
Fast DDS is bundled with the ROS 2 source and will always be built unless you put an ``COLCON_IGNORE`` file in the ``src\eProsima`` folder.
90+
8491
If you would like to use another DDS or RTPS vendor besides the default, you can find instructions :doc:`here <../DDS-Implementations>`.
8592

8693
Build the ROS 2 code
@@ -90,9 +97,7 @@ Build the ROS 2 code
9097

9198
To build ROS 2 you will need a Visual Studio Command Prompt ("x64 Native Tools Command Prompt for VS 2019") running as Administrator.
9299

93-
Fast RTPS is bundled with the ROS 2 source and will always be built unless you put an ``AMENT_IGNORE`` file in the ``src\eProsima`` folder.
94-
95-
To build the ``\dev\ros2_{DISTRO}`` folder tree:
100+
To build the ``\{DISTRO}`` folder tree:
96101

97102
.. code-block:: bash
98103
@@ -115,7 +120,7 @@ Start a command shell and source the ROS 2 setup file to set up the workspace:
115120

116121
.. code-block:: bash
117122
118-
call C:\dev\ros2_{DISTRO}\install\local_setup.bat
123+
call C:\{DISTRO}\install\local_setup.bat
119124
120125
This will automatically set up the environment for any DDS vendors that support was built for.
121126

source/Related-Projects/Intel-ROS2-Projects.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ We are working on below ROS 2 projects and publish source code through https://g
2121
* `ROS2 CV Bridge <https://github.com/ros-perception/vision_opencv/tree/ros2/cv_bridge>`__: ROS 2 package to bridge with openCV.
2222
* `ROS2 Object Map <https://github.com/intel/ros2_object_map>`__: ROS 2 package to mark tag of objects on map when SLAM based on information provided by ROS 2 object analytics.
2323
* `ROS2 Moving Object <https://github.com/intel/ros2_moving_object>`__: ROS 2 package to provide object motion information (like object velocity on x, y, z axis) based on information provided by ROS 2 object analytics.
24-
* `ROS2 Grasp Library <https://github.com/intel/ros2_grasp_library>`__: ROS 2 package for grasp position analysis, and compatible with `MoveIt <https://github.com/ros-planning/moveit.git>`__ grasp interfaces.
24+
* `ROS2 Grasp Library <https://github.com/intel/ros2_grasp_library>`__: ROS 2 package for grasp position analysis, and compatible with `MoveIt <https://github.com/ros-planning/moveit2.git>`__ grasp interfaces.
2525
* `ROS2 Navigation <https://github.com/ros-planning/navigation2>`__: ROS 2 package for robot navigation, it's already integrated to ROS 2 Crystal release.
26-
* `Robot SDK <https://github.com/intel/robot_sdk>`__: An open source project which enables developers to easily and efficiently create, customize, optimize, and deploy a robot software stack to an Autonomous Mobile Robot (AMR) platform based on the Robot Operating System 2 (ROS 2) framework.
26+
* `Intel Robot DevKit (SDK) <https://github.com/intel/robot_devkit>`__: An open source project which enables developers to easily and efficiently create, customize, optimize, and deploy a robot software stack to an Autonomous Mobile Robot (AMR) platform based on the Robot Operating System 2 (ROS 2) framework.
2727

2828
Reference
2929
---------

source/The-ROS2-Project/Contributing/Developer-Guide.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ Examples:
209209
Testing
210210
^^^^^^^
211211

212-
All packages should have some level of system, integration, and/or unit tests.
212+
All packages should have some level of :ref:`system, integration, and/or unit tests.<TestingMain>`
213213

214214
**Unit tests** should always be in the package which is being tested and should make use of tools like ``Mock`` to try and test narrow parts of the code base in constructed scenarios.
215215
Unit tests should not bring in test dependencies that are not testing tools, e.g. gtest, nosetest, pytest, mock, etc...

source/The-ROS2-Project/Roadmap.rst

+12
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,18 @@ If you'd like to take on one of these tasks, please :doc:`get in touch with us <
9191
- Large
9292
- Open Robotics
9393
- Q2 2023
94+
* - `ContentFiltering fallback in rcl <https://github.com/ros2/design/pull/282>`__
95+
- Large
96+
- Sony Group Corporation
97+
- Q1 2023
98+
* - `on_pub/sub_matched callback support <https://github.com/ros2/rmw/issues/330>`__
99+
- Medium
100+
- Sony Group Corporation
101+
- Q1 2023
102+
* - ROS 2 core ContentFiltering Enhancement
103+
- Medium
104+
- Sony Group Corporation
105+
- Q2 2023
94106

95107
Additional project-specific roadmaps can be found in the links below:
96108

source/Tutorials/Advanced/Simulators/Ignition.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ In particular you are going to create a bridge for the topic ``/model/vehicle_bl
116116
source /opt/ros/{DISTRO}/setup.bash
117117
ros2 run ros_ign_bridge parameter_bridge /model/vehicle_blue/cmd_vel@geometry_msgs/msg/Twist]ignition.msgs.Twist
118118
119-
For more details about the ``ros_ign_bridge`` please check this `README <https://github.com/ignitionrobotics/ros_ign/tree/ros2/ros_ign_bridge>`__ .
119+
For more details about the ``ros_ign_bridge`` please check this `README <https://github.com/gazebosim/ros_gz/tree/ros2/ros_gz_bridge>`__ .
120120

121121
Once the bridge is running the robot is able to follow your motor commands.
122122
There are two options:

source/Tutorials/Advanced/Simulators/Webots.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ The ``robot_description`` parameter holds the contents of the URDF file which re
234234

235235
After that, the three nodes are set to be launched in the ``LaunchDescription`` constructor:
236236

237-
.. literalinclude:: Code/robot_launch_linux.py
237+
.. literalinclude:: Code/robot_launch.py
238238
:language: python
239239
:dedent: 4
240240
:lines: 30-33

source/Tutorials/Beginner-Client-Libraries/Custom-ROS2-Interfaces.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Since we will use the pub/sub and service/client packages created in earlier tut
5252
Note that it is a CMake package; there currently isn’t a way to generate a ``.msg`` or ``.srv`` file in a pure Python package.
5353
You can create a custom interface in a CMake package, and then use it in a Python node, which will be covered in the last section.
5454

55-
It is good practice to keep ``.msg`` and ``.srv`` files in their own directories within a package.
55+
The ``.msg`` and ``.srv`` files are required to be placed in directories called ``msg`` and ``srv`` respectively.
5656
Create the directories in ``ros2_ws/src/tutorial_interfaces``:
5757

5858
.. code-block:: console

0 commit comments

Comments
 (0)