ros2_control - humble
rrbot_system_multi_interface.hpp
1 // Copyright 2021 Department of Engineering Cybernetics, NTNU
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 #ifndef ROS2_CONTROL_DEMO_EXAMPLE_3__RRBOT_SYSTEM_MULTI_INTERFACE_HPP_
16 #define ROS2_CONTROL_DEMO_EXAMPLE_3__RRBOT_SYSTEM_MULTI_INTERFACE_HPP_
17 
18 #include <chrono>
19 #include <cstdint>
20 #include <memory>
21 #include <string>
22 #include <vector>
23 
24 #include "hardware_interface/handle.hpp"
25 #include "hardware_interface/hardware_info.hpp"
26 #include "hardware_interface/system_interface.hpp"
27 #include "hardware_interface/types/hardware_interface_return_values.hpp"
28 #include "rclcpp/clock.hpp"
29 #include "rclcpp/duration.hpp"
30 #include "rclcpp/logger.hpp"
31 #include "rclcpp/macros.hpp"
32 #include "rclcpp/time.hpp"
33 #include "rclcpp_lifecycle/node_interfaces/lifecycle_node_interface.hpp"
34 #include "rclcpp_lifecycle/state.hpp"
35 
36 namespace ros2_control_demo_example_3
37 {
39 {
40 public:
41  RCLCPP_SHARED_PTR_DEFINITIONS(RRBotSystemMultiInterfaceHardware);
42 
44  const hardware_interface::HardwareInfo & info) override;
45 
46  std::vector<hardware_interface::StateInterface> export_state_interfaces() override;
47 
48  std::vector<hardware_interface::CommandInterface> export_command_interfaces() override;
49 
50  hardware_interface::return_type prepare_command_mode_switch(
51  const std::vector<std::string> & start_interfaces,
52  const std::vector<std::string> & stop_interfaces) override;
53 
55  const rclcpp_lifecycle::State & previous_state) override;
56 
58  const rclcpp_lifecycle::State & previous_state) override;
59 
60  hardware_interface::return_type read(
61  const rclcpp::Time & time, const rclcpp::Duration & period) override;
62 
63  hardware_interface::return_type write(
64  const rclcpp::Time & time, const rclcpp::Duration & period) override;
65 
67 
70  rclcpp::Logger get_logger() const { return *logger_; }
71 
73 
76  rclcpp::Clock::SharedPtr get_clock() const { return clock_; }
77 
78 private:
79  // Parameters for the RRBot simulation
80  double hw_start_sec_;
81  double hw_stop_sec_;
82  double hw_slowdown_;
83 
84  // Objects for logging
85  std::shared_ptr<rclcpp::Logger> logger_;
86  rclcpp::Clock::SharedPtr clock_;
87 
88  // Store the commands for the simulated robot
89  std::vector<double> hw_commands_positions_;
90  std::vector<double> hw_commands_velocities_;
91  std::vector<double> hw_commands_accelerations_;
92  std::vector<double> hw_states_positions_;
93  std::vector<double> hw_states_velocities_;
94  std::vector<double> hw_states_accelerations_;
95 
96  // Enum defining at which control level we are
97  // Dumb way of maintaining the command_interface type per joint.
98  enum integration_level_t : std::uint8_t
99  {
100  UNDEFINED = 0,
101  POSITION = 1,
102  VELOCITY = 2,
103  ACCELERATION = 3
104  };
105 
106  // Active control mode for each actuator
107  std::vector<integration_level_t> control_level_;
108 };
109 
110 } // namespace ros2_control_demo_example_3
111 #endif // ROS2_CONTROL_DEMO_EXAMPLE_3__RRBOT_SYSTEM_MULTI_INTERFACE_HPP_
Definition: system_interface.hpp:73
Definition: rrbot_system_multi_interface.hpp:39
std::vector< hardware_interface::CommandInterface > export_command_interfaces() override
Exports all command interfaces for this hardware interface.
Definition: rrbot_system_multi_interface.cpp:123
hardware_interface::return_type prepare_command_mode_switch(const std::vector< std::string > &start_interfaces, const std::vector< std::string > &stop_interfaces) override
Prepare for a new command interface switch.
Definition: rrbot_system_multi_interface.cpp:140
rclcpp::Logger get_logger() const
Get the logger of the SystemInterface.
Definition: rrbot_system_multi_interface.hpp:70
hardware_interface::CallbackReturn on_init(const hardware_interface::HardwareInfo &info) override
Initialization of the hardware interface from data parsed from the robot's URDF.
Definition: rrbot_system_multi_interface.cpp:31
rclcpp::Clock::SharedPtr get_clock() const
Get the clock of the SystemInterface.
Definition: rrbot_system_multi_interface.hpp:76
hardware_interface::return_type read(const rclcpp::Time &time, const rclcpp::Duration &period) override
Read the current state values from the actuator.
Definition: rrbot_system_multi_interface.cpp:268
std::vector< hardware_interface::StateInterface > export_state_interfaces() override
Exports all state interfaces for this hardware interface.
Definition: rrbot_system_multi_interface.cpp:106
hardware_interface::return_type write(const rclcpp::Time &time, const rclcpp::Duration &period) override
Write the current command values to the actuator.
Definition: rrbot_system_multi_interface.cpp:309
rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn CallbackReturn
Virtual Class to implement when integrating a 1 DoF actuator into ros2_control.
Definition: actuator_interface.hpp:69
This structure stores information about hardware defined in a robot's URDF.
Definition: hardware_info.hpp:106