ROS2入门教程—ros2doctor简介

  当ROS 2安装程序未按预期运行时，可以使用 ros2 doctor工具检查其设置。 ros2 doctor检查ROS 2的所有方面，包括平台，版本，网络，环境，正在运行的系统等，并警告您可能的错误和问题原因。

  ros2 doctor仅在Eloquent及更高的版本中可以使用。

  ros2 doctor是ros2cli包的一部分。只要我们安装了ros2cli，我们就能够使用ros2 doctor，通常我们安装ros2的时候就安装了这个包。

1 检查设置

  打开一个新终端，设置环境变量，运行如下命令可以查看ros2 doctor的帮助文档：

ros2 doctor -h

  终端中输出如下信息：

usage: ros2 doctor [-h] [--report | --report-failed] [--include-warnings]

Check ROS setup and other potential issues

optional arguments:
  -h, --help            show this help message and exit
  --report, -r          Print all reports.
  --report-failed, -rf  Print reports of failed checks only.
  --include-warnings, -iw
                        Include warnings as failed checks. Warnings are
                        ignored by default.

  接下来让我们用ros2 doctor对ros2的整体设置进行检查，运行如下命令：

ros2 doctor

  这将对所有安装模块进行检查，并返回警告和错误。
  当没有任何警告以及错误信息时，您将看到类似如下形式的输出：

All <n> checks passed

  然而，返回一些警告并不罕见。UserWarning并不意味着你的设置不可用；更可能的是，这只是一种暗示，表明某些东西的配置方式并不理想。如果您确实收到警告，它将如下所示：

<path>: <line>: UserWarning: <message>

  例如，如果您使用的是不稳定的ROS 2发布版本，则ros2 doctor将发出此警告：

UserWarning: Distribution <distro> is not fully supported or tested. To get more consistent features, download a stable version at https://index.ros.org/doc/ros2/Installation/

  如果ros2 doctor仅在您的系统中发现警告，您仍将收到All <n> checks passed的提示消息。大多数检查都是进行警告而不是报错。主要还是取决于用户自己来决定ros2 doctor反馈的重要性。如果在我们的设置当中找到一个比较严重的错误，就会显示UserWarning: ERROR:，并且认为检查失败。同时，我们会收到类似于这样的一条消息：

1/3 checks failed

Failed modules:  network

  错误表示系统缺少对ROS2非常重要的设置或功能，我们应该解决错误以确保系统正常运行。

2 检查系统

  我们还可以检查正在运行的ROS 2系统，以确定问题的可能原因。要查看ros2 doctor在运行系统上的工作情况，让我们运行Turtlesim，使得节点之间可以进行主动通信。

  打开新终端，设置环境变量，并运行：

ros2 run turtlesim turtlesim_node

  打开另一个终端，设置环境变量并运行：

ros2 run turtlesim turtle_teleop_key

  再次运行ros2 doctor，我们会得到下面这样两条警告信息：

UserWarning: Publisher without subscriber detected on /turtle1/color_sensor.
UserWarning: Publisher without subscriber detected on /turtle1/pose.

  上面显示的问题表明/turtlesim节点将数据发布到两个话题，但是这两个话题并没有被订阅，ros2 doctor认为这可能会导致问题。如果我们使用echo命令去打印两个话题消息，这两个警告信息就会消失，因为此时这两个话题将会有订阅者。新开两个终端，设置环境变量，然后分别运行如下命令：

ros2 topic echo /turtle1/color_sensor

ros2 topic echo /turtle1/pose

  我们再次运行ros2 doctor会发现这两个警告就没有了。我们Ctrl + C依次关掉这两个终端，再次运行ros2 doctor，我们会看到这两个警告又出现了。

  现在尝试退出乌龟模拟仿真器窗口或退出键盘控制窗口，并再次运行ros2 doctor。由于系统中的一个节点不可用，您将看到更多警告，指示publisher without subscriber或者subscriber without publisher。

  在一个具有多个节点的复杂系统中，ros2 doctor对于确定通信问题的可能原因是非常有用的。

3 获得完整的报告

  虽然ros2 doctor会让您知道有关网络、系统等的警告，但使用--report参数运行它将为您提供更多详细信息，帮助您分析问题。比如，如果您收到有关网络设置的警告，并且希望确切地知道是哪个配置部分导致了此警告，则可能需要使用--report。又比如，当我们要发帖进行求助的时候，我们可以赋值粘贴报告中相关的部分在帖子里面，这样别人就可以更好的了解你电脑当前的环境，提供更好的帮助。

  要获取完整报告，请在终端中输入以下命令：

ros2 doctor --report

  执行上述命令之后，终端中将返回分为五组的信息列表：

NETWORK CONFIGURATION
...

PLATFORM INFORMATION
...

RMW MIDDLEWARE
...

ROS 2 INFORMATION
...

TOPIC LIST
...

  例如，假设ros2 doctor返回的警告是我们使用的ros版本是没有完全支持或测试的版本，我们就可以查看报告中ROS 2 INFORMATION关于ros详细信息的部分，假设得到如下信息：

distribution name      : <distro>
distribution type      : ros2
distribution status    : prerelease
release platforms      : {'<platform>': ['<version>']}

  我们可看到我们版本的发行状态是预发行，所以我们就会得到这个警告。

  ros2 doctor会告诉我们ROS2在安装和运行过程中的问题，我们可以使用--report参数更深入地了解这些警告背后的信息。
但是请记住，ros2 doctor它不是调试工具，它不会帮助解决代码或系统实现方面的错误。