使用事件处理程序

目标： 了解 ROS 2 启动文件中的事件处理程序

教程级别： 中级

时间： 15 分钟

背景 

ROS 2 中的启动是一个执行和管理用户定义进程的系统。它负责监视其启动的进程的状态，以及报告和响应这些进程状态的变化。这些变化称为事件，可以通过向启动系统注册事件处理程序来处理。事件处理程序可以注册特定事件，并可用于监视进程的状态。此外，它们还可用于定义一组复杂的规则，可用于动态修改启动文件。

本教程展示了 ROS 2 启动文件中事件处理程序的使用示例。

先决条件 

本教程使用 turtlesim 包。本教程还假设您已创建了一个名为 ``launch_tutorial` 的构建类型为 ament_python 的新包 <../../Beginner-Client-Libraries/Creating-Your-First-ROS2-Package>`。

本教程扩展了在启动文件中使用替换教程中显示的代码。

使用事件处理程序 

1 事件处理程序示例启动文件 

在“launch_tutorial”包的“launch”文件夹中创建一个名为“example_event_handlers.launch.py”的新文件。

from launch_ros.actions import Node

from launch import LaunchDescription
from launch.actions import (DeclareLaunchArgument, EmitEvent, ExecuteProcess,
                            LogInfo, RegisterEventHandler, TimerAction)
from launch.conditions import IfCondition
from launch.event_handlers import (OnExecutionComplete, OnProcessExit,
                                OnProcessIO, OnProcessStart, OnShutdown)
from launch.events import Shutdown
from launch.substitutions import (EnvironmentVariable, FindExecutable,
                                LaunchConfiguration, LocalSubstitution,
                                PythonExpression)


def generate_launch_description():
    turtlesim_ns = LaunchConfiguration('turtlesim_ns')
    use_provided_red = LaunchConfiguration('use_provided_red')
    new_background_r = LaunchConfiguration('new_background_r')

    turtlesim_ns_launch_arg = DeclareLaunchArgument(
        'turtlesim_ns',
        default_value='turtlesim1'
    )
    use_provided_red_launch_arg = DeclareLaunchArgument(
        'use_provided_red',
        default_value='False'
    )
    new_background_r_launch_arg = DeclareLaunchArgument(
        'new_background_r',
        default_value='200'
    )

    turtlesim_node = Node(
        package='turtlesim',
        namespace=turtlesim_ns,
        executable='turtlesim_node',
        name='sim'
    )
    spawn_turtle = ExecuteProcess(
        cmd=[[
            FindExecutable(name='ros2'),
            ' service call ',
            turtlesim_ns,
            '/spawn ',
            'turtlesim/srv/Spawn ',
            '"{x: 2, y: 2, theta: 0.2}"'
        ]],
        shell=True
    )
    change_background_r = ExecuteProcess(
        cmd=[[
            FindExecutable(name='ros2'),
            ' param set ',
            turtlesim_ns,
            '/sim background_r ',
            '120'
        ]],
        shell=True
    )
    change_background_r_conditioned = ExecuteProcess(
        condition=IfCondition(
            PythonExpression([
                new_background_r,
                ' == 200',
                ' and ',
                use_provided_red
            ])
        ),
        cmd=[[
            FindExecutable(name='ros2'),
            ' param set ',
            turtlesim_ns,
            '/sim background_r ',
            new_background_r
        ]],
        shell=True
    )

    return LaunchDescription([
        turtlesim_ns_launch_arg,
        use_provided_red_launch_arg,
        new_background_r_launch_arg,
        turtlesim_node,
        RegisterEventHandler(
            OnProcessStart(
                target_action=turtlesim_node,
                on_start=[
                    LogInfo(msg='Turtlesim started, spawning turtle'),
                    spawn_turtle
                ]
            )
        ),
        RegisterEventHandler(
            OnProcessIO(
                target_action=spawn_turtle,
                on_stdout=lambda event: LogInfo(
                    msg='Spawn request says "{}"'.format(
                        event.text.decode().strip())
                )
            )
        ),
        RegisterEventHandler(
            OnExecutionComplete(
                target_action=spawn_turtle,
                on_completion=[
                    LogInfo(msg='Spawn finished'),
                    change_background_r,
                    TimerAction(
                        period=2.0,
                        actions=[change_background_r_conditioned],
                    )
                ]
            )
        ),
        RegisterEventHandler(
            OnProcessExit(
                target_action=turtlesim_node,
                on_exit=[
                    LogInfo(msg=(EnvironmentVariable(name='USER'),
                            ' closed the turtlesim window')),
                    EmitEvent(event=Shutdown(
                        reason='Window closed'))
                ]
            )
        ),
        RegisterEventHandler(
            OnShutdown(
                on_shutdown=[LogInfo(
                    msg=['Launch was asked to shutdown: ',
                        LocalSubstitution('event.reason')]
                )]
            )
        ),
    ])

在启动描述中定义了“OnProcessStart”、“OnProcessIO”、“OnExecutionComplete”、“OnProcessExit”和“OnShutdown”事件的“RegisterEventHandler”操作。

“OnProcessStart”事件处理程序用于注册在 turtlesim 节点启动时执行的回调函数。它会将消息记录到控制台并在 turtlesim 节点启动时执行“spawn_turtle”操作。

RegisterEventHandler(
    OnProcessStart(
        target_action=turtlesim_node,
        on_start=[
            LogInfo(msg='Turtlesim started, spawning turtle'),
            spawn_turtle
        ]
    )
),

OnProcessIO 事件处理程序用于注册一个回调函数，该函数在 spawn_turtle 操作写入其标准输出时执行。它记录生成请求的结果。

RegisterEventHandler(
    OnProcessIO(
        target_action=spawn_turtle,
        on_stdout=lambda event: LogInfo(
            msg='Spawn request says "{}"'.format(
                event.text.decode().strip())
        )
    )
),

OnExecutionComplete 事件处理程序用于注册在 spawn_turtle 操作完成时执行的回调函数。它会将一条消息记录到控制台，并在 spawn 操作完成时执行 change_background_r 和 change_background_r_condition 操作。

RegisterEventHandler(
    OnExecutionComplete(
        target_action=spawn_turtle,
        on_completion=[
            LogInfo(msg='Spawn finished'),
            change_background_r,
            TimerAction(
                period=2.0,
                actions=[change_background_r_conditioned],
            )
        ]
    )
),

OnProcessExit 事件处理程序用于注册在 turtlesim 节点退出时执行的回调函数。它会将消息记录到控制台，并在 turtlesim 节点退出时执行 EmitEvent 操作以发出 Shutdown 事件。这意味着当 turtlesim 窗口关闭时，启动过程将关闭。

RegisterEventHandler(
    OnProcessExit(
        target_action=turtlesim_node,
        on_exit=[
            LogInfo(msg=(EnvironmentVariable(name='USER'),
                    ' closed the turtlesim window')),
            EmitEvent(event=Shutdown(
                reason='Window closed'))
        ]
    )
),

最后，OnShutdown 事件处理程序用于注册一个回调函数，该函数在要求关闭启动文件时执行。它会将一条消息记录到控制台，说明要求关闭启动文件的原因。它会记录一条消息，其中包含关闭的原因，例如 turtlesim 窗口的关闭或用户发出的 ctrl-c 信号。

RegisterEventHandler(
    OnShutdown(
        on_shutdown=[LogInfo(
            msg=['Launch was asked to shutdown: ',
                LocalSubstitution('event.reason')]
        )]
    )
),

构建包 

转到工作区的根目录，然后构建包：

colcon build

还要记住在构建后获取工作区。

启动示例 

现在您可以使用“ros2 launch”命令启动“example_event_handlers.launch.py”文件。

ros2 launch launch_tutorial example_event_handlers.launch.py turtlesim_ns:='turtlesim3' use_provided_red:='True' new_background_r:=200

这将执行以下操作：

启动具有蓝色背景的 turtlesim 节点
生成第二只海龟
将颜色更改为紫色
如果提供的 background_r 参数为 200 且 use_provided_red 参数为 True，则在两秒后将颜色更改为粉红色
在 turtlesim 窗口关闭时关闭启动文件

此外，它将在以下情况下将消息记录到控制台：

turtlesim 节点启动
执行生成操作
执行 change_background_r 操作
执行 change_background_r_condition 操作
turtlesim 节点退出
要求关闭启动过程。

文档 

The launch documentation provides detailed information about available event handlers.

摘要 

在本教程中，您学习了如何在启动文件中使用事件处理程序。您了解了它们的语法和使用示例，以定义一组复杂的规则来动态修改启动文件。