`/spin`#

Caution

This documentation page has been auto-generated.

It may be missing some details.

/spin Quick Facts

Category: 🧭 Navigation
Message type: nav2_msgs/action/Spin

Nav2 Behavior Plugin implementing a configurable spin behavior. It makes the robot rotate by a certaing angle.

For more information on this Behavior, check the Nav2 Spin Behavior documentation.

Quick snippets#

Send a goal from the command-line#

$ ros2 action send_goal /spin nav2_msgs/action/Spin # press Tab to complete the message prototype

How to use in your code#

Call the action from a Python script#

#!/usr/bin/env python

import rclpy
from rclpy.action import ActionClient
from rclpy.node import Node

from nav2_msgs.action import Spin

class SpinActionClient(Node):

    def __init__(self):
        super().__init__('spin_client')
        self._action_client = ActionClient(self, Spin, '/spin')

    def send_goal(self, a, b):
        goal_msg = Spin.Goal()

        # TODO: adapt to the action's parameters
        # check https://docs.ros2.org/latest/api/nav2_msgs/action/Spin.html
        # for the possible goal parameters
        # goal_msg.a = a
        # goal_msg.b = b

        self._action_client.wait_for_server()

        return self._action_client.send_goal_async(goal_msg)

if __name__ == '__main__':
    rclpy.init(args=args)

    action_client = SpinActionClient()

    # TODO: adapt to your action's parameters
    future = action_client.send_goal(a, b)

    rclpy.spin_until_future_complete(action_client, future)

    rclpy.shutdown()

Call the action from a C++ program#

#include <functional>
#include <future>
#include <memory>
#include <string>
#include <sstream>
#include <chrono>

#include "nav2_msgs/action/spin.hpp"

#include "rclcpp/rclcpp.hpp"
#include "rclcpp_action/rclcpp_action.hpp"
#include "rclcpp_components/register_node_macro.hpp"

using namespace std::chrono_literals;
using namespace std;

class SpinActionClient : public rclcpp::Node
{
public:
  using Spin = nav2_msgs::action::Spin;
  using GoalHandleSpin = rclcpp_action::ClientGoalHandle<Spin>;

  explicit SpinActionClient(const rclcpp::NodeOptions & options)
  : Node("spin_action_client", options)
  {
    this->client_ptr_ = rclcpp_action::create_client<Spin>(
            this,
            "/spin");

    this->timer_ = this->create_wall_timer(
            500ms,
            bind(&SpinActionClient::send_goal, this));
  }

  void send_goal()
  {
    using namespace std::placeholders;

    this->timer_->cancel();

    if (!this->client_ptr_->wait_for_action_server()) {
      RCLCPP_ERROR(this->get_logger(), "Action server not available after waiting");
      rclcpp::shutdown();
    }

    auto goal_msg = Spin::Goal();

    // check https://docs.ros2.org/latest/api/nav2_msgs/action/Spin.html
    // for the possible goal parameters
    // goal_msg.... = ...;

    RCLCPP_INFO(this->get_logger(), "Sending goal");

    auto send_goal_options = rclcpp_action::Client<Spin>::SendGoalOptions();

    send_goal_options.goal_response_callback =
        bind(&SpinActionClient::goal_response_callback, this, _1);

    send_goal_options.feedback_callback =
        bind(&SpinActionClient::feedback_callback, this, _1, _2);

    send_goal_options.result_callback =
        bind(&SpinActionClient::result_callback, this, _1);


    this->client_ptr_->async_send_goal(goal_msg, send_goal_options);
  }

private:
  rclcpp_action::Client<Spin>::SharedPtr client_ptr_;
  rclcpp::TimerBase::SharedPtr timer_;

  void goal_response_callback(const GoalHandleSpin::SharedPtr & goal_handle)
  {
    if (!goal_handle) {
      RCLCPP_ERROR(this->get_logger(), "Goal was rejected by server");
    } else {
      RCLCPP_INFO(this->get_logger(), "Goal accepted by server, waiting for result");
    }
  }

  void feedback_callback(
      GoalHandleSpin::SharedPtr,
      const shared_ptr<const Spin::Feedback> feedback)
  {
    stringstream ss;
    ss << "Next number in sequence received: ";
    for (auto number : feedback->partial_sequence) {
      ss << number << " ";
    }
    RCLCPP_INFO(this->get_logger(), ss.str().c_str());
  }

  void result_callback(const GoalHandleSpin::WrappedResult & result)
  {
    switch (result.code) {
      case rclcpp_action::ResultCode::SUCCEEDED:
          break;
      case rclcpp_action::ResultCode::ABORTED:
          RCLCPP_ERROR(this->get_logger(), "Goal was aborted");
          return;
      case rclcpp_action::ResultCode::CANCELED:
          RCLCPP_ERROR(this->get_logger(), "Goal was canceled");
          return;
      default:
          RCLCPP_ERROR(this->get_logger(), "Unknown result code");
          return;
    }
    stringstream ss;
    ss << "Result received: ";
    for (auto number : result.result->sequence) {
      ss << number << " ";
    }
    RCLCPP_INFO(this->get_logger(), ss.str().c_str());
    rclcpp::shutdown();
  }
};  // class SpinActionClient


RCLCPP_COMPONENTS_REGISTER_NODE(SpinActionClient)

/spin#

Quick snippets#

How to use in your code#

`/spin`#