在launch文件中使用事件处理程序 [待校准@7641]
Goal目标: Learn了解ROS 2launch文件中的事件处理程序 [待校准@7642]
Tutorial教程级别: Advanced高级 [待校准@7643]
时间: 15分钟 [Alyssa@6755]
背景
ROS 2中的Launch是执行和管理用户定义进程的系统。负责监控进程的状态它launched以及报告和反应变化的这些进程。这些更改是调用事件，可以通过向launch系统注册事件处理程序来处理。可以为特定事件注册事件处理程序，并且可以用于监视进程的状态。此外，它们可用于定义一组复杂的规则，这些规则可用于动态调用y修改launch文件。 [待校准@7644]
本教程展示了ROS 2launch文件中事件处理程序的使用示例。 [待校准@7645]
先决条件
本教程使用 turtlesim package. This tutorial also assumes you have created a new package 构建类型 ament_python 调用ed launch_tutorial 。 [待校准@7646]
本教程扩展了 Using substitutions in launch files 教程中显示的代码。 [待校准@7647]
使用事件处理程序 [待校准@7648]
1事件处理程序示例launch文件 [待校准@7649]
在 launch_tutorial 包的 /launch 文件夹中创建一个调用 example_event_handlers.launch.py 文件的新文件。 [待校准@7650]
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')]
)]
)
),
])
[需手动修复的语法]``RegisterEventHandler`` actions for the OnProcessStart, OnProcessIO, OnExecutionComplete, OnProcessExit, and OnShutdown events在launch的描述中被定义。 [待校准@7651]
[需手动修复的语法] OnProcessStart 事件处理程序用于注册在turtlesim节点启动时执行的调用函数。它将一条消息记录到控制台，并在turtlesim节点启动时执行 spawn_turtle 动作。 [待校准@7652]
RegisterEventHandler(
OnProcessStart(
target_action=turtlesim_node,
on_start=[
LogInfo(msg='Turtlesim started, spawning turtle'),
spawn_turtle
]
)
),
[需手动修复的语法] OnProcessIO 事件处理程序用于注册一个调用函数，该函数在 spawn_turtle 动作写入其标准输出时执行。它记录生成请求的结果。 [待校准@7653]
RegisterEventHandler(
OnProcessIO(
target_action=spawn_turtle,
on_stdout=lambda event: LogInfo(
msg='Spawn request says "{}"'.format(
event.text.decode().strip())
)
)
),
[需手动修复的语法] OnExecutionComplete 事件处理程序用于注册在 spawn_turtle 动作完成时执行的调用函数。它将一条消息记录到控制台，并在生成动作完成时执行 change_background_r 和 change_background_r_conditioned 动作。 [待校准@7654]
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窗口关闭时，launch进程将关闭。 [待校准@7655]
RegisterEventHandler(
OnProcessExit(
target_action=turtlesim_node,
on_exit=[
LogInfo(msg=(EnvironmentVariable(name='USER'),
' closed the turtlesim window')),
EmitEvent(event=Shutdown(
reason='Window closed'))
]
)
),
最后， OnShutdown 事件处理程序用于注册在要求关闭launch文件时执行的调用函数。它会向控制台记录一条消息，说明为什么要求关闭launch文件。它会记录带有关闭原因的消息，例如关闭turtlesim窗口或用户发出的 ctrl-c 信号。 [待校准@7656]
RegisterEventHandler(
OnShutdown(
on_shutdown=[LogInfo(
msg=['Launch was asked to shutdown: ',
LocalSubstitution('event.reason')]
)]
)
),
Launch示例 [待校准@7657]
现在你可以launch的 example_event_handlers.launch.py 文件 ros2 launch 命令。 [待校准@7658]
ros2 launch launch_tutorial example_event_handlers.launch.py turtlesim_ns:='turtlesim3' use_provided_red:='True' new_background_r:=200
这将执行以下操作: [待校准@7659]
启动蓝色背景的turtlesim节点 [待校准@7660]
产卵第二只乌龟 [待校准@7661]
将颜色更改为紫色 [待校准@7662]
如果提供的
background_r参数是200，use_provided_red参数是True，则在两秒后将颜色更改为粉红色。 [待校准@7663]关闭turtlesim窗口时关闭launch文件 [待校准@7664]
此外，它将在以下情况下将消息记录到控制台: [待校准@7665]
turtlesim节点启动 [待校准@7666]
执行生成动作 [待校准@7667]
执行
change_background_r动作 [待校准@7668]执行
change_background_r_conditioned动作 [待校准@7669]turtlesim节点退出 [待校准@7670]
要求launch工艺关闭。 [待校准@7671]
文档 [待校准@7638]
[需手动修复的语法] The launch documentation 提供有关可用事件处理程序的详细信息。 [待校准@7672]
总结
在本教程中，您学习了在launch文件中使用事件处理程序。您了解了它们的语法和用法示例，以定义一组复杂的规则来动态调用y修改launch文件。 [待校准@7673]