navigate_through_poses.cpp

// Copyright (c) 2021 Samsung Research
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#include <vector>
#include <string>
#include <set>
#include <memory>
#include <limits>
#include <stdexcept>
#include "nav2_bt_navigator/navigators/navigate_through_poses.hpp"
#include "nav2_util/path_utils.hpp"
#include "nav2_msgs/msg/tracking_feedback.hpp"
#include "nav2_ros_common/node_utils.hpp"
 
namespace nav2_bt_navigator
{
 
bool
NavigateThroughPosesNavigator::configure(
  nav2::LifecycleNode::WeakPtr parent_node,
  std::shared_ptr<nav2_util::OdomSmoother> odom_smoother)
{
  start_time_ = rclcpp::Time(0);
  auto node = parent_node.lock();
 
  goals_blackboard_id_ =
    node->declare_or_get_parameter(getName() + ".goals_blackboard_id", std::string("goals"));
  path_blackboard_id_ =
    node->declare_or_get_parameter(getName() + ".path_blackboard_id", std::string("path"));
  tracking_feedback_blackboard_id_ = node->declare_or_get_parameter(
    getName() + ".tracking_feedback_blackboard_id",
    std::string("tracking_feedback"));
  waypoint_statuses_blackboard_id_ =
    node->declare_or_get_parameter(
    getName() + ".waypoint_statuses_blackboard_id",
    std::string("waypoint_statuses"));
 
  search_window_ = node->declare_or_get_parameter(getName() + "search_window", 2.0);
  transform_staleness_threshold_ = node->declare_or_get_parameter(
    getName() + ".transform_staleness_threshold", 0.0);
 
  // Odometry smoother object for getting current speed
  odom_smoother_ = odom_smoother;
 
  bool enable_groot_monitoring =
    node->declare_or_get_parameter(getName() + ".enable_groot_monitoring", false);
  int groot_server_port =
    node->declare_or_get_parameter(getName() + ".groot_server_port", 1669);
 
  bt_action_server_->setGrootMonitoring(
    enable_groot_monitoring,
    groot_server_port);
 
  return true;
}
 
std::string
NavigateThroughPosesNavigator::getDefaultBTFilepath(
  nav2::LifecycleNode::WeakPtr parent_node)
{
  auto node = parent_node.lock();
  std::string pkg_share_dir =
    nav2::get_package_share_directory("nav2_bt_navigator");
 
  auto default_bt_xml_filename = node->declare_or_get_parameter(
    "default_nav_through_poses_bt_xml",
    pkg_share_dir +
    "/behavior_trees/navigate_through_poses_w_replanning_and_recovery.xml");
 
  return default_bt_xml_filename;
}
 
bool
NavigateThroughPosesNavigator::goalReceived(ActionT::Goal::ConstSharedPtr goal)
{
  return initializeGoalPoses(goal);
}
 
void
NavigateThroughPosesNavigator::goalCompleted(
  typename ActionT::Result::SharedPtr result,
  nav2_behavior_tree::BtStatus & final_bt_status)
{
  if (result->error_code == 0) {
    if (bt_action_server_->populateInternalError(result)) {
      RCLCPP_WARN(
        logger_,
        "NavigateThroughPosesNavigator::goalCompleted, internal error %d:'%s'.",
        result->error_code,
        result->error_msg.c_str());
    }
  } else {
    RCLCPP_WARN(
      logger_, "NavigateThroughPosesNavigator::goalCompleted error %d:'%s'.",
      result->error_code,
      result->error_msg.c_str());
  }
 
  // populate waypoint statuses in result
  auto blackboard = bt_action_server_->getBlackboard();
  auto waypoint_statuses =
    blackboard->get<std::vector<nav2_msgs::msg::WaypointStatus>>(waypoint_statuses_blackboard_id_);
 
  // populate remaining waypoint statuses based on final_bt_status
  auto integrate_waypoint_status = final_bt_status == nav2_behavior_tree::BtStatus::SUCCEEDED ?
    nav2_msgs::msg::WaypointStatus::COMPLETED : nav2_msgs::msg::WaypointStatus::FAILED;
  for (auto & waypoint_status : waypoint_statuses) {
    if (waypoint_status.waypoint_status == nav2_msgs::msg::WaypointStatus::PENDING) {
      waypoint_status.waypoint_status = integrate_waypoint_status;
    }
  }
 
  result->waypoint_statuses = std::move(waypoint_statuses);
}
 
void
NavigateThroughPosesNavigator::onLoop()
{
  using namespace nav2_util::geometry_utils;  // NOLINT
 
  // action server feedback (pose, duration of task,
  // number of recoveries, and distance remaining to goal, etc)
  auto feedback_msg = std::make_shared<ActionT::Feedback>();
 
  auto blackboard = bt_action_server_->getBlackboard();
 
  nav_msgs::msg::Goals goal_poses;
  [[maybe_unused]] auto res = blackboard->get(goals_blackboard_id_, goal_poses);
 
  feedback_msg->waypoint_statuses =
    blackboard->get<std::vector<nav2_msgs::msg::WaypointStatus>>(waypoint_statuses_blackboard_id_);
 
  if (goal_poses.goals.size() == 0) {
    bt_action_server_->publishFeedback(feedback_msg);
    return;
  }
 
  geometry_msgs::msg::PoseStamped current_pose;
  if (!nav2_util::getFreshPose(
      *feedback_utils_.tf, feedback_utils_.global_frame,
      feedback_utils_.robot_frame, clock_->now(),
      transform_staleness_threshold_, current_pose))
  {
    RCLCPP_ERROR(logger_, "Robot pose is not available.");
    return;
  }
 
  // Get current path points
  nav_msgs::msg::Path current_path;
  res = blackboard->get(path_blackboard_id_, current_path);
  if (res && current_path.poses.size() > 0u) {
    // Reset start index if path or goal is updated
    if (nav2_util::isPathUpdated(current_path, previous_path_) ||
      nav2_util::isGoalUpdated(current_path, previous_path_) ||
      previous_path_.poses.size() == 0u)
    {
      start_index_ = 0;
      previous_path_ = current_path;
    }
    // Find the closest pose to current pose on global path
    const auto path_search_result = nav2_util::distance_from_path(
      current_path, current_pose.pose, start_index_, search_window_);
 
    // Calculate distance on the path
    start_index_ = path_search_result.closest_segment_index;
    double distance_remaining =
      nav2_util::geometry_utils::calculate_path_length(current_path, start_index_);
 
    // Default value for time remaining
    rclcpp::Duration estimated_time_remaining = rclcpp::Duration::from_seconds(0.0);
 
    // Get current speed
    geometry_msgs::msg::Twist current_odom = odom_smoother_->getTwist();
    double current_linear_speed = std::hypot(current_odom.linear.x, current_odom.linear.y);
 
    // Calculate estimated time taken to goal if speed is higher than 1cm/s
    // and at least 10cm to go
    if ((std::abs(current_linear_speed) > 0.01) && (distance_remaining > 0.1)) {
      estimated_time_remaining =
        rclcpp::Duration::from_seconds(distance_remaining / std::abs(current_linear_speed));
    }
 
    feedback_msg->distance_remaining = distance_remaining;
    feedback_msg->estimated_time_remaining = estimated_time_remaining;
  }
 
  int recovery_count = 0;
  res = blackboard->get("number_recoveries", recovery_count);
  feedback_msg->number_of_recoveries = recovery_count;
  feedback_msg->current_pose = current_pose;
  feedback_msg->navigation_time = clock_->now() - start_time_;
  feedback_msg->number_of_poses_remaining = goal_poses.goals.size();
  nav2_msgs::msg::TrackingFeedback tracking_feedback;
  res = blackboard->get(
    tracking_feedback_blackboard_id_,
    tracking_feedback);
  feedback_msg->position_tracking_error = tracking_feedback.position_tracking_error;
  feedback_msg->heading_tracking_error = tracking_feedback.heading_tracking_error;
 
  bt_action_server_->publishFeedback(feedback_msg);
}
 
void
NavigateThroughPosesNavigator::onPreempt(ActionT::Goal::ConstSharedPtr goal)
{
  RCLCPP_INFO(logger_, "Received goal preemption request");
 
  if (goal->behavior_tree == bt_action_server_->getCurrentBTFilenameOrID() ||
    (goal->behavior_tree.empty() &&
    bt_action_server_->getCurrentBTFilenameOrID() == bt_action_server_->getDefaultBTFilenameOrID()))
  {
    // if pending goal requests the same BT as the current goal, accept the pending goal
    // if pending goal has an empty behavior_tree field, it requests the default BT file
    // accept the pending goal if the current goal is running the default BT file
    if (!initializeGoalPoses(bt_action_server_->acceptPendingGoal())) {
      throw std::runtime_error(
        "Preemption request was rejected since the goal poses could not be "
        "transformed.");
    }
  } else {
    RCLCPP_WARN(
      logger_,
      "Preemption request was rejected since the requested BT XML file is not the same "
      "as the one that the current goal is executing. Preemption with a new BT is invalid "
      "since it would require cancellation of the previous goal instead of true preemption."
      "\nCancel the current goal and send a new action request if you want to use a "
      "different BT XML file. For now, continuing to track the last goal until completion.");
    bt_action_server_->terminatePendingGoal();
  }
}
 
bool
NavigateThroughPosesNavigator::initializeGoalPoses(ActionT::Goal::ConstSharedPtr goal)
{
  geometry_msgs::msg::PoseStamped current_pose;
  if (!nav2_util::getFreshPose(
      *feedback_utils_.tf, feedback_utils_.global_frame,
      feedback_utils_.robot_frame, clock_->now(),
      transform_staleness_threshold_, current_pose))
  {
    bt_action_server_->setInternalError(
      ActionT::Result::TF_ERROR,
      "Initial robot pose is not available.");
    return false;
  }
 
  nav_msgs::msg::Goals goals_array = goal->poses;
  int i = 0;
  for (auto & goal_pose : goals_array.goals) {
    if (!nav2_util::transformPoseInTargetFrame(
        goal_pose, goal_pose, *feedback_utils_.tf, feedback_utils_.global_frame,
        feedback_utils_.transform_tolerance))
    {
      bt_action_server_->setInternalError(
        ActionT::Result::TF_ERROR,
        "Failed to transform a goal pose (" + std::to_string(i) + ") provided with frame_id '" +
        goal_pose.header.frame_id +
        "' to the global frame '" +
        feedback_utils_.global_frame +
        "'.");
      return false;
    }
    i++;
  }
 
  if (goals_array.goals.size() > 0) {
    RCLCPP_INFO(
      logger_, "Begin navigating from current location through %zu poses to (%.2f, %.2f)",
      goals_array.goals.size(), goals_array.goals.back().pose.position.x,
      goals_array.goals.back().pose.position.y);
  }
 
  // Reset state for new action feedback
  start_time_ = clock_->now();
  auto blackboard = bt_action_server_->getBlackboard();
  blackboard->set("number_recoveries", 0);  // NOLINT
  previous_path_ = nav_msgs::msg::Path();
 
  // Update the goal pose and path on the blackboard
  blackboard->set<nav_msgs::msg::Goals>(
    goals_blackboard_id_,
    std::move(goals_array));
  blackboard->set<nav_msgs::msg::Path>(
    path_blackboard_id_,
    nav_msgs::msg::Path());
 
  // Reset the waypoint states vector in the blackboard
  std::vector<nav2_msgs::msg::WaypointStatus> waypoint_statuses(goals_array.goals.size());
  for (size_t waypoint_index = 0; waypoint_index < goals_array.goals.size(); ++waypoint_index) {
    waypoint_statuses[waypoint_index].waypoint_index = waypoint_index;
    waypoint_statuses[waypoint_index].waypoint_pose = goals_array.goals[waypoint_index];
  }
  blackboard->set<decltype(waypoint_statuses)>(
    waypoint_statuses_blackboard_id_,
    std::move(waypoint_statuses));
 
  return true;
}
 
}  // namespace nav2_bt_navigator
 
#include "pluginlib/class_list_macros.hpp"
PLUGINLIB_EXPORT_CLASS(
  nav2_bt_navigator::NavigateThroughPosesNavigator,
  nav2_core::NavigatorBase)