nav2_panel.hpp

// Copyright (c) 2019 Intel Corporation
//
// 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_RVIZ_PLUGINS__NAV2_PANEL_HPP_
#define NAV2_RVIZ_PLUGINS__NAV2_PANEL_HPP_
 
#include <QtWidgets>
#include <QBasicTimer>
#include <QStateMachine>
#include <QSignalTransition>
#undef NO_ERROR
 
#include <memory>
#include <string>
#include <vector>
 
#include "nav2_lifecycle_manager/lifecycle_manager_client.hpp"
#include "nav2_msgs/action/navigate_to_pose.hpp"
#include "nav2_msgs/action/navigate_through_poses.hpp"
#include "nav2_msgs/action/follow_waypoints.hpp"
#include "nav2_rviz_plugins/ros_action_qevent.hpp"
#include "rclcpp/executors/single_threaded_executor.hpp"
#include "rclcpp/node.hpp"
#include "rclcpp/publisher.hpp"
#include "rclcpp_action/rclcpp_action.hpp"
#include "rviz_common/panel.hpp"
#include "rviz_common/ros_integration/ros_node_abstraction_iface.hpp"
#include "tf2_geometry_msgs/tf2_geometry_msgs.hpp"
#include "visualization_msgs/msg/marker_array.hpp"
#include "nav2_util/geometry_utils.hpp"
#include "nav2_ros_common/tf2_factories.hpp"
 
class QPushButton;
 
namespace nav2_rviz_plugins
{
 
struct NavThroughPoseTab
{
  QWidget * widget;
  QLineEdit * frame_id_edit;
  QDoubleSpinBox * pos_x_spin;
  QDoubleSpinBox * pos_y_spin;
  QDoubleSpinBox * yaw_spin;
};
 
class InitialThread;
 
class Nav2Panel : public rviz_common::Panel
{
  Q_OBJECT
 
public:
  explicit Nav2Panel(QWidget * parent = 0);
  virtual ~Nav2Panel();
 
  void onInitialize() override;
 
  void load(const rviz_common::Config & config) override;
  void save(rviz_common::Config config) const override;
 
private Q_SLOTS:
  void startThread();
  void onStartup();
  void onShutdown();
  void onCancel();
  void onPause();
  void onResume();
  void onIdle();
  void onResumedWp();
  void onAccumulatedWp();
  void onAccumulatedNTP();
  void onAccumulating();
  void onNewGoal(double x, double y, double theta, QString frame);
  void handleGoalSaver();
  void handleGoalLoader();
  void loophandler();
  void initialStateHandler();
  void onSendNavToPose();
  void onAddNavThroughPose();
  void onRemoveNavThroughPose();
 
private:
  void loadLogFiles();
  void onCancelButtonPressed();
  void timerEvent(QTimerEvent * event) override;
  bool isLoopValueValid(std::string & loop);
  void createNavThroughPoseTab(int index);
  void syncTabsWithAccumulatedPoses();
  void updateAccumulatedPosesFromTabs();
  geometry_msgs::msg::PoseStamped getPoseFromNavThroughTab(const NavThroughPoseTab & tab);
 
  int unique_id {0};
  int goal_index_ = 0;
  int loop_count_ = 0;
  bool store_initial_pose_ = false;
  bool initial_pose_stored_ = false;
  bool loop_counter_stop_ = true;
  std::string loop_no_ = "0";
  std::string base_frame_;
 
  // The Node pointer that we need to keep alive for the duration of this plugin.
  std::shared_ptr<rviz_common::ros_integration::RosNodeAbstractionIface> node_ptr_;
 
  // Call to send NavigateToPose action request for goal poses
  geometry_msgs::msg::PoseStamped convert_to_msg(
    std::vector<double> pose,
    std::vector<double> orientation);
  void startWaypointFollowing(std::vector<geometry_msgs::msg::PoseStamped> poses);
  void startNavigation(geometry_msgs::msg::PoseStamped);
  void startNavThroughPoses(nav_msgs::msg::Goals poses);
  using NavigationGoalHandle =
    rclcpp_action::ClientGoalHandle<nav2_msgs::action::NavigateToPose>;
  using WaypointFollowerGoalHandle =
    rclcpp_action::ClientGoalHandle<nav2_msgs::action::FollowWaypoints>;
  using NavThroughPosesGoalHandle =
    rclcpp_action::ClientGoalHandle<nav2_msgs::action::NavigateThroughPoses>;
 
  // The (non-spinning) client node used to invoke the action client
  rclcpp::Node::SharedPtr client_node_;  //  nosemgrep
  rclcpp::executors::SingleThreadedExecutor::SharedPtr executor_;
  // Timeout value when waiting for action servers to respond
  std::chrono::milliseconds server_timeout_;
 
  // A timer used to check on the completion status of the action
  QBasicTimer timer_;
 
  // The NavigateToPose action client
  nav2::ActionClient<nav2_msgs::action::NavigateToPose>::SharedPtr navigation_action_client_;
  nav2::ActionClient<nav2_msgs::action::FollowWaypoints>::SharedPtr
    waypoint_follower_action_client_;
  nav2::ActionClient<nav2_msgs::action::NavigateThroughPoses>::SharedPtr
    nav_through_poses_action_client_;
 
  // Navigation action feedback subscribers
  nav2::Subscription<nav2_msgs::action::NavigateToPose::Impl::FeedbackMessage>::SharedPtr
    navigation_feedback_sub_;
  nav2::Subscription<nav2_msgs::action::NavigateThroughPoses::Impl::FeedbackMessage>::SharedPtr
    nav_through_poses_feedback_sub_;
  nav2::Subscription<nav2_msgs::action::NavigateToPose::Impl::GoalStatusMessage>::SharedPtr
    navigation_goal_status_sub_;
  nav2::Subscription<nav2_msgs::action::NavigateThroughPoses::Impl::GoalStatusMessage>::SharedPtr
    nav_through_poses_goal_status_sub_;
 
  // Tf's for initial pose
  nav2::TransformBuffer::SharedPtr tf2_buffer_;
  nav2::TransformListener::SharedPtr transform_listener_;
 
  // Goal-related state
  nav2_msgs::action::NavigateToPose::Goal navigation_goal_;
  nav2_msgs::action::FollowWaypoints::Goal waypoint_follower_goal_;
  nav2_msgs::action::NavigateThroughPoses::Goal nav_through_poses_goal_;
  NavigationGoalHandle::SharedPtr navigation_goal_handle_;
  WaypointFollowerGoalHandle::SharedPtr waypoint_follower_goal_handle_;
  NavThroughPosesGoalHandle::SharedPtr nav_through_poses_goal_handle_;
 
  // The client used to control the nav2 stack
  std::shared_ptr<nav2_lifecycle_manager::LifecycleManagerClient> client_nav_;
 
  QCheckBox * store_initial_pose_checkbox_{nullptr};
 
  QPushButton * start_reset_button_{nullptr};
  QPushButton * pause_resume_button_{nullptr};
  QPushButton * navigation_mode_button_{nullptr};
  QPushButton * add_pose_button_{nullptr};
  QPushButton * remove_pose_button_{nullptr};
  QPushButton * save_waypoints_button_{nullptr};
  QPushButton * load_waypoints_button_{nullptr};
  QPushButton * pause_waypoint_button_{nullptr};
  QPushButton * start_nav_to_pose_button_{nullptr};
 
  QLabel * navigation_status_indicator_{nullptr};
  QLabel * navigation_goal_status_indicator_{nullptr};
  QLabel * navigation_feedback_indicator_{nullptr};
  QLabel * waypoint_status_indicator_{nullptr};
  QLabel * number_of_loops_{nullptr};
 
  QLineEdit * nr_of_loops_{nullptr};
 
  // Behavior tree XML file selection
  QLineEdit * behavior_tree_file_{nullptr};
 
  // Tab widget for tools
  QTabWidget * tools_tab_widget_{nullptr};
 
  // NavigateToPose manual input widgets
  QLineEdit * nav_to_pose_frame_id_{nullptr};
  QDoubleSpinBox * nav_to_pose_x_{nullptr};
  QDoubleSpinBox * nav_to_pose_y_{nullptr};
  QDoubleSpinBox * nav_to_pose_yaw_{nullptr};
 
  // NavigateThroughPoses manual input widgets
  QTabWidget * nav_through_poses_tabs_{nullptr};
 
  QStateMachine state_machine_;
  InitialThread * initial_thread_;
 
  QState * pre_initial_{nullptr};
  QState * initial_{nullptr};
  QState * idle_{nullptr};
  QState * reset_{nullptr};
  QState * paused_{nullptr};
  QState * resumed_{nullptr};
  QState * paused_wp_{nullptr};
  QState * resumed_wp_{nullptr};
 
  QLabel * imgDisplayLabel_{nullptr};
 
  // The following states are added to allow for the state of the button to only expose reset
  // while the NavigateToPoses action is not active. While running, the user will be allowed to
  // cancel the action. The ROSActionTransition allows for the state of the action to be detected
  // and the button state to change automatically.
  QState * running_{nullptr};
  QState * canceled_{nullptr};
  // The following states are added to allow to collect several poses to perform a waypoint-mode
  // navigation or navigate through poses mode.
  QState * accumulating_{nullptr};
  QState * accumulated_wp_{nullptr};
  QState * accumulated_nav_through_poses_{nullptr};
 
  nav_msgs::msg::Goals acummulated_poses_;
  nav_msgs::msg::Goals store_poses_;
 
  // Storage for NavigateThroughPoses manual tabs
  std::vector<NavThroughPoseTab> nav_through_pose_tabs_;
 
  // Publish the visual markers with the waypoints
  void updateWpNavigationMarkers();
 
  // Create unique id numbers for markers
  int getUniqueId();
 
  void resetUniqueId();
 
  // create label string from feedback msg
  static inline QString getNavToPoseFeedbackLabel(
    nav2_msgs::action::NavigateToPose::Feedback msg =
    nav2_msgs::action::NavigateToPose::Feedback());
  static inline QString getNavThroughPosesFeedbackLabel(
    nav2_msgs::action::NavigateThroughPoses::Feedback =
    nav2_msgs::action::NavigateThroughPoses::Feedback());
  template<typename T>
  static inline std::string toLabel(T & msg);
 
  // round off double to the specified precision and convert to string
  static inline std::string toString(double val, int precision = 0);
 
  // Waypoint navigation visual markers publisher
  //  nosemgrep
  rclcpp::Publisher<visualization_msgs::msg::MarkerArray>::SharedPtr wp_navigation_markers_pub_;
};
 
class InitialThread : public QThread
{
  Q_OBJECT
 
public:
  using SystemStatus = nav2_lifecycle_manager::SystemStatus;
 
  explicit InitialThread(
    std::shared_ptr<nav2_lifecycle_manager::LifecycleManagerClient> & client_nav)
  : client_nav_(client_nav)
  {}
 
  void run() override
  {
    SystemStatus status_nav = SystemStatus::TIMEOUT;
 
    while (status_nav == SystemStatus::TIMEOUT) {
      status_nav = client_nav_->is_active(std::chrono::seconds(1));
    }
 
    if (status_nav == SystemStatus::ACTIVE) {
      emit navigationActive();
    } else {
      emit navigationInactive();
    }
  }
 
signals:
  void navigationActive();
  void navigationInactive();
 
private:
  std::shared_ptr<nav2_lifecycle_manager::LifecycleManagerClient> client_nav_;
};
 
}  // namespace nav2_rviz_plugins
 
#endif  //  NAV2_RVIZ_PLUGINS__NAV2_PANEL_HPP_