waypoint_follower.hpp

// Copyright (c) 2019 Samsung Research America
//
// 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.
 
#ifndef NAV2_WAYPOINT_FOLLOWER__WAYPOINT_FOLLOWER_HPP_
#define NAV2_WAYPOINT_FOLLOWER__WAYPOINT_FOLLOWER_HPP_
 
#include <memory>
#include <string>
#include <vector>
#include <mutex>
 
#include "rclcpp_action/rclcpp_action.hpp"
#include "pluginlib/class_loader.hpp"
#include "pluginlib/class_list_macros.hpp"
#include "geographic_msgs/msg/geo_pose.hpp"
#include "nav2_ros_common/lifecycle_node.hpp"
#include "nav2_msgs/action/navigate_to_pose.hpp"
#include "nav2_msgs/action/follow_waypoints.hpp"
#include "nav2_msgs/msg/waypoint_status.hpp"
#include "nav2_ros_common/simple_action_server.hpp"
#include "nav2_ros_common/node_utils.hpp"
#include "nav2_util/string_utils.hpp"
#include "nav2_msgs/action/follow_gps_waypoints.hpp"
#include "nav2_ros_common/service_client.hpp"
#include "nav2_core/waypoint_task_executor.hpp"
#include "nav2_waypoint_follower/parameter_handler.hpp"
 
#include "robot_localization/srv/from_ll.hpp"
 
namespace nav2_waypoint_follower
{
 
enum class ActionStatus
{
  UNKNOWN = 0,
  PROCESSING = 1,
  FAILED = 2,
  SUCCEEDED = 3
};
 
struct GoalStatus
{
  ActionStatus status;
  int error_code;
  std::string error_msg;
};
 
class WaypointFollower : public nav2::LifecycleNode
{
public:
  using ActionT = nav2_msgs::action::FollowWaypoints;
  using ClientT = nav2_msgs::action::NavigateToPose;
  using ActionServer = nav2::SimpleActionServer<ActionT>;
  using ActionClient = nav2::ActionClient<ClientT>;
 
  // Shorten the types for GPS waypoint following
  using ActionTGPS = nav2_msgs::action::FollowGPSWaypoints;
  using ActionServerGPS = nav2::SimpleActionServer<ActionTGPS>;
 
  explicit WaypointFollower(const rclcpp::NodeOptions & options = rclcpp::NodeOptions());
  ~WaypointFollower();
 
protected:
  nav2::CallbackReturn on_configure(const rclcpp_lifecycle::State & state) override;
  nav2::CallbackReturn on_activate(const rclcpp_lifecycle::State & state) override;
  nav2::CallbackReturn on_deactivate(const rclcpp_lifecycle::State & state) override;
  nav2::CallbackReturn on_cleanup(const rclcpp_lifecycle::State & state) override;
  nav2::CallbackReturn on_shutdown(const rclcpp_lifecycle::State & state) override;
 
  template<typename T, typename V, typename Z>
  void followWaypointsHandler(const T & action_server, const V & feedback, const Z & result);
 
  template<typename T>
  bool goalReceived(std::shared_ptr<const typename T::Goal> goal);
 
  void followWaypointsCallback();
 
  void followGPSWaypointsCallback();
 
  void resultCallback(const rclcpp_action::ClientGoalHandle<ClientT>::WrappedResult & result);
 
  void goalResponseCallback(const rclcpp_action::ClientGoalHandle<ClientT>::SharedPtr & goal);
 
  std::vector<geometry_msgs::msg::PoseStamped> convertGPSPosesToMapPoses(
    const std::vector<geographic_msgs::msg::GeoPose> & gps_poses);
 
 
  template<typename T>
  std::vector<geometry_msgs::msg::PoseStamped> getLatestGoalPoses(const T & action_server);
 
  // Common vars used for both GPS and cartesian point following
  std::vector<int> failed_ids_;
 
  // Our action server
  typename ActionServer::SharedPtr xyz_action_server_;
  ActionClient::SharedPtr nav_to_pose_client_;
  rclcpp::CallbackGroup::SharedPtr callback_group_;
  rclcpp::executors::SingleThreadedExecutor callback_group_executor_;
  std::shared_future<rclcpp_action::ClientGoalHandle<ClientT>::SharedPtr> future_goal_handle_;
 
  // Our action server for GPS waypoint following
  typename ActionServerGPS::SharedPtr gps_action_server_;
  nav2::ServiceClient<robot_localization::srv::FromLL>::SharedPtr from_ll_to_map_client_;
 
  GoalStatus current_goal_status_;
 
  // Task Execution At Waypoint Plugin
  pluginlib::ClassLoader<nav2_core::WaypointTaskExecutor>
  waypoint_task_executor_loader_;
  pluginlib::UniquePtr<nav2_core::WaypointTaskExecutor>
  waypoint_task_executor_;
 
  // Parameter Handler
  std::unique_ptr<nav2_waypoint_follower::ParameterHandler> param_handler_;
  Parameters * params_;
};
 
}  // namespace nav2_waypoint_follower
 
#endif  // NAV2_WAYPOINT_FOLLOWER__WAYPOINT_FOLLOWER_HPP_