16 #include "angles/angles.h"
17 #include "nav2_ros_common/rate.hpp"
18 #include "opennav_docking_core/docking_exceptions.hpp"
19 #include "opennav_following/following_server.hpp"
20 #include "nav2_util/geometry_utils.hpp"
21 #include "nav2_util/robot_utils.hpp"
22 #include "tf2_geometry_msgs/tf2_geometry_msgs.hpp"
23 #include "tf2/utils.hpp"
25 using namespace std::chrono_literals;
26 using rcl_interfaces::msg::ParameterType;
27 using std::placeholders::_1;
29 namespace opennav_following
32 FollowingServer::FollowingServer(
const rclcpp::NodeOptions & options)
33 : nav2::LifecycleNode(
"following_server",
"", options)
35 RCLCPP_INFO(get_logger(),
"Creating %s", get_name());
41 RCLCPP_INFO(get_logger(),
"Configuring %s", get_name());
43 param_handler_ = std::make_unique<ParameterHandler>(
45 params_ = param_handler_->getParams();
47 vel_publisher_ = std::make_unique<nav2_util::TwistPublisher>(node,
"cmd_vel");
48 tf2_buffer_ = nav2::create_transform_buffer(node);
51 odom_sub_ = std::make_unique<nav2_util::OdomSmoother>(node, params_->odom_duration,
55 following_action_server_ = node->create_action_server<FollowObject>(
58 nullptr,
nullptr, std::chrono::milliseconds(500),
65 std::make_unique<opennav_docking::Controller>(node, tf2_buffer_, params_->fixed_frame,
68 if (params_->use_collision_detection) {
71 "Collision detection is not supported in the following server. Please disable "
72 "the controller.use_collision_detection parameter.");
73 return nav2::CallbackReturn::FAILURE;
77 filter_ = std::make_unique<opennav_docking::PoseFilter>(params_->filter_coef,
78 params_->detection_timeout);
81 filtered_dynamic_pose_pub_ =
82 create_publisher<geometry_msgs::msg::PoseStamped>(
"filtered_dynamic_pose");
85 static_timer_initialized_ =
false;
86 static_object_start_time_ = rclcpp::Time(0);
88 return nav2::CallbackReturn::SUCCESS;
94 RCLCPP_INFO(get_logger(),
"Activating %s", get_name());
96 tf2_listener_ = nav2::create_transform_listener(*tf2_buffer_,
this,
true);
97 vel_publisher_->on_activate();
98 filtered_dynamic_pose_pub_->on_activate();
99 following_action_server_->activate();
100 param_handler_->activate();
105 return nav2::CallbackReturn::SUCCESS;
111 RCLCPP_INFO(get_logger(),
"Deactivating %s", get_name());
113 following_action_server_->deactivate();
114 vel_publisher_->on_deactivate();
115 filtered_dynamic_pose_pub_->on_deactivate();
116 param_handler_->deactivate();
118 tf2_listener_.reset();
123 return nav2::CallbackReturn::SUCCESS;
129 RCLCPP_INFO(get_logger(),
"Cleaning up %s", get_name());
131 following_action_server_.reset();
133 vel_publisher_.reset();
134 filtered_dynamic_pose_pub_.reset();
136 dynamic_pose_sub_.reset();
137 return nav2::CallbackReturn::SUCCESS;
143 RCLCPP_INFO(get_logger(),
"Shutting down %s", get_name());
144 return nav2::CallbackReturn::SUCCESS;
147 template<
typename ActionT>
149 typename std::shared_ptr<const typename ActionT::Goal> goal,
150 const typename nav2::SimpleActionServer<ActionT>::SharedPtr & action_server)
157 template<
typename ActionT>
159 typename nav2::SimpleActionServer<ActionT>::SharedPtr & action_server,
160 const std::string & name)
163 RCLCPP_WARN(get_logger(),
"Goal was cancelled. Cancelling %s action", name.c_str());
169 template<
typename ActionT>
171 typename nav2::SimpleActionServer<ActionT>::SharedPtr & action_server,
172 const std::string & name)
175 RCLCPP_WARN(get_logger(),
"Goal was preempted. Cancelling %s action", name.c_str());
183 std::unique_lock<std::mutex> lock_reinit(param_handler_->getMutex());
184 action_start_time_ = this->now();
185 nav2::Rate loop_rate(
this, params_->controller_frequency);
187 auto goal = following_action_server_->get_current_goal();
188 auto result = std::make_shared<FollowObject::Result>();
190 if (!following_action_server_ || !following_action_server_->is_server_active()) {
191 RCLCPP_DEBUG(get_logger(),
"Action server unavailable or inactive. Stopping.");
195 if (checkAndWarnIfCancelled<FollowObject>(following_action_server_,
"follow_object")) {
196 following_action_server_->terminate_all();
200 getPreemptedGoalIfRequested<FollowObject>(goal, following_action_server_);
202 static_timer_initialized_ =
false;
205 detected_dynamic_pose_.header.stamp = rclcpp::Time(0);
208 auto pose_topic = goal->pose_topic;
209 auto target_frame = goal->tracked_frame;
210 if (target_frame.empty()) {
211 if (pose_topic.empty()) {
214 "Both pose topic and target frame are empty. Cannot follow object.");
215 result->error_code = FollowObject::Result::FAILED_TO_DETECT_OBJECT;
216 result->error_msg =
"No pose topic or target frame provided.";
217 following_action_server_->terminate_all(result);
220 lock_reinit.unlock();
221 RCLCPP_INFO(get_logger(),
"Subscribing to pose topic: %s", pose_topic.c_str());
222 dynamic_pose_sub_ = create_subscription<geometry_msgs::msg::PoseStamped>(
224 [
this](
const geometry_msgs::msg::PoseStamped::ConstSharedPtr & pose) {
225 detected_dynamic_pose_ = *pose;
231 RCLCPP_INFO(get_logger(),
"Following frame: %s instead of pose", target_frame.c_str());
235 geometry_msgs::msg::PoseStamped object_pose;
236 rclcpp::Duration max_duration = goal->max_duration;
237 while (rclcpp::ok()) {
240 if (this->now() - action_start_time_ > max_duration && max_duration.seconds() > 0.0) {
241 RCLCPP_INFO(get_logger(),
"Exceeded max duration. Stopping.");
242 result->total_elapsed_time = this->now() - action_start_time_;
243 result->num_retries = num_retries_;
245 following_action_server_->succeeded_current(result);
246 dynamic_pose_sub_.reset();
253 if (!static_timer_initialized_) {
254 static_object_start_time_ = this->now();
255 static_timer_initialized_ =
true;
259 RCLCPP_INFO_THROTTLE(
260 get_logger(), *get_clock(), 1000,
261 "Reached object. Stopping until goal is moved again.");
266 if (params_->static_object_timeout > 0.0) {
267 auto static_duration = this->now() - static_object_start_time_;
268 if (static_duration.seconds() > params_->static_object_timeout) {
271 "Object has been static for %.2f seconds (timeout: %.2f), stopping.",
272 static_duration.seconds(), params_->static_object_timeout);
273 result->total_elapsed_time = this->now() - action_start_time_;
274 result->num_retries = num_retries_;
276 following_action_server_->succeeded_current(result);
277 dynamic_pose_sub_.reset();
283 static_timer_initialized_ =
false;
284 result->total_elapsed_time = this->now() - action_start_time_;
286 following_action_server_->terminate_all(result);
287 dynamic_pose_sub_.reset();
291 if (++num_retries_ > params_->max_retries) {
292 RCLCPP_ERROR(get_logger(),
"Failed to follow, all retries have been used");
295 RCLCPP_WARN(get_logger(),
"Following failed, will retry: %s", e.what());
298 if (params_->search_by_rotating) {
299 RCLCPP_INFO(get_logger(),
"Rotating to find object again");
303 following_action_server_->terminate_all(result);
307 RCLCPP_INFO(get_logger(),
"Using last known heading to find object again");
312 }
catch (
const tf2::TransformException & e) {
313 result->error_msg = std::string(
"Transform error: ") + e.what();
314 RCLCPP_ERROR(get_logger(),
"%s", result->error_msg.c_str());
315 result->error_code = FollowObject::Result::TF_ERROR;
317 result->error_msg = e.what();
318 RCLCPP_ERROR(get_logger(),
"%s", result->error_msg.c_str());
319 result->error_code = FollowObject::Result::FAILED_TO_DETECT_OBJECT;
321 result->error_msg = e.what();
322 RCLCPP_ERROR(get_logger(),
"%s", result->error_msg.c_str());
323 result->error_code = FollowObject::Result::FAILED_TO_CONTROL;
325 result->error_msg = e.what();
326 RCLCPP_ERROR(get_logger(),
"%s", result->error_msg.c_str());
327 result->error_code = FollowObject::Result::UNKNOWN;
328 }
catch (std::exception & e) {
329 result->error_msg = e.what();
330 RCLCPP_ERROR(get_logger(),
"%s", result->error_msg.c_str());
331 result->error_code = FollowObject::Result::UNKNOWN;
335 result->total_elapsed_time = this->now() - action_start_time_;
336 result->num_retries = num_retries_;
338 following_action_server_->terminate_current(result);
339 dynamic_pose_sub_.reset();
343 geometry_msgs::msg::PoseStamped & object_pose,
const std::string & target_frame)
345 rclcpp::Rate loop_rate(params_->controller_frequency);
346 while (rclcpp::ok()) {
348 iteration_start_time_ = this->now();
353 if (checkAndWarnIfCancelled<FollowObject>(following_action_server_,
"follow_object") ||
354 checkAndWarnIfPreempted<FollowObject>(following_action_server_,
"follow_object"))
373 const double backward_projection = 0.25;
374 const double effective_distance = params_->desired_distance - backward_projection;
379 tf2_buffer_->transform(
380 target_pose, target_pose, params_->base_frame,
381 tf2::durationFromSec(params_->transform_tolerance));
382 }
catch (
const tf2::TransformException & ex) {
383 RCLCPP_WARN(get_logger(),
"Failed to transform target pose: %s", ex.what());
388 auto command = std::make_unique<geometry_msgs::msg::TwistStamped>();
389 command->header.stamp = now();
390 if (!controller_->computeVelocityCommand(target_pose.pose, command->twist,
true,
false)) {
393 vel_publisher_->publish(std::move(command));
401 geometry_msgs::msg::PoseStamped & object_pose,
const std::string & target_frame)
403 const double dt = 1.0 / params_->controller_frequency;
407 const std::string reference_frame =
408 object_pose.header.frame_id.empty() ? params_->fixed_frame : object_pose.header.frame_id;
411 iteration_start_time_ = this->now();
414 geometry_msgs::msg::PoseStamped robot_pose;
415 if (!nav2_util::getCurrentPose(
416 robot_pose, *tf2_buffer_, reference_frame, params_->base_frame,
417 params_->transform_tolerance,
418 iteration_start_time_))
420 RCLCPP_WARN(get_logger(),
"Failed to get current robot pose");
423 double initial_yaw = tf2::getYaw(robot_pose.pose.orientation);
426 std::vector<double> angles = {initial_yaw + params_->search_angle,
427 initial_yaw - params_->search_angle};
429 rclcpp::Rate loop_rate(params_->controller_frequency);
430 auto start = this->now();
431 auto timeout = rclcpp::Duration::from_seconds(params_->rotate_to_object_timeout);
434 for (
const double & target_angle : angles) {
436 auto target_pose = object_pose;
437 target_pose.pose.orientation = nav2_util::geometry_utils::orientationAroundZAxis(target_angle);
440 while (rclcpp::ok()) {
442 iteration_start_time_ = this->now();
447 if (checkAndWarnIfCancelled<FollowObject>(following_action_server_,
"follow_object") ||
448 checkAndWarnIfPreempted<FollowObject>(following_action_server_,
"follow_object"))
454 if (!nav2_util::getCurrentPose(
455 robot_pose, *tf2_buffer_, reference_frame, params_->base_frame,
456 params_->transform_tolerance,
457 iteration_start_time_))
459 RCLCPP_WARN(get_logger(),
"Failed to get current robot pose");
463 double angular_distance_to_heading = angles::shortest_angular_distance(
464 tf2::getYaw(robot_pose.pose.orientation), target_angle);
467 if (fabs(angular_distance_to_heading) < params_->angular_tolerance) {
480 geometry_msgs::msg::Twist current_vel;
481 current_vel.angular.z = odom_sub_->getRawTwist().angular.z;
483 auto command = std::make_unique<geometry_msgs::msg::TwistStamped>();
484 command->header = robot_pose.header;
485 command->twist = controller_->computeRotateToHeadingCommand(
486 angular_distance_to_heading, current_vel, dt);
488 vel_publisher_->publish(std::move(command));
490 if (this->now() - start > timeout) {
504 auto cmd_vel = std::make_unique<geometry_msgs::msg::TwistStamped>();
505 cmd_vel->header.frame_id = params_->base_frame;
506 cmd_vel->header.stamp = now();
507 vel_publisher_->publish(std::move(cmd_vel));
512 auto feedback = std::make_shared<FollowObject::Feedback>();
513 feedback->state = state;
514 feedback->following_time = iteration_start_time_ - action_start_time_;
515 feedback->num_retries = num_retries_;
516 following_action_server_->publish_feedback(feedback);
522 geometry_msgs::msg::PoseStamped detected = detected_dynamic_pose_;
525 if (detected.header.stamp == builtin_interfaces::msg::Time{}) {
526 auto start = this->now();
527 auto timeout = rclcpp::Duration::from_seconds(params_->detection_timeout);
528 nav2::Rate wait_rate(
this, params_->controller_frequency);
529 while (this->now() - start < timeout) {
531 if (detected_dynamic_pose_.header.stamp != builtin_interfaces::msg::Time{}) {
532 detected = detected_dynamic_pose_;
537 if (detected.header.stamp == builtin_interfaces::msg::Time{}) {
538 RCLCPP_WARN(this->get_logger(),
"No detection received within timeout period");
544 auto timeout = rclcpp::Duration::from_seconds(params_->detection_timeout);
545 if (this->now() - detected.header.stamp > timeout) {
546 RCLCPP_WARN(this->get_logger(),
"Lost detection or did not detect: timeout exceeded");
551 if (detected.header.frame_id != params_->fixed_frame) {
553 tf2_buffer_->transform(
554 detected, detected, params_->fixed_frame,
555 tf2::durationFromSec(params_->transform_tolerance));
556 }
catch (
const tf2::TransformException & ex) {
557 RCLCPP_WARN(this->get_logger(),
"Failed to transform detected object pose");
566 if (params_->skip_orientation) {
567 geometry_msgs::msg::PoseStamped robot_pose;
568 if (!nav2_util::getCurrentPose(
569 robot_pose, *tf2_buffer_, detected.header.frame_id, params_->base_frame,
570 params_->transform_tolerance,
571 iteration_start_time_))
573 RCLCPP_WARN(get_logger(),
"Failed to get current robot pose");
576 double dx = detected.pose.position.x - robot_pose.pose.position.x;
577 double dy = detected.pose.position.y - robot_pose.pose.position.y;
578 double angle_to_target = std::atan2(dy, dx);
579 detected.pose.orientation = nav2_util::geometry_utils::orientationAroundZAxis(angle_to_target);
583 auto pose_filtered = filter_->update(detected);
584 filtered_dynamic_pose_pub_->publish(pose_filtered);
586 pose = pose_filtered;
591 geometry_msgs::msg::PoseStamped & pose,
const std::string & frame_id)
595 auto transform = tf2_buffer_->lookupTransform(
596 params_->fixed_frame, frame_id, iteration_start_time_,
597 tf2::durationFromSec(params_->transform_tolerance));
600 pose.header.frame_id = params_->fixed_frame;
601 pose.header.stamp = transform.header.stamp;
602 pose.pose.position.x = transform.transform.translation.x;
603 pose.pose.position.y = transform.transform.translation.y;
604 pose.pose.position.z = transform.transform.translation.z;
605 pose.pose.orientation = transform.transform.rotation;
606 }
catch (
const tf2::TransformException & ex) {
609 "Failed to get transform for frame %s: %s", frame_id.c_str(), ex.what());
614 auto filtered_pose = filter_->update(pose);
615 filtered_dynamic_pose_pub_->publish(filtered_pose);
617 pose = filtered_pose;
622 geometry_msgs::msg::PoseStamped & pose,
const std::string & frame_id)
625 if (!frame_id.empty()) {
628 "Failed to get pose in target frame: " + frame_id);
640 const geometry_msgs::msg::PoseStamped & pose,
double distance)
642 geometry_msgs::msg::PoseStamped robot_pose;
643 if (!nav2_util::getCurrentPose(
644 robot_pose, *tf2_buffer_, pose.header.frame_id, params_->base_frame,
645 params_->transform_tolerance,
646 iteration_start_time_))
648 RCLCPP_WARN(get_logger(),
"Failed to get current robot pose");
652 double dx = pose.pose.position.x - robot_pose.pose.position.x;
653 double dy = pose.pose.position.y - robot_pose.pose.position.y;
654 const double dist = std::hypot(dx, dy);
658 geometry_msgs::msg::PoseStamped forward_pose = pose;
659 forward_pose.pose.position.x -= distance * (dx / dist);
660 forward_pose.pose.position.y -= distance * (dy / dist);
666 geometry_msgs::msg::PoseStamped robot_pose;
667 if (!nav2_util::getCurrentPose(
668 robot_pose, *tf2_buffer_, goal_pose.header.frame_id, params_->base_frame,
669 params_->transform_tolerance,
670 iteration_start_time_))
672 RCLCPP_WARN(get_logger(),
"Failed to get current robot pose");
675 const double dist = std::hypot(
676 robot_pose.pose.position.x - goal_pose.pose.position.x,
677 robot_pose.pose.position.y - goal_pose.pose.position.y);
678 const double yaw = angles::shortest_angular_distance(
679 tf2::getYaw(robot_pose.pose.orientation), tf2::getYaw(goal_pose.pose.orientation));
680 return dist < params_->linear_tolerance && abs(yaw) < params_->angular_tolerance;
685 #include "rclcpp_components/register_node_macro.hpp"
void destroyBond()
Destroy bond connection to lifecycle manager.
nav2::LifecycleNode::SharedPtr shared_from_this()
Get a shared pointer of this.
void createBond()
Create bond connection to lifecycle manager.
A sim-time-aware rate for Nav2 loops.
bool is_cancel_requested() const
Whether or not a cancel command has come in.
bool is_preempt_requested() const
Whether the action server has been asked to be preempted with a new goal.
const std::shared_ptr< const typename ActionT::Goal > accept_pending_goal()
Accept pending goals.
A QoS profile for standard reliable topics with a history of 10 messages.
Abstract docking exception.
Failed to control into or out of the dock.
Failed to detect the charging dock.
An action server which implements a dynamic following behavior.
bool checkAndWarnIfCancelled(typename nav2::SimpleActionServer< ActionT >::SharedPtr &action_server, const std::string &name)
Checks and logs warning if action canceled.
nav2::CallbackReturn on_shutdown(const rclcpp_lifecycle::State &state) override
Called when in shutdown state.
void followObject()
Main action callback method to complete following request.
virtual bool getFramePose(geometry_msgs::msg::PoseStamped &pose, const std::string &frame_id)
Get the pose of a specific frame in the fixed frame.
virtual bool approachObject(geometry_msgs::msg::PoseStamped &object_pose, const std::string &target_frame=std::string(""))
Use control law and perception to approach the object.
virtual bool getTrackingPose(geometry_msgs::msg::PoseStamped &pose, const std::string &frame_id)
Get the tracking pose based on the current tracking mode.
void publishFollowingFeedback(uint16_t state)
Publish feedback from a following action.
geometry_msgs::msg::PoseStamped getPoseAtDistance(const geometry_msgs::msg::PoseStamped &pose, double distance)
Get the pose at a distance in front of the input pose.
virtual bool getRefinedPose(geometry_msgs::msg::PoseStamped &pose)
Method to obtain the refined dynamic pose.
nav2::CallbackReturn on_deactivate(const rclcpp_lifecycle::State &state) override
Deactivate member variables.
void publishZeroVelocity()
Publish zero velocity at terminal condition.
void getPreemptedGoalIfRequested(typename std::shared_ptr< const typename ActionT::Goal > goal, const typename nav2::SimpleActionServer< ActionT >::SharedPtr &action_server)
Gets a preempted goal if immediately requested.
bool isGoalReached(const geometry_msgs::msg::PoseStamped &goal_pose)
Check if the goal has been reached.
virtual bool rotateToObject(geometry_msgs::msg::PoseStamped &object_pose, const std::string &target_frame=std::string(""))
Rotate the robot to find the object again.
bool checkAndWarnIfPreempted(typename nav2::SimpleActionServer< ActionT >::SharedPtr &action_server, const std::string &name)
Checks and logs warning if action preempted.
nav2::CallbackReturn on_activate(const rclcpp_lifecycle::State &state) override
Activate member variables.
nav2::CallbackReturn on_configure(const rclcpp_lifecycle::State &state) override
Configure member variables.
nav2::CallbackReturn on_cleanup(const rclcpp_lifecycle::State &state) override
Reset member variables.