omni_wheel_drive_controller.hpp

// Copyright 2025 Aarav Gupta
//
// 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 OMNI_WHEEL_DRIVE_CONTROLLER__OMNI_WHEEL_DRIVE_CONTROLLER_HPP_
#define OMNI_WHEEL_DRIVE_CONTROLLER__OMNI_WHEEL_DRIVE_CONTROLLER_HPP_
 
#include <memory>
#include <string>
#include <vector>
 
#include "control_msgs/srv/set_odometry.hpp"
#include "controller_interface/chainable_controller_interface.hpp"
#include "geometry_msgs/msg/twist_stamped.hpp"
#include "nav_msgs/msg/odometry.hpp"
#include "omni_wheel_drive_controller/odometry.hpp"
#include "realtime_tools/realtime_publisher.hpp"
#include "realtime_tools/realtime_thread_safe_box.hpp"
#include "tf2_msgs/msg/tf_message.hpp"
 
// auto-generated by generate_parameter_library
#include "omni_wheel_drive_controller/omni_wheel_drive_controller_parameters.hpp"
 
namespace omni_wheel_drive_controller
{
class OmniWheelDriveController : public controller_interface::ChainableControllerInterface
{
  using TwistStamped = geometry_msgs::msg::TwistStamped;
 
public:
  OmniWheelDriveController();
 
  controller_interface::CallbackReturn on_init() override;
 
  controller_interface::InterfaceConfiguration command_interface_configuration() const override;
 
  controller_interface::InterfaceConfiguration state_interface_configuration() const override;
 
  controller_interface::CallbackReturn on_configure(
    const rclcpp_lifecycle::State & previous_state) override;
 
  controller_interface::CallbackReturn on_activate(
    const rclcpp_lifecycle::State & previous_state) override;
 
  controller_interface::CallbackReturn on_deactivate(
    const rclcpp_lifecycle::State & previous_state) override;
 
  controller_interface::return_type update_reference_from_subscribers(
    const rclcpp::Time & time, const rclcpp::Duration & period) override;
 
  controller_interface::return_type update_and_write_commands(
    const rclcpp::Time & time, const rclcpp::Duration & period) override;
 
  controller_interface::CallbackReturn on_cleanup(
    const rclcpp_lifecycle::State & previous_state) override;
 
  controller_interface::CallbackReturn on_error(
    const rclcpp_lifecycle::State & previous_state) override;
 
  void set_odometry(
    const std::shared_ptr<rmw_request_id_t> request_header,
    const std::shared_ptr<control_msgs::srv::SetOdometry::Request> req,
    std::shared_ptr<control_msgs::srv::SetOdometry::Response> res);
 
protected:
  std::vector<hardware_interface::CommandInterface> on_export_reference_interfaces() override;
 
  // Parameters from ROS for omni_wheel_drive_controller
  std::shared_ptr<ParamListener> param_listener_;
  Params params_;
 
  struct WheelHandle
  {
    std::optional<std::reference_wrapper<const hardware_interface::LoanedStateInterface>> feedback;
    std::reference_wrapper<hardware_interface::LoanedCommandInterface> velocity;
  };
  std::vector<WheelHandle> registered_wheel_handles_;
 
  controller_interface::CallbackReturn configure_wheel_handles(
    const std::vector<std::string> & wheel_names, std::vector<WheelHandle> & registered_handles);
 
  // Timeout to consider cmd_vel commands old
  rclcpp::Duration cmd_vel_timeout_ = rclcpp::Duration::from_seconds(0.5);
 
  std::atomic_bool subscriber_is_active_ = false;
  rclcpp::Subscription<TwistStamped>::SharedPtr velocity_command_subscriber_ = nullptr;
  // Realtime container to exchange the reference from subscriber
  realtime_tools::RealtimeThreadSafeBox<TwistStamped> received_velocity_msg_;
  // Save the last reference in case of unable to get value from box
  TwistStamped command_msg_;
 
  std::shared_ptr<rclcpp::Publisher<nav_msgs::msg::Odometry>> odometry_publisher_ = nullptr;
  std::shared_ptr<realtime_tools::RealtimePublisher<nav_msgs::msg::Odometry>>
    realtime_odometry_publisher_;
  nav_msgs::msg::Odometry odometry_message_;
 
  Odometry odometry_;
 
  std::shared_ptr<rclcpp::Publisher<tf2_msgs::msg::TFMessage>> odometry_transform_publisher_ =
    nullptr;
  std::shared_ptr<realtime_tools::RealtimePublisher<tf2_msgs::msg::TFMessage>>
    realtime_odometry_transform_publisher_;
  geometry_msgs::msg::TransformStamped transform_;
 
  void compute_and_set_wheel_velocities();
  const char * feedback_type() const;
  void halt();
  bool reset();
  bool on_set_chained_mode(bool chained_mode) override;
 
  rclcpp::Service<control_msgs::srv::SetOdometry>::SharedPtr set_odom_service_;
  std::atomic<bool> set_odom_requested_{false};
  realtime_tools::RealtimeThreadSafeBox<control_msgs::srv::SetOdometry::Request>
    requested_odom_params_;
 
private:
  void reset_buffers();
};
}  // namespace omni_wheel_drive_controller
 
#endif  // OMNI_WHEEL_DRIVE_CONTROLLER__OMNI_WHEEL_DRIVE_CONTROLLER_HPP_