Rename ackermann msg to controller state msg type (backport #1662) (#1663)

Co-authored-by: Mukunda Bharatheesha <[email protected]>

Author: mergify[bot]

ackermann_steering_controller/test/test_ackermann_steering_controller.hpp

@@ -34,7 +34,7 @@
 #include "rclcpp_lifecycle/node_interfaces/lifecycle_node_interface.hpp"
 
 using ControllerStateMsg =
-  steering_controllers_library::SteeringControllersLibrary::AckermannControllerState;
+  steering_controllers_library::SteeringControllersLibrary::SteeringControllerStateMsg;
 using ControllerReferenceMsg =
   steering_controllers_library::SteeringControllersLibrary::ControllerTwistReferenceMsg;
 

bicycle_steering_controller/test/test_bicycle_steering_controller.hpp

@@ -34,7 +34,7 @@
 #include "rclcpp_lifecycle/node_interfaces/lifecycle_node_interface.hpp"
 
 using ControllerStateMsg =
-  steering_controllers_library::SteeringControllersLibrary::AckermannControllerState;
+  steering_controllers_library::SteeringControllersLibrary::SteeringControllerStateMsg;
 using ControllerReferenceMsg =
   steering_controllers_library::SteeringControllersLibrary::ControllerTwistReferenceMsg;
 

steering_controllers_library/CMakeLists.txt

@@ -21,7 +21,6 @@ set(THIS_PACKAGE_INCLUDE_DEPENDS
   tf2
   tf2_msgs
   tf2_geometry_msgs
-  ackermann_msgs
 )
 
 find_package(ament_cmake REQUIRED)

steering_controllers_library/include/steering_controllers_library/steering_controllers_library.hpp

@@ -33,7 +33,6 @@
 #include "steering_controllers_library/visibility_control.h"
 
 // TODO(anyone): Replace with controller specific messages
-#include "ackermann_msgs/msg/ackermann_drive_stamped.hpp"
 #include "control_msgs/msg/steering_controller_status.hpp"
 #include "geometry_msgs/msg/twist.hpp"
 #include "geometry_msgs/msg/twist_stamped.hpp"
@@ -82,11 +81,12 @@ class SteeringControllersLibrary : public controller_interface::ChainableControl
   STEERING_CONTROLLERS__VISIBILITY_PUBLIC controller_interface::return_type
   update_and_write_commands(const rclcpp::Time & time, const rclcpp::Duration & period) override;
 
-  using ControllerAckermannReferenceMsg = ackermann_msgs::msg::AckermannDriveStamped;
   using ControllerTwistReferenceMsg = geometry_msgs::msg::TwistStamped;
   using ControllerStateMsgOdom = nav_msgs::msg::Odometry;
   using ControllerStateMsgTf = tf2_msgs::msg::TFMessage;
-  using AckermannControllerState = control_msgs::msg::SteeringControllerStatus;
+  using SteeringControllerStateMsg = control_msgs::msg::SteeringControllerStatus;
+  using AckermannControllerState [[deprecated]] =
+    SteeringControllerStateMsg;  // unused, but kept for backwards compatibility
 
 protected:
   controller_interface::CallbackReturn set_interface_numbers(
@@ -97,7 +97,8 @@ class SteeringControllersLibrary : public controller_interface::ChainableControl
 
   // Command subscribers and Controller State publisher
   rclcpp::Subscription<ControllerTwistReferenceMsg>::SharedPtr ref_subscriber_twist_ = nullptr;
-  rclcpp::Subscription<ControllerTwistReferenceMsg>::SharedPtr ref_subscriber_ackermann_ = nullptr;
+  rclcpp::Subscription<ControllerTwistReferenceMsg>::SharedPtr ref_subscriber_ackermann_ =
+    nullptr;  // unused, but kept for avoiding ABI break
   rclcpp::Subscription<geometry_msgs::msg::Twist>::SharedPtr ref_subscriber_unstamped_ = nullptr;
   realtime_tools::RealtimeBuffer<std::shared_ptr<ControllerTwistReferenceMsg>> input_ref_;
   rclcpp::Duration ref_timeout_ = rclcpp::Duration::from_seconds(0.0);  // 0ms
@@ -119,10 +120,10 @@ class SteeringControllersLibrary : public controller_interface::ChainableControl
   /// Odometry:
   steering_odometry::SteeringOdometry odometry_;
 
-  AckermannControllerState published_state_;
+  SteeringControllerStateMsg published_state_;
 
-  using ControllerStatePublisher = realtime_tools::RealtimePublisher<AckermannControllerState>;
-  rclcpp::Publisher<AckermannControllerState>::SharedPtr controller_s_publisher_;
+  using ControllerStatePublisher = realtime_tools::RealtimePublisher<SteeringControllerStateMsg>;
+  rclcpp::Publisher<SteeringControllerStateMsg>::SharedPtr controller_s_publisher_;
   std::unique_ptr<ControllerStatePublisher> controller_state_publisher_;
 
   // name constants for state interfaces

steering_controllers_library/package.xml

@@ -38,7 +38,6 @@
   <depend>tf2</depend>
   <depend>tf2_msgs</depend>
   <depend>tf2_geometry_msgs</depend>
-  <depend>ackermann_msgs</depend>
 
   <test_depend>ament_cmake_gmock</test_depend>
   <test_depend>controller_manager</test_depend>

steering_controllers_library/src/steering_controllers_library.cpp

@@ -193,7 +193,7 @@ controller_interface::CallbackReturn SteeringControllersLibrary::on_configure(
   try
   {
     // State publisher
-    controller_s_publisher_ = get_node()->create_publisher<AckermannControllerState>(
+    controller_s_publisher_ = get_node()->create_publisher<SteeringControllerStateMsg>(
       "~/controller_state", rclcpp::SystemDefaultsQoS());
     controller_state_publisher_ =
       std::make_unique<ControllerStatePublisher>(controller_s_publisher_);

steering_controllers_library/test/test_steering_controllers_library.hpp

@@ -34,7 +34,7 @@
 #include "steering_controllers_library/steering_controllers_library.hpp"
 
 using ControllerStateMsg =
-  steering_controllers_library::SteeringControllersLibrary::AckermannControllerState;
+  steering_controllers_library::SteeringControllersLibrary::SteeringControllerStateMsg;
 using ControllerReferenceMsg =
   steering_controllers_library::SteeringControllersLibrary::ControllerTwistReferenceMsg;
 

tricycle_steering_controller/test/test_tricycle_steering_controller.hpp

@@ -34,7 +34,7 @@
 #include "tricycle_steering_controller/tricycle_steering_controller.hpp"
 
 using ControllerStateMsg =
-  steering_controllers_library::SteeringControllersLibrary::AckermannControllerState;
+  steering_controllers_library::SteeringControllersLibrary::SteeringControllerStateMsg;
 using ControllerReferenceMsg =
   steering_controllers_library::SteeringControllersLibrary::ControllerTwistReferenceMsg;