Nav2 Navigation Stack - rolling  main
ROS 2 Navigation Stack
docking_panel.cpp
1 // Copyright (c) 2024 Alberto J. Tudela Roldán
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 // QT
16 #include <QLineEdit>
17 #include <QVBoxLayout>
18 #include <QHBoxLayout>
19 #include <QLabel>
20 
21 // C++
22 #include <chrono>
23 #include <memory>
24 #include <sstream>
25 #include <string>
26 
27 #include <rclcpp/rclcpp.hpp>
28 #include <rviz_common/display_context.hpp>
29 
30 #include "nav2_util/geometry_utils.hpp"
31 #include "nav2_rviz_plugins/docking_panel.hpp"
32 #include "nav2_rviz_plugins/ros_action_qevent.hpp"
33 #include "nav2_rviz_plugins/utils.hpp"
34 
35 using namespace std::chrono_literals;
36 
37 namespace nav2_rviz_plugins
38 {
39 
40 DockingPanel::DockingPanel(QWidget * parent)
41 : Panel(parent),
42  server_timeout_(100)
43 {
44  // Create the control buttons and its tooltip
45  main_layout_ = new QVBoxLayout;
46  info_layout_ = new QHBoxLayout;
47  feedback_layout_ = new QVBoxLayout;
48  dock_id_layout_ = new QHBoxLayout;
49  dock_type_layout_ = new QHBoxLayout;
50  dock_pose_layout_ = new QHBoxLayout;
51  nav_stage_layout_ = new QHBoxLayout;
52  dock_type_ = new QComboBox;
53  docking_button_ = new QPushButton;
54  undocking_button_ = new QPushButton;
55  docking_goal_status_indicator_ = new QLabel;
56  docking_feedback_indicator_ = new QLabel;
57  docking_result_indicator_ = new QLabel;
58  use_dock_id_checkbox_ = new QCheckBox;
59  nav_to_staging_checkbox_ = new QCheckBox;
60  dock_id_ = new QLineEdit;
61  dock_pose_x_ = new QLineEdit;
62  dock_pose_y_ = new QLineEdit;
63  dock_pose_yaw_ = new QLineEdit;
64 
65  // Create the state machine used to present the proper control button states in the UI
66  const char * nav_to_stage_msg = "Navigate to the staging pose before docking";
67  const char * use_dock_id_msg = "Use the dock id or the dock pose to dock the robot";
68  const char * dock_msg = "Dock the robot at the specified docking station";
69  const char * undock_msg = "Undock the robot from the docking station";
70  const char * cancel_dock_msg = "Cancel the current docking action";
71  const char * cancel_undock_msg = "Cancel the current undocking action";
72 
73  docking_goal_status_indicator_->setText(nav2_rviz_plugins::getGoalStatusLabel());
74  docking_feedback_indicator_->setText(getDockFeedbackLabel());
75  docking_goal_status_indicator_->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
76  docking_feedback_indicator_->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
77 
78  pre_initial_ = new QState();
79  pre_initial_->setObjectName("pre_initial");
80  pre_initial_->assignProperty(docking_button_, "text", "Dock robot");
81  pre_initial_->assignProperty(docking_button_, "enabled", false);
82 
83  pre_initial_->assignProperty(undocking_button_, "text", "Undock robot");
84  pre_initial_->assignProperty(undocking_button_, "enabled", false);
85 
86  pre_initial_->assignProperty(nav_to_staging_checkbox_, "enabled", false);
87  pre_initial_->assignProperty(nav_to_staging_checkbox_, "checked", true);
88  pre_initial_->assignProperty(use_dock_id_checkbox_, "enabled", false);
89  pre_initial_->assignProperty(use_dock_id_checkbox_, "checked", true);
90  pre_initial_->assignProperty(dock_id_, "enabled", false);
91  pre_initial_->assignProperty(dock_type_, "enabled", false);
92  pre_initial_->assignProperty(dock_pose_x_, "enabled", false);
93  pre_initial_->assignProperty(dock_pose_y_, "enabled", false);
94  pre_initial_->assignProperty(dock_pose_yaw_, "enabled", false);
95 
96  // State entered when the docking / undocking action is not active
97  idle_ = new QState();
98  idle_->setObjectName("idle");
99  idle_->assignProperty(docking_button_, "text", "Dock robot");
100  idle_->assignProperty(docking_button_, "toolTip", dock_msg);
101  idle_->assignProperty(docking_button_, "enabled", true);
102 
103  idle_->assignProperty(undocking_button_, "text", "Undock robot");
104  idle_->assignProperty(undocking_button_, "toolTip", undock_msg);
105  idle_->assignProperty(undocking_button_, "enabled", true);
106 
107  idle_->assignProperty(nav_to_staging_checkbox_, "enabled", true);
108  idle_->assignProperty(nav_to_staging_checkbox_, "toolTip", nav_to_stage_msg);
109  idle_->assignProperty(use_dock_id_checkbox_, "enabled", true);
110  idle_->assignProperty(use_dock_id_checkbox_, "toolTip", use_dock_id_msg);
111  idle_->assignProperty(dock_id_, "enabled", true);
112  idle_->assignProperty(dock_type_, "enabled", true);
113 
114  // State entered to cancel the docking action
115  canceled_docking_ = new QState();
116  canceled_docking_->setObjectName("canceled_docking");
117 
118  // State entered to cancel the undocking action
119  canceled_undocking_ = new QState();
120  canceled_undocking_->setObjectName("canceled_undocking");
121 
122  // State entered while the docking action is active
123  docking_ = new QState();
124  docking_->setObjectName("docking");
125  docking_->assignProperty(docking_button_, "text", "Cancel docking");
126  docking_->assignProperty(docking_button_, "toolTip", cancel_dock_msg);
127 
128  docking_->assignProperty(undocking_button_, "enabled", false);
129 
130  // State entered while the undocking action is active
131  undocking_ = new QState();
132  undocking_->setObjectName("undocking");
133  undocking_->assignProperty(docking_button_, "enabled", false);
134 
135  undocking_->assignProperty(undocking_button_, "text", "Cancel undocking");
136  undocking_->assignProperty(undocking_button_, "toolTip", cancel_undock_msg);
137 
138  QObject::connect(docking_, SIGNAL(entered()), this, SLOT(onDockingButtonPressed()));
139  QObject::connect(undocking_, SIGNAL(entered()), this, SLOT(onUndockingButtonPressed()));
140  QObject::connect(canceled_docking_, SIGNAL(exited()), this, SLOT(onCancelDocking()));
141  QObject::connect(canceled_undocking_, SIGNAL(exited()), this, SLOT(onCancelUndocking()));
142 
143  // Start/Cancel button click transitions
144  idle_->addTransition(docking_button_, SIGNAL(clicked()), docking_);
145  idle_->addTransition(undocking_button_, SIGNAL(clicked()), undocking_);
146  docking_->addTransition(docking_button_, SIGNAL(clicked()), canceled_docking_);
147  undocking_->addTransition(undocking_button_, SIGNAL(clicked()), canceled_undocking_);
148 
149  // Internal state transitions
150  canceled_docking_->addTransition(canceled_docking_, SIGNAL(entered()), idle_);
151  canceled_undocking_->addTransition(canceled_undocking_, SIGNAL(entered()), idle_);
152 
153  // ROSAction Transitions: So when actions are updated remotely (failing, succeeding, etc)
154  // the state of the application will also update. This means that if in the processing
155  // states and then goes inactive, move back to the idle state. Vice versa as well.
156  ROSActionQTransition * idleDockTransition = new ROSActionQTransition(QActionState::INACTIVE);
157  idleDockTransition->setTargetState(docking_);
158  idle_->addTransition(idleDockTransition);
159 
160  ROSActionQTransition * idleUndockTransition = new ROSActionQTransition(QActionState::INACTIVE);
161  idleUndockTransition->setTargetState(undocking_);
162  idle_->addTransition(idleUndockTransition);
163 
164  ROSActionQTransition * dockingTransition = new ROSActionQTransition(QActionState::ACTIVE);
165  dockingTransition->setTargetState(idle_);
166  docking_->addTransition(dockingTransition);
167 
168  ROSActionQTransition * undockingTransition = new ROSActionQTransition(QActionState::ACTIVE);
169  undockingTransition->setTargetState(idle_);
170  undocking_->addTransition(undockingTransition);
171 
172  client_node_ = std::make_shared<rclcpp::Node>("nav2_rviz_docking_panel_node");
173 
174  state_machine_.addState(pre_initial_);
175  state_machine_.addState(idle_);
176  state_machine_.addState(docking_);
177  state_machine_.addState(undocking_);
178  state_machine_.addState(canceled_docking_);
179  state_machine_.addState(canceled_undocking_);
180 
181  state_machine_.setInitialState(pre_initial_);
182 
183  // Delay starting initial thread until state machine has started or a race occurs
184  QObject::connect(&state_machine_, SIGNAL(started()), this, SLOT(startThread()));
185  state_machine_.start();
186 
187  // Create the layout for the panel
188  info_layout_->addWidget(docking_goal_status_indicator_);
189  info_layout_->addWidget(docking_result_indicator_);
190  feedback_layout_->addWidget(docking_feedback_indicator_);
191 
192  QLabel * nav_stage_label = new QLabel("Nav. to staging pose");
193  QLabel * dock_id_label = new QLabel("Dock id");
194  QLabel * dock_type_label = new QLabel("Dock type");
195 
196  nav_stage_label->setFixedWidth(150);
197  dock_id_label->setFixedWidth(150);
198  dock_type_label->setFixedWidth(170);
199 
200  nav_stage_layout_->addWidget(nav_stage_label);
201  nav_stage_layout_->addWidget(nav_to_staging_checkbox_);
202  dock_id_layout_->addWidget(dock_id_label);
203  dock_id_layout_->addWidget(use_dock_id_checkbox_);
204  dock_id_layout_->addWidget(dock_id_);
205  dock_type_layout_->addWidget(dock_type_label);
206  dock_type_layout_->addWidget(dock_type_);
207  dock_pose_layout_->addWidget(new QLabel("Dock pose {X"));
208  dock_pose_layout_->addWidget(dock_pose_x_);
209  dock_pose_layout_->addWidget(new QLabel("Y"));
210  dock_pose_layout_->addWidget(dock_pose_y_);
211  dock_pose_layout_->addWidget(new QLabel("θ"));
212  dock_pose_layout_->addWidget(dock_pose_yaw_);
213  dock_pose_layout_->addWidget(new QLabel("}"));
214 
215  QGroupBox * group_box = new QGroupBox();
216  QVBoxLayout * group_box_layout = new QVBoxLayout;
217  group_box_layout->addLayout(nav_stage_layout_);
218  group_box_layout->addLayout(dock_id_layout_);
219  group_box_layout->addLayout(dock_type_layout_);
220  group_box_layout->addLayout(dock_pose_layout_);
221  group_box->setLayout(group_box_layout);
222 
223  main_layout_->setContentsMargins(10, 10, 10, 10);
224  main_layout_->addLayout(info_layout_);
225  main_layout_->addLayout(feedback_layout_);
226  main_layout_->addWidget(group_box);
227  main_layout_->addWidget(docking_button_);
228  main_layout_->addWidget(undocking_button_);
229 
230  setLayout(main_layout_);
231  action_timer_.start(200, this);
232 
233  dock_client_ = rclcpp_action::create_client<Dock>(client_node_, "dock_robot");
234  undock_client_ = rclcpp_action::create_client<Undock>(client_node_, "undock_robot");
235  initial_thread_ = new InitialDockThread(dock_client_, undock_client_);
236  connect(initial_thread_, &InitialDockThread::finished, initial_thread_, &QObject::deleteLater);
237 
238  QSignalTransition * activeDockSignal = new QSignalTransition(
239  initial_thread_, &InitialDockThread::dockingActive);
240  activeDockSignal->setTargetState(idle_);
241  pre_initial_->addTransition(activeDockSignal);
242 
243  QSignalTransition * activeUndockSignal = new QSignalTransition(
244  initial_thread_, &InitialDockThread::undockingActive);
245  activeUndockSignal->setTargetState(idle_);
246  pre_initial_->addTransition(activeUndockSignal);
247 
248  QObject::connect(
249  initial_thread_, &InitialDockThread::dockingActive,
250  [this] {
251  // Load the plugins if not already loaded
252  if (!plugins_loaded_) {
253  RCLCPP_INFO(client_node_->get_logger(), "Loading dock plugins");
254  nav2_rviz_plugins::pluginLoader(
255  client_node_, server_failed_, "docking_server", "dock_plugins", dock_type_);
256  plugins_loaded_ = true;
257  }
258  });
259 
260  // Connect buttons with functions
261  QObject::connect(
262  use_dock_id_checkbox_, &QCheckBox::stateChanged, this, &DockingPanel::dockIdCheckbox);
263 }
264 
265 void DockingPanel::onInitialize()
266 {
267  node_ptr_ = getDisplayContext()->getRosNodeAbstraction().lock();
268  if (node_ptr_ == nullptr) {
269  // The node no longer exists, so just don't initialize
270  RCLCPP_ERROR(
271  rclcpp::get_logger("docking_panel"),
272  "Underlying ROS node no longer exists, initialization failed");
273  return;
274  }
275  rclcpp::Node::SharedPtr node = node_ptr_->get_raw_node();
276 
277  // Create action feedback subscriber
278  docking_feedback_sub_ = node->create_subscription<Dock::Impl::FeedbackMessage>(
279  "dock_robot/_action/feedback",
280  rclcpp::SystemDefaultsQoS(),
281  [this](const Dock::Impl::FeedbackMessage::SharedPtr msg) {
282  docking_feedback_indicator_->setText(getDockFeedbackLabel(msg->feedback));
283  });
284 
285  // Create action goal status subscribers
286  docking_goal_status_sub_ = node->create_subscription<action_msgs::msg::GoalStatusArray>(
287  "dock_robot/_action/status",
288  rclcpp::SystemDefaultsQoS(),
289  [this](const action_msgs::msg::GoalStatusArray::SharedPtr msg) {
290  docking_goal_status_indicator_->setText(
291  nav2_rviz_plugins::getGoalStatusLabel("Feedback", msg->status_list.back().status));
292  // Reset values when action is completed
293  if (msg->status_list.back().status == action_msgs::msg::GoalStatus::STATUS_SUCCEEDED) {
294  docking_feedback_indicator_->setText(getDockFeedbackLabel());
295  }
296  });
297 
298  undocking_goal_status_sub_ = node->create_subscription<action_msgs::msg::GoalStatusArray>(
299  "undock_robot/_action/status",
300  rclcpp::SystemDefaultsQoS(),
301  [this](const action_msgs::msg::GoalStatusArray::SharedPtr msg) {
302  docking_goal_status_indicator_->setText(
303  nav2_rviz_plugins::getGoalStatusLabel("Feedback", msg->status_list.back().status));
304  });
305 }
306 
307 void DockingPanel::startThread()
308 {
309  // start initial thread now that state machine is started
310  initial_thread_->start();
311 }
312 
313 DockingPanel::~DockingPanel()
314 {
315 }
316 
317 void DockingPanel::load(const rviz_common::Config & config)
318 {
319  Panel::load(config);
320 }
321 
322 void DockingPanel::save(rviz_common::Config config) const
323 {
324  Panel::save(config);
325 }
326 
327 void DockingPanel::onDockingButtonPressed()
328 {
329  auto is_action_server_ready =
330  dock_client_->wait_for_action_server(std::chrono::seconds(5));
331  if (!is_action_server_ready) {
332  RCLCPP_ERROR(client_node_->get_logger(), "dock_robot action server is not available.");
333  return;
334  }
335 
336  QComboBox * combo_box = dock_type_;
337  // If "default" option is selected, it gets removed and the next item is selected
338  if (combo_box->findText("Default") != -1) {
339  combo_box->removeItem(0);
340  }
341 
342  // If there are no plugins available, return
343  if (combo_box->count() == 0) {
344  return;
345  }
346 
347  // Send the goal to the action server
348  auto goal_msg = Dock::Goal();
349  goal_msg.use_dock_id = use_dock_id_;
350  goal_msg.navigate_to_staging_pose = nav_to_staging_checkbox_->isChecked();
351  if (use_dock_id_) {
352  if (dock_id_->text().isEmpty()) {
353  RCLCPP_ERROR(client_node_->get_logger(), "Dock id is empty.");
354  return;
355  }
356  goal_msg.dock_id = dock_id_->text().toStdString();
357 
358  RCLCPP_INFO(
359  client_node_->get_logger(), "DockRobot will be called using dock id: %s",
360  goal_msg.dock_id.c_str());
361 
362  } else {
363  if (dock_pose_x_->text().isEmpty() || dock_pose_y_->text().isEmpty() ||
364  dock_pose_yaw_->text().isEmpty())
365  {
366  RCLCPP_ERROR(client_node_->get_logger(), "Dock pose is empty.");
367  return;
368  }
369  goal_msg.dock_pose.header.frame_id = "map";
370  goal_msg.dock_pose.header.stamp = client_node_->now();
371  goal_msg.dock_pose.pose.position.x = dock_pose_x_->text().toDouble();
372  goal_msg.dock_pose.pose.position.y = dock_pose_y_->text().toDouble();
373  goal_msg.dock_pose.pose.orientation = nav2_util::geometry_utils::orientationAroundZAxis(
374  dock_pose_yaw_->text().toDouble());
375  goal_msg.dock_type = combo_box->currentText().toStdString();
376 
377  RCLCPP_INFO(
378  client_node_->get_logger(), "DockRobot will be called using dock pose: (%f, %f) and type: %s",
379  goal_msg.dock_pose.pose.position.x, goal_msg.dock_pose.pose.position.y,
380  goal_msg.dock_type.c_str());
381  }
382 
383  // Enable result awareness by providing an empty lambda function
384  auto send_goal_options = nav2::ActionClient<Dock>::SendGoalOptions();
385  send_goal_options.result_callback = [this](const DockGoalHandle::WrappedResult & result) {
386  dock_goal_handle_.reset();
387  if (result.result->success) {
388  docking_result_indicator_->setText("");
389  } else {
390  docking_result_indicator_->setText(
391  QString(std::string("(" + dockErrorToString(result.result->error_code) + ")").c_str()));
392  }
393  };
394 
395  auto future_goal_handle = dock_client_->async_send_goal(goal_msg, send_goal_options);
396  if (rclcpp::spin_until_future_complete(client_node_, future_goal_handle, server_timeout_) !=
397  rclcpp::FutureReturnCode::SUCCESS)
398  {
399  RCLCPP_ERROR(client_node_->get_logger(), "Send goal call failed");
400  return;
401  }
402 
403  // Get the goal handle and save so that we can check on completion in the timer callback
404  dock_goal_handle_ = future_goal_handle.get();
405  if (!dock_goal_handle_) {
406  RCLCPP_ERROR(client_node_->get_logger(), "Goal was rejected by server");
407  return;
408  }
409 
410  action_timer_.start(200, this);
411 }
412 
413 void DockingPanel::onUndockingButtonPressed()
414 {
415  auto is_action_server_ready =
416  undock_client_->wait_for_action_server(std::chrono::seconds(5));
417  if (!is_action_server_ready) {
418  RCLCPP_ERROR(client_node_->get_logger(), "undock_robot action server is not available.");
419  return;
420  }
421 
422  QComboBox * combo_box = dock_type_;
423  // If "default" option is selected, it gets removed and the next item is selected
424  if (combo_box->findText("Default") != -1) {
425  combo_box->removeItem(0);
426  }
427 
428  // If there are no plugins available, return
429  if (combo_box->count() == 0) {
430  return;
431  }
432 
433  // Send the goal to the action server
434  auto goal_msg = Undock::Goal();
435  goal_msg.dock_type = combo_box->currentText().toStdString();
436 
437  RCLCPP_INFO(
438  client_node_->get_logger(), "UndockRobot will be called using dock type: %s",
439  goal_msg.dock_type.c_str());
440 
441  // Enable result awareness by providing an empty lambda function
442  auto send_goal_options = nav2::ActionClient<Undock>::SendGoalOptions();
443  send_goal_options.result_callback = [this](const UndockGoalHandle::WrappedResult & result) {
444  undock_goal_handle_.reset();
445  if (result.result->success) {
446  docking_result_indicator_->setText("");
447  } else {
448  docking_result_indicator_->setText(
449  QString(std::string("(" + dockErrorToString(result.result->error_code) + ")").c_str()));
450  }
451  };
452 
453  auto future_goal_handle = undock_client_->async_send_goal(goal_msg, send_goal_options);
454  if (rclcpp::spin_until_future_complete(client_node_, future_goal_handle, server_timeout_) !=
455  rclcpp::FutureReturnCode::SUCCESS)
456  {
457  RCLCPP_ERROR(client_node_->get_logger(), "Send goal call failed");
458  return;
459  }
460 
461  // Get the goal handle and save so that we can check on completion in the timer callback
462  undock_goal_handle_ = future_goal_handle.get();
463  if (!undock_goal_handle_) {
464  RCLCPP_ERROR(client_node_->get_logger(), "Goal was rejected by server");
465  return;
466  }
467 
468  action_timer_.start(200, this);
469 }
470 
471 void DockingPanel::dockIdCheckbox()
472 {
473  if (use_dock_id_checkbox_->isChecked()) {
474  use_dock_id_ = true;
475  dock_id_->setEnabled(true);
476  dock_pose_x_->setEnabled(false);
477  dock_pose_y_->setEnabled(false);
478  dock_pose_yaw_->setEnabled(false);
479  } else {
480  use_dock_id_ = false;
481  dock_id_->setEnabled(false);
482  dock_pose_x_->setEnabled(true);
483  dock_pose_y_->setEnabled(true);
484  dock_pose_yaw_->setEnabled(true);
485  }
486 }
487 
488 void DockingPanel::onCancelDocking()
489 {
490  if (dock_goal_handle_) {
491  auto future_cancel = dock_client_->async_cancel_goal(dock_goal_handle_);
492 
493  if (rclcpp::spin_until_future_complete(client_node_, future_cancel, server_timeout_) !=
494  rclcpp::FutureReturnCode::SUCCESS)
495  {
496  RCLCPP_ERROR(client_node_->get_logger(), "Failed to cancel goal");
497  } else {
498  dock_goal_handle_.reset();
499  }
500  }
501 
502  action_timer_.stop();
503 }
504 
505 void DockingPanel::onCancelUndocking()
506 {
507  if (undock_goal_handle_) {
508  auto future_cancel = undock_client_->async_cancel_goal(undock_goal_handle_);
509 
510  if (rclcpp::spin_until_future_complete(client_node_, future_cancel, server_timeout_) !=
511  rclcpp::FutureReturnCode::SUCCESS)
512  {
513  RCLCPP_ERROR(client_node_->get_logger(), "Failed to cancel goal");
514  } else {
515  undock_goal_handle_.reset();
516  }
517  }
518 
519  action_timer_.stop();
520 }
521 
522 void DockingPanel::timerEvent(QTimerEvent * event)
523 {
524  if (event->timerId() == action_timer_.timerId()) {
525  // Check the status of the action servers
526  if (state_machine_.configuration().contains(docking_)) {
527  if (!dock_goal_handle_) {
528  RCLCPP_DEBUG(client_node_->get_logger(), "Waiting for Goal");
529  state_machine_.postEvent(new ROSActionQEvent(QActionState::INACTIVE));
530  return;
531  }
532 
533  rclcpp::spin_some(client_node_);
534  auto status = dock_goal_handle_->get_status();
535 
536  // Check if the goal is still executing
537  if (status == action_msgs::msg::GoalStatus::STATUS_ACCEPTED ||
538  status == action_msgs::msg::GoalStatus::STATUS_EXECUTING)
539  {
540  state_machine_.postEvent(new ROSActionQEvent(QActionState::ACTIVE));
541  } else {
542  state_machine_.postEvent(new ROSActionQEvent(QActionState::INACTIVE));
543  action_timer_.stop();
544  }
545  } else if (state_machine_.configuration().contains(undocking_)) {
546  if (!undock_goal_handle_) {
547  RCLCPP_DEBUG(client_node_->get_logger(), "Waiting for Goal");
548  state_machine_.postEvent(new ROSActionQEvent(QActionState::INACTIVE));
549  return;
550  }
551 
552  rclcpp::spin_some(client_node_);
553  auto status = undock_goal_handle_->get_status();
554 
555  // Check if the goal is still executing
556  if (status == action_msgs::msg::GoalStatus::STATUS_ACCEPTED ||
557  status == action_msgs::msg::GoalStatus::STATUS_EXECUTING)
558  {
559  state_machine_.postEvent(new ROSActionQEvent(QActionState::ACTIVE));
560  } else {
561  state_machine_.postEvent(new ROSActionQEvent(QActionState::INACTIVE));
562  action_timer_.stop();
563  }
564  }
565  }
566 }
567 
568 inline QString DockingPanel::getDockFeedbackLabel(Dock::Feedback msg)
569 {
570  return QString(std::string("<table>" + toLabel(msg) + "</table>").c_str());
571 }
572 
573 template<typename T>
574 inline std::string DockingPanel::toLabel(T & msg)
575 {
576  return std::string(
577  "</td></tr><tr><td width=150>State:</td><td>" +
578  dockStateToString(msg.state) +
579  "</td></tr><tr><td width=150>Time taken:</td><td>" +
580  toString(rclcpp::Duration(msg.docking_time).seconds(), 0) + " s"
581  "</td></tr><tr><td width=150>Retries:</td><td>" +
582  std::to_string(msg.num_retries) +
583  "</td></tr>");
584 }
585 
586 inline std::string DockingPanel::toString(double val, int precision)
587 {
588  std::ostringstream out;
589  out.precision(precision);
590  out << std::fixed << val;
591  return out.str();
592 }
593 
594 inline std::string DockingPanel::dockStateToString(int16_t state)
595 {
596  switch (state) {
597  case 0:
598  return "none";
599  case 1:
600  return "nav. to staging pose";
601  case 2:
602  return "initial perception";
603  case 3:
604  return "controlling";
605  case 4:
606  return "wait for charge";
607  case 5:
608  return "retry";
609  default:
610  return "none";
611  }
612 }
613 
614 inline std::string DockingPanel::dockErrorToString(int16_t error_code)
615 {
616  switch (error_code) {
617  case 0:
618  return "none";
619  case 901:
620  return "dock not in database";
621  case 902:
622  return "dock not valid";
623  case 903:
624  return "failed to stage";
625  case 904:
626  return "failed to detect dock";
627  case 905:
628  return "failed to control";
629  case 906:
630  return "failed to charge";
631  case 999:
632  default:
633  return "unknown";
634  }
635 }
636 
637 } // namespace nav2_rviz_plugins
638 
639 #include <pluginlib/class_list_macros.hpp> // NOLINT
640 PLUGINLIB_EXPORT_CLASS(nav2_rviz_plugins::DockingPanel, rviz_common::Panel)
Panel to interface to the docking server.